Jump to content

Recommended Posts

@Raymond - if that's what happens then it is working correctly :-). Blog does not automatically associate permissions and roles. That would be assuming too much. It is left to you to set up. To help you, it creates the role 'blog-author' and a permission 'blog'. The role 'blog-author' is used to find and list, uh, Blog Authors' posts. The permission 'blog' is used to grant view access to the Blog Dashboard.

So, as per normal PW access control setup, you will need to assign roles/permissions to your users at both the access and template level. You can still create additional permissions/roles to fine tune who can post, publish, edit, posts, etc. So, if you want your user to view the dashboard you can add the permission 'blog' to the role 'blog-author' (or any other role you create) and give your user that role. If you want them to access the Blog pages tree, you can do that at the template level. E.g. create a role 'blog-editor', and use that to control template-level permissions for Blog pages (view, edit, delete, etc). You can take advantage of PW's cascading permissions feature (i.e. children inherit parents').

Please note that if you do not want users to be able to delete Blog posts at the template level then you should also not give them access to the Blog Dashboard since they will be able to delete posts anyway. I have not had the need to add such an access control at the Blog Dashboard level beyond checking if they have 'view permission' ('blog') and for the 'Cleanup' utility, that they are supersusers.

  • Like 1

Share this post


Link to post
Share on other sites

Hi Kogondo,

Thanks for the quick reply. Adding the permission 'blog' to the role 'blog-author' look likes its sufficient for my needs. (havent tested it all yet)

Now i only need to do is redirect a logged in user with blog-author role to the blog page after loggin in.

Share this post


Link to post
Share on other sites

Hi,

I would like to add some of my standard fields to the blog templates. These trigger support for generating microdata and so on. Are there any obvious reasons not to do this? Any advice much appreciated!

Cheers.

Share this post


Link to post
Share on other sites

@Gazley. None whatsoever from the point of view of upgrading Blog. Upgrades don't overwrite anything outside /site/modules/ProcessBlog/. Nothing is reinstalled, your content, fields, etc are not affected. You could even rename your Blog pages and it will still work fine. Only two don't dos: don't change the IDs of the main Blog pages in the db and don't rename Blog fields and templates :-)

Share this post


Link to post
Share on other sites

Hi Kongondo,

Thanks for the heads-up! :) That's great to hear - now I can add my little standard "bits and pieces" and all will be well in my world :)

Getting along great with the Blog;  thanks once again for providing such an awesome module!

Cheers.

Share this post


Link to post
Share on other sites

I need to ask a question i need to reformat the content but i don't want to modify the core because when there's an update it would be overwritten and that's bad practice what are my options. I want to be in control of the template without having to hack it. 

Share this post


Link to post
Share on other sites

@Sephiroth, you are in control of the template (files)  :-). Could your question be a bit more specific? If you are referring to the optional demo content - those are just that; demos...

Share this post


Link to post
Share on other sites

@Sephiroth, you are in control of the template (files)  :-). Could your question be a bit more specific? If you are referring to the optional demo content - those are just that; demos...

I might jump in here too and ask the same thing. Hopefully we're asking the same question.

Currently, my /blog/posts/ page lists all my posts in the structure as follows

  • Post Title
  • Posted by Author Name. Date and Time
  • Post summary with ellipses at approx 50 words

If we want to change this to add the contents of a field such as

  • Post Title
  • Post_Summary field
  • Posted by Author Name. Date and Time
  • Post summary with ellipses at approx 50 words

would we need to edit the file called MarkupBlog.module ?

And if so, how is that not overwritten when we perform an update to the Blog module?

Share this post


Link to post
Share on other sites

Thanks @Knight we are both asking the same question but it seems we might have to create a function in our init.php and paste the same code from MarkupBlog in order to change the structure from the code. I want to reformat the markup, because i have a template for the blog and i want it to follow that template structure. 

Share this post


Link to post
Share on other sites

Peter & Sephiroth,

It is trivial to add extra fields pulled from any PW page into the generated output without having to modify the blog module code.

When you call the renderPost() function (or any of the blog functions), you'll get the markup. Using something like QueryPath (http://querypath.org/), you can convert your blog markup into a DOM object that responds to jQuery-like CSS3 selectors and modify the markup, adding whatever you want into the DOM tree. When you are done, then simply call the html() method on the modified QueryPath object and echo the converted markup into your PW template.

I hope this helps.

  • Like 1

Share this post


Link to post
Share on other sites

I'm definitely missing some key logic here. 

If I look at my current blog-post.php template, the entire contents of that template are

<?php 

/**
 * Post template
 * Demo template file populated with MarkupBlog output and additional custom code for a Blog Post
 *
 */

	//CALL THE MODULE - MarkupBlog
	$blog = $modules->get("MarkupBlog");
        
    //subnav
    $subNav = '';
    
    //subnav: get date info for creating link to archives page in subnav
    $date = $page->getUnformatted('blog_date'); 
    $year = date('Y', $date); 
    $month = date('n', $date); 

    //subnav: if there are categories and/or tags, then make a separate nav for them
    if(count($page->blog_categories)) $subNav .= $blog->renderNav(__('Related Categories'), $page->blog_categories); 
    if(count($page->blog_tags)) $subNav .= $blog->renderNav(__('Related Tags'), $page->blog_tags); 

    //subnav: contains authors, archives and categories links
    $authorURL = $pages->get('template=blog-authors')->url;
    $archivesURL = $pages->get('template=blog-archives')->url;

    $subNavItems = array(
                            $authorURL . $page->createdUser->name . "/" => $page->createdUser->get('title|name'), 
                            $archivesURL . $year . "/" . $month . "/" => strftime('%B %Y', $date)
    );

    $subNav .= $blog->renderNav(__('See Also'), $subNavItems);

     //main content
    
    //render a single full post including title, comments, comment form + next/prev posts links, etc
    //$blog->postAuthor(): if available, add 'post author widget' at the end (or at the top if desired) of each post
   // $content = $blog->renderPosts($page) . $blog->renderComments($page->blog_comments) . $blog->renderNextPrevPosts($page);//without post author

    /*
        for this demo, renderComments() has to adapt to whether blog commenting feature was installed or not whilst remaining blog structure/style-agnostic
        in your own blog install, you would know if you enabled the feature so there would be no need for such a check
		in addition, our 'check' code is not code you would normally use in a template file. 
		we use such code here to be both foolproof that the commenting feature is installed and blog structure-agnostic 
    */
    #not foolproof; user could have post-installed custom commenting feature (e.g. Disqus) with a similar field blog_comments
	//$renderComments = $page->template->hasField('blog_comments') ? $blog->renderComments($page->blog_comments) : '';

    $blogConfigs = $modules->getModuleConfigData('ProcessBlog');

    $renderComments = $blogConfigs['commentsUse'] == 1 ? $blog->renderComments($page->blog_comments) : '';   

    $content = $blog->renderPosts($page) . $blog->postAuthor() . $renderComments . $blog->renderNextPrevPosts($page);//with post author widget 	
    
    //include the main/common markup
    require_once("blog-main.inc");

I can see towards the end that Kongondo has a content variable and is outouts

Page

Author

Comments

Next / Previous links

I guess the black hole for me is - where is the html markup which wraps around these? it's not in blog-post.php and we're not supposed to touch blog.module.  ???

Perhaps I'm approaching this with my old MODX mindset and the Articles school of templating where each part of the blog (posts, comments, Tags) had their own mni template with html.

Share this post


Link to post
Share on other sites

For now due to time will work with this, but might have to create a different module that allows control over the template. sadly no free time.

Share this post


Link to post
Share on other sites

Here is my blog-post template:

<?php

$spex->setLayout('two-column');

$blog = $modules->get('MarkupBlog');

$blogPost = $blog->renderPosts($page, false, [ 'post_large_headline_tag' => 'h1', 'post_comments' => 0 ]);

$dom = $modules->get('BlogMicrodata');

echo $spex->partial('blog_post', [ 'blog_post' => $dom->enrich($blogPost) ]);

$spex->slot('sidebar_content', $spex->partial('blog_categories') . $spex->partial('blog_tags'));

?>

<?php $spex->docReady() ?>

<?php $spex->docReady() ?>

I'm simply calling renderPost(), passing its output into my module (BlogMicrodata) via $dom->enrich($blogPost) (which decorates the blog markup with microdata) that in turn is passed into a partial, that in turn is echoed into a template called "two-column".

I've chosen to use the Spex module for my templating mechanism. Irrespective, it all resolves into a target DIV in a PHP file. All of the blog markup is returned from renderPosts(). All you need to do is echo that markup into your wrapper template.

Share this post


Link to post
Share on other sites

@ kongondo: I experience a problem truncating posts.

When I render renderPosts like you described on your blog. All posts truncate fine. When I use the included template posts will not truncate. I only altered blog-main.

blog-main

<?php
    $topNavItems = array();
    $templates = array('blog-archives');
    foreach ($templates as $t) {

        $p = $pages->get("template=$t");
        if($p->id)  $topNavItems[] = $p;
    }
    $topNav = $blog->renderNav('', $topNavItems, $page);
?>
<?php include("./head.inc"); ?> 

<div class="container blog-container">
	<div class="row">
		<div class="col-md-8">
			<div class="row">
				<div class="col-md-12">
					<h2>Blog</h2>
				</div>
			</div>
			<div class="row">
				<div class="col-md-12">
					<?php
					$noAuthor = $pages->get('template=blog-widget-basic, name=post-author, include=all')->is(Page::statusUnpublished) ? ' no-author' : '';
            		?>		
					<div><?php echo $content?></div>
				</div>
			</div>
		</div>
		
		<div class="col-md-4 link6 hidden-xs" id="blog-col-sidebar">
			<p id="zoekblog">Zoek in:</p>
			<div id="top-nav"><?php echo $topNav;?></div>
		</div>
	</div>
</div>

<?php include("./foot.inc"); ?>  

blog-posts (did not changed this template, renderpost is set to true )

    //main content
    $content = '';
    $content .= "<h2>{$page->get('blog_headline|title')}</h2>";
    //render a limited number of summarised posts
    $content .= $blog->renderPosts("limit=5", true); 

 This is my output

Share this post


Link to post
Share on other sites

Hi @toothpaste,

To prove it out, why not try something like this

$posts = $pages->find('template=blog-post, limit=5');

and see whether you get the page posts you expect in the page array.

If you do, then try this:

$content .= $blog->renderPosts($posts, true);
  • Like 1

Share this post


Link to post
Share on other sites

Found the problem. The Blog page is linked to blog.php. Changed

$content .= $blog->renderPosts("limit=$limit");

to

$content .= $blog->renderPosts("limit=$limit,true");

Sorry...., dumb of me. Got to learn more about the structure of the template demo files.

  • Like 1

Share this post


Link to post
Share on other sites

Thanks @Knight we are both asking the same question but it seems we might have to create a function in our init.php and paste the same code from MarkupBlog in order to change the structure from the code. I want to reformat the markup, because i have a template for the blog and i want it to follow that template structure. 

Still curious exactly what your template structure looks like...

Share this post


Link to post
Share on other sites

I'm definitely missing some key logic here. 

If I look at my current blog-post.php template, the entire contents of that template are

<?php 
    
    //include the main/common markup
    require_once("blog-main.inc");

I can see towards the end that Kongondo has a content variable and is outouts

Page

Author

Comments

Next / Previous links

I guess the black hole for me is - where is the html markup which wraps around these? it's not in blog-post.php and we're not supposed to touch blog.module.  ???

Perhaps I'm approaching this with my old MODX mindset and the Articles school of templating where each part of the blog (posts, comments, Tags) had their own mni template with html.

The HTML comes from two places:

1. From the various render methods in MarkupBlog (e.g., have a look at renderPosts())

2. From blog-main.inc - we inject variables we have previously set in this file, e.g. $content

<div id="main" class="block<?php echo $noAuthor?>"><?php echo $content?></div> <!-- #main -->

Share this post


Link to post
Share on other sites

For now due to time will work with this, but might have to create a different module that allows control over the template. sadly no free time.

I've been looking at creating my own templates and test pages and adding some much more lo-fi / basic code.

As Kongondo says, the templates provided are just examples and you could output any markup you wish by making your own templates.

For example, if you wish to create your own blog-post.php template, you can make a template called blog-post-custom.php etc and manually call a few fields.

Here's the body of an extremley basic blog post template. It relies less on variables within other files and includes. 

<!-- Get the title in a H3 tag-->
   <h3><?php echo $page->title; ?></h3>

<!-- Get the body -->
   <?php echo $page->blog_body; ?>

<!-- Get the comments -->
   <?php echo $page->blog_comments->render(); ?>

<!-- Get the comment form -->
   <?php echo $page->blog_comments->renderForm(); ?>

               

Likely it bypasses much Kongondos genius but this would actually suffice for my requirements. 

I'm not sure how I would grab the number of comments this page has but I'll figure it out.

  • Like 1

Share this post


Link to post
Share on other sites

I might jump in here too and ask the same thing. Hopefully we're asking the same question.

Currently, my /blog/posts/ page lists all my posts in the structure as follows

  • Post Title
  • Posted by Author Name. Date and Time
  • Post summary with ellipses at approx 50 words

If we want to change this to add the contents of a field such as

  • Post Title
  • Post_Summary field
  • Posted by Author Name. Date and Time
  • Post summary with ellipses at approx 50 words

would we need to edit the file called MarkupBlog.module ?

And if so, how is that not overwritten when we perform an update to the Blog module?

Not in this particular case, but there are times when a str_replace would suffice. In this case it would be a bit hacky :-)....

Btw, is a 'summary field' like this a common feature of Blogs?

Anyway, your question got me thinking, so thanks for asking :-)....Given your example, there's maybe 3 options to enable you to inject your custom fields inside Blog Markup (i.e. modify the markup server-side).

Option 1. Add an post_extra_fields => array()

I could add an 'array option' in renderPosts() 3rd argument, i.e. $options for specifying any extra fields (that return strings) that a user might want to inject in their markup (e.g. your post_summary field), i.e. a post_extra_fields => array()

$options = array(

                    'post_small_image' => 3,
                    'post_small_image_width' => 250,
                    'post_comments_label'=>'',
                    'post_extra_fields' => array('post_summary' => 1, 'post_teaser' => 4, 'post_other_field' => 3);
);

The numbers in the values inside 'post_extra_fields' (e.g. 1 in 'post_summary') refer to the position (see illustration below) where you want that extra field to appear within the Blog Post

post-894-0-33757900-1419103558_thumb.png

Option 2. Add other methods to output various parts of Blog Posts

In this option, those who wish to use renderPosts() can do so but those who want finer control can use these other methods, i.e.

renderPostTitle()

renderPosByline()

renderPostBody()

renderPostCategories()

renderPostTags()

.....but hold it right there. What is wrong with this picture? renderPostTitle()! Why create a method to do what ProcessWire already does ($page->title) and does well!? :D Option #2 (and probably the first one too) is dead in the water and I'll show you why in option #3 below.

Option 3. Use both native ProcessWire methods/properties and MarkupBlog methods as applicable

I will need to put this in the Blog Docs as well. What I should have been clear about in the Blog Docs is that you do not have to use renderPosts() to output the main content of your Blog Post (i.e., post title, post body, etc). You can, if it suits your needs, use native PW methods/properties, especially if you want full control over your Posts structure and Markup. Nothing stops you from combining these with MarkupBlog methods. For instance, you can use MarkupBlog to render your Blog's tags, categories, authors, archives, etc but use ProcessWire methods/properties to render your Blog Post including adding content from any other extra fields you have anywhere on your site. 

So instead of:

$content = $blog->renderPosts($page, '', $options) . $blog->postAuthor() . $blog->renderComments($page->blog_comments) . $blog->renderNextPrevPosts($page);//with post author

in your blog-post.php...you can have:

$content = $body . $blog->postAuthor() . $blog->renderComments($page->blog_comments) . $blog->renderNextPrevPosts($page);//with post author

..where $body is a variable holding your custom content (blog_body, post_summary, $page->title, etc). I will write a full example in a post below.

So, back to the original question. How do we inject extra content or have full control over our Blog Post Markup if we do not want to or cannot use str_replace, etc.? Use option #3. Unless convinced otherwise, this is the option I will be recommending (hence, for now at least, will not be adding option #1 to renderPosts()).

OK, let me finish writing the example option #3...

  • Like 2

Share this post


Link to post
Share on other sites

Btw, is a 'summary field' like this a common feature of Blogs?

Think it depends on the designer/developer.

I like to have a summary on blog-posts at least as sometimes you wish to keep the title short but then have a longer summary.

Originally, I did that for SEO reasons too.

Share this post


Link to post
Share on other sites

........I'm not sure how I would grab the number of comments this page has but I'll figure it out.

:-)

$numComments = $page->blog_comments->count();

OK, let me finish writing the example option #3...

@Peter beat me to it...https://processwire.com/talk/topic/7403-module-blog/?p=83118

If anybody else wants more examples let me know...

  • Like 1

Share this post


Link to post
Share on other sites

If anybody else wants more examples let me know...

Can you point me in the right direction for mirroring a list of pages by say, archive (month) or authors or categories.

For example, the Archives page might have:

December 2014

Post 1 Title

Post 2 Title

November 2013

Post 1 Title

Post 2 Title

For example, the Categories page might have:

Category A

Post 1 Title

Post 2 Title

Category B

Post 1 Title

Post 2 Title

In MarkupBlog Module, you're using this. is it less verbose if it's done with native PW methods?

	public function renderArchives(Array $years, Array $options = null) {

		$out = '';

		//default options for archives
		$defaultOptions = array(

							'archives_posts_text' =>$this->_('post,posts'),//come in the format 'singular,plural' for e.g. October 5 'posts'
							'archives_month_view_all_text' => $this->_('View All'),//'view all' that month's archives if limit set on amount to list
		);

		//merge user options with default archives options
		if($options != null && is_array($options)) $options = array_merge($defaultOptions, $options);
		else $options = $defaultOptions;

		list($singular, $plural) = explode(',', $options['archives_posts_text']);//come in the format 'singular,plural'	
		$post = '%d ' . $singular;
		$posts = '%d ' . $plural;

		foreach($years as $year=>$y) {
			
				$year 	=  $y['name'];
				$total 	=  $y['total']; 
				$months =  $y['months'];//this is an array
				$url 	=  $y['url']; 

				$out .= "<div class='archive'>
						<h3><a href='$url'>$year</a></h3>
						<span class='num-posts'>" . sprintf(_n($post, $posts, $total), $total) . "</span>";
						

				$out .= "<ul class='posts-group'>";

				foreach($months as $monthNum => $month){

							$out .= "<li><a href='" . $month['url'] . "'>" . $month['name'] . "</a>";
							$out .=  "<span class='num-posts'>" . sprintf(_n($post, $posts, $month['total']), $month['total']) . "</span>";

							if(count($month['posts'])) {//posts will be empty if $blog->archives() call specified 0 for limit;

									$out .= "<ul>";

									foreach($month['posts'] as $item){
											
											$out .= "<li><a href='$item->url'>$item->title</a></li>";
									}

									if($month['total'] > count($month['posts'])){
											
											$out .= "<li><a class='more' href='" . $month['url'] . "'>" . $options['archives_month_view_all_text'] . "</a></li>";
									}

									$out .=  "</ul>";

							}

							$out .=  "</li>";

				}//end foreach $months as $monthNum

				$out .= "</ul></div>";

		}//end foreach $years as $year

		return $out; 
	}

Share this post


Link to post
Share on other sites

@Peter, I am afraid I don't follow :-)...Isn't that what you already have? What do you mean mirroring pages? And where?...I'm just slow that way  :P

Share this post


Link to post
Share on other sites

@kongondo: I'am running your blog and like it a lot. At this point I would like to add the option so people can give a comment. But I installed the blog without the comment feature.

Is it possible enable comments without starting over and install a fresh blog?

post-2698-0-05624500-1419423006_thumb.pn

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 bernhard
      DEPRECATED
      I'm using this module in several projects, but it will likely not see any updates in the future. I'm not happy with it and I'm looking for ways to develop better solutions. RockTabulator was my first try, but I'm also not 100% happy with that. The tabulator library is great, but my module implementation is not. I hope to get a good solution soon, but it will be a lot of work...
      ---
      Some of you might have followed the development of this module here: https://processwire.com/talk/topic/15524-previewdiscussion-rockdatatables/ . It is the successor of "RockDataTables" and requires RockFinder to get the data for the grid easily and efficiently. It uses the open source part of agGrid for grid rendering.
       
      WHY?
      ProcessWire is awesome for creating all kinds of custom backend applications, but where it is not so awesome in my opinion is when it comes to listing this data. Of course we have the built in page lister and we have ListerPro, but none of that solutions is capable of properly displaying large amounts of data, for example lists of revenues, aggregations, quick and easy sorts by the user, instant filter and those kind of features. RockGrid to the rescue 😉 
       
      Features/Highlights:
      100k+ rows Instant (client side) filter, search, sort (different sort based on data type, eg "lower/greater than" for numbers, "contains" for strings) extendable via plugins (available plugins at the moment: fullscreen, csv export, reload, batch-processing of data, column sum/statistics, row selection) all the agGrid features (cell renderers, cell styling, pagination, column grouping etc) vanilla javascript, backend and frontend support (though not all plugins are working on the frontend yet and I don't plan to support it as long as I don't need it myself)  
      Limitations:
      While there is an option to retrieve data via AJAX the actual processing of the grid (displaying, filtering, sorting) is done on the client side, meaning that you can get into troubles when handling really large datasets of several thousands of rows. agGrid should be one of the most performant grid options in the world (see the official example page with a 100k row example) and does a lot to prevent problems (such as virtual row rendering), but you should always have this limitation in mind as this is a major difference to the available lister options that do not have this limitation.
      Currently it only supports AdminThemeUikit and I don't plan to support any other admin theme.
       
      Download: https://gitlab.com/baumrock/FieldtypeRockGrid
      Installation: https://gitlab.com/baumrock/RockGrid/wikis/Installation
      Quikckstart: https://gitlab.com/baumrock/RockGrid/wikis/quickstart
      Further instructions: https://gitlab.com/baumrock/RockGrid/wikis/quickstart#further-instructions
      German Translation File: site--modules--fieldtyperockgrid--fieldtyperockgrid-module-php.json
      Changelog: https://gitlab.com/baumrock/FieldtypeRockGrid/raw/master/changelog.md
       
      Module status: alpha, License: MIT
      Note that every installation and uninstallation sends an anonymous google analytics event to my google analytics account. If you don't want that feel free to remove the appropriate lines of code before installation/uninstallation.
       
      Contribute:
      You can contribute to the development of this and other modules or just say thank you by
      testing, reporting issues and making PRs at gitlab liking this post buying me a drink: paypal.me/baumrock/5 liking my facebook page: facebook.com/baumrock hiring me for pw work: baumrock.com  
      Support: Please note that this module might not be as easy and plug&play as many other modules. It needs a good understanding of agGrid (and JavaScript in general) and it likely needs some looks into the code to get all the options. Please understand that I can not provide free support for every request here in the forum. I try to answer all questions that might also help others or that might improve the module but for individual requests I offer paid support (please contact me via PM).
       
      Use Cases / Examples:
      Colored grid cells, Icons, Links etc. The Grid also has a "batcher" feature built in that helps communicating with the server via AJAX and managing resource intensive tasks in batches:

      Filters, PW panel links and instant reload on panel close:

      You can combine the grid with a chart library like I did with the (outdated) RockDataTables module:

    • By Paul Greinke
      Hi there. I wrote a custom module for one of my projects. In fact I maybe want to use my module in other projects too. In order to be variable and customizable  I need to implement some custom hooks into my module. So I can afterwards hook into the my functions in order to modify them to match the needs of the new project.
      I tried simply defining functions with the '__' prefix. But that did not work. I'm imagining something like the following:
      <?php class MyClass { public function ___someFunction() { // Do something } } // ready.php $this->addHookBefore('MyClass::someFunction', function($event) { // some customization }); Is there a way to accomplish that? 
    • By adrian
      Hi everyone,
      Here's a new module that I have been meaning to build for a long time.
      http://modules.processwire.com/modules/process-admin-actions/
      https://github.com/adrianbj/ProcessAdminActions
       
      What does it do?
      Do you have a bunch of admin snippets laying around, or do you recreate from them from scratch every time you need them, or do you try to find where you saw them in the forums, or on the ProcessWire Recipes site?
      Admin Actions lets you quickly create actions in the admin that you can use over and over and even make available to your site editors (permissions for each action are assigned to roles separately so you have full control over who has access to which actions).
       
      Included Actions
      It comes bundled with several actions and I will be adding more over time (and hopefully I'll get some PRs from you guys too). You can browse and sort and if you have @tpr's Admin on Steroid's datatables filter feature, you can even filter based on the content of all columns. 

      The headliner action included with the module is: PageTable To RepeaterMatrix which fully converts an existing (and populated) PageTable field to either a Repeater or RepeaterMatrix field. This is a huge timesaver if you have an existing site that makes heavy use of PageTable fields and you would like to give the clients the improved interface of RepeaterMatrix.
      Copy Content To Other Field
      This action copies the content from one field to another field on all pages that use the selected template.
      Copy Field Content To Other Page
      Copies the content from a field on one page to the same field on another page.
      Copy Repeater Items To Other Page
      Add the items from a Repeater field on one page to the same field on another page.
      Copy Table Field Rows To Other Page
      Add the rows from a Table field on one page to the same field on another page.
      Create Users Batcher
      Allows you to batch create users. This module requires the Email New User module and it should be configured to generate a password automatically.
      Delete Unused Fields
      Deletes fields that are not used by any templates.
      Delete Unused Templates
      Deletes templates that are not used by any pages.
      Email Batcher
      Lets you email multiple addresses at once.
      Field Set Or Search And Replace
      Set field values, or search and replace text in field values from a filtered selection of pages and fields.
      FTP Files to Page
      Add files/images from a folder to a selected page.
      Page Active Languages Batcher
      Lets you enable or disable active status of multiple languages on multiple pages at once.
      Page Manipulator
      Uses an InputfieldSelector to query pages and then allows batch actions on the matched pages.
      Page Table To Repeater Matrix
      Fully converts an existing (and populated) PageTable field to either a Repeater or RepeaterMatrix field.
      Template Fields Batcher
      Lets you add or remove multiple fields from multiple templates at once.
      Template Roles Batcher
      Lets you add or remove access permissions, for multiple roles and multiple templates at once.
      User Roles Permissions Batcher
      Lets you add or remove permissions for multiple roles, or roles for multiple users at once.
       
      Creating a New Action
      If you create a new action that you think others would find useful, please add it to the actions subfolder of this module and submit a PR. If you think it is only useful for you, place it in /site/templates/AdminActions/ so that it doesn't get lost on module updates.
      A new action file can be as simple as this:
      class UnpublishAboutPage extends ProcessAdminActions { protected function executeAction() { $p = $this->pages->get('/about/'); $p->addStatus(Page::statusUnpublished); $p->save(); return true; } } Each action:
      class must extend "ProcessAdminActions" and the filename must match the class name and end in ".action.php" like: UnpublishAboutPage.action.php the action method must be: executeAction() As you can see there are only a few lines needed to wrap the actual API call, so it's really worth the small extra effort to make an action.
      Obviously that example action is not very useful. Here is another more useful one that is included with the module. It includes $description, $notes, and $author variables which are used in the module table selector interface. It also makes use of the defineOptions() method which builds the input fields used to gather the required options before running the action.
      class DeleteUnusedFields extends ProcessAdminActions { protected $description = 'Deletes fields that are not used by any templates.'; protected $notes = 'Shows a list of unused fields with checkboxes to select those to delete.'; protected $author = 'Adrian Jones'; protected $authorLinks = array( 'pwforum' => '985-adrian', 'pwdirectory' => 'adrian-jones', 'github' => 'adrianbj', ); protected function defineOptions() { $fieldOptions = array(); foreach($this->fields as $field) { if ($field->flags & Field::flagSystem || $field->flags & Field::flagPermanent) continue; if(count($field->getFieldgroups()) === 0) $fieldOptions[$field->id] = $field->label ? $field->label . ' (' . $field->name . ')' : $field->name; } return array( array( 'name' => 'fields', 'label' => 'Fields', 'description' => 'Select the fields you want to delete', 'notes' => 'Note that all fields listed are not used by any templates and should therefore be safe to delete', 'type' => 'checkboxes', 'options' => $fieldOptions, 'required' => true ) ); } protected function executeAction($options) { $count = 0; foreach($options['fields'] as $field) { $f = $this->fields->get($field); $this->fields->delete($f); $count++; } $this->successMessage = $count . ' field' . _n('', 's', $count) . ' ' . _n('was', 'were', $count) . ' successfully deleted'; return true; } }  
      This defineOptions() method builds input fields that look like this:

      Finally we use $options array in the executeAction() method to get the values entered into those options fields to run the API script to remove the checked fields.
      There is one additional method that I didn't outline called: checkRequirements() - you can see it in action in the PageTableToRepeaterMatrix action. You can use this to prevent the action from running if certain requirements are not met.
      At the end of the executeAction() method you can populate $this->successMessage, or $this->failureMessage which will be returned after the action has finished.
       
      Populating options via URL parameters
      You can also populate the option parameters via URL parameters. You should split multiple values with a “|” character.
      You can either just pre-populate options:
      http://mysite.dev/processwire/setup/admin-actions/options?action=TemplateFieldsBatcher&templates=29|56&fields=219&addOrRemove=add
      or you can execute immediately:
      http://mysite.dev/processwire/setup/admin-actions/execute?action=TemplateFieldsBatcher&templates=29|56&fields=219&addOrRemove=add

      Note the “options” vs “execute” as the last path before the parameters.
       
      Automatic Backup / Restore
      Before any action is executed, a full database backup is automatically made. You have a few options to run a restore if needed:
      Follow the Restore link that is presented after an action completes Use the "Restore" submenu: Setup > Admin Actions > Restore Move the restoredb.php file from the /site/assets/cache/AdminActions/ folder to the root of your site and load in the browser Manually restore using the AdminActionsBackup.sql file in the /site/assets/cache/AdminActions/ folder I think all these features make it very easy to create custom admin data manipulation methods that can be shared with others and executed using a simple interface without needing to build a full Process Module custom interface from scratch. I also hope it will reduce the barriers for new ProcessWire users to create custom admin functionality.
      Please let me know what you think, especially if you have ideas for improving the interface, or the way actions are defined.
       
       
    • By joshua
      ---
      Module Directory: https://modules.processwire.com/modules/privacy-wire/
      Github: https://github.com/blaueQuelle/privacywire/
      Packagist:https://packagist.org/packages/blauequelle/privacywire
      Module Class Name: PrivacyWire
      Changelog: https://github.com/blaueQuelle/privacywire/blob/master/Changelog.md
      ---
      This module is (yet another) way for implementing a cookie management solution.
      Of course there are several other possibilities:
      - https://processwire.com/talk/topic/22920-klaro-cookie-consent-manager/
      - https://github.com/webmanufaktur/CookieManagementBanner
      - https://github.com/johannesdachsel/cookiemonster
      - https://www.oiljs.org/
      - ... and so on ...
      In this module you can configure which kind of cookie categories you want to manage:

      You can also enable the support for respecting the Do-Not-Track (DNT) header to don't annoy users, who already decided for all their browsing experience.
      Currently there are four possible cookie groups:
      - Necessary (always enabled)
      - Functional
      - Statistics
      - Marketing
      - External Media
      All groups can be renamed, so feel free to use other cookie group names. I just haven't found a way to implement a "repeater like" field as configurable module field ...
      When you want to load specific scripts ( like Google Analytics, Google Maps, ...) only after the user's content to this specific category of cookies, just use the following script syntax:
      <script type="text/plain" data-type="text/javascript" data-category="statistics" data-src="/path/to/your/statistic/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="marketing" data-src="/path/to/your/mareketing/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="external_media" data-src="/path/to/your/external-media/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="marketing">console.log("Inline scripts are also working!");</script> The data-attributes (data-type and data-category) are required to get recognized by PrivacyWire. the data-attributes are giving hints, how the script shall be loaded, if the data-category is within the cookie consents of the user. These scripts are loaded asynchronously after the user made the decision.
      If you want to give the users the possibility to change their consent, you can use the following Textformatter:
      [[privacywire-choose-cookies]] It's planned to add also other Textformatters to opt-out of specific cookie groups or delete the whole consent cookie.
      You can also add a custom link to output the banner again with a link / button with following class:
      <a href="#" class="privacywire-show-options">Show Cookie Options</a> <button class="privacywire-show-options">Show Cookie Options</button>  
      I would love to hear your feedback 🙂
      CHANGELOG
      You can find the always up-to-date changelog file here.
    • By joshua
      As we often use Matomo (former known as Piwik) instead of Google Analytics we wanted to embed Matomo not only in the template code but also via the ProcessWire backend.
      That's why I developed a tiny module for the implementation.
      The module provides the possibility to connect to an existing Matomo installation with the classical site tracking and also via the Matomo Tag Manager.
      If you have also PrivacyWire installed, you can tell MatomoWire to only load the script, if the user has accepted cookies via PrivacyWire.
      To offer an Opt-Out solution you can choose between the simple Opt-Out iFrame, delivered by your Matomo installation, or a button to choose cookies via PrivacyWire.
      You'll find the module both in the module directory and via github:
      ProcessWire Module Directory MatomoWire @ GitHub MatomoWire @ Packagist ->installable via composer require blauequelle/matomowire I'm looking forward to hear your feedback!


×
×
  • Create New...