HTML helper in codeigniter

HTML Helper

The HTML Helper file contains functions that assist in working with HTML.

Loading this Helper

This helper is loaded using the following code:

Available Functions

The following functions are available:

heading([$data = ”[, $h = ‘1’[, $attributes = ”]]])

Parameters:
  • $data (string) – Content
  • $h (string) – Heading leve
  • $attributes (mixed) – HTML attributes
  • Returns:HTML heading tag
    Return type:string

    Lets you create HTML heading tags. The first parameter will contain the data, the second the size of the heading.

    Examples:

    The above would produce:

    Welcome!

    Additionally, in order to add attributes to the heading tag such as HTML classes, ids or inline styles, a third parameter accepts either a string or an array:

    The above code produces:

    img([$src = ”[, $index_page = FALSE[, $attributes = ”]]])

    Parameters:
  • $src (string) – Image source data
  • $index_page (bool) – Whether to treat $src as a routed URI string
  • $attributes (array) – HTML attributes
  • Returns:HTML image tag
    Return type:string

    Lets you create HTML tags. The first parameter contains the image source. Example:

    There is an optional second parameter that is a TRUE/FALSE value that specifics if the src should have the page specified by $config[‘index_page’] added to the address it creates. Presumably, this would be if you were using a media controller:

    Additionally, an associative array can be passed to the img() function for complete control over all attributes and values. If an alt attribute is not provided, CodeIgniter will generate an empty string.

    Example:

    link_tag([$href = ”[, $rel = ‘stylesheet'[, $type = ‘text/css'[, $title = ”[, $media = ”[, $index_page = FALSE]]]]]])

    Parameters:
  • $href (string) – What are we linking to
  • $rel (string) – Relation type
  • $type (string) – Type of the related document
  • $title (string) – Link title
  • $media (string) – Media type
  • $index_page (bool) – Whether to treat $src as a routed URI string
  • Returns:HTML link tag
    Return type:string

    Lets you create HTML tags. This is useful for stylesheet links, as well as other links. The parameters are href, with optional rel, type, title, media and index_page.

    index_page is a boolean value that specifies if the href should have the page specified by $config[‘index_page’] added to the address it creates.

    Example:

    Further examples:

    Additionally, an associative array can be passed to the link() function for complete control over all attributes and values:

    ul($list[, $attributes = ”])

    Parameters:
  • $list (array) – List entries
  • $attributes (array) – HTML attributes
  • Returns:HTML-formatted unordered list
    Return type:string

    Permits you to generate unordered HTML lists from simple or multi-dimensional arrays. Example:

    The above code will produce this:

    Here is a more complex example, using a multi-dimensional array:

    The above code will produce this:

    ol($list, $attributes = ”)

    Parameters:
  • $list (array) – List entries
  • $attributes (array) – HTML attributes
  • Returns:HTML-formatted ordered list
    Return type:string

    Identical to ul(), only it produces the

      tag for ordered lists instead of

        .

        meta([$name = ”[, $content = ”[, $type = ‘name'[, $newline = “n”]]]])

        Parameters:
      • $name (string) – Meta name
      • $content (string) – Meta content
      • $type (string) – Meta type
      • $newline (string) – Newline character
      • Returns:HTML meta tag
        Return type:string

        Helps you generate meta tags. You can pass strings to the function, or simple arrays, or multidimensional ones.

        Examples:

        doctype([$type = ‘xhtml1-strict’])

        Parameters:
      • $type (string) – Doctype name
      • Returns:HTML DocType tag
        Return type:string

        Helps you generate document type declarations, or DTD’s. XHTML 1.0 Strict is used by default, but many doctypes are available.

        Example:

        The following is a list of doctype choices. These are configurable, and pulled from application/config/doctypes.php

        Document typeOptionResult
        XHTML 1.1xhtml11<!DOCTYPE html PUBLIC “-//W3C//DTD XHTML 1.1//EN” “http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd“>
        XHTML 1.0 Strictxhtml1-strict<!DOCTYPE html PUBLIC “-//W3C//DTD XHTML 1.0 Strict//EN” “http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd“>
        XHTML 1.0 Transitionalxhtml1-trans<!DOCTYPE html PUBLIC “-//W3C//DTD XHTML 1.0 Transitional//EN” “http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd“>
        XHTML 1.0 Framesetxhtml1-frame<!DOCTYPE html PUBLIC “-//W3C//DTD XHTML 1.0 Frameset//EN” “http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd“>
        XHTML Basic 1.1xhtml-basic11<!DOCTYPE html PUBLIC “-//W3C//DTD XHTML Basic 1.1//EN” “http://www.w3.org/TR/xhtml-basic/xhtml-basic11.dtd“>
        HTML 5html5<!DOCTYPE html>
        HTML 4 Stricthtml4-strict<!DOCTYPE HTML PUBLIC “-//W3C//DTD HTML 4.01//EN” “http://www.w3.org/TR/html4/strict.dtd“>
        HTML 4 Transitionalhtml4-trans<!DOCTYPE HTML PUBLIC “-//W3C//DTD HTML 4.01 Transitional//EN” “http://www.w3.org/TR/html4/loose.dtd“>
        HTML 4 Framesethtml4-frame<!DOCTYPE HTML PUBLIC “-//W3C//DTD HTML 4.01 Frameset//EN” “http://www.w3.org/TR/html4/frameset.dtd“>
        MathML 1.01mathml1<!DOCTYPE math SYSTEM “http://www.w3.org/Math/DTD/mathml1/mathml.dtd“>
        MathML 2.0mathml2<!DOCTYPE math PUBLIC “-//W3C//DTD MathML 2.0//EN” “http://www.w3.org/Math/DTD/mathml2/mathml2.dtd“>
        SVG 1.0svg10<!DOCTYPE svg PUBLIC “-//W3C//DTD SVG 1.0//EN” “http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd“>
        SVG 1.1 Fullsvg11<!DOCTYPE svg PUBLIC “-//W3C//DTD SVG 1.1//EN” “http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd“>
        SVG 1.1 Basicsvg11-basic<!DOCTYPE svg PUBLIC “-//W3C//DTD SVG 1.1 Basic//EN” “http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-basic.dtd“>
        SVG 1.1 Tinysvg11-tiny<!DOCTYPE svg PUBLIC “-//W3C//DTD SVG 1.1 Tiny//EN” “http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-tiny.dtd“>
        XHTML+MathML+SVG (XHTML host)xhtml-math-svg-xh<!DOCTYPE html PUBLIC “-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN” “http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd“>
        XHTML+MathML+SVG (SVG host)xhtml-math-svg-sh<!DOCTYPE svg:svg PUBLIC “-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN” “http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd”>
        XHTML+RDFa 1.0xhtml-rdfa-1<!DOCTYPE html PUBLIC “-//W3C//DTD XHTML+RDFa 1.0//EN” “http://www.w3.org/MarkUp/DTD/xhtml-rdfa-1.dtd“>
        XHTML+RDFa 1.1xhtml-rdfa-2<!DOCTYPE html PUBLIC “-//W3C//DTD XHTML+RDFa 1.1//EN” “http://www.w3.org/MarkUp/DTD/xhtml-rdfa-2.dtd“>

        br([$count = 1])

        Parameters:
      • $count (int) – Number of times to repeat the tag
      • Returns:HTML line break tag
        Return type:string

        Generates line break tags (
        ) based on the number you submit. Example:

        The above would produce:

        Note
        This function is DEPRECATED. Use the native str_repeat() in combination with
        instead.

        nbs([$num = 1])

        Parameters:
      • $num (int) – Number of space entities to produce
      • Returns:A sequence of non-breaking space HTML entities
        Return type:string

        Generates non-breaking spaces ( ) based on the number you submit. Example:

        The above would produce:

        Note
        This function is DEPRECATED. Use the native str_repeat() in combination with   instead.