Cheat Sheet

pHAML	What it does
%tagname.class1.class2#id{attribute_1="value 1"...} Element Content	Create and element and put the content after it
A text line without preceding command	Just print as is (according to indent)
\ the line	Eat the '\', print the line as is
/ the line	Create HTML comment from the line
<<< >>>	Print everything between <<< & >>> verbatim
-	Wrap what follows in PHP tags
?	Turn on/off debug HTML comments
??	Turn on/off rendering as browser viewable HTML
!!! & !!!!	Opening doctype elements
Spacing
Indentation is how pHAML determines the tag structure. Elements indented more than the elements above will be contained within the one above. Elements with the same (or less) indentation will cause all elements above with more indentation to close.
Simple HTML Document	Simple XML Document
!!!! %html %head %title Simple Document %body %p this is the body, 5 lines=real document	!!! XML %element_1 %element_2 <![CDATA[ Stuff ]]> %element_3
Debug Hints
Try the following, turn on the debug comments, then show the HTML: %pre ? ?? %problem_element(s) ... ?? ?	Here are some common debug issues, in order of occurence: Lead Spacing (is your editor using tabs, pHAML assumes they are 4 spaces wide) Is the command/element syntax correct (as a PHP guy, I have a very quick '$' instead of '%') Use the debug system, or the pHAML Live tool (the reference implementation). When in doubt, you can look through the documentation code, since that is all pHAML, or read the source. If after all that, and you have found an undocumented feature (ok, call it a bug), or have a suggestion, submit it please.

A Simple Tag

pHAML	HTML Result
`%tagname`	<tagname> </tagname>

A Tag With a Class

pHAML	HTML Result
`%tagname.class`	<tagname class="class"> </tagname>

A Tag With Two Classes

pHAML	HTML Result
`%tagname.class.class_two`	<tagname class="class class_two"> </tagname>

A Tag With a Class and ID

pHAML	HTML Result
`%tagname.class#id`	<tagname class="class" id="id"> </tagname>

A Tag with Content

pHAML	HTML Result
`%tagname Some content`	<tagname> Some content </tagname>

Please note that the content has a space before it.

A Tag with Attributes

pHAML	HTML Result
`%tagname{att1="v1" att2="v2"}`	<tagname att1="v1" att2="v2"> </tagname>

This is a different structure than HAML. pHAML takes everything in brackets and adds it to the tag literally.

Bare Class Creates a DIV Tag with that Class

pHAML	HTML Result
`.class`	<div class="class"> </div>

Bare ID Creates a DIV Tag with that ID

pHAML	HTML Result
`#id`	<div id="id"> </div>

Same for Attributes

pHAML	HTML Result
`{att1="v1" att2="v2"}`	<div att1="v1" att2="v2"> </div>

Mix and Match

pHAML	HTML Result
`.class1.class2#id{a="1" b="2"}`	<div class="class1 class2" id="id" a="1" b="2"> </div>

An Ordered List

pHAML	HTML Result
%ol %li Hello %li World	<ol> <li> Hello </li> <li> World </li> </ol>

A Table

pHAML	HTML Result
%table.table#t_1{width="100%"} %tr %td.sam{valign="top" style="color:white;bgcolor:red;"} Data %tr %td.bob Other Data	<table class="table" id="t_1" width="100%"> <tr> <td class="sam" valign="top" style="color:white;bgcolor:red;"> Data </td> </tr> <tr> <td class="bob"> Other Data </td> </tr> </table>

pHAML

HTML Result

  %table.table#t_1{width="100%"}
    %tr
      %td.sam{valign="top" style="color:white;bgcolor:red;"} Data
    %tr
      %td.bob Other Data

<table class="table" id="t_1" width="100%">
<tr>
<td class="sam" valign="top" style="color:white;bgcolor:red;">
Data
</td>
</tr>
<tr>
<td class="bob">
Other Data 
</td>
</tr>
</table>

Escape Lines

pHAML	HTML Result
\%donottagme.meneither#ohnoo{not="us"} %tagme.meto#cool \/do not comment me /comment me	%donottagme.meneither#ohnoo{not="us"} <tagme class="meto" id="cool"> </tagme> /do not comment me <!-- comment me -->

pHAML

HTML Result

  \%donottagme.meneither#ohnoo{not="us"}
  %tagme.meto#cool
  \/do not comment me
  /comment me

%donottagme.meneither#ohnoo{not="us"}
<tagme class="meto" id="cool">
</tagme>
/do not comment me
<!-- comment me -->

HTML Comments

pHAML	HTML Result
/this is a comment	<!-- this is a comment -->

Non Rendered Comments

pHAML	HTML Result
now you see me!! //now you don't good to see you again!!	now you see me!! good to see you again!!

Here Doc Example

pHAML	HTML Result
%style{type="text/css"} <<< body { height:100%; font-size:11px; margin-left:5%; margin-right:5%; background-color:white; color:black; } >>>	<style type="text/css"> body { height:100%; font-size:11px; margin-left:5%; margin-right:5%; background-color:white; color:black; } </style>

pHAML

HTML Result

  %style{type="text/css"}
     <<<
        body {
        height:100%;
        font-size:11px;
        margin-left:5%;
        margin-right:5%;
        background-color:white;
        color:black;
        }
     >>>

<style type="text/css">
        body {
        height:100%;
        font-size:11px;
        margin-left:5%;
        margin-right:5%;
        background-color:white;
        color:black;
        }
</style>

Here Doc Example(Indents Matter)

pHAML	HTML Result
%style{type="text/css"} <<< body { height:100%; font-size:11px; margin-left:5%; margin-right:5%; background-color:white; color:black; } >>>	<style type="text/css"> body { height:100%; font-size:11px; margin-left:5%; margin-right:5%; background-color:white; color:black; } </style>

pHAML

HTML Result

  %style{type="text/css"}
     <<<
body {
height:100%;
font-size:11px;
margin-left:5%;
margin-right:5%;
background-color:white;
color:black;
}
     >>>

<style type="text/css">
body {
height:100%;
font-size:11px;
margin-left:5%;
margin-right:5%;
background-color:white;
color:black;
}
</style>

Here Doc Example(Renders "//" and empty lines)

pHAML	HTML Result
<<< line line //comments are rendered. When bug stomping, //not a good idea to wisecrack on users here. line >>>	line line //comments are rendered. When bug stomping, //not a good idea to wisecrack on users here. line

pHAML

HTML Result

     <<<
line

line
//comments are rendered. When bug stomping,
//not a good idea to wisecrack on users here.
line
     >>>

line

line
//comments are rendered. When bug stomping,
//not a good idea to wisecrack on users here.
line

The "-" Command (Embed PHP Code)

The "-" command will wrap the following code with tags, so that the rendered template can be evaled as PHP code (the class has a command to do it for you).

This class was written for two groups of users, developers and web users. The - command will create the PHP, but will not execute it, that is performed by a different class command. So you could have web users create their own templates, and render them, but they cannot execute PHP on the system host, unless you--the implementor--make a subsequent "phpExec" call to the object explicitly. You are warned.

It is at this point that you may want to consider a much richer set of templating functionality that is achieved by using Smarty and pHAML together.

Embedded PHP Example

pHAML	HTML Result
- for($x;$x<=10;$x++){ %p hello world - }	<?PHP for($x;$x<=10;$x++){ ?> <p> hello world </p> <?PHP } ?>
%table - $arr = array(); - $arr[0] = array('a','b','c'); - $arr[1] = array('d','e','f'); - foreach($arr as $row){ %tr - foreach($row as $col){ %td - echo $col; - } - }	<table> <?PHP $arr = array(); ?> <?PHP $arr[0] = array('a','b','c'); ?> <?PHP $arr[1] = array('d','e','f'); ?> <?PHP foreach($arr as $row){ ?> <tr> <?PHP foreach($row as $col){ ?> <td> <?PHP echo $col; ?> </td> <?PHP } ?> </tr> <?PHP } ?> </table>

pHAML

HTML Result

  - for($x;$x<=10;$x++){
    %p hello world
  - }

<?PHP for($x;$x<=10;$x++){ ?>
<p>
hello world
</p>
<?PHP } ?>

    %table
        - $arr = array();
        - $arr[0] = array('a','b','c');
        - $arr[1] = array('d','e','f');
        - foreach($arr as $row){
            %tr 
              - foreach($row as $col){
                %td
                  - echo $col;
              - }
        - }

<table>
<?PHP $arr = array(); ?>
<?PHP $arr[0] = array('a','b','c'); ?>
<?PHP $arr[1] = array('d','e','f'); ?>
<?PHP foreach($arr as $row){ ?>
<tr>
<?PHP foreach($row as $col){ ?>
<td>
<?PHP echo $col; ?>
</td>
<?PHP } ?>
</tr>
<?PHP } ?>
</table>

The "?" Command (Toggle Debug)

The "?" command will toggle the debug mode. If the debug mode is on, it is turned off, if off; it is turned on. Debug mode will print an HTML comment before each processed line of pHAML code, which can be very useful during design.

The "??" Command (Toggle Show HTML)

The "??" command will toggle the HTML mode. If the HTML mode is on, it is turned off; if off, it is turned on. The HTML mode will print everything in HTML characters, allowing the generated HTML to be seen (this is used in this document).

The "$" and "$-" Command (Insert Value from Passed PHP Array)

The "$" command will turn the pHAML renderer into a simple template system. You set the values of the assignment using the classes assign method. If you pass an array to the render call, the text following the $ will be used as an array key. The $- will strip the whitespace from both sides of the inserted value (good for textarea elements and such).

Debugging

Motivation

The debugging system inside of pHAML was developed quickly as pHAML was used to creating working sites. It consists of two principal commands.

The "?" (Show Line Information)

The "?" can be place on a single line at any horizontal location, it is not "preceding space sensitive". When on, an HTML comment containing useful information is created.

The debug information is provided in a format of:

Debug Command Example

pHAML	HTML Result
No debug info for this line, turn it on-- ? This text line is simple, it is indented by 20 /This is a comment line-see the / show up Now start a here doc <<< In the here doc, see the [on]? >>> Out of heredoc Turn off the debug ? This line does not have debug info	No debug info for this line, turn it on-- <!-- Debug on --> <!-- 870:20: This text line is simple, it is indented by 20 --> This text line is simple, it is indented by 20 <!-- 871:20{/}: /This is a comment line-see the '/' show up? --> <!-- This is a comment line-see the '/' show up? --> <!-- 872:20: Now start a here doc --> Now start a here doc <!-- 873:22{<<<}: <<< --> <!-- 874:23[on]: In the here doc, see the [on]? --> In the here doc, see the [on]? <!-- 875:22{>>>}[on]: >>> --> <!-- 876:20: Out of heredoc --> Out of heredoc <!-- 877:20: Turn off the debug --> Turn off the debug <!-- 878:20{?}: ? --> <!-- Debug off --> This line does not have debug info

pHAML

HTML Result

  No debug info for this line, turn it on--
  ?
  This text line is simple, it is indented by 20
  /This is a comment line-see the / show up
  Now start a here doc
    <<<
     In the here doc, see the [on]?
    >>>
  Out of heredoc
  Turn off the debug
  ?
  This line does not have debug info

No debug info for this line, turn it on--
<!-- Debug on -->
  <!-- 870:20: This text line is simple, it is indented by 20 -->
This text line is simple, it is indented by 20
  <!-- 871:20{/}: /This is a comment line-see the '/' show up? -->
<!-- This is a comment line-see the '/' show up? -->
  <!-- 872:20: Now start a here doc -->
Now start a here doc
    <!-- 873:22{<<<}: <<< -->
     <!-- 874:23[on]: In the here doc, see the [on]? -->
     In the here doc, see the [on]?
    <!-- 875:22{>>>}[on]: >>> -->
  <!-- 876:20: Out of heredoc -->
Out of heredoc
  <!-- 877:20: Turn off the debug -->
Turn off the debug
  <!-- 878:20{?}: ? -->
<!-- Debug off -->
This line does not have debug info

The "??" (Show the HTML)

The second tool in the debug toolbox is the "??" toggle, this command is "preceding space sensitive". When on, the content that follows is converted to HTML compatible characters, so that is will show up in the browser. This is the command that is used to show all of the HTML results in this document.

Show HTML Command Example

pHAML	HTML Result
?? %element#id data ??	<element id="id"> data </element>

Makes it easy to see everything.

The Most Useful Debug Combination

Combine the two commands to see both the code and debug info (use a %pre to help):

%pre
?
??
%problem_element(s)
...
??
?

Installation

pHAML is contained entirely in one class: class.pHAML.php. You may put the class anywhere in your web directory, it is safe. The easiest way to install is to put it in your class path.

Just include the class in your PHP code, create an instance--and of you go. Here is an example:

<?PHP
//include the pHAMLClass here
include('class.pHAML.php');
//create a template
$template=
'!!!!
%html
  %head
    %title Hello From pHAML!!
  %body
    %p Hello World';
//instantiate the class
$pHAML = new pHAML();
//render the content
$content = $pHAML->render($template);
//echo to the browser
echo $content;
?>

To turn pHAML into a simple templating system (good for prototyping sites), send an array along with the template, and use the "$" command.

<?PHP
//include the pHAMLClass here
include('class.pHAML.php');
//create an array composed of: name_of_variable_in_template_without_leading_dollar=>value_of_replacement_text
$values = array('greeting'=>'Hello World, I am a template!!!!');
//create a template
$template=
'!!!!
%html
  %head
    %title Hello From pHAML!!
  %body
    %p 
      $greeting';
//instantiate the class
$pHAML = new pHAML();
//render the content
$content = $pHAML->render($template,$values);
//echo to the browser
echo $content;
?>

pHAML has a recursive feature in the rendering of $key_name. If it cannot find the key that matches in the value array, it will look for a template in the template array, and compile that...and so on.

What template array? Good question, the render function can take an array of templates, and will compile them all, but return only the final result of the one with the array key of 'contents'. This allows the design to break into several different templates, maybe an example will help.

<?PHP
//include the pHAMLClass here
include('class.pHAML.php');
//create an array composed of: name_of_variable_in_template_without_leading_dollar=>value_of_replacement_text
$values = array('greeting'=>'Hello World, I am a template!!!!');
//create a template for a simple web site
$template['content']=
'!!!!
%html
  %head
    %title Hello From pHAML!!
  %body
    %table{width ="1300px"  border="0" cellspacing="0" cellpadding="0"}
      %tr
        %td
          $banner
      %tr
        %td
          $center
      %tr
        %td
          $footer';
$template['banner']='%b I am a banner';
$template['center']=
'I am center content, and I say
$greeting';          
$template['footer']='I am footer content';          
//instantiate the class
$pHAML = new pHAML();
//render the content
$content = $pHAML->render($template,$values);
//echo to the browser
echo $content;
?>

That is really cool...let's see the other implementations of HAML do that! So now you can break up a web site, build a CMS, whatever.

Smarty Integration

Both the Smarty and the Zend Framework implementations are used in our enterprise level web services, should you need some experience and help, please feel free to contact us.

The original target of this code was a Smarty template system, to simplify writing templates.

Smarty Considerations

Smarty is a well developed template system, that in today's web server environment is fast and expandable. Still, you are stuck with HTML writing, and in today's Web 2.0 "div rich" world, it is easy to get lost in the depths of a large template. Hours doing that led to the writing of this code.

Smarty and pHAML combine to create a very powerful and fast content design tool.

OK, so you are going to Smarty

The implementation selected was a Smarty "Block" command. Block commands are nice, since they process after the Smarty replacement. This means that you can use Smarty variables, looping, commands, formating...you name it. The pHAML code will be rendered after Smarty puts everything in.

There are two differences in the Smarty implementation from the stand alone class. The first is that the PHP command "-" does not exist. This is because Smarty is a "compiling" template engine, and the PHP code would get parsed and run by the Smarty engine--creating a security risk. The second is minor, Smarty passes the block as a string, so there is no array processing or assigning of template values by the pHAMLSmarty class. The functionality that is lost can be replaced by using Smarty assigns and Smarty variables ({$variable}).

Bad News and Good News on "{}"'s

The bad news, Smarty uses curly braces as a command delimeter. This creates a conflict with the pHAML, IE: %element{v="v"}. This can be solved by setting Smarty to use different delimeters, or the easier route of using {ldelim} and {rdelim} that Smarty offers. The good news, a tool has been written to do this for you, simply enter your standard pHAML code and see the Smarty compatible code created before your eyes, pHAML Live tool .

Installation

There are three ways to install the pHAMLSmarty class:

Drop the block.pHAML.php class into your Smarty plugin directory, SMARTY_DIR/plugins_dir.
Put the block.pHAML.php class into a directory, and append that directory via PHP code using $smarty->plugins_dir[] ='your/directory'.
Use the Smarty register_block() function.

Smarty Examples

Hello World

Here is an example based on the Quick Start example from the Smarty Documentation:

The PHP Code

include('Smarty.class.php');
// create object
$smarty = new Smarty;
// assign some content. This would typically come from
// a database or other source, but we'll use static
// values for the purpose of this example.
$smarty->assign('greeting', 'Hello World');
// display it
$smarty->display('index.tpl');

The Smarty Template

{pHAML}
!!!!
%html
  %head
    %title Simple Document
  %body
    %p {$greeting}
{/pHAML}

Hello World

Here is a more complex example based again on the Quick Start example from the Smarty Documentation:

The PHP Code

include('Smarty.class.php');

// create object
$smarty = new Smarty;

// assign an array of data
$smarty->assign('name', array('bob','jim','joe','jerry','fred'));

// assign an associative array of data
$smarty->assign('users', array(
	array('name' => 'bob', 'phone' => '555-3425'),
	array('name' => 'jim', 'phone' => '555-4364'),
	array('name' => 'joe', 'phone' => '555-3422'),
	array('name' => 'jerry', 'phone' => '555-4973'),
	array('name' => 'fred', 'phone' => '555-3235')
	));


// display it
$smarty->display('index.tpl');

The Smarty Template

{pHAML}
%table
{section name=mysec loop=$name}
   %tr{ldelim}bgcolor="{cycle values="#eeeeee,#dddddd"}"{rdelim}
      %td {$name[mysec]}
{/section}

%table
{section name=mysec loop=$users}
   %tr{ldelim}bgcolor="{cycle values="#aaaaaa,#bbbbbb"}"{rdelim}
      %td {$users[mysec].name}
      %td {$users[mysec].phone}</td>
{/section}
{/pHAML}

Smarty Tips

Experience has provided some quick tips on using pHAML and Smarty:

The {strip} Smarty block function is always a bad idea, it removes indents and returns, pure badness for a spacing sensitive syntax like pHAML.

Zend Framework Integration

The pHAML class is a good fit with the Zend Framework. The pHAML object, AA_View_pHAML offers a full Zend View Interface implementation, this means that you can use pHAML in your Zend Framework solution seemlessly.

Mind Numbing Technical Discussion

The following is a deeper technical discussion of some of the theory in the implementation, you should still be able to get the examples to work without knowing all this�it is included to hopefully help in understanding.

The easiest option may be to leave the Zend View object intact, and placing all of the logic into the phtml template file. Incidentally, the default Zend View object just includes the phtml file, and wraps it with output buffer start (ob_start) and get_clean (ob_get_clean) methods. So this is the simplest implementation, works out of the box, but requires that php code be put into each template.

Everything in the Zend Framework flows through an �index.php� file, this is called the bootstrap file. The bootstrap then creates a controller. The controller then will call the appropriate controller class and action function call based on the url (www.myzendframework.com/controller_class/action). The action object has a default viewer implementation, that will render the view script using a series of defaults for location and type. This is good behavior if we want to override the action viewer helper and use pHAML system wide.

This is not so good when you want to constrain the pHAML rendering to a specific module, controller, or action. The pHAML will compile and be added to the response object, but so will the default .phtml script, which will also be rendered and added to the response object afterwards by postDispatch afterwards. You can prevent this by setting �$this->getFrontController()->setParam('noViewRenderer', true);� in the controller under the action. If you want the entire controller to turn off the native view renderer--put the command in the preDispatch.

The following provides examples of each of the solutions. Here is a copy of the httpd.conf that was used (this is a bit different than the Zend tutorial, the rewrite routes all unresolved documents through the index, simpler when adding css and such):

	Alias /hlzendex1/ "/your/web/zend/root/hlzendex1/www/"
	<Directory "/your/web/zend/root/hlzendex1/www/">
		AllowOverride None
		RewriteEngine on
		RewriteCond %{REQUEST_FILENAME} !-f
		RewriteRule ^.*$ /hlzendex1/index.php
	</Directory>        
	Alias /hlzendex2/ "/your/web/zend/root/hlzendex2/www/"
	<Directory "/your/web/zend/root/hlzendex2/www/">
		AllowOverride None
		RewriteEngine on
		RewriteCond %{REQUEST_FILENAME} !-f
		RewriteRule ^.*$ /hlzendex2/index.php
	</Directory>

Installation

The best way to install is to place the pHAML class in the same library directory as the Zend directory. That will allow us to use the class loader. Simply create an /AA/View directory tree, and put the class in it.

--library (Zend Library)
       |
       --AA--View
       |     |
       |      -pHAML.php
       --Zend
          |
         (Zend lib files)

hlzendex1:The Simple Approach, Put Everything in the Action phtml File

This is trivial to do, just use the following structure, there are five files needed (this mirrors the Zend Framework Zend_Controller Quickstart documentation):

The index.php (Bootstrap) Code

The index is usually named /app/www/index.php (i.e. 'hlzendex1/www/index.php')

<?php
/* hlzendex1/www/index.php */
/** Zend Bootstrap File */
require_once 'Zend/Controller/Front.php';
Zend_Controller_Front::run('/your/web/zend/root/hlzendex1/controllers');

The IndexController.php Code

The controller is usually named /app/controllers/IndexController.php (i.e. 'hlzendex1/controllers/IndexController.php')

/* hlzendex1/controllers/IndexController.php */
/** Zend_Controller_Action */
require_once 'Zend/Controller/Action.php';

class IndexController extends Zend_Controller_Action
{
    public function indexAction()
    {
    }

}

The ErrorController.php Code

The controller is usually named /app/controllers/ErrorController.php (i.e. 'hlzendex1/controllers/ErrorController.php')

<?php
/* hlzendex1/controllers/ErrorController.php */
/** Zend_Controller_Action */
require_once 'Zend/Controller/Action.php';

class ErrorController extends Zend_Controller_Action
{
    public function errorAction()
    {
    }
}

The index.phtml Template Code

The template is usually named /app/views/scripts/controller/index.phtml (i.e. 'hlzendex1/views/scripts/index/index.phtml'')

<?PHP
/* hlzendex1/views/scripts/index/index.phtml */
//The heredoc syntax works great, just backslash all of the "$"'s
$template =<<<EndOfTemplate
!!!!
%html
  %head
    %title Simple Document
  %body
    %p Hello World Simple from the .phtml Template
EndOfTemplate;
//instance and invoke
require_once('AA/View/pHAML.php');
$hl = new pHAML();
echo $hl->render($template);
?>

The error.phtml Template Code

The template is usually named /app/views/scripts/controller/error.phtml (i.e. 'hlzendex1/views/scripts/error/error.phtml'')

<?php
/* hlzendex1/views/scripts/error/error.phtml */
//The heredoc syntax works great, just backslash all of the "$"'s
$template =<<<EndOfTemplate
!!!!
%html
  %head
    %meta{http-equiv="Content-Type" content="text/html; charset=utf-8"}
    %title Simple Document
  %body
    %h1 An error occurred
    %p An error occurred; please try again later.
EndOfTemplate;
//instance and invoke
require_once('AA/View/pHAML.php');
$hl = new pHAML();
echo $hl->render($template);

hlzendex2:A Better Solution, Use AA_View_pHAML Class

This is a better solution, as it allows you to render pHAML and do assigns using the Zend Framework way.

The index.php (Bootstrap) Code

The index is usually named /app/www/index.php (i.e. 'hlzendex2/www/index.php')

<?php
/* hlzendex2/www/index.php */
/** Zend Bootstrap File */
require_once 'Zend/Controller/Front.php';
Zend_Controller_Front::run('/your/web/zend/root/hlzendex2/controllers');

The IndexController.php Code

The controller is usually named /app/controllers/IndexController.php (i.e. 'hlzendex2/controllers/IndexController.php')

/* hlzendex2/controllers/IndexController.php */
/** Zend_Controller_Action */
require_once 'Zend/Controller/Action.php';

class IndexController extends Zend_Controller_Action
{
    //uncomment the following to turn off default view for the entire module
    /*public function preDispatch()
    {
        // Turn off the default view for everything in this module
        $this->getFrontController()->setParam('noViewRenderer', true);
    }*/
    
    public function indexAction()
    {
        //grab the front controller and turn off the default view rendering
        //(you can delete this line if the noViewRenderer is set in the preDispatch)
        $this->getFrontController()->setParam('noViewRenderer', true);
        //since the class is in the Zend lib tree, can find it using the loader
        Zend_Loader::loadClass('AA_View_pHAML');
        //instance the Zend compliant class
        $view = new AA_View_pHAML();
        //tell the class where to find the template, this can be any path
        $view->setScriptPath('D:/wamp/asf/hlzendex2/views/scripts/index');
        //here is how we assign variables
        $view->assign('greeting','Hello from the index action!!');
        //pass the name of the template to be rendered
        echo  $view->render('index.hml');
    }

}

The ErrorController.php Code

The controller is usually named /app/controllers/ErrorController.php (i.e. 'hlzendex2/controllers/ErrorController.php')

<?php
/* hlzendex2/controllers/ErrorController.php */
/** Zend_Controller_Action */
require_once 'Zend/Controller/Action.php';

class ErrorController extends Zend_Controller_Action
{
    public function errorAction()
    {
    }
}

The index.hml Template Code

The template will be in the path is set in the controller (here we use 'hlzendex2/views/scripts/index/index.hml'')

// hlzendex2/views/scripts/index/index.hml //
!!!!
%html
  %head
    %title Document With Assigns
  %body
    %p Hello World :
       $greeting
EndOfTemplate;
//instance and invoke
require_once('AA/View/pHAML.php');
$hl = new pHAML();
echo $hl->render($template);
?>

The error.phtml Template Code

The template is usually named /app/views/scripts/controller/error.phtml (i.e. 'hlzendex2/views/scripts/error/error.phtml'')

<?PHP /* hlzendex2/views/scripts/error/error.phtml */ ?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  <title>Error</title>
</head>
<body>
    <h1>An error occurred</h1>
    <p>An error occurred; please try again later.</p>
</body>
</html>

Final Notes

Thank you for taking the time to read and I hope that you find pHAML as productive as we have.

I am sure that we will be improving pHAML, but we will work very hard to keep it compatable with what is out there.

Please feel free to use our pHAML live site to make suggestions and file bugs.

The latest code drop and documentation will always be found at our pHAML live site.

Relax...

What if someone told you that there is a simple and powerful tool to quickly develop HTML, XHTML, and XML that works standalone, with Smarty, and with the Zend Framework? Welcome...

Opps, did we mention that it has been used in production since 2006?

But we are not done...there is a new version in testing...it is even cooler...and should be out Q4 of 2009...stay tuned.

pHAML User's Guide

This work is licensed under the Creative Commons Attribution License. To view a copy of this license, visit http://creativecommons.org/licenses/by/2.0/ or send a letter to Creative Commons, 559 Nathan Abbott Way, Stanford, California 94305, USA.

Edition for pHAML .9 Beta

Cheat Sheet

You can test/learn/build all of this code and your code using our pHAML Live testing tool.

Why pHAML?

PHP. Very fast to produce well formed code. Built in templating for simple projects, integrates with Smarty for complex projects. Used in enterprise projects. Easy to learn. Fast to use. Did we say easy and fast?

Preface

How pHAML is Like HAML

How pHAML is different from HAML

Differences from HAML Syntax

Using pHAML

Basic Structure

More Interesting Examples

Commands and Tools

Commands

The "!!!" Command

To start your document as XHTML:

How about an XML header:

1.1 XML:

Strict XHTML:

The "!!!!" Command (HTML4 Doctypes)

To start your document as Strict HTML 4:

Transitional HTML4:

HTML4 Frameset:

No Command? Print the line as is

The "\" Command (Escape Line)

The "/" Command (HTML Comment)

The "//" Command (Non Rendered Comment)

The "<<<" and ">>>" or Heredoc Command

The "-" Command (Embed PHP Code)

The "?" Command (Toggle Debug)

The "??" Command (Toggle Show HTML)

The "$" and "$-" Command (Insert Value from Passed PHP Array)

Debugging

The "?" (Show Line Information)

The "??" (Show the HTML)

The Most Useful Debug Combination

Installation

Smarty Integration

Smarty Considerations

OK, so you are going to Smarty

Bad News and Good News on "{}"'s

Installation

Smarty Examples

Hello World

Hello World

Smarty Tips

Zend Framework Integration

Mind Numbing Technical Discussion

Installation

hlzendex1:The Simple Approach, Put Everything in the Action phtml File

hlzendex2:A Better Solution, Use AA_View_pHAML Class

Final Notes