mods/phpdoc2/PhpDocumentor/phpDocumentor/Converters/HTML/frames/templates/earthli/templates/class.tpl

   1 {include file="header.tpl" top3=true}\r
   2 \r
   3 <h2 class="class-name"><img src="{$subdir}media/images/{if $abstract}{if $access == 'private'}AbstractPrivate{else}Abstract{/if}{else}{if $access == 'private'}Private{/if}{/if}{if $is_interface}Interface{else}Class{/if}_logo.png"\r
   4                                                                                                                 alt="{if $abstract}{if $access == 'private'}AbstractPrivate{else}Abstract{/if}{else}{if $access == 'private'}Private{/if}{/if} Class"\r
   5                                                                                                                 title="{if $abstract}{if $access == 'private'}AbstractPrivate{else}Abstract{/if}{else}{if $access == 'private'}Private{/if}{/if} Class"\r
   6                                                                                                                 style="vertical-align: middle">{if $is_interface}Interface{/if} {$class_name}</h2>\r
   7 \r
   8 <a name="sec-description"></a>\r
   9 <div class="info-box">\r
  10         <div class="info-box-title">Description</div>\r
  11         <div class="nav-bar">\r
  12                 {if $children || $vars || $ivars || $methods || $imethods || $consts || $iconsts}\r
  13                         <span class="disabled">Description</span> |\r
  14                 {/if}\r
  15                 {if $children}\r
  16                         <a href="#sec-descendents">Descendents</a>\r
  17                         {if $vars || $ivars || $methods || $imethods || $consts || $iconsts}|{/if}\r
  18                 {/if}\r
  19                 {if $vars || $ivars}\r
  20                         {if $vars}\r
  21                                 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)\r
  22                         {else}\r
  23                                 <a href="#sec-vars">Vars</a>\r
  24                         {/if}\r
  25                         {if $methods || $imethods}|{/if}\r
  26                 {/if}\r
  27                 {if $methods || $imethods}\r
  28                         {if $methods}\r
  29                                 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)\r
  30                         {else}\r
  31                                 <a href="#sec-methods">Methods</a>\r
  32                         {/if}                   \r
  33                 {/if}\r
  34                 {if $consts || $iconsts}\r
  35                         {if $consts}\r
  36                                 <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)\r
  37                         {else}\r
  38                                 <a href="#sec-consts">Constants</a>\r
  39                         {/if}                   \r
  40                 {/if}\r
  41         </div>\r
  42         <div class="info-box-body">\r
  43         {if $implements}\r
  44         <p class="implements">\r
  45             Implements interfaces:\r
  46             <ul>\r
  47                 {foreach item="int" from=$implements}<li>{$int}</li>{/foreach}\r
  48             </ul>\r
  49         </p>\r
  50         {/if}\r
  51                 {include file="docblock.tpl" type="class" sdesc=$sdesc desc=$desc}\r
  52                 <p class="notes">\r
  53                         Located in <a class="field" href="{$page_link}">{$source_location}</a> (line <span class="field">{if $class_slink}{$class_slink}{else}{$line_number}{/if}</span>)\r
  54                 </p>\r
  55                 \r
  56                 {if $tutorial}\r
  57                         <hr class="separator" />\r
  58                         <div class="notes">Tutorial: <span class="tutorial">{$tutorial}</span></div>\r
  59                 {/if}\r
  60                 \r
  61                 <pre>{section name=tree loop=$class_tree.classes}{$class_tree.classes[tree]}{$class_tree.distance[tree]}{/section}</pre>\r
  62         \r
  63                 {if $conflicts.conflict_type}\r
  64                         <hr class="separator" />\r
  65                         <div><span class="warning">Conflicts with classes:</span><br /> \r
  66                         {section name=me loop=$conflicts.conflicts}\r
  67                                 {$conflicts.conflicts[me]}<br />\r
  68                         {/section}\r
  69                         </div>\r
  70                 {/if}\r
  71         </div>\r
  72 </div>\r
  73 \r
  74 {if $children}\r
  75         <a name="sec-descendents"></a>\r
  76         <div class="info-box">\r
  77                 <div class="info-box-title">Direct descendents</div>\r
  78                 <div class="nav-bar">\r
  79                         <a href="#sec-description">Description</a> |\r
  80                         <span class="disabled">Descendents</span>\r
  81                         {if $vars || $ivars || $methods || $imethods || $consts || $iconsts}|{/if}\r
  82                         {if $vars || $ivars}\r
  83                                 {if $vars}\r
  84                                         <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)\r
  85                                 {else}\r
  86                                         <a href="#sec-vars">Vars</a>\r
  87                                 {/if}\r
  88                                 {if $methods || $imethods}|{/if}\r
  89                         {/if}\r
  90                         {if $methods || $imethods}\r
  91                                 {if $methods}\r
  92                                         <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)\r
  93                                 {else}\r
  94                                         <a href="#sec-methods">Methods</a>\r
  95                                 {/if}                   \r
  96                         {/if}\r
  97                         {if $consts || $iconsts}\r
  98                                 {if $consts}\r
  99                                         <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)\r
 100                                 {else}\r
 101                                         <a href="#sec-consts">Constants</a>\r
 102                                 {/if}                   \r
 103                         {/if}\r
 104                 </div>\r
 105                 <div class="info-box-body">\r
 106                         <table cellpadding="2" cellspacing="0" class="class-table">\r
 107                                 <tr>\r
 108                                         <th class="class-table-header">Class</th>\r
 109                                         <th class="class-table-header">Description</th>\r
 110                                 </tr>\r
 111                                 {section name=kids loop=$children}\r
 112                                 <tr>\r
 113                                         <td style="padding-right: 2em; white-space: nowrap">\r
 114                                                 <img src="{$subdir}media/images/{if $children[kids].abstract}Abstract{/if}{if $children[kids].access == 'private'}Private{/if}Class.png"\r
 115                                                                  alt="{if $children[kids].abstract}Abstract{/if}{if $children[kids].access == 'private'}Private{/if} class"\r
 116                                                                  title="{if $children[kids].abstract}Abstract{/if}{if $children[kids].access == 'private'}Private{/if} class"\r
 117                                                                  style="vertical-align: center"/>\r
 118                                                 {$children[kids].link}\r
 119                                         </td>\r
 120                                         <td>\r
 121                                         {if $children[kids].sdesc}\r
 122                                                 {$children[kids].sdesc}\r
 123                                         {else}\r
 124                                                 {$children[kids].desc}\r
 125                                         {/if}\r
 126                                         </td>\r
 127                                 </tr>\r
 128                                 {/section}\r
 129                         </table>\r
 130                 </div>\r
 131         </div>\r
 132 {/if}\r
 133 \r
 134 {if $consts}\r
 135         <a name="sec-const-summary"></a>\r
 136         <div class="info-box">\r
 137                 <div class="info-box-title">Class Constant Summary</span></div>\r
 138                 <div class="nav-bar">\r
 139                         <a href="#sec-description">Description</a> |\r
 140                         {if $children}\r
 141                                 <a href="#sec-descendents">Descendants</a> |\r
 142                         {/if}\r
 143                         <span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)\r
 144                         {if $vars || $ivars}\r
 145                                 {if $vars}\r
 146                                         <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)\r
 147                                 {else}\r
 148                                         <a href="#sec-vars">Vars</a>\r
 149                                 {/if} \r
 150                                 |\r
 151                         {/if}\r
 152                         {if $methods || $imethods}\r
 153                                 | \r
 154                                 {if $methods}\r
 155                                         <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)\r
 156                                 {else}\r
 157                                         <a href="#sec-methods">Methods</a>\r
 158                                 {/if}                   \r
 159                         {/if}\r
 160                 </div>\r
 161                 <div class="info-box-body">\r
 162                         <div class="const-summary">\r
 163                                 {section name=consts loop=$consts}\r
 164                                 <div class="const-title">\r
 165                                         <img src="{$subdir}media/images/Constant.png" alt=" " />\r
 166                                         <a href="#{$consts[consts].const_name}" title="details" class="const-name">{$consts[consts].const_name}</a> =                                   <span class="var-type">{$consts[consts].const_value}</span>\r
 167 \r
 168                                 </div>\r
 169                                 {/section}\r
 170                         </div>\r
 171                 </div>\r
 172         </div>\r
 173 {/if}\r
 174 \r
 175 {if $vars}\r
 176         <a name="sec-var-summary"></a>\r
 177         <div class="info-box">\r
 178                 <div class="info-box-title">Variable Summary</span></div>\r
 179                 <div class="nav-bar">\r
 180                         <a href="#sec-description">Description</a> |\r
 181                         {if $children}\r
 182                                 <a href="#sec-descendents">Descendants</a> |\r
 183                         {/if}\r
 184                         <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)\r
 185                         {if $methods || $imethods}\r
 186                                 | \r
 187                                 {if $methods}\r
 188                                         <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)\r
 189                                 {else}\r
 190                                         <a href="#sec-methods">Methods</a>\r
 191                                 {/if}                   \r
 192                         {/if}\r
 193                         {if $consts || $iconsts}\r
 194                                 {if $consts}\r
 195                                         <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)\r
 196                                 {else}\r
 197                                         <a href="#sec-consts">Constants</a>\r
 198                                 {/if}                   \r
 199                         {/if}\r
 200                 </div>\r
 201                 <div class="info-box-body">\r
 202                         <div class="var-summary">\r
 203                                 {section name=vars loop=$vars}\r
 204                                 {if $vars[vars].static}\r
 205                                 <div class="var-title">\r
 206                                         <img src="{$subdir}media/images/StaticVariable.png" alt=" " />\r
 207                                         static <span class="var-type">{$vars[vars].var_type}</span>\r
 208                                         <a href="#{$vars[vars].var_name}" title="details" class="var-name">{$vars[vars].var_name}</a>\r
 209                                 </div>\r
 210                                 {/if}\r
 211                                 {/section}\r
 212                                 {section name=vars loop=$vars}\r
 213                                 {if !$vars[vars].static}\r
 214                                 <div class="var-title">\r
 215                                         <img src="{$subdir}media/images/{if $vars[vars].access == 'private'}PrivateVariable{else}Variable{/if}.png" alt=" " />\r
 216                                         <span class="var-type">{$vars[vars].var_type}</span>\r
 217                                         <a href="#{$vars[vars].var_name}" title="details" class="var-name">{$vars[vars].var_name}</a>\r
 218                                 </div>\r
 219                                 {/if}\r
 220                                 {/section}\r
 221                         </div>\r
 222                 </div>\r
 223         </div>\r
 224 {/if}\r
 225 \r
 226 {if $methods}\r
 227         <a name="sec-method-summary"></a>\r
 228         <div class="info-box">\r
 229                 <div class="info-box-title">Method Summary</span></div>\r
 230                 <div class="nav-bar">\r
 231                         <a href="#sec-description">Description</a> |\r
 232                         {if $children}\r
 233                                 <a href="#sec-descendents">Descendants</a> |\r
 234                         {/if}\r
 235                         {if $consts || $iconsts}\r
 236                                 {if $consts}\r
 237                                         <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)\r
 238                                 {else}\r
 239                                         <a href="#sec-consts">Constants</a>\r
 240                                 {/if}                   \r
 241                         {/if}\r
 242                         {if $vars || $ivars}\r
 243                                 {if $vars}\r
 244                                         <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)\r
 245                                 {else}\r
 246                                         <a href="#sec-vars">Vars</a>\r
 247                                 {/if} \r
 248                                 |\r
 249                         {/if}\r
 250                         <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)\r
 251                 </div>\r
 252                 <div class="info-box-body">                     \r
 253                         <div class="method-summary">\r
 254                                 {section name=methods loop=$methods}\r
 255                                 {if $methods[methods].static}\r
 256                                 <div class="method-definition">\r
 257                                         <img src="{$subdir}media/images/StaticMethod.png" alt=" "/>\r
 258                                         {if $methods[methods].function_return}\r
 259                                                 static <span class="method-result">{$methods[methods].function_return}</span>\r
 260                                         {/if}\r
 261                                         <a href="#{$methods[methods].function_name}" title="details" class="method-name">{if $methods[methods].ifunction_call.returnsref}&amp;{/if}{$methods[methods].function_name}</a>\r
 262                                         {if count($methods[methods].ifunction_call.params)}\r
 263                                                 ({section name=params loop=$methods[methods].ifunction_call.params}{if $smarty.section.params.iteration != 1}, {/if}{if $methods[methods].ifunction_call.params[params].hasdefault}[{/if}<span class="var-type">{$methods[methods].ifunction_call.params[params].type}</span>&nbsp;<span class="var-name">{$methods[methods].ifunction_call.params[params].name}</span>{if $methods[methods].ifunction_call.params[params].hasdefault} = <span class="var-default">{$methods[methods].ifunction_call.params[params].default}</span>]{/if}{/section})\r
 264                                         {else}\r
 265                                         ()\r
 266                                         {/if}\r
 267                                 </div>\r
 268                                 {/if}\r
 269                                 {/section}\r
 270                                 {section name=methods loop=$methods}\r
 271                                 {if !$methods[methods].static}\r
 272                                 <div class="method-definition">\r
 273                                         <img src="{$subdir}media/images/{if $methods[methods].ifunction_call.constructor}Constructor{elseif $methods[methods].ifunction_call.destructor}Destructor{elseif $methods[methods].access == 'private'}{if $methods[methods].abstract}Abstract{/if}PrivateMethod{else}{if $methods[methods].abstract}Abstract{/if}Method{/if}.png" alt=" "/>\r
 274                                         {if $methods[methods].function_return}\r
 275                                                 <span class="method-result">{$methods[methods].function_return}</span>\r
 276                                         {/if}\r
 277                                         <a href="#{$methods[methods].function_name}" title="details" class="method-name">{if $methods[methods].ifunction_call.returnsref}&amp;{/if}{$methods[methods].function_name}</a>\r
 278                                         {if count($methods[methods].ifunction_call.params)}\r
 279                                                 ({section name=params loop=$methods[methods].ifunction_call.params}{if $smarty.section.params.iteration != 1}, {/if}{if $methods[methods].ifunction_call.params[params].hasdefault}[{/if}<span class="var-type">{$methods[methods].ifunction_call.params[params].type}</span>&nbsp;<span class="var-name">{$methods[methods].ifunction_call.params[params].name}</span>{if $methods[methods].ifunction_call.params[params].hasdefault} = <span class="var-default">{$methods[methods].ifunction_call.params[params].default}</span>]{/if}{/section})\r
 280                                         {else}\r
 281                                         ()\r
 282                                         {/if}\r
 283                                 </div>\r
 284                                 {/if}\r
 285                                 {/section}\r
 286                         </div>\r
 287                 </div>\r
 288         </div>          \r
 289 {/if}\r
 290 \r
 291 {if $vars || $ivars}\r
 292         <a name="sec-vars"></a>\r
 293         <div class="info-box">\r
 294                 <div class="info-box-title">Variables</div>\r
 295                 <div class="nav-bar">\r
 296                         <a href="#sec-description">Description</a> |\r
 297                         {if $children}\r
 298                                 <a href="#sec-descendents">Descendents</a> |\r
 299                         {/if}\r
 300                         {if $methods}\r
 301                                 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)\r
 302                         {else}\r
 303                                 <span class="disabled">Vars</span>\r
 304                         {/if}                   \r
 305                         \r
 306                         {if $consts || $iconsts}\r
 307                                 {if $consts}\r
 308                                         <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)\r
 309                                 {else}\r
 310                                         <a href="#sec-consts">Constants</a>\r
 311                                 {/if}                   \r
 312                         {/if}\r
 313                         {if $methods || $imethods}\r
 314                                 | \r
 315                                 {if $methods}\r
 316                                         <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)\r
 317                                 {else}\r
 318                                         <a href="#sec-methods">Methods</a>\r
 319                                 {/if}                   \r
 320                         {/if}\r
 321                 </div>\r
 322                 <div class="info-box-body">\r
 323                         {include file="var.tpl"}\r
 324                         {if $ivars}\r
 325                                 <h4>Inherited Variables</h4>\r
 326                                 <A NAME='inherited_vars'><!-- --></A>\r
 327                                 {section name=ivars loop=$ivars}\r
 328                                         <p>Inherited from <span class="classname">{$ivars[ivars].parent_class}</span></p>\r
 329                                         <blockquote>\r
 330                                                 {section name=ivars2 loop=$ivars[ivars].ivars}\r
 331                                                         <img src="{$subdir}media/images/{if $ivars[ivars].ivars[ivars2].access == 'private'}PrivateVariable{else}Variable{/if}.png" />\r
 332                                                         <span class="var-title">\r
 333                                                                 <span class="var-name">{$ivars[ivars].ivars[ivars2].link}</span>{if $ivars[ivars].ivars[ivars2].ivar_sdesc}: {$ivars[ivars].ivars[ivars2].ivar_sdesc}{/if}<br>\r
 334                                                         </span>\r
 335                                                 {/section}\r
 336                                         </blockquote> \r
 337                                 {/section}\r
 338                         {/if}                   \r
 339                 </div>\r
 340         </div>\r
 341 {/if}\r
 342         \r
 343 {if $methods || $imethods}\r
 344         <a name="sec-methods"></a>\r
 345         <div class="info-box">\r
 346                 <div class="info-box-title">Methods</div>\r
 347                 <div class="nav-bar">\r
 348                         <a href="#sec-description">Description</a> |\r
 349                         {if $children}\r
 350                                 <a href="#sec-descendents">Descendents</a> |\r
 351                         {/if}\r
 352                         {if $vars || $ivars}\r
 353                                 {if $vars}\r
 354                                         <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)\r
 355                                 {else}\r
 356                                         <a href="#sec-vars">Vars</a>\r
 357                                 {/if}\r
 358                         {/if}\r
 359                         {if $methods}\r
 360                                 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)\r
 361                         {else}\r
 362                                 <span class="disabled">Methods</span>\r
 363                         {/if}                   \r
 364                 </div>\r
 365                 <div class="info-box-body">\r
 366                         {include file="method.tpl"}\r
 367                         {if $imethods}\r
 368                                 <h4>Inherited Methods</h4>\r
 369                                 <a name='inherited_methods'><!-- --></a>        \r
 370                                 {section name=imethods loop=$imethods}\r
 371                                         <!-- =========== Summary =========== -->\r
 372                                         <p>Inherited From <span class="classname">{$imethods[imethods].parent_class}</span></p>\r
 373                                         <blockquote>\r
 374                                                 {section name=im2 loop=$imethods[imethods].imethods}\r
 375                                                         <img src="{$subdir}media/images/{if $imethods[imethods].imethods[im2].constructor}Constructor{elseif $imethods[imethods].imethods[im2].destructor}Destructor{elseif $imethods[imethods].imethods[im2].access == 'private'}{if $imethods[imethods].imethods[im2].abstract}Abstract{/if}PrivateMethod{else}{if $imethods[imethods].imethods[im2].abstract}Abstract{/if}Method{/if}.png" alt=" "/>\r
 376                                                         <span class="method-name">{$imethods[imethods].imethods[im2].link}</span>{if $imethods[imethods].imethods[im2].ifunction_sdesc}: {$imethods[imethods].imethods[im2].ifunction_sdesc}{/if}<br>\r
 377                                                 {/section}\r
 378                                         </blockquote>\r
 379                                 {/section}\r
 380                         {/if}                   \r
 381                 </div>\r
 382         </div>\r
 383 {/if}\r
 384 \r
 385 {if $consts || $iconsts}\r
 386         <a name="sec-consts"></a>\r
 387         <div class="info-box">\r
 388                 <div class="info-box-title">Class Constants</div>\r
 389                 <div class="nav-bar">\r
 390                         <a href="#sec-description">Description</a> |\r
 391                         {if $children}\r
 392                                 <a href="#sec-descendents">Descendants</a> |\r
 393                         {/if}\r
 394                         {if $methods}\r
 395                                 <a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)\r
 396                         {else}\r
 397                                 <span class="disabled">Constants</span>\r
 398                         {/if}                   \r
 399                         \r
 400                         {if $vars || $ivars}\r
 401                                 {if $vars}\r
 402                                         <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)\r
 403                                 {else}\r
 404                                         <a href="#sec-vars">Vars</a>\r
 405                                 {/if}\r
 406                         {/if}\r
 407                         {if $methods || $imethods}\r
 408                                 | \r
 409                                 {if $methods}\r
 410                                         <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)\r
 411                                 {else}\r
 412                                         <a href="#sec-methods">Methods</a>\r
 413                                 {/if}                   \r
 414                         {/if}\r
 415                 </div>\r
 416                 <div class="info-box-body">\r
 417                         {include file="const.tpl"}\r
 418                         {if $iconsts}\r
 419                                 <h4>Inherited Constants</h4>\r
 420                                 <A NAME='inherited_consts'><!-- --></A>\r
 421                                 {section name=iconsts loop=$iconsts}\r
 422                                         <p>Inherited from <span class="classname">{$iconsts[iconsts].parent_class}</span></p>\r
 423                                         <blockquote>\r
 424                                                 {section name=iconsts2 loop=$iconsts[iconsts].iconsts}\r
 425                                                         <img src="{$subdir}media/images/{if $iconsts[iconsts].iconsts[iconsts2].access == 'private'}PrivateVariable{else}Variable{/if}.png" />\r
 426                                                         <span class="const-title">\r
 427                                                                 <span class="const-name">{$iconsts[iconsts].iconsts[iconsts2].link}</span>{if $iconsts[iconsts].iconsts[iconsts2].iconst_sdesc}: {$iconsts[iconsts].iconsts[iconsts2].iconst_sdesc}{/if}<br>\r
 428                                                         </span>\r
 429                                                 {/section}\r
 430                                         </blockquote> \r
 431                                 {/section}\r
 432                         {/if}                   \r
 433                 </div>\r
 434         </div>\r
 435 {/if}\r
 436         \r
 437 {include file="footer.tpl" top3=true}\r