Jump to content
ryan

Hanna Code

Recommended Posts

It's render($field), not render([

]). So jmartsch example is little off.

Actually doesn't work. But with the fix both work.

Share this post


Link to post
Share on other sites

Thanks guys, and sorry about the bug there. The problem was actually not what was highlighted above, but this line: 

public function render($value) {
  $value = $this->formatValue(new NullPage(), new Field(), $value); // this line
  return $value; 
}
...is supposed to be this:
public function render($value) {
  $this->formatValue(new NullPage(), new Field(), $value); // this line
  return $value; 
}

The formatValue function accepts $value as reference, not a separate copy (i.e. &$value rather than $value). So the line that blanks out $this->value is intentional. The point of that is to clear the memory, ensuring the module doesn't keep a separate copy of the text, since it no longer is working with it. So if you commented that line, I would uncomment it again. Actually I'm updating the source to fix the issue now, so you can also just grab the latest version. 

  • Like 2

Share this post


Link to post
Share on other sites

Hey Ryan. Thanks for the quick fix :)

Now the PHP example works, but why can´t we use Hanna Code directly in our template files just by using [[name_of_hanna_code_snippet]]?

Are there performance issues?

  • Like 1

Share this post


Link to post
Share on other sites

Another problem.

If i set Hanna Code Text Formatter for the field body and then want to output the body field in my template via PHP, all other code from my Hanna Code snippet is overwritten. Only the field $page->body appears.

To clarify, here is what i got:

Field with the name body -> Text Formatter: Hanna Code Text Formatter

Hanna code:

!HannaCode:newsdetails:eyJuYW1lIjoibmV3c2RldGFpbHMiLCJ0eXBlIjoiMiIsImNvZGUiOiJlY2hvICRwYWdlLT50aXRsZTtcclxuXHJcblxyXG5pZigkcGFnZS0+dGh1bWJuYWlsKXtcclxuXHQkaW1hZ2UgPVwiPGEgaHJlZj0neyRwYWdlLT50aHVtYm5haWwtPnVybH0nIGNsYXNzPSdsaWdodGJveCc+XCI7XHJcblx0JGltYWdlIC49XCI8aW1nIGNsYXNzPSdwdWxsLXJpZ2h0IGltZy1wb2xhcm9pZCcgc3JjPSd7JHBhZ2UtPnRodW1ibmFpbC0+d2lkdGgoMjAwKS0+dXJsfSc+XCI7XHJcblx0XHRcdFx0XHRcL1wvICRpbWFnZSAuPVwiPGltZyBjbGFzcz0ncHVsbC1yaWdodCBpbWctcG9sYXJvaWQnIHNyYz0neyRwYWdlLT50aHVtYm5haWwtPmdldFRodW1iKHRodW1ibmFpbCl9Jz5cIjtcclxuXHQkaW1hZ2UgLj1cIjxcL2E+XCI7XHJcbn1cclxuXHJcbmVjaG8gJGltYWdlO1xyXG5lY2hvICRwYWdlLT5ib2R5O1x0In0=/!HannaCode

here is the PHP for the Hanna Code:

echo $page->title;

if($page->thumbnail){
	$image ="<a href='{$page->thumbnail->url}' class='lightbox'>";
	$image .="<img class='pull-right img-polaroid' src='{$page->thumbnail->width(200)->url}'>";
					// $image .="<img class='pull-right img-polaroid' src='{$page->thumbnail->getThumb(thumbnail)}'>";
	$image .="</a>";
}

echo $image;
echo $page->body;

template newsdetail.php

<?php
$hanna = $modules->get('TextformatterHannaCode'); 
echo $hanna->render('[[newsdetails]]');
?>

When i open the page, only the contents of the body field appear.

No Hanna Code is actually used in the body field. Just plain text!!!!

If i remove the text formatter for the body field, everything works fine.

But sometimes i want to use Hanna Code in my body field as well.

So how do i do that?

Share this post


Link to post
Share on other sites

Now the PHP example works, but why can´t we use Hanna Code directly in our template files just by using [[name_of_hanna_code_snippet]]?

Are there performance issues?

Actually you could do this by hooking $hanna->render() into Page::render. But I don't recommend it because then you always have to filter for Hanna Codes in any user input that gets echoed back to the screen. Basically, it just opens up security issues that would be potentially difficult for someone to keep track of. It's a lot safer to be specific and just render Hanna Codes in the blocks of content you intend. 

When i open the page, only the contents of the body field appear.

No Hanna Code is actually used in the body field. Just plain text!!!!

The problem I can see with your Hanna Code is that it's echoing $page->body. Your Hanna Code should only echo what actually replaces the tag. Maybe that's what you want when you do a call like $hanna->render("[[newdetails]]"); but that's definitely not what you want to be textformatting your $page->body field -- seems like that could potentially result in an infinite loop.

Share this post


Link to post
Share on other sites

I've posted an update to Hanna Code to address some of the things brought up earlier:

  • It now comes with a proper code editor (Ace Editor). You can configure the theme and editor height in the ProcessHannaCode module settings. 
  • There is now a "Save & Test" option. When you click that, it will save then attempt to run the Hanna code. This is primarily useful for determining if you have any PHP parse errors or the like. 
  • The default behavior of "Save" is now to continue editing, rather than going back to the list of Hanna codes. There is now a separate "Save & Exit" button to do that. 
  • The interface now uses tabs. 

post-2-0-18368200-1375715945_thumb.png

post-2-0-74838800-1375715954_thumb.png

post-2-0-11747200-1375715964_thumb.png

  • Like 2

Share this post


Link to post
Share on other sites

Just tested on 2.3.2.

Save does not continue editing; instead, it saves then goes to the add new Hanna Code screen  :)

Edit:

The above refers to when you create a new Hanna Code. I was expecting save to let me continue editing; however, it takes me to the add new screen. In the case of existing Hanna Codes, if I edit them, save works as stated; I can continue editing. 

Edited by kongondo

Share this post


Link to post
Share on other sites
The above refers to when you create a new Hanna Code. I was expecting save to let me continue editing; however, it takes me to the add new screen. In the case of existing Hanna Codes, if I edit them, save works as stated; I can continue editing. 

Oops. Just fixed. :) Thanks. 

Share this post


Link to post
Share on other sites

Thanks, will test.

Btw, does it matter that the folder name has changed from TextformatterHannaCode to ProcessHannaCode from the point of view of installing/updating via Modules Manager? I recently got a gotcha when updating a module (I think it was PageDelete) who's folder name had changed to ProcessPageDelete or similar). I got a cannot redeclare class fatal error. What happened is that the update did not replace the old folder, hence, the class was getting called twice. Maybe the module name had changed as well, come to think of it..

Edited by kongondo

Share this post


Link to post
Share on other sites
Btw, does it matter that the folder name has changed from TextformatterHannaCode to ProcessHannaCode from the point of view of installing/updating via Modules Manager? I recently got a gotcha when updating a module (I think it was PageDelete) who's folder name had changed to ProcessPageDelete or similar). I got a cannot redeclare class fatal error. What happened is that the update did not replace the old folder, hence, the class was getting called twice. Maybe the module name had changed as well, come to think of it..

It's best that the directory name and filename don't change after it's installed. It should be uninstalled first, deleted, then re-installed, if such things change. I

It looks like I've got a disconnect between the class name listed on the modules directory and the repository name at GitHub. The class name listed in the modules directory is what should be used for the directory name (TextformatterHannaCode). Though you certainly could install it under ProcessHannaCode too, but this would confuse the modules manager (including the built-in one). So I recommend using a folder name of TextformatterHannaCode for compatibility with the modules directory.

Share this post


Link to post
Share on other sites

Ryan, is there a reason why I have to use echo instead of my preferred approach to using php when templating? i.e.:

<?
if ($page->rootParent->numChildren > 0) {
?>
	<nav>
		<ul class="subnav">
		<? 
		foreach($page->rootParent->children as $child) { 
		?>
			<li <? if($page === $child) echo 'class="active"' ?> ><a href='<?= $child->url ?>'><?= $child->title ?></a></li>
		<? 
		} 
		?>
		</ul><!-- /subnav -->
	</nav>
<?
}
?>

I really prefer the markup-first approach to keep the markup as structured and readable as possible (well, at least to my eyes). I'd hate to have to convert all of my code snippets in order to use them with hanna code.

Share this post


Link to post
Share on other sites

When you specify PHP as the type, then the Hanna code is a block of PHP. But you should be able to specify a closing PHP tag like ?> and then be in your HTML. If that does not work, start your Hanna code with: <?php ?>, which should prevent Hanna code from automatically inserting an opening PHP tag, and leave you in HTML.

  • Like 2

Share this post


Link to post
Share on other sites

Hey Ryan,

How would you recommend using Hanna code to wrap a larger amount of markup? For example, if a client wants to create a two column layout within a body section. E.g. In TinyMCE:

[[col2 content=

This is a block of content...

]]

This seems to work with the following simple PHP as a hanna code tag:

<?php echo "<div class=\"column\">\n".trim($content)."\n</div>\n"; ?>

When its output, I get invalid formatting much like this: (with closing and opening tags still being output due to breaks in hanna code tag within TinyMCE.

<div class="column"></p><p>This is content</p><p></div>

Would there be a way to create a hanna code tag wrapper type?

E.g.

[[col2]]

This is a block of content...

[[/col2]]

  • Like 2

Share this post


Link to post
Share on other sites

@ryanscherler

i've been doing that sort of thing by just using 2 hanna codes, one for the opening markup and one for the closing markup;

like this:

[[col2]]

This is a block of content...

[[_col2]]

eventually if the shortcodes module supports more than 1 shortcode per page, then this would be pretty easy to do with shortcode;

the biggest thing i'm lacking now in terms of hanna/shortcode is with respect to tabs and accordions, and being able to sometimes put a set of tabs inside a body content;

like this:

[[tab title=Tab 1]]

Tab content 1

[[tab title=Tab 2]]

tab content 2

[[/tabs]]

  • Like 1

Share this post


Link to post
Share on other sites

sometimes though you need to be able to just put in a section of a body with 2 columns, so repeaters are less flexible; and also a lot of sites i do have flexible column layouts like 1/3 - 2/3 or 1/5 - 4/5

shortcodes work ok for columns, but can be tricky with hanna codes if you need a column wrapper

[[columns]]

[[column50]]

text

[[_column]]

[[column50]]

text

[[_column]]

[[_columns]]

Share this post


Link to post
Share on other sites

Other possibility:

[[page rendered]] <--- actual $page (wrapper)

    // child page, 2 rows in repeater
    [col-50]txt[/col-50] - [col50]txt[/col50]

    // child page, 3 rows in repeater
    [col-33]txt[/col-33] - [col-33]txt[/col-33] - [col33]txt[/col33]

    // child page, 1 row in repeater
    [col-100]txt[/col-100]

    // child page, 4 rows in repeater
    [col-25]txt[/col-25] - [col-25]txt[/col-25] - [col-25]txt[/col-25] - [col-25]txt[/col-25]

[[/page rendered]]

Share this post


Link to post
Share on other sites

i get it.. that's a cool idea; but maybe a simple hanna code in combo with this:

http://welcome.totheinter.net/columnizer-jquery-plugin/

could be really the way to go for columns...

you could setup the js for some different columns and then use hanna for placing the div with the correct class before and after the text... then you could do this:

[[2col]]

a lot of text which will be rendered in multiple columns

[[_2col]]

it's responsive

Share this post


Link to post
Share on other sites

Or:

Every repeater is a row <div class='row'>

Repeater with a body field. (containing textformatter that splits the content in columns when finding a <hr />)

Share this post


Link to post
Share on other sites
How would you recommend using Hanna code to wrap a larger amount of markup? For example, if a client wants to create a two column layout within a body section. E.g. In TinyMCE:

Currently you can't pass multiline arguments to Hanna code. But I'm not sure how user friendly that looks even if you could. What I would probably suggest is to populate your content in a dedicated field on the page and have your Hanna code automatically look in that field. For example, your [col2] Hanna code might look like this:

<?php
if(!empty($attr['content'])) $content = $attr['content']; // use content attribute if supplied
  else $content = $page->col2; // otherwise pull from "col2" field on page
// ...now $content is ready for you to use
  • Like 1

Share this post


Link to post
Share on other sites

I'm having trouble with this hanna code:

<?php
foreach($page->children as $child) {
    echo '<h2>' . $child->title . '</h2>';
    echo $child->body;
}
?>

it's not working (it does work in the template) but in the hanna code, it only outputs the body of the last child.

Share this post


Link to post
Share on other sites

I'm having trouble with this hanna code:

<?php
foreach($page->children as $child) {
    echo '<h2>' . $child->title . '</h2>';
    echo $child->body;
}
?>

it's not working (it does work in the template) but in the hanna code, it only outputs the body of the last child.

I can confirm this. My best bet is that you've got enabled HannaCode as a textformatter in the setting of the "body"-field. I'm not sure what's happening, but I guess Hanna Code calls itself again, and overwrites the output itself. As a workaround, you could use different body-fields in parent and children - one with, the other one without Hanna Code enabled.

Share this post


Link to post
Share on other sites

right, i just reverted to doing it in the template... wonder if this could be fixed in hanna though..

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 d'Hinnisdaël
      Happy new year, everybody 🥬
      I've been sitting on this Dashboard module I made for a client and finally came around to cleaning it up and releasing it to the wider public. This is how it looks.
      ProcessWire Dashboard

      If anyone is interested in trying this out, please go ahead! I'd love to get some feedback on it. If this proves useful and survives some real-world testing, I'll add this to the module directory.
      Download
      You can find the latest release on Github.
      Documentation
      Check out the documentation to get started. This is where you'll find information about included panel types and configuration options.
      Custom Panels
      My goal was to make it really simple to create custom panels. The easiest way to do that is to use the panel type template and have it render a file in your templates folder. This might be enough for 80% of all use cases. For anything more complex (FormBuilder submissions? Comments? Live chat?), you can add new panel types by creating modules that extend the DashboardPanel base class. Check out the documentation on custom panels or take a look at the HelloWorld panel to get started. I'm happy to merge any user-created modules into the main repo if they might be useful to more than a few people.
       Disclaimer
      This is a pre-release version. Please treat it as such — don't install it on production sites. Just making sure 🍇
      Roadmap
      These are the things I'm looking to implement myself at some point. The wishlist is a lot longer, but those are the 80/20 items that I probably won't regret spending time on.
      Improve documentation & add examples ⚙️ Panel types Google Analytics ⚙️ Add new page  🔥 Drafts 🔥 At a glance / Page counter 404s  Layout options Render multiple tabs per panel panel groups with heading and spacing between ✅ panel wrappers as grid item (e.g. stacked notices) ✅ Admin themes support AdminThemeReno and AdminThemeDefault ✅ Shortcuts panel add a table layout with icon, title & summary ✅ Chart panel add default styles for common chart types ✅ load chart data from JS file (currently passed as PHP array) Collection panel support image columns ✅ add buttons: view all & add new ✅
    • By Gadgetto
      Status update links (inside this thread) for SnipWire development will be always posted here:
      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 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 (open spoiler):
      (Please note: these screenshots are from an early development state of SnipWire. To see actual screens please have a look at later posts below!)
       
    • By Robin S
      This module is inspired by and similar to the Template Stubs module. The author of that module has not been active in the PW community for several years now and parts of the code for that module didn't make sense to me, so I decided to create my own module. Auto Template Stubs has only been tested with PhpStorm because that is the IDE that I use.
      Auto Template Stubs
      Automatically creates stub files for templates when fields or fieldgroups are saved.
      Stub files are useful if you are using an IDE (e.g. PhpStorm) that provides code assistance - the stub files let the IDE know what fields exist in each template and what data type each field returns. Depending on your IDE's features you get benefits such as code completion for field names as you type, type inference, inspection, documentation, etc.
      Installation
      Install the Auto Template Stubs module.
      Configuration
      You can change the class name prefix setting in the module config if you like. It's good to use a class name prefix because it reduces the chance that the class name will clash with an existing class name.
      The directory path used to store the stub files is configurable.
      There is a checkbox to manually trigger the regeneration of all stub files if needed.
      Usage
      Add a line near the top of each of your template files to tell your IDE what stub class name to associate with the $page variable within the template file. For example, with the default class name prefix you would add the following line at the top of the home.php template file:
      /** @var tpl_home $page */ Now enjoy code completion, etc, in your IDE.

      Adding data types for non-core Fieldtype modules
      The module includes the data types returned by all the core Fieldtype modules. If you want to add data types returned by one or more non-core Fieldtype modules then you can hook the AutoTemplateStubs::getReturnTypes() method. For example, in /site/ready.php:
      // Add data types for some non-core Fieldtype modules $wire->addHookAfter('AutoTemplateStubs::getReturnTypes', function(HookEvent $event) { $extra_types = [ 'FieldtypeDecimal' => 'string', 'FieldtypeLeafletMapMarker' => 'LeafletMapMarker', 'FieldtypeRepeaterMatrix' => 'RepeaterMatrixPageArray', 'FieldtypeTable' => 'TableRows', ]; $event->return = $event->return + $extra_types; }); Credits
      Inspired by and much credit to the Template Stubs module by mindplay.dk.
       
      https://github.com/Toutouwai/AutoTemplateStubs
      https://modules.processwire.com/modules/auto-template-stubs/
    • By Mike Rockett
      Jumplinks for ProcessWire
      Release: 1.5.60
      Composer: rockett/jumplinks
      ⚠️ NOTICE: 1.5.60 is an important security patch-release for an XSS vulnerability discovered by @phlp. It's HIGHLY RECOMMENDED that all Jumplinks users update to the latest version as soon as possible.
      Jumplinks is an enhanced version of the original ProcessRedirects by Antti Peisa.
      The Process module manages your permanent and temporary redirects (we'll call these "jumplinks" from now on, unless in reference to redirects from another module), useful for when you're migrating over to ProcessWire from another system/platform. Each jumplink supports wildcards, shortening the time needed to create them.
      Unlike similar modules for other platforms, wildcards in Jumplinks are much easier to work with, as Regular Expressions are not fully exposed. Instead, parameters wrapped in curly braces are used - these are described in the documentation.
      Under Development: 2.0, to be powered by FastRoute
      As of version 1.5.0, Jumplinks requires at least ProcessWire 2.6.1 to run.
      View on GitLab
      Download via the Modules Directory
      Read the docs
      Features
      The most prominent features include:
      Basic jumplinks (from one fixed route to another) Parameter-based wildcards with "Smart" equivalents Mapping Collections (for converting ID-based routes to their named-equivalents without the need to create multiple jumplinks) Destination Selectors (for finding and redirecting to pages containing legacy location information) Timed Activation (activate and/or deactivate jumplinks at specific times) 404-Monitor (for creating jumplinks based on 404 hits) Additionally, the following features may come in handy:
      Stale jumplink management Legacy domain support for slow migrations An importer (from CSV or ProcessRedirects) Feedback & Feature Requests
      I’d love to know what you think of this module. Please provide some feedback on the module as a whole, or even regarding smaller things that make it whole. Also, please feel free to submit feature requests and their use-cases.
      Note: Features requested so far have been added to the to-do list, and will be added to 2.0, and not the current dev/master branches.
      Open Source

      Jumplinks is an open-source project, and is free to use. In fact, Jumplinks will always be open-source, and will always remain free to use. Forever. If you would like to support the development of Jumplinks, please consider making a small donation via PayPal.
      Enjoy! 🙂
    • By Robin S
      Add Image URLs
      Allows images/files to be added to Image/File fields by pasting URLs.

      Usage
      Install the Add Image URLs module.
      A "Paste URLs" button will be added to all image and file fields. Use the button to show a textarea where URLs may be pasted, one per line. Images/files are added when the page is saved.
       
      https://github.com/Toutouwai/AddImageUrls
      https://modules.processwire.com/modules/add-image-urls/
×
×
  • Create New...