Jump to content
ryan

Hanna Code

Recommended Posts

Thank you, Robin S.

It's so easy to make CKEditor get worried. Your trick prevents the warning message, so it looks less worrying to me...

Share this post


Link to post
Share on other sites

A other solution to Hannacode in this case yould be working with a Textformatter....

If you in concern of usability you could let your user just put in the mp3 file in CKEEditor and let the Textformatter search for it (href regex for *.mp3*) and replace it with the player. So zero worrying about include audio files.

You could take a look at the Youtube Textformatter from Ryan:
https://github.com/ryancramerdesign/TextformatterVideoEmbed/blob/master/TextformatterVideoEmbed.module

...just as an additional option.

regards mr-fan

Share this post


Link to post
Share on other sites

Thanks mr-fan - that seems to be a nice idea! I for sure will take a nearer look into it - after my actual problems hopefully will be solved... (I've got a similar Hanna Code to display a Video, using the jQuery plugin VideoJS - which mostly works well, but not on some mobile devices, e.g. on WinPhone 8 or iPhone...)

Share this post


Link to post
Share on other sites

Hi all

i've used Hannacode to include a php page with a form. The "action" of this form is to another page that have another php file include. Last php file get post var and print the result. The problem is that when i submit the form 8/10 the new page loading but site freeze. If i reload the page (and re-submit the form) it works. I don't know if it depends to hannacode or processwire.  I have another site on same server written in pure php but i never have this type of problem.

Thank in advance.

 

 

 

Below the result page php code:

Hannacode

<?php
    include (wire('config')->paths->templates.'_form-application-result.php');
?>

_form-application-result.php

<?php
	foreach ($input->post as $k=>$v) {


      if ($v != '' && $k != 'g-recaptcha-response') {
        $session->set($k,trim($v));
  ?>

        <div class="row">
            <div class="col-sm-3"><?= ucwords(str_replace('_',' ',$k)) ?></div>
            <div class="col-sm-9"><?= strtoupper($v) ?></div>
        </div>

  <?
      }

    }

 

Share this post


Link to post
Share on other sites

It's harder to edit files inside Ace editor where you can't get proper debugging, type hinting, autocomplete etc. So what I propose is a way to hook into the module. Then we could:

<?php 
// filtered hook for some specific Hanna code
wire()->addHook('TextformatterHannaCode::getPHP(name="random-post")', function(HookEvent $e) {
  // the arguments specified by the user, inside an associated array
  $args = $e->arguments(0);
  // build markup, 
  // since $vars parameter is an array 
  // we can pass it directly as variables for the template
  $e->return = wireRenderFile('template/file', $vars);
  $e->replace = true;
});

and then inside a php file, you perform your checks, build your markup with given parameters, and return it. Making this function hookable is quite easy, this is enough

<?php 
public function getPHP($name, $code, array $attrs) {}
// would become
public function ___getPHP($name, $code, array $attrs) {}
// just prefixing alone probably woudn't allow filtering hooks though.

 

Share this post


Link to post
Share on other sites
1 hour ago, abdus said:

It's harder to edit files inside Ace editor where you can't get proper debugging, type hinting, autocomplete etc.

Actually AceEditor does support this stuff pretty well - I use it in Tracy's Console and Template Editor panels. Perhaps someone could put together a PR for the Hanna code module to add these?

Share this post


Link to post
Share on other sites
1 hour ago, abdus said:

It's harder to edit files inside Ace editor where you can't get proper debugging, type hinting, autocomplete etc. So what I propose is a way to hook into the module.

I also dislike editing code outside of my IDE. The workaround currently is pretty simple - just set this for all your PHP Hanna codes:

include($config->paths->templates . 'hannas/' . $hanna->name . '.php');

But I'm in favour of anything that would make it even easier.

  • Like 1

Share this post


Link to post
Share on other sites
3 hours ago, adrian said:

Perhaps someone could put together a PR for the Hanna code module to add these?

I made a PR for it.

https://github.com/ryancramerdesign/ProcessHannaCode/pull/19

Changes include:

  • Updating module to ProcessWire namespace. This requires standard library classes be prefixed with \ (PDO -> \PDO etc.)
  • Changing internal references inside ProcessHannaCode for TextFormatterHannaCode to use the module instance in $this->hanna instead.
  • Changing getPHPgetJS, and adding getText method for hooking.

This allows hooking into TextformatterHannaCode::getPHP, TextformatterHannaCode::getJS and TextformatterHannaCode::getText. Inside these hooks you check for the hanna code name, then do as you wish, like so

wire()->addHookBefore('TextformatterHannaCode::getPHP', function (HookEvent $e) {
    if($e->arguments(0) === 'refer') {
        $e->replace = true;
        $args = $e->arguments(2);
        // $e->return = wireRenderFile('refer', $args);
        $e->return = 'rendered template output';
    }
});
 
  • Like 1

Share this post


Link to post
Share on other sites

Hmm, one surprising advantage would be addition of shortcodes like in Wordpress. Modules can require, (install if necessary), then hook into Hanna Code and define their own shortcodes to be used in fields. One example would be

<?php
class EmbedShortcodes extends Wire implements Module
{
    public static function getModuleInfo()
    {
        return [
            'title' => 'Shortcodes',
            'version' => '0.0.1',
            'author' => 'abdus',
            'summary' => 'Adds `embed` shortcode',
            'href' => 'https://abdus.co',
            'autoload' => true, // set to true if module should auto-load at boot
            'requires' => [
                'TextformatterHannaCode',
            ],
            'installs' => ['TextformatterHannaCode'],
        ];
    }

    public function ready() {
        $this->addHook('TextformatterHannaCode::getPHP', $this, 'renderEmbed');
    }

    protected function renderEmbed(HookEvent $e) {
        if($e->arguments(0) === 'embed') {
            $e->replace = true;
            $e->return = '<div>embedded output</div>';
        }
    }
}

This works fine for predefined hanna codes, but, for arbitrary shortcodes, it requires a change in the logic of the module where it fetches available hanna codes from database here

<?php
protected function getReplacement($name, array $attrs, &$consume) {

    $database = $this->wire('database');

    $sql = 'SELECT `id`, `type`, `code` FROM hanna_code WHERE `name`=:name';
    $query = $database->prepare($sql);
    bd($name, 'before');
    $query->bindValue(':name', $name, \PDO::PARAM_STR);
    $query->execute();
    if(!$query->rowCount()) return false;
    // here if it cannot find the hanna code it does nothing.
  
    // rest of the function
}

It should be refactored instead into ___getReplacement(), which allows defining access to hanna codes outside the DB.

Once done, we can just [[embed url=youtube.com/asdfgh]] to embed a video etc.

  • Like 1

Share this post


Link to post
Share on other sites

Just a suggestion but it'd be really useful if there was

 

  1. a Description field available when creating a HannaCode. I like to keep my HC names short and choppy and a description would greatly help users later on establishing what the HC is for or does
  2. a Description column on the HannaCode overview page too pulling in above Description

It would also be great to be able to see a list of pages where HCs are used within RTEs or templates but that (for me) isn't such a biggie.

 

  • Like 3

Share this post


Link to post
Share on other sites

Hi,

I've just installed the Hanna Code module. I wanted to try it out first with something simple - using something like [[title]] to easily insert the current page's title in a textarea.

However, when I try to add a new Hanna Code, if I choose the PHP option, I get a 403 error whenever I hit save.

Could there be a permission I need to change somewhere? Please help!

Thanks,

Margaret

PS. I'm running PW 3.0.62

EDIT: Never mind, it's now working.

I'm not entirely sure how, but I got it to work.

For the benefit of any other newcomers who might experience a similar issue in the future...

First I created a Text/HTML Hanna Code called figurename and just made it output <strong>Boo!</strong>. It let me save it and it worked on my page.

I then edited that code by changing it to PHP - it let me save. I then changed the code to echo $page->title and it let me save again. It now works! :)

I did notice when I initially tried to set up the PHP one it included the opening php tag in the code window, but when I changed the Text one to be PHP that opening tag was omitted. I did a test by adding it back in and once again got the 403 error when I tried to save.

Maybe it's something different in 3.0+, but evidently you can no longer include <?php, even though in the Hanna Code usage notes it says "you may use them when/if necessary".

Share this post


Link to post
Share on other sites

@Margie, it's likely that the error you're seeing is due to interference by the mod_security Apache module. Ask your host to disable mod_security and it should resolve your issue.

  • Like 2

Share this post


Link to post
Share on other sites

Has anyone a script to get all specific pages that uses a special hanna code...

give me me all pages with [[my-hanna-code]] in use?

regards mr-fan

Share this post


Link to post
Share on other sites
5 hours ago, mr-fan said:

Has anyone a script to get all specific pages that uses a special hanna code...

give me me all pages with [[my-hanna-code]] in use?

You can search for the text string that makes up the start of the tag (to allow for varying attributes).

// Get fields with TextformatterHannaCode applied
$hanna_fields = array();
foreach($fields as $field) if(is_array($field->textformatters) && in_array('TextformatterHannaCode', $field->textformatters)) $hanna_fields[] = $field->name;
// Implode for use in selector string
$hanna_fields = implode('|', $hanna_fields);
// Find pages with a given Hanna tag
$has_hanna = $pages->find("$hanna_fields*=[[your_tag");

 

  • Like 2

Share this post


Link to post
Share on other sites

Thank you Robin - will try asap!
[ot]At the moment i'm a little but lethal snuffy...and could not think clearly (i think it is deadly man-flu). So don't think i'm to lazy to search a solution...i'm not...i've read your code and it was clear for me that my question was silly...i'm just standing a little beside me but i think that the peak of my desease is done. :lol:[/ot]

Best regards mr-fan

  • Like 1

Share this post


Link to post
Share on other sites

I'm using Hanna code to embed content from different pages on a site. What I would need is a way to get the created and modified date of the page that has been embedded. I need to use/show these dates in the front-end of the page that has the embedded content. Is there some elegant way I could get this information?

Share this post


Link to post
Share on other sites
16 minutes ago, nikoka said:

I'm using Hanna code to embed content from different pages on a site. What I would need is a way to get the created and modified date of the page that has been embedded. I need to use/show these dates in the front-end of the page that has the embedded content. Is there some elegant way I could get this information?

I always get confused about this. Try accessing it using wire('page') and see if that helps.

Quote

The $page API variable available to your Hanna code represents the page where the Hanna code exists.It is possible for this to be different from wire('page'), which represents the page that originated the request.

From the PHP Usage notes section on here

http://modules.processwire.com/modules/process-hanna-code/

Edited by kongondo

Share this post


Link to post
Share on other sites

Thanks @kongondo, I was a bit unclear, I have a page (let's call it page A) with and embedded page (let's call it page B). I need to show the modified/created dates of page B on page A. But how do I get this information from the embedded page B to the "wrapper" page A?   

Share this post


Link to post
Share on other sites
7 hours ago, nikoka said:

Thanks @kongondo, I was a bit unclear, I have a page (let's call it page A) with and embedded page (let's call it page B). I need to show the modified/created dates of page B on page A. But how do I get this information from the embedded page B to the "wrapper" page A?   

What does your hanna code look like? 

Share this post


Link to post
Share on other sites
10 hours ago, kongondo said:

What does your hanna code look like? 

The tag I use for adding embedded page content is: [[single-source url=""]] For the url I add the page ID and the content is then shown. There's a bunch of other things happening, but the essence of the hanna code for getting the embedded page content goes like this: 

$return = $attr["url"];
$id = (int) $return;
$embeddedPage = $pages->get($id);
echo $embeddedPage->body;

 

Share this post


Link to post
Share on other sites
2 hours ago, nikoka said:

The tag I use for adding embedded page content is: [[single-source url=""]] For the url I add the page ID and the content is then shown. There's a bunch of other things happening, but the essence of the hanna code for getting the embedded page content goes like this: 


$return = $attr["url"];
$id = (int) $return;
$embeddedPage = $pages->get($id);
echo $embeddedPage->body;

 

I must be missing something then. Do you:

  1. Want to grab $embeddedPage and use it later on in your page or
  2. Want to echo $embeddedPage properies (body, created, etc) right within your Hanna Code?

If #2, you are already doing it by echo $embeddedPage->body. E.g., the following works correctly for me (code in the Hanna Code itself)

$return = $attr["url"];
$id = (int) $return;
$embeddedPage = $pages->get($id);
echo $embeddedPage->body;
$modified = $embeddedPage->modified;
echo date("l jS \of F Y h:i:s A", $modified);

I have this Hanna Code Tag in Page A, where 1049 is the ID of Page B.

[[test url=1049]]

That outputs Page B's modified date.

But this seems too easy. I have a feeling I'm still not getting you.

Edited by kongondo
  • Like 2

Share this post


Link to post
Share on other sites
5 minutes ago, kongondo said:

I must be missing something then. Do you:

  1. Want to grab $embeddedPage and use it later on in your page or
  2. Want to echo $embeddedPage properies (body, created, etc) right within your Hanna Code?

If #2, you are already doing it by echo $embeddedPage->body. E.g., the following works correctly for me (code in the Hanna Code itself)


$return = $attr["url"];
$id = (int) $return;
$embeddedPage = $pages->get($id);
echo $embeddedPage->body;
$modified = $embeddedPage->modified;
echo date("l jS \of F Y h:i:s A", $modified);

I have this Hanna Code Tag in Page A, where 1049 is the ID of Page B.


[[test url=1049]]

That outputs Page B's modified date.

But this seems too easy. I have a feeling I'm still not getting you.

Thanks for sticking with me @kongondo :) Number 1 is what I want to do. I need to use the modified/created dates of Page B to compare to the modified/created dates of Page A and insert some badges on Page A according to which of these pages have been updated more recently. 

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 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-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 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 (alpha version only available via GitHub) 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 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 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...