vars_inherited.inc.html

OPTIONAL file included by class.html

Template variables required by this page:

<vars_inherited loop>
{parent_class} -- parent class the variables were inherited from, includes hyperlink generated by parserClass::getInheritedVars() and formatted by HTMLConverter::getFormattedInheritedVars()
<ivars loop>
{ipath} -- file.ext name of class documentation file for parent class
{ivar_name} -- name of the variable (leading $ included)
{ivar_default} -- default value from parsed php code
{ivar_sdesc} -- short description from the DocBlock

This optional file describes variables inherited from parent classes. Use these values directly in class.html or include this file.

Example:

<!-- =========== VAR SUMMARY =========== -->
<A NAME='var_summary'><!-- --></A>
<TABLE BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='100%'>
   <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
      <TD>
         <FONT SIZE='+2'><B>Inherited Class Variable Summary</B></FONT>
      </TD>
   </TR>

   <loop name="vars_inherited">
   <!-- =========== Summary =========== -->
   <TR BGCOLOR='white' CLASS='TableRowColor'>
      <TD>
         <FONT SIZE='+2'><B>Inherited From Class {parent_class}</B></FONT>
         <blockquote>
         <table BORDER='1' CELLPADDING='3' CELLSPACING='0' WIDTH='95%'>
         <tr>
            <th>Variable</th>
            <th>Default Value</th>
            <th>Description</th>
         </tr>
            <loop name="ivars">
            <tr>
            <td><CODE><B><A HREF='{ipath}#{ivar_name}'>{ivar_name}</A></B></CODE></td>
            <td><CODE>->{ivar_default}<-</CODE></td>
            <td>{ivar_sdesc}</td>
            </tr>
            </loop name="ivars">
         </table>
         </blockquote>
      </TD>
   </TR>
   </loop name="vars_inherited">
</TABLE>