Templates

Nextcloud provides its own templating system which is basically plain PHP with some additional functions and preset variables. All the parameters which have been passed from the controller are available in an array called $_[], e.g.:

  1. array('key' => 'something')

can be accessed through:

  1. $_['key']

Note

To prevent XSS the following PHP functions for printing are forbidden: echo, print() and <?=. Instead use the p() function for printing your values. Should you require unescaped printing, double check for XSS and use: :php:func:`print_unescaped`.

Printing values is done by using the p() function, printing HTML is done by using print_unescaped()

templates/main.php

  1. <?php foreach($_['entries'] as $entry){ ?>
  2.   <p><?php p($entry); ?></p>
  3. <?php
  4. }

Including templates

Templates can also include other templates by using the $this->inc(‘templateName’) method.

  1. <?php print_unescaped($this->inc('sub.inc')); ?>

The parent variables will also be available in the included templates, but should you require it, you can also pass new variables to it by using the second optional parameter as array for $this->inc.

templates/sub.inc.php

  1. <div>I am included, but I can still access the parents variables!</div>
  2. <?php p($_['name']); ?>
  4. <?php print_unescaped($this->inc('other_template', array('variable' => 'value'))); ?>

Including CSS and JavaScript

To include CSS or JavaScript use the style and script functions:

  1. <?php
  2. script('myapp', 'script');  // add js/script.js
  3. style('myapp', 'style');  // add css/style.css

Including images

To generate links to images use the image_path function:

  1. <img src="<?php print_unescaped(image_path('myapp', 'app.png')); ?>" />