silverorange Code


Swat.SwatCommentHtmlHeadEntry
/Swat/SwatCommentHtmlHeadEntry.php at line 14

Class SwatCommentHtmlHeadEntry

SwatObject
└─SwatHtmlHeadEntry
└─SwatCommentHtmlHeadEntry

public class SwatCommentHtmlHeadEntry
extends SwatHtmlHeadEntry

Stores and outputs an HTML head entry for an XML comment

Copyright:
2006 silverorange
License:
http://www.gnu.org/copyleft/lesser.html LGPL License 2.1

Field Summary
protected mixed

$comment

Fields inherited from Swat.SwatHtmlHeadEntry
package_id, uri
Constructor Summary

SwatCommentHtmlHeadEntry(string comment, integer package_id)

Creates a new HTML head entry.

Method Summary
void

display(string uri_prefix)

Displays this html head entry.

void

displayInline(string path)

Displays the resource referenced by this html head entry inline.

Methods inherited from Swat.SwatHtmlHeadEntry
display, displayInline, getPackageId, getType, getUri

Field Detail

/Swat/SwatCommentHtmlHeadEntry.php at line 18

comment

protected mixed $comment

Constructor Detail

/Swat/SwatCommentHtmlHeadEntry.php at line 30

SwatCommentHtmlHeadEntry

public SwatCommentHtmlHeadEntry(string comment, integer package_id)

Creates a new HTML head entry

Parameters:
comment - the comment of this entry.
package_id - the package id of the package this HTML head entry belongs to.

Method Detail

/Swat/SwatCommentHtmlHeadEntry.php at line 39

display

public void display(string uri_prefix)

Displays this html head entry

Entries are displayed differently based on type.

Parameters:
uri_prefix - an optional string to prefix the URI with.

/Swat/SwatCommentHtmlHeadEntry.php at line 49

displayInline

public void displayInline(string path)

Displays the resource referenced by this html head entry inline

Entries are displayed differently based on type.

Parameters:
path - the path containing the resource files.

silverorange Code