Jump to content
apeisa

Multisite

Recommended Posts

(Added by Soma)

Note that this module is deprecated.

The newer and more maintained version is found here:

https://github.com/somatonic/Multisite/

You can get the current dev version here https://github.com/somatonic/Multisite/tree/dev

(Original Post)

Just pushed simple multisite module to github: https://github.com/a...ultisite.module


What this module does?
It allows you to run multiple sites with different domains run from single install, using same database. While you can easily do "subsites" like www.domain.com/campaign/, this allows you to turn that into www.campaign.com. This is nice stuff, when you have multiple simple sites, that all belong to same organisation and same people maintain.

How to use it?
Just create page with name like www.campaigndomain.com under your homepage, then edit this module through modules menu and add same domain there. If your domain resolves to same place where your main domain, it should just work. Please notice that if you have editing rights, it allows you to browse the site from www.olddomain.com/www.campaigndomain.com/, but users with no editing rights are redirected to www.campaigndomain.com (this is because session cookie is otherwise lost).

Any problems?
Not any real problems, at least yet known. Of course think twice when deciding should the site have own install instead of this. There are few benefits, like getting data from other sites, one admin view for all sites etc... but it can easily get out of the hands: number of templates, fields etc.. It is harder to maintain for sure.

Isn't there multisite support in core?
Yes, kind of. It is very different from this. It allows you to run multiple pw-installations with shared core files (/wire/ folder). This is totally different: this is single pw-installation which has multiple sites running from different domains.



This is basically just a wrapper with one config field for this little snippet Ryan posted here: http://processwire.c...ndpost__p__5578 (so most of the credit goes to Mr. Cramer here). What it also does is that it manipulates $page->path / url properties to have right subdomain value.

  • Like 9

Share this post


Link to post
Share on other sites

Antti, this looks fantastic. I'm pointing another domain to processwire.com so that I can test this out.

One suggestion that I have is to change this:

// If subdomain is visible on url, we might wanna redirect
if(strpos($_GET['it'],$subdomain) !== false) {
   // We don't redirect if one has editing access (because user would need to login on new domain also)
   $page = $this->pages->get("/". $_GET['it']);
   if(!$page->editable()) {
       $_GET['it'] = str_replace("{$subdomain}/", "", $_GET['it']);
       $this->session->redirect('http://' . $subdomain . '/' . $_GET['it']);
   }
}

…to this (or something like it, as I've not actually tested, but hopefully the intention is there): :)

// saved $_GET['it'], since PW unsets it after using it
// note this is an unsanitized variable, so only look at it, don't use it
protected $it;

public function init() { 
   $this->subdomainsArray = explode("\n", strtolower($this->subdomains));
   $this->it = ltrim($_GET['it'], '/');

   // ...then your existing code…

}

public function ready() {
   // if $this->subdomain was valid in init(), then no need to do more here.
   if($this->subdomain) return; 

   $subdomain = $this->page->rootParent->name; 
   // if rootParent->name isn't a subdomain, then no need to continue
   if(!in_array($subdomain, $this->subdomainsArray)) return;

   // if subdomain is visible on url, we might wanna redirect
   if(strpos($this->it, $subdomain) === 0 && !$this->page->editable()) { 
    $url = str_replace("/{$subdomain}/", '/', $this->page->httpUrl);
    $this->session->redirect(url); 
   }
}

The point of this is to avoid sending an unfiltered $_GET['it'] into $pages->get(), which may contain anything in it at that point. There's always a security concern with sending unfiltered input to any function that isn't expecting it. You can avoid the issue completely by moving the check into the ready() function, which gets called after PW has already validated the URL and determined the page. If you wanted to get more fancy with it, you could also foreach($input->urlSegments) and append $input->pageNum (if > 1), but I really don't think that's necessary.

  • Like 1

Share this post


Link to post
Share on other sites

Nice, apeisa. Some multisite features would be a great enhancement for PW. For example to provide a mobile site using a subdomain. So this is a nice step forward here. I have been experimenting on something like this several weeks ago, too, but then had to focus on some other modules. So I’m curious about your ideas.

Share this post


Link to post
Share on other sites

Ryan, thanks for suggestion. For some reason I thought that $_GET['it'] has only path values like /fdas/asd/ (like htaccess wouldn't send it to pw otherwise) but of course that isn't the case (we can have get parameters in url). I will update my code soon.

Oliver: you could definitely use this for m.domain.com type of stuff, actually a great use case for this module also. Many of our clients tend to have multiple smaller sites, that need to use data from main site, are maintained by same people, but usually have different marketing domain and own visuals. That is the original need for this module, but actually I would probably use this for m.domain.com type of mobile versions also.

Share this post


Link to post
Share on other sites

Just pushed changes made by Ryan. They went in almost exactly like that.

  • Like 2

Share this post


Link to post
Share on other sites

Hi Atti, thanks for your module! I am a bit confused about the usage, though... How am I supposed to access the backend? The module rewrites the URL so I can access my pages under the domain page, but the admin page can't be moved inside this domain page. But without that I cannot access it because the URL domain.com/processwire/ is catched by the module and tries to redirect to domain.com/domain.com/processwire which fails.

Thx for help!

edit: I changed line 40 into:

if(strpos($httpHost, $subdomain) !== false && strpos($httpHost, 'admin') !== false) {

which works for now. But I think this is not intended, so I would appreciate the "proper" solution ;-)

Another edit: How is the homepage supposed to work? Now it is the root page, but with several domains it would be nice to have several homepages (under the domain page or the domain page itself). What do you think?

Edited by MadeMyDay

Share this post


Link to post
Share on other sites

This is how we use this:

www.maindomain.com // This is the mainsite, runs just like any other pw-site

www.campaign.com // This is the first one using multisite, this domain is entered into module settings, but also as page under maindomain.com

www.anothercampaign.com // Just like the above

Admin for all these pages is accessible from www.maindomain.com/processwire/

First level of site tree from maindomain.com looks like this:

  • About Us
  • News
  • Contact us
  • Sitemap
  • www.campaign.com (hidden)
  • www.anothercampaign.com (hidden)

I won't suggest building very complicated setups with this, but it is superb for few specific campaign sites (especially if same people maintain or they reuse the data between). If you have many big sites under same site, you will end up with huge amount of templates & fields.

  • Like 1

Share this post


Link to post
Share on other sites

I would like to ask if it could be possible for a site with this module to have "the same" pages urls or processwire won't allow it to be made in any way? What I mean by "the same" is domain.com/particular-page and domain.net/particular-page or m.domain.com/particular-page. It would be very useful ie in case of desktop and mobile websites.

So I suppose the question is if page in ProcessWire has to have unique Name or we might have got pages with the same names under different "Categories".

website.com/race1/first-place

website.com/race1/second-place

website.com/race2/first-place

website.com/race2/second-place

?

Share this post


Link to post
Share on other sites

I am not sure I fully understand your question. Page name needs to be unique only among siblings. So your described page-tree is perfectly valid.

If you were asking if this module is suitable for offering same content for differend devices, then it is not intention of this module and that could be done in template level.

Share this post


Link to post
Share on other sites

Ok, I just rechecked and everything is working fine. So sorry for unnecessary question. I must have been very asleep when messing with it this night. I was doing stupid mistake - cloning a page and wanting to set the same name without moving it in a tree earlier. But if I didn't ask I probably wouldn't check it again.

Thanks :)

Share this post


Link to post
Share on other sites

@apeisa, thanks for this module -- it's working beautifully!

For our needs I had to implement support for alternative domains (each extra domain can have n alternatives, which all point to the same location.) With separate domains for development and secure addresses -- not to mention that in this case the client required alternative domains that couldn't be handled very well with just redirects -- that was pretty much the easiest way to put together a consistent experience.

So, basically I'm asking if you'd be interested in incorporating that addition in the main module if I sent you a pull request for it (of course once I've tested it properly first?) :)

Share this post


Link to post
Share on other sites

Sure. How are alternative domains setup in the config? Ie. how does the textarea scales here? Just commas between the different urls where the first one maps to the actual page?

Share this post


Link to post
Share on other sites

Pretty much like that, though at the moment only space is supported separator. Should probably add support for commas too, now that you mentioned it :)

Share this post


Link to post
Share on other sites

Currently I'm trying to get this to work, but I'm seriously questioning if I'm using this right. What I initially thought that had to do the following steps:

1) Make sure all the traffic from www.seconddomain.com points to the home directory of the www.maindomain.com. (checked)

2) Install the module and make sure that www.seconddomain.com is added to the textarea. (checked)

3) Create a new page with the template 'home' with the title matching the domain - in this case www.seconddomain.com. Status of the page is published and hidden. (checked)

Then I thought I have to add another page to make this work:

4) Create a page with a template underneath the 'second' homepage called 'Testpage'. Status of the page is published.

I can reach the page using the following URL:

http://www.maindomain.com/www.seconddomain.com/testpage/

But I can't reach the page using this URL:

http://www.seconddomain.com/testpage/

Things I've noticed

1. When I try to reach www.seconddomain.com it displays a 404 error.

2. The other items (like the primary navigation) on rootlevel are changed to www.seconddomain.com.

Thinking

Then I starting thinking (just about then ;) ): is this supposed to work like this?

The idea

I got a very simple site with three pages and the client really liked to the idea to create some landing pages using other domains but using the same structure. Hence I thought apeisa's Multisite could be used here.

Many thanks for any thoughts!

Share this post


Link to post
Share on other sites

Arjen, sorry to hear about problems. Your setup seems right to me.

Just to confirm: if you do remove the domain from module settings, you can use www.seconddomain.com and browse the "root site" normally? Also www.maindomain.com/www.seconddomain.com/ works and you can access that page normally?

Then if you try www.seconddomain.com is the 404 error msg generated by PW or Apache? Does the module do any redirects? What is visible on addressbar? Feel free to PM me any additional details if you want me to take closer look.

Share this post


Link to post
Share on other sites

If I remove the domain from the module setting I can browse the root site normally.

If I browse:

http://www.maindomain.com/www.seconddomain.com/

it loads the seconddomain homepage.

The 404 error is generated by PW. It doesn't redirect when I try to reach:

http://www.seconddomain.com/testpage/

I am using this with some subdomains. Could that be the issue here? The root site is located at:

http://clientdomainname.clients.mysite.com/

I will PM you in a short moment.

Share this post


Link to post
Share on other sites

I did forget to update this: there was an actual issue that is fixed now on latest commit. Thanks Arjen for finding and Teppo for fixing!

  • Like 3

Share this post


Link to post
Share on other sites

Hi,

with Options #1: multiple sites with multiple databases how

Sites can't easily share data with each other, since they are running independently from one another.

is hard?

I've 4 sites:

HQ (advertising and redirect to one of the children, in the future this control the newsletter sending operation and the main events calendar)

\_ site2

\_ site3

\_ site4

Site2 have the most users and contents.

Sites 2,3,4 can share a couple of "translator user".

HQ news/events must be viewed also in 2, 3 and 4.

Site2 specific news/events must be viewed in HQ, 3 and 4.

Only this.

Thanks,

Marco

Share this post


Link to post
Share on other sites

Unless I misunderstand, i think the answer is actually the module that this thread is about. Option 1 is for multiple databases that don't share data. Option 2 (this module) is the one you'd want with multiple sites sharing data.

Share this post


Link to post
Share on other sites

Hi Ryan,

you are right.

All ok, but in the pros and cons docs says can't easily, so I imagine that this can be done.

Which is the best way to have private database and template but share few info (e.g. global news) between the sites?

Share this post


Link to post
Share on other sites
Which is the best way to have private database and template but share few info (e.g. global news) between the sites?

The problem with having multiple sites pulling and/or manipulating from the same database is that the two sites become dependent upon one another. If something needs to change with the data source, then both sites need to change. If one site becomes compromised, both sites are compromised.

When two sites need to talk to each other, regardless of platform, the best practice is to use JSON or XML web services.

For the example you mentioned, and in the context of ProcessWire, I would use RSS feeds. Generate a feed of the data you want to share using the RSS Feed Generator module. Then output it on another site using the RSS Feed Loader module. Now you have two sites easily sharing data in a bulletproof manner.

For more complex needs, you might also want to check out the Pages Web Service module.

  • Like 2

Share this post


Link to post
Share on other sites

I have a website where the multisite module by apeia is running smoothly. One thing I can't get to work is how to share accounts on multiple sites. I've created an extra role called 'subscriber'. When I check:

if ($user->hasRole("subscriber")) {
echo "This is a subscriber.";
}

It's echoed on the mainsite.com, but it returns nothing (empty) on the otherdomain.com.

Then I checked:

echo $user->name;

It returns the $user->name on the mainsite.com, but again empty (actually guest) on the otherdomain.com.

Is this a session thing? Any thoughts on how to make a user who is logged in on the mainsite.com is also logged in on the subdomain.com?

Thanks!

Share this post


Link to post
Share on other sites

Sessions are based on cookies, which are domain spesific. So you need some kind of single sign on solution to share sessions between the domains.

  • Like 1

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 dimitrios
      Hello,
      this module can publish content of a Processwire page on a Facebook page, triggered by saving the Processwire page.
      To set it up, configure the module with a Facebook app ID, secret and a Page ID. Following is additional configuration on Facebook for developers:
      Minimum Required Facebook App configuration:
      on Settings -> Basics, provide the App Domains, provide the Site URL, on Settings -> Advanced, set the API version (has been tested up to v3.3), add Product: Facebook Login, on Facebook Login -> Settings, set Client OAuth Login: Yes, set Web OAuth Login: Yes, set Enforce HTTPS: Yes, add "http://www.example.com/processwire/page/" to field Valid OAuth Redirect URIs. This module is configurable as follows:
      Templates: posts can take place only for pages with the defined templates. On/Off switch: specify a checkbox field that will not allow the post if checked. Specify a message and/or an image for the post.
      Usage
      edit the desired PW page and save; it will post right after the initial Facebook log in and permission granting. After that, an access token is kept.
       
      Download
      PW module directory: http://modules.processwire.com/modules/auto-fb-post/ Github: https://github.com/kastrind/AutoFbPost   Note: Facebook SDK for PHP is utilized.


    • By kongondo
      FieldtypeRuntimeMarkup and InputfieldRuntimeMarkup
       
      Modules Directory: http://modules.processwire.com/modules/fieldtype-runtime-markup/
      GitHub: https://github.com/kongondo/FieldtypeRuntimeMarkup
      As of 11 May 2019 ProcessWire versions earlier than 3.x are not supported
      This module allows for custom markup to be dynamically (PHP) generated and output within a page's edit screen (in Admin).
       
      The value for the fieldtype is generated at runtime. No data is saved in the database. The accompanying InputfieldRuntimeMarkup is only used to render/display the markup in the page edit screen.
       
      The field's value is accessible from the ProcessWire API in the frontend like any other field, i.e. it has access to $page and $pages.
       
      The module was commissioned/sponsored by @Valan. Although there's certainly other ways to achieve what this module does, it offers a dynamic and flexible alternative to generating your own markup in a page's edit screen whilst also allowing access to that markup in the frontend. Thanks Valan!
       
      Warning/Consideration
      Although access to ProcessWire's Fields' admin pages is only available to Superusers, this Fieldtype will evaluate and run the custom PHP Code entered and saved in the field's settings (Details tab). Utmost care should therefore be taken in making sure your code does not perform any CRUD operations!! (unless of course that's intentional) The value for this fieldtype is generated at runtime and thus no data is stored in the database. This means that you cannot directly query a RuntimeMarkup field from $pages->find(). Usage and API
       
      Backend
      Enter your custom PHP snippet in the Details tab of your field (it is RECOMMENDED though that you use wireRenderFile() instead. See example below). Your code can be as simple or as complicated as you want as long as in the end you return a value that is not an array or an object or anything other than a string/integer.
       
      FieldtypeRuntimeMarkup has access to $page (the current page being edited/viewed) and $pages. 
       
      A very simple example.
      return 'Hello'; Simple example.
      return $page->title; Simple example with markup.
      return '<h2>' . $page->title . '</h2>'; Another simple example with markup.
      $out = '<h1>hello '; $out .= $page->title; $out .= '</h1>'; return $out; A more advanced example.
      $p = $pages->get('/about-us/')->child('sort=random'); return '<p>' . $p->title . '</p>'; An even more complex example.
      $str =''; if($page->name == 'about-us') { $p = $page->children->last(); $str = "<h2><a href='{$p->url}'>{$p->title}</a></h2>"; } else { $str = "<h2><a href='{$page->url}'>{$page->title}</a></h2>"; } return $str; Rather than type your code directly in the Details tab of the field, it is highly recommended that you placed all your code in an external file and call that file using the core wireRenderFile() method. Taking this approach means you will be able to edit your code in your favourite text editor. It also means you will be able to type more text without having to scroll. Editing the file is also easier than editing the field. To use this approach, simply do:
      return wireRenderFile('name-of-file');// file will be in /site/templates/ If using ProcessWire 3.x, you will need to use namespace as follows:
      return ProcessWire\wireRenderFile('name-of-file'); How to access the value of RuntimeMarkup in the frontend (our field is called 'runtime_markup')
       
      Access the field on the current page (just like any other field)
      echo $page->runtime_markup; Access the field on another page
      echo $pages->get('/about-us/')->runtime_markup; Screenshots
       
      Backend
       

       

       
      Frontend
       

    • By kongondo
      Media Manager
       
      Released 31 March 2016
      https://processwireshop.pw/plugins/media-manager/
      Documentation 
      http://mediamanager.kongondo.com/
      As of 10 May 2019 ProcessWire versions earlier than 3.x are not supported
      *******************************************************   ORIGINAL POST   *******************************************************
      API Example (frontend; will be added to documentation site)
      Accessing and outputting the contents of the MediaManager field(s) in your template is quite simple. The fields are accessed like many other ProcessWire fields. The fields return an array of type MediaManagerArray that need to be looped to output each media within. Assuming you created a field of type MediaManager named 'media', you can loop through it for a given page as shown below.
        @note: Each MediaManager object has the following 5 basic properties:   DATABASE (saved properties) 1. id => pageID of the page where the media lives (hidden in admin and not important to know about) 2. type => integer denoting media type (1=audio; 2=document; 3=image [for variations this will be 3x, where x is the number of the variation of an original image]; 4=video)   RUNTIME 3. typeLabel => user friendly string denoting media type (audio, document, image, video) 4. media => a ProcessWire Image/File Object including all their properties (ext, filesizeStr, height, width, description, tags, filename, basename, etc.) 5. title => title of media (@note: this is the title of the page where the media lives; may or may not be the same as the name of the media file itself). This can be used as a user-friendly name for your media $media = $page->media;// returns a MediaManagerArray. Needs to be looped through foreach ($media as $m) { echo $m->id;// e.g. 1234 (hidden page in /admin/media-manager/media-parent/) echo $m->type;// e.g. 3 (a media of type image) OR 1 (a media of type audio) echo $m->typeLabel;// e.g. 'document' (i.e. type would be 2) echo $m->title;// e.g. 'My Nice Trip' (whose media file could be my-nice-trip.mp4) /* @note: - $m->media returns an object; either a ProcessWire Image (for image media) or File object (for audio, document and video media) - This means you have access to all the properties of that object, e.g. ext, tags, description, url, filename, basename, width, height, modified, created, filesize, filesizeStr, etc as well as associated methods, e.g. size() */ echo $m->media->tags; } // only output images foreach ($media as $m) { if($m->typeLabel =='image') { echo "<img src='" . $m->media->size(100,75)->url . "'><br>"; } } // There's also a toString() method so you can do: echo $page->media; /* All your media will be output wrapped in appropriate HTML tags, i.e.: audio: <audio></audio>; document: <a></a>; image: <img>; video: <video></video>; */  
      *******************************************************   ORIGINAL POST   *******************************************************
       
      The topic of a central media manager feature for ProcessWire has come up several times:
       
      https://processwire.com/talk/topic/4330-get-image-from-other-pages-via-images-field/
      https://processwire.com/talk/topic/4330-get-image-from-other-pages-via-images-field/?p=42578
      https://processwire.com/talk/topic/4330-get-image-from-other-pages-via-images-field/?p=42582
      https://processwire.com/talk/topic/425-file-manager/
      https://processwire.com/talk/topic/425-file-manager/?p=13802
      https://processwire.com/talk/topic/425-file-manager/?p=13861
      https://processwire.com/talk/topic/10763-asset-manager-asset-selector/
       
      More recently, regarding my Visual Page Selector module, I have been asked several times why the module does not have an in-built feature to upload images.
       
      There's two camps on the topic of a central media manager: those who like them (especially those coming in to PW from other CMSes) and those who don't like them (primarily because of the chaotic way some CMSes (dis)organise their media management) . I think that we can have our cake and eat it too! If done the right way, closely following the principles of and harnessing the power of ProcessWire, we can have a well-implemented, organised, feature-rich, site-wide media manager.
       
      Introducing Media Manager: (a commercial module)
       
      Alongside a number of modules I am currently working on (both free and commercial), I have been developing  a centralised Media Manager for ProcessWire. Before you cast the first stone, no, this is not going to be a one-large-media-bucket as in other CMS where it gets very messy very quickly . In the backend things are neatly stored away, yes, in pages. However, those are pages you will not see (just like repeater pages). Before anyone has a go at pages, remember a page is not that thing you see on the ProcessWire Tree (that's just its visual representation); A page is a record/row in the database    . For the end-user of Media Manager, all they will see is the 'familiar media bucket' to select their media from. As long as it works efficiently, I don't think they care about the wizardry behind the scenes  . 
       
      The module allows for the comprehensive management of several media types:
      Audio Video Images Documents Each media type will be handled by its own sub-module so the user can pick and install/choose the type of media management they want.
       
      Features include:
      Access controls Centralized uploads of media Bulk management of media: tag, delete, describe, replace, etc. Bulk upload: zip; scan, single Quick upload in page edit mode Usage stats across pages (maybe?) Etc.. Would love to hear your thoughts and any feature suggestions. I think there's enough demand for such a module. If not, please let me know so that I can instead focus on other things  , thanks.
       
      How other CMS do it

       
      The more efficient (PW) way of doing it

    • By Robin S
      I have had this module sitting in a 95% complete state for a while now and have finally made the push to get it out there. Thanks to @teppo for his Hanna Code Helper module which I referred to and borrowed from during development.
      http://modules.processwire.com/modules/hanna-code-dialog/
      https://github.com/Toutouwai/HannaCodeDialog
      HannaCodeDialog
      A module for ProcessWire CMS/CMF. Provides a number of enhancements for working with Hanna Code tags in CKEditor. The main enhancement is that Hanna tags in a CKEditor field may be double-clicked to edit their attributes using core ProcessWire inputfields in a modal dialog.
      Requires the Hanna Code module.
      Installation
      Install the HannaCodeDialog module using any of the normal methods.
      For any CKEditor field where you want the "Insert Hanna tag" dropdown menu to appear in the CKEditor toolbar, visit the field settings and add "HannaDropdown" to the "CKEditor Toolbar" settings field.
      Module configuration
      Visit the module configuration screen to set any of the following:
      Exclude prefix: Hanna tags named with this prefix will not appear in the CKEditor toolbar dropdown menu for Hanna tag insertion. Exclude Hanna tags: Hanna tags selected here will not appear in the CKEditor toolbar dropdown menu for Hanna tag insertion. Background colour of tag widgets: you can customise the background colour used for Hanna tags in CKEditor if you like. Dialog width: in pixels Dialog height: in pixels Features
      Insert tag from toolbar dropdown menu
      Place the cursor in the CKEditor window where you want to insert your Hanna tag, then select the tag from the "Insert Hanna tag" dropdown.

      Advanced: if you want to control which tags appear in the dropdown on particular pages or templates you can hook HannaCodeDialog::getDropdownTags. See the forum support thread for examples .
      Edit tag attributes in modal dialog
      Insert a tag using the dropdown or double-click an existing tag in the CKEditor window to edit the tag attributes in a modal dialog.

      Tags are widgets
      Hanna tags that have been inserted in a CKEditor window are "widgets" - they have a background colour for easy identification, are protected from accidental editing, and can be moved within the text by drag-and-drop.
      ![Hanna tag widget]
      Options for tag attributes may be defined
      You can define options for a tag attribute so that editors must choose an option rather than type text. This is useful for when only certain strings are valid for an attribute and also has the benefit of avoiding typos.
      Add a new attribute for the Hanna tag, named the same as the existing attribute you want to add options for, followed by "__options". The options themselves are defined as a string, using a pipe character as a delimiter between options. Example for an existing attribute named "vegetables":
      vegetables__options=Spinach|Pumpkin|Celery|Tomato|Brussels Sprout|Potato You can define a default for an attribute as normal. Use a pipe delimiter if defining multiple options as the default, for example:
      vegetables=Tomato|Potato Dynamic options
      Besides defining static options as above, you can use one Hanna tag to dynamically generate options for another. For instance, you could create a Hanna tag that generates options based on images that have been uploaded to the page, or the titles of children of the page.
      Your Hanna tag that generates the options should echo a string of options delimited by pipe characters (i.e. the same format as a static options string).
      You will probably want to name the Hanna tag that generates the options so that it starts with an underscore (or whatever prefix you have configured as the "exclude" prefix in the module config), to avoid it appearing as an insertable tag in the HannaCodeDialog dropdown menu.
      Example for an existing attribute named "image":
      image__options=[[_images_on_page]] And the code for the _images_on_page tag:
      <?php $image_names = array(); $image_fields = $page->fields->find('type=FieldtypeImage')->explode('name'); foreach($image_fields as $image_field) { $image_names = array_unique( array_merge($image_names, $page->$image_field->explode('name') ) ); } echo implode('|', $image_names); Advanced: define or manipulate options in a hook
      You can hook HannaCodeDialog::prepareOptions to define or manipulate options for a Hanna tag attribute. Your Hanna tag must include a someattribute__options attribute in order for the hook to fire. The prepareOptions method receives the following arguments that can be used in your hook:
      options_string Any existing string of options you have set for the attribute attribute_name The name of the attribute the options are for tag_name The name of the Hanna tag page The page being edited If you hook after HannaCodeDialog::prepareOptions then your hook should set $event->return to an array of option values, or an associative array in the form of $value => $label.
      Choice of inputfield for attribute
      You can choose the inputfield that is used for an attribute in the dialog.
      For text attributes the supported inputfields are text (this is the default inputfield for text attributes so it isn't necessary to specify it if you want it) and textarea. Note: any manual line breaks inside a textarea are removed because these will break the CKEditor tag widget.
      Inputfields that support the selection of a single option are select (this is the default inputfield for attributes with options so it isn't necessary to specify it if you want it) and radios.
      Inputfields that support the selection of multiple options are selectmultiple, asmselect and checkboxes.
      You can also specify a checkbox inputfield - this is not for attributes with defined options but will limit an attribute to an integer value of 1 or 0.
      The names of the inputfield types are case-insensitive.
      Example for an existing attribute named "vegetables":
      vegetables__type=asmselect Descriptions and notes for inputfields
      You can add a description or notes to an attribute and these will be displayed in the dialog.
      Example for an existing attribute named "vegetables":
      vegetables__description=Please select vegetables for your soup. vegetables__notes=Pumpkin and celery is a delicious combination. Notes
      When creating or editing a Hanna tag you can view a basic cheatsheet outlining the HannaCodeDialog features relating to attributes below the "Attributes" config inputfield.
      Troubleshooting
      HannaCodeDialog includes and automatically loads the third-party CKEditor plugins Line Utilities and Widget. If you have added these plugins to your CKEditor field already for some purpose and experience problems with HannaCodeDialog try deactivating those plugins from the CKEditor field settings.
×
×
  • Create New...