Jump to content

Wireframe


teppo

Recommended Posts

5 hours ago, Mats said:

When i disable Wireframe (remove Wireframe as alternate template filename) the functional field shows up on the edit page. 

Does this mean that you've got the __text() call directly in the template file, site/templates/sometemplate.php? If so, then it's likely the issue I mentioned in my previous post: if you use functional fields in any file other than the default template file, you'll have to select that file via field config "file mode" setting.

  • Like 1
Link to comment
Share on other sites

  • 2 weeks later...

Hi @teppo

I need a small hint. 
I'm using components as building blocks of a layout like:

// wireframe.php 

$this->wire()->set('siteJS', new FilenameArray());
$this->wire()->set('siteCSS', new FilenameArray());

$wireframe = $this->wire()->modules->get('Wireframe');
$wireframe->init();
echo $wireframe->render();
// layouts/default.php

<?php namespace ProcessWire; ?>

<!DOCTYPE html>
<html lang="ru" class="<?= setting('html-classes')->implode(' '); ?>">
	<head>
		<?= Wireframe::component("Head"); ?>
	</head>
	<body>
		<div class="layout">
				<div class="layout__topbar">
					<div class="layout__container">
						<?= Wireframe::component("Topbar"); ?>
					</div>
				</div>
				<div class="layout__header">
					<?= Wireframe::component("Header"); ?>
				</div>
				<div class="layout__masthead">
					<?= Wireframe::component("Masthead"); ?>
				</div>
				<main class="layout__content">
					<?= $placeholders->default; ?>
				</main>
				<footer class="layout__footer">
					<?= Wireframe::component("Footer"); ?>
				</footer>
			</div>
	</body>
</html>

For the content part of a page, I'm using RepeaterMatrix and every type of repeater matrix is also a component prepared in the controller of a page.

'global' (Header, Footer etc.) and 'Matrix' (that are used for rendering matrix items) components could add its own CSS and JS assets like 

// components/Footer.php

<?php namespace Wireframe\Component;

class Footer extends \Wireframe\Component {


	public function __construct()
	{
		$this->wire()->siteCSS->add('footer);
	}

	// ...
}

Current program flow looks like

  1. Init method of a page controller file
  2. wireframe.php
  3. Render method of a page controller file
  4. layouts/default.php
  5. components/Head.php construct method
  6. components/Head.php render method
  7. construct and render method of other components
  8. components/Footer.php construct method
  9. components/Footer.php render method

The issue starts here. Head component should render links to CSS and JS assets, but as it goes before any other component and the construct method of components that goes below are not called, so its assets is not yet populated. 

Hope you get what the issue is and can give a hit. 

-------------------

Before Wireframe, I used a custom front-end module that was doing the same thing that Wireframe does but differently. I had a controller also for layouts and in this way, all partials were already rendered,  data needed for layout rendering was prepared before the layout was rendered. Say 'Copmonents' concept was exposed to the layouts.  
Is it possible somehow in the Wireframe? 

Thanks. 

Link to comment
Share on other sites

On 8/16/2021 at 12:53 AM, Zeka said:

The issue starts here. Head component should render links to CSS and JS assets, but as it goes before any other component and the construct method of components that goes below are not called, so its assets is not yet populated. 

This is an interesting dilemma for sure 🙂

Indeed components are rendered when their render methods are called (or they are converted to strings via __toString(), which then calls the render method), so they can't easily handle this type of logic. At the moment I think the easiest solution would involve placing some sort of tag in the layout which then gets replaced (likely via a hook) when markup is already rendered. This may not be what you're looking for, but here's how that hook could work:

$this->addHookAfter('View::render', function(HookEvent $event) {
	$event->return = str_replace('{{ head_component }}', Wireframe::component('Head'), $event->return);
});

(Bundling this into a component is of course not really necessary at this point. Also: if you do this, you'll likely want to check if wire('siteJS') etc. exists before setting it, since wireframe.php may get executed multiple times.)

Another option would be pre-rendering your components in wireframe.php or a controller class for a template and passing them to Wireframe::render() as arguments. Depending on the use case this may or may not make sense; I've used that approach on some occasions myself.

I tried a few other things, but right now I don't have anything more sophisticated than this. One idea I played with a bit that could solve this was similar to Blade components (<x-head arg="value"></x-head> etc.) but this comes with some limitations, so not sure yet if it makes sense... or perhaps we should have a way for components to specify methods that then get executed automatically later with predefined arguments?

Anyway, I'll keep this in mind and let you know if I figure out a better way 🙂 

  • Like 1
Link to comment
Share on other sites

@teppo Thanks for info. Will investigate proposed options. 

Could you please give an advice on how is it better to orgonize a large number of components.

Curretly I add to boot.php

wire('classLoader')->addNamespace('Wireframe\Blocks', paths('templates') . 'LayoutComponents/');
wire('classLoader')->addNamespace('Wireframe\Blocks', paths('templates') . 'BuilderComponents/');

In this way I put all components that are used in layout to LayoutComponents folder, all blocks for content builder to 'BuilderComponents' folder and component folder is used for components that are not part of the above groups. Maybe there is build in options for such task? 


 

Link to comment
Share on other sites

Hey @Zeka

To be honest what you're currently doing sounds like a reasonable solution, and also goes beyond what I've personally ever done/needed. In most projects I've got a handful of components — I think around ten or so at most — so splitting them into directories hasn't really been worth it. Boils down to preference, really; I tend to use partials for most things, and components only when I really need the power (and complexity) they add 🙂

So, long story short: there's no built-in way to split components into directories, but that's not a bad idea (after all that's always been there for partials), so I've added it to my list for now.

  • Like 1
Link to comment
Share on other sites

  • 2 months later...
On 8/20/2020 at 8:37 PM, bernhard said:

Well, the great thing about custom pageClasses is that they do also work on the backend. You can use them for hooking the pageedit form for example. Or today I did some custom redirects when a page is save+exit'ed. This really belongs to the page object imho, so it makes sense to have everything in a class extending the Page class. I'm not sure yet where to draw the line between page classes and controllers for wireframe...

Hey, @teppo! I am back at this great module. Trying to make everything work as it should. I've read your conversation with @bernhard a number of times and think that a lot of issues discussed should make their way into the docs somehow. And answering the question quoted above (about the usage of custom page classes and controllers in Wireframe) would make another great page for Patterns and practices . The great docs are one of the main things that make Wireframe so attractive, as we can easily point to them when working in a team or passing a project to someone else. So keeping them up to date and adding more info is definitely as important (for someone who didn't write the framework in the 1st place))) as adding new features.

I would participate in this process if there was a way to. At least I would fix some typos. But as cool as PW backend is it is not as good for open documentation. Is there a chance we can move the content creation to github and populate/update pages in PW via a script? I think someone already done this before...

  • Like 1
Link to comment
Share on other sites

On 11/12/2021 at 7:21 PM, Ivan Gretsky said:

By the way, @bernhard, could you please provide an example)

I'm not sure what I was talking about back then, but you can simply do something like this:

<?php namespace ProcessWire;
class MyPage extends Page {
  
  public function init() {
    $this->addHookAfter("ProcessPageEdit::buildForm", $this, "buildForm");
  }

  public function buildForm(HookEvent $event) {
    $page = $event->process->getPage();
    if(!$page instanceof self) return;
    // $page is a MyPage object now
    
    $form = $event->return;
    // get the title field and add a note if we find it
    if($f = $form->get('title')) {
      // note that we use $page->foo() and not $this->foo()
      $f->notes = "I am a MyPage object and my foo() method says: ".$page->foo();
    }
  }
  
  public function foo() {
    return 'MyPage-Foo!';
  }
  
}

Note that the hook in this example never gets executed! You'd need to trigger it once. Where you do that is up to you - I'm usually doing that via RockMigrations (https://github.com/BernhardBaumrock/RockMigrations/blob/5cafb3c6c0f2004b8d4087ca243cc0d5f771dd11/RockMigrations.module.php#L377) but you could also add it in init.php

<?php
$tmp = new MyPage();
$tmp->init();

This adds a little overhead since we load an additional instance of MyPage on every request but I do much more prefer that over getting more and more of a hook hell on larger projects. The way I showed above is much cleaner and keeps everything where it belongs: To the MyPage class.

Now once you open a MyPage in the PW backend you get the note on the title field and you know where to look for that hook: In MyPage.php - not in ready.php, or init.php, or another module, or wherever else...

  • Like 3
Link to comment
Share on other sites

@teppo Hi. It would be great to have a note about PageRenderNoCachePage session variable in the docs, it took me some time to understand the reason for the non-worked cache for some pages.

  • Like 1
Link to comment
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 monollonom
      (once again I was surprised to see a work of mine pop up in the newsletter, this time without even listing the module on PW modules website 😅. Thx @teppo !)
      FieldtypeQRCode
      Github: https://github.com/romaincazier/FieldtypeQRCode
      Modules directory: https://processwire.com/modules/fieldtype-qrcode/
      A simple fieldtype generating a QR Code from the public URL of the page, and more.
      Using the PHP library QR Code Generator by Kazuhiko Arase.

      Options
      In the field’s Details tab you can change between .gif or .svg formats. If you select .svg you will have the option to directly output the markup instead of a base64 image. SVG is the default.
      You can also change what is used to generate the QR code and even have several sources. The accepted sources (separated by a comma) are: httpUrl, editUrl, or the name of any text/URL/file/image field.
      If LanguageSupport is installed the compatible sources (httpUrl, text field, ...) will return as many QR codes as there are languages. Note however that when outputting on the front-end, only the languages visible to the user will be generated.
      Formatting
      Unformatted value
      When using $page->getUnformatted("qrcode_field") it returns an array with the following structure:
      [ [ "label" => string, // label used in the admin "qr" => string, // the qrcode image "source" => string, // the source, as defined in the configuration "text" => string // and the text used to generate the qrcode ], ... ] Formatted value
      The formatted value is an <img>/<svg> (or several right next to each other). There is no other markup.
      Should you need the same markup as in the admin you could use:
      $field = $fields->get("qrcode_field"); $field->type->markupValue($page, $field, $page->getUnformatted("qrcode_field")); But it’s a bit cumbersome, plus you need to import the FieldtypeQRCode's css/js. Best is to make your own markup using the unformatted value.
      Static QR code generator
      You can call FieldtypeQRCode::generateQRCode to generate any QR code you want. Its arguments are:
      string $text bool $svg Generate the QR code as svg instead of gif ? (default=true) bool $markup If svg, output its markup instead of a base64 ? (default=false) Hooks
      Please have a look at the source code for more details about the hookable functions.
      Examples
      $wire->addHookAfter("FieldtypeQRCode::getQRText", function($event) { $page = $event->arguments("page"); $event->return = $page->title; // or could be: $event->return = "Your custom text"; }) $wire->addHookAfter("FieldtypeQRCode::generateQRCodes", function($event) { $qrcodes = $event->return; // keep everything except the QR codes generated from editUrl foreach($qrcodes as $key => &$qrcode) { if($qrcode["source"] === "editUrl") { unset($qrcodes[$key]); } } unset($qrcode); $event->return = $qrcodes; })
    • By Sebi
      AppApiFile adds the /file endpoint to the AppApi routes definition. Makes it possible to query files via the api. 
      This module relies on the base module AppApi, which must be installed before AppApiFile can do its work.
      Features
      You can access all files that are uploaded at any ProcessWire page. Call api/file/route/in/pagetree?file=test.jpg to access a page via its route in the page tree. Alternatively you can call api/file/4242?file=test.jpg (e.g.,) to access a page by its id. The module will make sure that the page is accessible by the active user.
      The GET-param "file" defines the basename of the file which you want to get.
      The following GET-params (optional) can be used to manipulate an image:
      width height maxwidth maxheight cropX cropY Use GET-Param format=base64 to receive the file in base64 format.
    • By MarkE
      This fieldtype and inputfield bundle was built for storing measurement values within a field, rendering them in a variety of formats and converting them to other units or otherwise modifying them via the API.
      The API consists of a number of predefined functions, some of which include...
      render() for rendering the measurement object, valueAs() for converting the value to another unit value, convertTo() for converting the whole measurement object to different units, and add() and subtract() for for modifying the stored value by the value (converted as required) in another measurement. In the admin the inputfield includes a checkbox (which can be optionally disabled) for converting values on page save. For an example if a value was typed in as centimeters, the unit was changed to metres, and the page saved with this checkbox selected, said value would be automatically converted so that e.g. 170 cm becomes 1.7 m.

      A simple length field using Fieldtype Measurement and Inputfield Measurement.
      Combination units (e.g. feet and inches) are also supported.
      Please note that this module is 'proof of concept' at the moment - there are limited units available and quite a lot of code tidying to do. More units will be added shortly.
      See the GitHub at https://github.com/MetaTunes/FieldtypeMeasurement for full details and updates.
    • By tcnet
      File Manager for ProcessWire is a module to manager files and folders from the CMS backend. It supports creating, deleting, renaming, packing, unpacking, uploading, downloading and editing of files and folders. The integrated code editor ACE supports highlighting of all common programming languages.
      https://github.com/techcnet/ProcessFileManager

      Warning
      This module is probably the most powerful module. You might destroy your processwire installation if you don't exactly know what you doing. Be careful and use it at your own risk!
      ACE code editor
      This module uses ACE code editor available from: https://github.com/ajaxorg/ace

      Dragscroll
      This module uses the JavaScript dragscroll available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability to drag the table horizontally with the mouse pointer.
      PHP File Manager
      This module uses a modified version of PHP File Manager available from: https://github.com/alexantr/filemanager
       
    • By tcnet
      This module implements the website live chat service from tawk.to. Actually the module doesn't have to do much. It just need to inserted a few lines of JavaScript just before the closing body tag </body> on each side. However, the module offers additional options to display the widget only on certain pages.
      Create an account
      Visit https://www.tawk.to and create an account. It's free! At some point you will reach a page where you can copy the required JavaScript-code.

      Open the module settings and paste the JavaScript-code into the field as shown below. Click "Submit" and that's all.

      Open the module settings
      The settings for this module are located int the menu Modules=>Configure=>LiveChatTawkTo.

       
×
×
  • Create New...