Forums / Developer / Template

Template

Author Message

namita varshney

Tuesday 28 December 2010 10:54:22 pm

Can we write PHP code in Template file?

Thanks

Namita

Ivo Lukac

Wednesday 29 December 2010 1:27:27 am

Directly no.

You can easily create custom template operators which are basically wrapped php code

http://www.linkedin.com/in/ivolukac
http://www.netgen.hr/eng/blog
http://twitter.com/ilukac

namita varshney

Wednesday 29 December 2010 5:45:29 am

I had just started working on eZ publish,

So please can you say me how custom template operator is created?

Thanks

Namita

Ivo Lukac

Wednesday 29 December 2010 7:15:18 am

Well,

If you are a php developer it should be easy:

  • create an extension ( e.g. extensions/foo )
  • create folder autoloads in your extension (extensions/foo/autoloads)
  • create file eztemplateautoload.php in that folder (extensions/foo/autoloads/eztemplateautoload.php)
<?php
$eZTemplateOperatorArray = array();
$eZTemplateOperatorArray[] = array( 'script' => 'extension/foo/autoloads/bar.php',
        'class' => 'FooBarOperator',        
        'operator_names' => array('foobar' ) );
?>
  • create the actual php file (extensions/foo/autoloads/bar.php)
<?php
class FooBarOperator {   
 function operatorList() { 
   return array( 'foobar' ); 
 }
 function namedParameterPerOperator() { 
   return true; 
 }
 function namedParameterList() {  
   return array( 'foobar' => array(
      'param1' => array( 'type' => 'string', 'required' => true, 'default' => '') ,
      'param2' => array( 'type' => 'array', 'required' => false, 'default' => array() ) ) );
 }
 function modify( $tpl, $operatorName, $operatorParameters, $rootNamespace, $currentNamespace, &$operatorValue, &$namedParameters ) {
   switch ( $operatorName ) { 
     case 'foobar':           
     {              
         $operatorValue = $this->fooBar( $namedParameters['param1'],$namedParameters['param2']  );           
     } break;       
   }   
 }      
 function fooBar($param1, $param2) { 
   return "Hello World"; 
 }
}
?>

So we mapped fooBar() function to the "foobar" operator so you can call it from template like this: {foobar('something')}

For finishing you need to enable the extension and regenerate autoloads to make it work.

http://www.linkedin.com/in/ivolukac
http://www.netgen.hr/eng/blog
http://twitter.com/ilukac

Ivo Lukac

Wednesday 29 December 2010 7:22:56 am

I forgot that there is a wizard for getting this kind of skeleton.

Go to Setup->RAD->Template operator wizard

http://www.linkedin.com/in/ivolukac
http://www.netgen.hr/eng/blog
http://twitter.com/ilukac

namita varshney

Wednesday 29 December 2010 11:18:38 pm

Hello,

I have done all this process for creating the extension.

But its not working. I had called the operator from the template file but its not returning any value.

Can you say what i should do now?

Thanks

Namita

Ivo Lukac

Thursday 30 December 2010 3:37:20 am

Hm,

You enabled the extension, regenerated autoloads and cleared the cache?

Any errors in debug output?

ps

Just saw a typo in my previous post: Extension folder is 'extension', not 'extensions'

http://www.linkedin.com/in/ivolukac
http://www.netgen.hr/eng/blog
http://twitter.com/ilukac

namita varshney

Thursday 30 December 2010 9:47:40 pm

Thanks Ivo Lukac

Its working Fine. Thanks for Your help.

Namita

eZ debug

Timing: Jan 18 2025 10:16:45
Script start
Timing: Jan 18 2025 10:16:46
Module start 'content'
Timing: Jan 18 2025 10:16:46
Module end 'content'
Timing: Jan 18 2025 10:16:46
Script end

Main resources:

Total runtime0.2443 sec
Peak memory usage4,096.0000 KB
Database Queries141

Timing points:

CheckpointStart (sec)Duration (sec)Memory at start (KB)Memory used (KB)
Script start 0.00000.0085 587.5313180.8594
Module start 'content' 0.00850.0075 768.3906102.0469
Module end 'content' 0.01610.2281 870.4375529.5703
Script end 0.2442  1,400.0078 

Time accumulators:

 Accumulator Duration (sec) Duration (%) Count Average (sec)
Ini load
Load cache0.00361.4761200.0002
Check MTime0.00140.5715200.0001
Mysql Total
Database connection0.00110.465510.0011
Mysqli_queries0.190678.03721410.0014
Looping result0.00160.66271390.0000
Template Total0.227693.210.2276
Template load0.00090.367210.0009
Template processing0.226792.806910.2267
Override
Cache load0.00060.262410.0006
Sytem overhead
Fetch class attribute can translate value0.00150.597210.0015
XML
Image XML parsing0.00030.113410.0003
General
dbfile0.00692.8294200.0003
String conversion0.00000.002030.0000
Note: percentages do not add up to 100% because some accumulators overlap

CSS/JS files loaded with "ezjscPacker" during request:

CacheTypePacklevelSourceFiles
CSS0extension/community/design/community/stylesheets/ext/jquery.autocomplete.css
extension/community_design/design/suncana/stylesheets/scrollbars.css
extension/community_design/design/suncana/stylesheets/tabs.css
extension/community_design/design/suncana/stylesheets/roadmap.css
extension/community_design/design/suncana/stylesheets/content.css
extension/community_design/design/suncana/stylesheets/star-rating.css
extension/community_design/design/suncana/stylesheets/syntax_and_custom_tags.css
extension/community_design/design/suncana/stylesheets/buttons.css
extension/community_design/design/suncana/stylesheets/tweetbox.css
extension/community_design/design/suncana/stylesheets/jquery.fancybox-1.3.4.css
extension/bcsmoothgallery/design/standard/stylesheets/magnific-popup.css
extension/sevenx/design/simple/stylesheets/star_rating.css
extension/sevenx/design/simple/stylesheets/libs/fontawesome/css/all.min.css
extension/sevenx/design/simple/stylesheets/main.v02.css
extension/sevenx/design/simple/stylesheets/main.v02.res.css
JS0extension/ezjscore/design/standard/lib/yui/3.17.2/build/yui/yui-min.js
extension/ezjscore/design/standard/javascript/jquery-3.7.0.min.js
extension/community_design/design/suncana/javascript/jquery.ui.core.min.js
extension/community_design/design/suncana/javascript/jquery.ui.widget.min.js
extension/community_design/design/suncana/javascript/jquery.easing.1.3.js
extension/community_design/design/suncana/javascript/jquery.ui.tabs.js
extension/community_design/design/suncana/javascript/jquery.hoverIntent.min.js
extension/community_design/design/suncana/javascript/jquery.popmenu.js
extension/community_design/design/suncana/javascript/jScrollPane.js
extension/community_design/design/suncana/javascript/jquery.mousewheel.js
extension/community_design/design/suncana/javascript/jquery.cycle.all.js
extension/sevenx/design/simple/javascript/jquery.scrollTo.js
extension/community_design/design/suncana/javascript/jquery.cookie.js
extension/community_design/design/suncana/javascript/ezstarrating_jquery.js
extension/community_design/design/suncana/javascript/jquery.initboxes.js
extension/community_design/design/suncana/javascript/app.js
extension/community_design/design/suncana/javascript/twitterwidget.js
extension/community_design/design/suncana/javascript/community.js
extension/community_design/design/suncana/javascript/roadmap.js
extension/community_design/design/suncana/javascript/ez.js
extension/community_design/design/suncana/javascript/ezshareevents.js
extension/sevenx/design/simple/javascript/main.js

Templates used to render the page:

UsageRequested templateTemplateTemplate loadedEditOverride
1pagelayout.tpl<No override>extension/sevenx/design/simple/templates/pagelayout.tplEdit templateOverride template
 Number of times templates used: 1
 Number of unique templates used: 1

Time used to render debug report: 0.0002 secs