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

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
      --- Please use RockFinder3 ---
    • 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 (pending approval) If you are interested in learning more, the README is very extensive, with more usage examples, code samples and usage instructions!
    • By Craig
      I've been using Fathom Analytics for a while now and on a growing number of sites, so thought it was about time there was a PW module for it.
      WayFathomAnalytics
      WayFathomAnalytics is a group of modules which will allow you to view your Fathom Analytics dashboard in the PW admin panel and (optionally) automatically add and configure the tracking code on front-end pages.
      Links
      GitHub Readme & documentation Download Zip Modules directory Module settings screenshot What is Fathom Analytics?
      Fathom Analytics is a simple, privacy-focused website analytics tool for bloggers and businesses.

      Stop scrolling through pages of reports and collecting gobs of personal data about your visitors, both of which you probably don't need. Fathom is a simple and private website analytics platform that lets you focus on what's important: your business.
      Privacy focused Fast-loading dashboards, all data is on a single screen Easy to get what you need, no training required Unlimited email reports Private or public dashboard sharing Cookie notices not required (it doesn't use cookies or collect personal data) Displays: top content, top referrers, top goals and more
    • By daniels
      This is a lightweight alternative to other newsletter & newsletter-subscription modules.
      You can find the Module in the Modules directory and on Github
      It can subscribe, update, unsubscribe & delete a user in a list in Mailchimp with MailChimp API 3.0. It does not provide any forms or validation, so you can feel free to use your own. To protect your users, it does not save any user data in logs or sends them to an admin.
      This module fits your needs if you...
      ...use Mailchimp as your newsletter / email-automation tool ...want to let users subscribe to your newsletter on your website ...want to use your own form, validation and messages (with or without the wire forms) ...don't want any personal user data saved in any way in your ProcessWire environment (cf. EU data regulation terms) ...like to subscribe, update, unsubscribe or delete users to/from different lists ...like the Mailchimp UI for creating / sending / reviewing email campaigns *I have only tested it with PHP 7.x so far, so use on owners risk
      EDIT:
      Since 0.0.4, instructions and changelog can be found in the README only. You can find it here  🙂
      If you have questions or like to contribute, just post a reply or create an issue or pr on github, thanks!
    • By MoritzLost
      Sorry for the convoluted title. I have a problem with Process modules that define a custom page using the page key through getModuleInfo (as demonstrated in this excellent tutorial by @bernhard). Those pages are created automatically when the module is installed. The problem is that the title of the page only gets set in the current language. That's not a problem if the current language (language of the superuser who is installing the module) is the default language; if it isn't, the Process page is missing a title in the default language. This has the very awkward effect that a user using the backend in the default language (or any other language) will see an empty entry in the setup menu:

      This screenshot comes from my Cache Control module which includes a Process page. Now I realize the description sounds obscure, but for us it's a common setup: We a multiple bilingual sites where the default language is German and the second language is English. While the clients use the CMS in German, as a developer I prefer the English interface, so whenever I install a Process module I get this problem.
      As a module author, is there a way to handle this situation? I guess it would be possible to use post-installation hooks or create the pages manually, but I very much prefer the declarative approach. The page title is already translatable (through the __ function), but of course at the time of installation there is no translation, and as far as I'm aware it's not possible to ship translations with a module so they are used automatically. Could this situation be handled better in the core? I would prefer if the module installation process would always set the title of the Process page in the default language, instead of the language of the current user.
×
×
  • Create New...