OpenDocument
[ class tree: OpenDocument ] [ index: OpenDocument ] [ all elements ]

Class: OpenDocument_Element_Heading

Source Location: /OpenDocument-0.2.1/OpenDocument/Element/Heading.php

Class Overview

OpenDocument_Element
   |
   --OpenDocument_StyledElement
      |
      --OpenDocument_Element_Heading

Heading element


Author(s):

Version:

  • 0.1.0

Methods


Inherited Variables

Inherited Methods


Class Details

[line 41]
Heading element


[ Top ]


Method Detail

__construct (Constructor)   [line 85]

OpenDocument_Element_Heading __construct( DOMNode $node, OpenDocument_Document $document)

Constructor
  • Access: public

Overrides OpenDocument_StyledElement::__construct() (Constructor)

Parameters:

DOMNode   $node   —  Node to add heading to
OpenDocument   $document   —  Document to add heading to

[ Top ]

createHyperlink   [line 214]

OpenDocument_Element_Hyperlink createHyperlink( string $text, string $location, [string $type = 'simple'], [string $target = ''], [string $name = ''])

Create a hyperlink
  • Access: public

Parameters:

string   $text   —  Content text for link
string   $location   —  URL
string   $type   —  'simple'
string   $target   —  Target frame
string   $name   —  Name (id) of link

[ Top ]

createSpan   [line 229]

OpenDocument_Span createSpan( string $text)

Create span element
  • Access: public

Parameters:

string   $text   —  Content

[ Top ]

createTextElement   [line 198]

OpenDocument_Element_Text createTextElement( string $text)

Create text element
  • Access: public

Parameters:

string   $text   —  Contents

[ Top ]

generateStyleName   [line 183]

string generateStyleName( )

Generate element new style name
  • Access: public

Overrides OpenDocument_StyledElement::generateStyleName() (Generate new style name)
[ Top ]

instance   [line 105]

OpenDocument_Element_Heading instance( mixed $object, mixed $content, [integer $level = 1])

Create a heading element
  • Access: public

Parameters:

mixed   $object   —  Document or element to append heading to
mixed   $content   —  Content of heading
integer   $level   —  Level from 1 to 6 (1 highest)

[ Top ]

__get   [line 168]

mixed __get( string $name)

Get element properties
  • Access: public

Overrides OpenDocument_StyledElement::__get() (Magic method: Get a property value.)

Parameters:

string   $name   —  Name of property to retrieve

[ Top ]

__set   [line 145]

void __set( string $name, mixed $value)

Set element properties
  • Access: public

Parameters:

string   $name   —  Name of property to set ('level')
mixed   $value   —  Value of property

[ Top ]


Documentation generated on Wed, 09 Dec 2015 23:02:08 +0000 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.