{blog_heading}
+ + +{blog_heading}
- {blog_entries} -{title}
-{body}
- {/blog_entries} + {blog_entries} +{title}
+{body}
+ {/blog_entries} - - + + These variables are not actual PHP variables, but rather plain text representations that allow you to eliminate PHP from your templates (view files). .. note:: CodeIgniter does **not** require you to use this class since - using pure PHP in your view pages (for instance using the - :doc:`View renderer ` ) - lets them run a little faster. - However, some developers prefer to use some form of template engine if - they work with designers who they feel would find some - confusion working with PHP. + using pure PHP in your view pages (for instance using the + :doc:`View renderer ` ) + lets them run a little faster. + However, some developers prefer to use some form of template engine if + they work with designers who they feel would find some + confusion working with PHP. *************************** Using the View Parser Class @@ -45,12 +45,12 @@ Using the View Parser Class The simplest method to load the parser class is through its service:: - $parser = \Config\Services::parser(); + $parser = \Config\Services::parser(); Alternately, if you are not using the ``Parser`` class as your default renderer, you can instantiate it directly:: - $parser = new \CodeIgniter\View\Parser(); + $parser = new \CodeIgniter\View\Parser(); Then you can use any of the three standard rendering methods that it provides: **render(viewpath, options, save)**, **setVar(name, value, context)** and @@ -87,13 +87,13 @@ Parser templates You can use the ``render()`` method to parse (or render) simple templates, like this:: - $data = [ - 'blog_title' => 'My Blog Title', - 'blog_heading' => 'My Blog Heading', - ]; + $data = [ + 'blog_title' => 'My Blog Title', + 'blog_heading' => 'My Blog Heading', + ]; - echo $parser->setData($data) - ->render('blog_template'); + echo $parser->setData($data) + ->render('blog_template'); View parameters are passed to ``setData()`` as an associative array of data to be replaced in the template. In the above example, the @@ -110,18 +110,18 @@ Several options can be passed to the ``render()`` or ``renderString()`` methods. - ``cache`` - the time in seconds, to save a view's results; ignored for renderString() - ``cache_name`` - the ID used to save/retrieve a cached view result; defaults to the viewpath; - ignored for renderString() + ignored for renderString() - ``saveData`` - true if the view data parameters should be retained for subsequent calls; - default is **false** -- ``cascadeData`` - true if pseudo-variable settings should be passed on to nested - substitutions; default is **true** + default is **false** +- ``cascadeData`` - true if pseudo-variable settings should be passed on to nested + substitutions; default is **true** :: - echo $parser->render('blog_template', [ - 'cache' => HOUR, - 'cache_name' => 'something_unique', - ]); + echo $parser->render('blog_template', [ + 'cache' => HOUR, + 'cache_name' => 'something_unique', + ]); *********************** Substitution Variations @@ -134,12 +134,12 @@ The **simple substitution** performed by the parser is a one-to-one replacement of pseudo-variables where the corresponding data parameter has either a scalar or string value, as in this example:: - $template = '{blog_heading}
+ + +{blog_heading}
- {blog_entries} -{title}
-{body}
- {/blog_entries} + {blog_entries} +{title}
+{body}
+ {/blog_entries} - - + + In the above code you'll notice a pair of variables: {blog_entries} data... {/blog_entries}. In a case like this, the entire chunk of data @@ -186,20 +186,20 @@ Parsing variable pairs is done using the identical code shown above to parse single variables, except, you will add a multi-dimensional array corresponding to your variable pair data. Consider this example:: - $data = [ - 'blog_title' => 'My Blog Title', - 'blog_heading' => 'My Blog Heading', - 'blog_entries' => [ - ['title' => 'Title 1', 'body' => 'Body 1'], - ['title' => 'Title 2', 'body' => 'Body 2'], - ['title' => 'Title 3', 'body' => 'Body 3'], - ['title' => 'Title 4', 'body' => 'Body 4'], - ['title' => 'Title 5', 'body' => 'Body 5'], - ], - ]; - - echo $parser->setData($data) - ->render('blog_template'); + $data = [ + 'blog_title' => 'My Blog Title', + 'blog_heading' => 'My Blog Heading', + 'blog_entries' => [ + ['title' => 'Title 1', 'body' => 'Body 1'], + ['title' => 'Title 2', 'body' => 'Body 2'], + ['title' => 'Title 3', 'body' => 'Body 3'], + ['title' => 'Title 4', 'body' => 'Body 4'], + ['title' => 'Title 5', 'body' => 'Body 5'], + ], + ]; + + echo $parser->setData($data) + ->render('blog_template'); The value for the pseudo-variable ``blog_entries`` is a sequential array of associative arrays. The outer level does not have keys associated @@ -209,16 +209,16 @@ If your "pair" data is coming from a database result, which is already a multi-dimensional array, you can simply use the database ``getResultArray()`` method:: - $query = $db->query("SELECT * FROM blog"); + $query = $db->query("SELECT * FROM blog"); - $data = [ - 'blog_title' => 'My Blog Title', - 'blog_heading' => 'My Blog Heading', - 'blog_entries' => $query->getResultArray(), - ]; + $data = [ + 'blog_title' => 'My Blog Title', + 'blog_heading' => 'My Blog Heading', + 'blog_entries' => $query->getResultArray(), + ]; - echo $parser->setData($data) - ->render('blog_template'); + echo $parser->setData($data) + ->render('blog_template'); If the array you are trying to loop over contains objects instead of arrays, the parser will first look for an ``asArray`` method on the object. If it exists, @@ -236,17 +236,17 @@ Nested Substitutions A nested substitution happens when the value for a pseudo-variable is an associative array of values, like a record from a database:: - $data = [ - 'blog_title' => 'My Blog Title', - 'blog_heading' => 'My Blog Heading', - 'blog_entry' => [ - 'title' => 'Title 1', - 'body' => 'Body 1', - ], - ]; + $data = [ + 'blog_title' => 'My Blog Title', + 'blog_heading' => 'My Blog Heading', + 'blog_entry' => [ + 'title' => 'Title 1', + 'body' => 'Body 1', + ], + ]; - echo $parser->setData($data) - ->render('blog_template'); + echo $parser->setData($data) + ->render('blog_template'); The value for the pseudo-variable ``blog_entry`` is an associative array. The key/value pairs defined inside it will be exposed inside @@ -254,13 +254,13 @@ the variable pair loop for that variable. A ``blog_template`` that might work for the above:: -{blog_title} - {blog_heading}
- {blog_entry} -
-
- {/blog_entry}
+ {title}
-{body}
-{blog_title} - {blog_heading}
+ {blog_entry} +
+
+ {/blog_entry}
If you would like the other pseudo-variables accessible inside the "blog_entry"
scope, then make sure that the "cascadeData" option is set to true.
@@ -273,13 +273,13 @@ comments in a ``{# #}`` symbols.
::
- {# This comment is removed during parsing. #}
- {blog_entry}
- {title}
+{body}
+
-
- {/blog_entry}
+ {# This comment is removed during parsing. #}
+ {blog_entry}
+ {title}
-{body}
-
+
+ {/blog_entry}
Cascading Data
==============
@@ -289,30 +289,30 @@ data pairs into the inner substitution.
The following example is not impacted by cascading::
- $template = '{name} lives in {location}{city} on {planet}{/location}.';
+ $template = '{name} lives in {location}{city} on {planet}{/location}.';
- $data = [
- 'name' => 'George',
- 'location' => ['city' => 'Red City', 'planet' => 'Mars'],
- ];
+ $data = [
+ 'name' => 'George',
+ 'location' => ['city' => 'Red City', 'planet' => 'Mars'],
+ ];
- echo $parser->setData($data)->renderString($template);
- // Result: George lives in Red City on Mars.
+ echo $parser->setData($data)->renderString($template);
+ // Result: George lives in Red City on Mars.
This example gives different results, depending on cascading::
- $template = '{location}{name} lives in {city} on {planet}{/location}.';
+ $template = '{location}{name} lives in {city} on {planet}{/location}.';
- $data = [
- 'name' => 'George',
- 'location' => ['city' => 'Red City', 'planet' => 'Mars'],
- ];
+ $data = [
+ 'name' => 'George',
+ 'location' => ['city' => 'Red City', 'planet' => 'Mars'],
+ ];
- echo $parser->setData($data)->renderString($template, ['cascadeData'=>false]);
- // Result: {name} lives in Red City on Mars.
+ echo $parser->setData($data)->renderString($template, ['cascadeData'=>false]);
+ // Result: {name} lives in Red City on Mars.
- echo $parser->setData($data)->renderString($template, ['cascadeData'=>true]);
- // Result: George lives in Red City on Mars.
+ echo $parser->setData($data)->renderString($template, ['cascadeData'=>true]);
+ // Result: George lives in Red City on Mars.
Preventing Parsing
==================
@@ -322,9 +322,9 @@ section will stay exactly as it is, with no variable substitution, looping, etc,
::
- {noparse}
- {title}
+{body}
+Untouched Code
- {/noparse} + {noparse} +Untouched Code
+ {/noparse} Conditional Logic ================= @@ -332,15 +332,15 @@ Conditional Logic The Parser class supports some basic conditionals to handle ``if``, ``else``, and ``elseif`` syntax. All ``if`` blocks must be closed with an ``endif`` tag:: - {if $role=='admin'} -Welcome, Admin!
- {endif} + {if $role=='admin'} +Welcome, Admin!
+ {endif} This simple block is converted to the following during parsing:: - -Welcome, Admin!
- + +Welcome, Admin!
+ All variables used within if statements must have been previously set with the same name. Other than that, it is treated exactly like a standard PHP conditional, and all standard PHP rules would apply here. You can use any @@ -348,16 +348,16 @@ of the comparison operators you would normally, like ``==``, ``===``, ``!==``, ` :: - {if $role=='admin'} -Welcome, Admin
- {elseif $role=='moderator'} -Welcome, Moderator
- {else} -Welcome, User
- {endif} + {if $role=='admin'} +Welcome, Admin
+ {elseif $role=='moderator'} +Welcome, Moderator
+ {else} +Welcome, User
+ {endif} .. note:: In the background, conditionals are parsed using an **eval()**, so you must ensure that you take - care with the user data that is used within conditionals, or you could open your application up to security risks. + care with the user data that is used within conditionals, or you could open your application up to security risks. Escaping Data ============= @@ -367,13 +367,13 @@ supports several different contexts, like general **html**, when it's in an HTML else is specified, the data will be assumed to be in an HTML context. You can specify the context used by using the **esc** filter:: - { user_styles | esc(css) } - { title } + { user_styles | esc(css) } + { title } There will be times when you absolutely need something to used and NOT escaped. You can do this by adding exclamation marks to the opening and closing braces:: - {! unescaped_var !} + {! unescaped_var !} Filters ======= @@ -385,17 +385,17 @@ need to format the same data differently in several sections on the same page. Filters are commands that come after the pseudo-variable name, and are separated by the pipe symbol, ``|``:: - // -55 is displayed as 55 - { value|abs } + // -55 is displayed as 55 + { value|abs } If the parameter takes any arguments, they must be separated by commas and enclosed in parentheses:: - { created_at|date(Y-m-d) } + { created_at|date(Y-m-d) } Multiple filters can be applied to the value by piping multiple ones together. They are processed in order, from left to right:: - { created_at|date_modify(+5 days)|date(Y-m-d) } + { created_at|date_modify(+5 days)|date(Y-m-d) } Provided Filters ---------------- @@ -473,10 +473,10 @@ You can easily create your own filters by editing **app/Config/View.php** and ad ``$filters`` array. Each key is the name of the filter is called by in the view, and its value is any valid PHP callable:: - public $filters = [ - 'abs' => '\CodeIgniter\View\Filters::abs', - 'capitalize' => '\CodeIgniter\View\Filters::capitalize', - ]; + public $filters = [ + 'abs' => '\CodeIgniter\View\Filters::abs', + 'capitalize' => '\CodeIgniter\View\Filters::capitalize', + ]; PHP Native functions as Filters ------------------------------- @@ -485,9 +485,9 @@ You can use native php function as filters by editing **app/Config/View.php** an ``$filters`` array.Each key is the name of the native PHP function is called by in the view, and its value is any valid native PHP function prefixed with:: - public $filters = [ - 'str_repeat' => '\str_repeat', - ]; + public $filters = [ + 'str_repeat' => '\str_repeat', + ]; Parser Plugins ============== @@ -495,7 +495,7 @@ Parser Plugins Plugins allow you to extend the parser, adding custom features for each project. They can be any PHP callable, making them very simple to implement. Within templates, plugins are specified by ``{+ +}`` tags:: - {+ foo +} inner content {+ /foo +} + {+ foo +} inner content {+ /foo +} This example shows a plugin named **foo**. It can manipulate any of the content between its opening and closing tags. In this example, it could work with the text " inner content ". Plugins are processed before any pseudo-variable @@ -503,16 +503,16 @@ replacements happen. While plugins will often consist of tag pairs, like shown above, they can also be a single tag, with no closing tag:: - {+ foo +} + {+ foo +} Opening tags can also contain parameters that can customize how the plugin works. The parameters are represented as key/value pairs:: - {+ foo bar=2 baz="x y" } + {+ foo bar=2 baz="x y" } Parameters can also be single values:: - {+ include somefile.php +} + {+ include somefile.php +} Provided Plugins ---------------- @@ -520,14 +520,14 @@ Provided Plugins The following plugins are available when using the parser: ==================== ========================== ================================================================================== ================================================================ -Plugin Arguments Description Example +Plugin Arguments Description Example ==================== ========================== ================================================================================== ================================================================ current_url Alias for the current_url helper function. {+ current_url +} -previous_url Alias for the previous_url helper function. {+ previous_url +} +previous_url Alias for the previous_url helper function. {+ previous_url +} siteURL Alias for the site_url helper function. {+ siteURL "login" +} -mailto email, title, attributes Alias for the mailto helper function. {+ mailto email=foo@example.com title="Stranger Things" +} -safe_mailto email, title, attributes Alias for the safe_mailto helper function. {+ safe_mailto email=foo@example.com title="Stranger Things" +} -lang language string Alias for the lang helper function. {+ lang number.terabyteAbbr +} +mailto email, title, attributes Alias for the mailto helper function. {+ mailto email=foo@example.com title="Stranger Things" +} +safe_mailto email, title, attributes Alias for the safe_mailto helper function. {+ safe_mailto email=foo@example.com title="Stranger Things" +} +lang language string Alias for the lang helper function. {+ lang number.terabyteAbbr +} validation_errors fieldname(optional) Returns either error string for the field (if specified) or all validation errors. {+ validation_errors +} , {+ validation_errors field="email" +} route route name Alias for the route_to helper function. {+ route "login" +} ==================== ========================== ================================================================================== ================================================================ @@ -539,12 +539,12 @@ At its simplest, all you need to do to register a new plugin and make it ready f **app/Config/View.php**, under the **$plugins** array. The key is the name of the plugin that is used within the template file. The value is any valid PHP callable, including static class methods, and closures:: - public $plugins = [ - 'foo' => '\Some\Class::methodName', - 'bar' => function ($str, array $params=[]) { - return $str; - }, - ]; + public $plugins = [ + 'foo' => '\Some\Class::methodName', + 'bar' => function ($str, array $params=[]) { + return $str; + }, + ]; Any closures that are being used must be defined in the config file's constructor:: @@ -565,21 +565,21 @@ Any closures that are being used must be defined in the config file's constructo If the callable is on its own, it is treated as a single tag, not a open/close one. It will be replaced by the return value from the plugin:: - public $plugins = [ - 'foo' => '\Some\Class::methodName' - ]; + public $plugins = [ + 'foo' => '\Some\Class::methodName' + ]; - // Tag is replaced by the return value of Some\Class::methodName static function. - {+ foo +} + // Tag is replaced by the return value of Some\Class::methodName static function. + {+ foo +} If the callable is wrapped in an array, it is treated as an open/close tag pair that can operate on any of the content between its tags:: - public $plugins = [ - 'foo' => ['\Some\Class::methodName'] - ]; + public $plugins = [ + 'foo' => ['\Some\Class::methodName'] + ]; - {+ foo +} inner content {+ /foo +} + {+ foo +} inner content {+ /foo +} *********** Usage Notes @@ -588,49 +588,49 @@ Usage Notes If you include substitution parameters that are not referenced in your template, they are ignored:: - $template = 'Hello, {firstname} {lastname}'; - $data = [ - 'title' => 'Mr', - 'firstname' => 'John', - 'lastname' => 'Doe' - ]; - echo $parser->setData($data) - ->renderString($template); + $template = 'Hello, {firstname} {lastname}'; + $data = [ + 'title' => 'Mr', + 'firstname' => 'John', + 'lastname' => 'Doe' + ]; + echo $parser->setData($data) + ->renderString($template); - // Result: Hello, John Doe + // Result: Hello, John Doe If you do not include a substitution parameter that is referenced in your template, the original pseudo-variable is shown in the result:: - $template = 'Hello, {firstname} {initials} {lastname}'; - $data = [ - 'title' => 'Mr', - 'firstname' => 'John', - 'lastname' => 'Doe', - ]; - echo $parser->setData($data) - ->renderString($template); + $template = 'Hello, {firstname} {initials} {lastname}'; + $data = [ + 'title' => 'Mr', + 'firstname' => 'John', + 'lastname' => 'Doe', + ]; + echo $parser->setData($data) + ->renderString($template); - // Result: Hello, John {initials} Doe + // Result: Hello, John {initials} Doe If you provide a string substitution parameter when an array is expected, i.e., for a variable pair, the substitution is done for the opening variable pair tag, but the closing variable pair tag is not rendered properly:: - $template = 'Hello, {firstname} {lastname} ({degrees}{degree} {/degrees})'; - $data = [ - 'degrees' => 'Mr', - 'firstname' => 'John', - 'lastname' => 'Doe', - 'titles' => [ - ['degree' => 'BSc'], - ['degree' => 'PhD'], - ], - ]; - echo $parser->setData($data) - ->renderString($template); - - // Result: Hello, John Doe (Mr{degree} {/degrees}) + $template = 'Hello, {firstname} {lastname} ({degrees}{degree} {/degrees})'; + $data = [ + 'degrees' => 'Mr', + 'firstname' => 'John', + 'lastname' => 'Doe', + 'titles' => [ + ['degree' => 'BSc'], + ['degree' => 'PhD'], + ], + ]; + echo $parser->setData($data) + ->renderString($template); + + // Result: Hello, John Doe (Mr{degree} {/degrees}) View Fragments ============== @@ -642,53 +642,53 @@ of in the view. An example with the iteration controlled in the view:: - $template = '- {menuitems}
-
- {title} - {/menuitems}
- {menuitems}
+
- {title} + {/menuitems}
-
-
- First Link -
- Second Link -
-
+
- First Link +
- Second Link +
- {menuitems}
- {menuitems}
-
-
- First Link -
- Second Link -
-
+
- First Link +
- Second Link +
Username
+ + +Password
+ + +Password Confirm
+ + +Email Address
+ + + + + + + + + +Path: ``application/controllers/``:: + + load->helper(array('form', 'url')); + + $this->load->library('form_validation'); + + if ($this->form_validation->run() == FALSE) + { + $this->load->view('myform'); + } + else + { + $this->load->view('formsuccess'); + } + } + } + +Codeigniter Version 4.x +----------------------- +Path: ``app/Views``:: + + + +Username
+ + +Password
+ + +Password Confirm
+ + +Email Address
+ + + + + + + + + +Path: ``app/Controllers/``:: + + validate([])) + { + echo view('Signup', [ + 'validation' => $this->validator, + ]); + } + else + { + echo view('Success'); + } + } + } \ No newline at end of file diff --git a/user_guide_src/source/installation/upgrade_view_parser.rst b/user_guide_src/source/installation/upgrade_view_parser.rst new file mode 100644 index 000000000000..3b23a4ea1d0b --- /dev/null +++ b/user_guide_src/source/installation/upgrade_view_parser.rst @@ -0,0 +1,56 @@ +Upgrade View Parser +################### + +.. contents:: + :local: + :depth: 1 + + +Documentations +============== + +- `Template Parser Documentation Codeigniter 3.X-
+
-
-
+
-
+
-
+
-