cHTMLLink class represents a link.
package | Core |
---|---|
subpackage | Frontend |
__construct(string $href) : void
Creates an HTML link.
string
String with the location to link to
__toString() : string
inherited_from | \cHTML::__toString() |
---|
string
Generated markupaddRequiredScript(string $script) : \cHTML
Anyway, scripts are not included twice.
inherited_from | \cHTML::addRequiredScript() |
---|
string
the script to include
\cHTML
$thisadvanceID() : \cHTML
This function is useful if you need to use HTML elements in a loop, but don't want to re-create new objects each time.
inherited_from | \cHTML::advanceID() |
---|
\cHTML
$thisappendContent(string | object | array $content) : \cHTMLDiv
string
object
array
String with the content or a cHTML object to render or an array of strings / objects.
\cHTMLDiv
$thisappendStyleDefinition(string $property, string $value) : \cHTML
Example usage: $element->appendStyleDefinition('margin', '5px');
inherited_from | \cHTML::appendStyleDefinition() |
---|
string
the property name, e.g. 'margin'
string
the value of the property, e.g. '5px'
\cHTML
$thisappendStyleDefinitions(array $styles) : \cHTML
Example usage: $element->appendStyleDefinitions(array( 'margin' => '5px', 'padding' => '0' ));
inherited_from | \cHTML::appendStyleDefinitions() |
---|
string
the styles to append
\cHTML
$thisattachEventDefinition(string $name, string $event, string $code) : \cHTML
Example to attach an onClick handler: attachEventDefinition('foo', 'onClick', 'alert("foo");');
inherited_from | \cHTML::attachEventDefinition() |
---|
string
Defines the name of the event
string
Defines the event (e.g. onClick)
string
Defines the code
\cHTML
$thisattachStyleDefinition(string $name, string $definition) : \cHTML
This function is not restricted to a single style, e.g. you can set multiple style definitions as-is to the handler.
$example->attachStyle('myIdentifier', 'border: 1px solid black; white-space: nowrap'); $example->attachStyle('myIdentifier2', 'padding: 0px');
Results in:
style="border: 1px solid black; white-space: nowrap; padding: 0px;"
inherited_from | \cHTML::attachStyleDefinition() |
---|
string
Name for a style definition
string
Definition for the given entity
\cHTML
$thiscHTML()
inherited_from | \cHTML::cHTML() |
---|
disableAutomaticParameterAppend()
display()
inherited_from | \cHTML::display() |
---|
enableAutomaticParameterAppend()
fillCloseSkeleton() : string
inherited_from | \cHTML::fillCloseSkeleton() |
---|
string
filled SGML closer skeletonfillSkeleton(string $attributes) : string
fillSkeleton fills the SGML opener tag with the specified attributes. Attributes need to be passed in the stringyfied variant.
inherited_from | \cHTML::fillSkeleton() |
---|
string
Attributes to set
string
filled SGML opener skeletongetAttribute(string $attributeName) : string
inherited_from | \cHTML::getAttribute() |
---|
string
Attribute name
string
null value or null if the attribute does not
existgetAttributes(bool $returnAsString) : array
inherited_from | \cHTML::getAttributes() |
---|
bool
Whether to return the attributes as string
array
stringgetHref()
getID() : string
inherited_from | \cHTML::getID() |
---|
string
current IDremoveAttribute(string $attributeName) : \cHTML
inherited_from | \cHTML::removeAttribute() |
---|
string
Attribute name
\cHTML
$thisrender() : string
inherited_from | \cHTML::render() |
---|
string
Generated markupsetAlt(string $alt) : \cHTML
Sets the "alt" and "title" tags. Usually, "alt" is used for accessibility and "title" for mouse overs.
To set the text for all browsers for mouse over, set "alt" and "title". IE behaves incorrectly and shows "alt" on mouse over. Mozilla browsers only show "title" as mouse over.
inherited_from | \cHTML::setAlt() |
---|
string
Text to set as the "alt" and "title" attribute
\cHTML
$thissetAttribute(string $attributeName, string $value) : \cHTML
inherited_from | \cHTML::setAttribute() |
---|
string
Name of the attribute
string
Value of the attribute
\cHTML
$thissetAttributes(array $attributes) : \cHTML
inherited_from | \cHTML::setAttributes() |
---|
array
Associative array with attributes
\cHTML
$thissetCLink(string $targetarea, string $targetframe, string $targetaction) : \cHTMLLink
string
Target backend area
string
Target frame (1-4)
string
Target action
\cHTMLLink
$thissetClass(string $class) : \cHTML
inherited_from | \cHTML::setClass() |
---|
string
Text to set as the "class" attribute
\cHTML
$thissetContent(string | object | array $content) : \cHTMLLink
string
object
array
String with the content or a cHTML object to render or an array of strings / objects.
\cHTMLLink
$thissetCustom(string $key, string $value) : \cHTMLLink
setEvent(string $event, string $action) : \cHTML
example: $item->setEvent('change','document.forms[0].submit');
inherited_from | \cHTML::setEvent() |
---|
string
Type of the event, e. g. "change" for "onchange"
string
Function or action to call (JavaScript Code)
\cHTML
$thissetGenerateXHTML(bool $value)
inherited_from | \cHTML::setGenerateXHTML() |
---|
bool
setImage($src)
setMultiLink(string $righttoparea, string $righttopaction, string $rightbottomarea, string $rightbottomaction) : \cHTMLLink
string
Area (right top)
string
Action (right top)
string
Area (right bottom)
string
Action (right bottom)
\cHTMLLink
$thissetStyle(string $style) : \cHTML
inherited_from | \cHTML::setStyle() |
---|
string
Text to set as the "style" attribute
\cHTML
$thissetStyleDefinition(string $entity, string $definition) : \cHTML
inherited_from | \cHTML::setStyleDefinition() |
---|
string
Entity to define
string
Definition for the given entity
\cHTML
$thistoHTML() : string
string
Rendered HTMLunsetEvent(string $event) : \cHTML
example: $item->unsetEvent('change');
inherited_from | \cHTML::unsetEvent() |
---|
string
Type of the event
\cHTML
$thisupdateAttribute(string $name, string $value) : \cHTML
inherited_from | \cHTML::updateAttribute() |
---|
string
the name of the attribute
string
the value of the attribute with the given name
\cHTML
$thisupdateAttributes(array $attributes) : \cHTML
inherited_from | \cHTML::updateAttributes() |
---|
array
Associative array with attributes
\cHTML
$this_appendContent(string | object | array $content) : \cHTML
inherited_from | \cHTML::_appendContent() |
---|
string
object
array
String with the content or an object to render or an array of strings/objects.
\cHTML
$this_getAttrString(array $attributes) : string
inherited_from | \cHTML::_getAttrString() |
---|
array
Associative array with attributes
string
Attribute string in HTML format_parseAttributes(array $attributes) : array
inherited_from | \cHTML::_parseAttributes() |
---|
array
Associative array with attributes
array
the parsed attributes_setContent(string | object | array $content) : \cHTML
inherited_from | \cHTML::_setContent() |
---|
string
object
array
String with the content or a cHTML object to render or an array of strings / objects.
\cHTML
$this$_anchor
$_attributes : array
inherited_from | \cHTML::$$_attributes |
---|
$_content : string
$_contentlessTag : bool
inherited_from | \cHTML::$$_contentlessTag |
---|
$_custom
$_eventDefinitions : array
inherited_from | \cHTML::$$_eventDefinitions |
---|
$_generateXHTML : bool
inherited_from | \cHTML::$$_generateXHTML |
---|
$_idCounter : int
inherited_from | \cHTML::$$_idCounter |
---|
$_image
$_link
$_requiredScripts : array
inherited_from | \cHTML::$$_requiredScripts |
---|
$_skeletonClose : string
inherited_from | \cHTML::$$_skeletonClose |
---|
$_skeletonOpen : string
inherited_from | \cHTML::$$_skeletonOpen |
---|
$_skeletonSingle : string
inherited_from | \cHTML::$$_skeletonSingle |
---|
$_styleDefinitions : array
inherited_from | \cHTML::$$_styleDefinitions |
---|
$_styleDefs : array
inherited_from | \cHTML::$$_styleDefs |
---|
$_tag : string
inherited_from | \cHTML::$$_tag |
---|