mirror of
https://github.com/smarty-php/smarty.git
synced 2025-07-29 15:37:14 +02:00
Feature/add docs (#689)
* Add converted docs repo * Set theme jekyll-theme-minimal * Removed BC docs, added TOC * Added TOCs, rewrote most important links in documentation. Linked README to new Github Pages site * some link fixes
This commit is contained in:
82
docs/programmers/api-functions/api-display.md
Normal file
82
docs/programmers/api-functions/api-display.md
Normal file
@ -0,0 +1,82 @@
|
||||
display()
|
||||
|
||||
displays the template
|
||||
|
||||
Description
|
||||
===========
|
||||
|
||||
void
|
||||
|
||||
display
|
||||
|
||||
string
|
||||
|
||||
template
|
||||
|
||||
string
|
||||
|
||||
cache\_id
|
||||
|
||||
string
|
||||
|
||||
compile\_id
|
||||
|
||||
This displays the contents of a template. To return the contents of a
|
||||
template into a variable, use [`fetch()`](#api.fetch). Supply a valid
|
||||
[template resource](#resources) type and path. As an optional second
|
||||
parameter, you can pass a `$cache_id`, see the [caching
|
||||
section](#caching) for more information.
|
||||
|
||||
PARAMETER.COMPILEID
|
||||
|
||||
|
||||
<?php
|
||||
include(SMARTY_DIR.'Smarty.class.php');
|
||||
$smarty = new Smarty();
|
||||
$smarty->setCaching(true);
|
||||
|
||||
// only do db calls if cache doesn't exist
|
||||
if(!$smarty->isCached('index.tpl')) {
|
||||
|
||||
// dummy up some data
|
||||
$address = '245 N 50th';
|
||||
$db_data = array(
|
||||
'City' => 'Lincoln',
|
||||
'State' => 'Nebraska',
|
||||
'Zip' => '68502'
|
||||
);
|
||||
|
||||
$smarty->assign('Name', 'Fred');
|
||||
$smarty->assign('Address', $address);
|
||||
$smarty->assign('data', $db_data);
|
||||
|
||||
}
|
||||
|
||||
// display the output
|
||||
$smarty->display('index.tpl');
|
||||
?>
|
||||
|
||||
|
||||
|
||||
Use the syntax for [template resources](#resources) to display files
|
||||
outside of the [`$template_dir`](#variable.template.dir) directory.
|
||||
|
||||
|
||||
<?php
|
||||
// absolute filepath
|
||||
$smarty->display('/usr/local/include/templates/header.tpl');
|
||||
|
||||
// absolute filepath (same thing)
|
||||
$smarty->display('file:/usr/local/include/templates/header.tpl');
|
||||
|
||||
// windows absolute filepath (MUST use "file:" prefix)
|
||||
$smarty->display('file:C:/www/pub/templates/header.tpl');
|
||||
|
||||
// include from template resource named "db"
|
||||
$smarty->display('db:header.tpl');
|
||||
?>
|
||||
|
||||
|
||||
|
||||
See also [`fetch()`](#api.fetch) and
|
||||
[`templateExists()`](#api.template.exists).
|
Reference in New Issue
Block a user