# php_manual

id: UConverter::reasonText
type: function
doc:
<comment>Description:</comment>
  Obtém uma representação em string da razão da chamada de retorno
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>int</info>  <strong>$reason</strong>  

<comment>Return:</comment>
  <info>string</info>  


id: UConverter::setDestinationEncoding
type: function
doc:
<comment>Description:</comment>
  Define a codificação de destino
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$encoding</strong>  

<comment>Return:</comment>
  <info>bool</info>  


id: UConverter::setSourceEncoding
type: function
doc:
<comment>Description:</comment>
  Define a codificação da origem
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$encoding</strong>  

<comment>Return:</comment>
  <info>bool</info>  


id: UConverter::setSubstChars
type: function
doc:
<comment>Description:</comment>
  Define os caracteres de substituição
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$chars</strong>  

<comment>Return:</comment>
  <info>bool</info>  


id: UConverter::toUCallback
type: function
doc:
<comment>Description:</comment>
  Função de retorno padrão de destino
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>int</info>     <strong>$reason</strong>     
  <info>string</info>  <strong>$source</strong>     
  <info>string</info>  <strong>$codeUnits</strong>  
  <info>int</info>     <strong>$error</strong>      

<comment>Return:</comment>
  <info>string|int|array|null</info>  


id: UConverter::transcode
type: function
doc:
<comment>Description:</comment>
  Converte uma string de uma codificação de caracteres para outra
  
  Converte <strong>$str</strong> de <strong>$fromEncoding</strong> para <strong>$toEncoding</strong>.

<comment>Param:</comment>
  <info>string</info>      <strong>$str</strong>           A <info>string</info> a ser convertida.
  <info>string</info>      <strong>$toEncoding</strong>    A codificação desejada do resultado.
  <info>string</info>      <strong>$fromEncoding</strong>  A codificação atual usada para interpretar <strong>$str</strong>.
  <info>array|null</info>  <strong>$options</strong>       Um <info>array</info> opcional, que pode conter as seguintes chaves: <return>'to_subst'</return> - o
                             caractere de substituição a ser usado no lugar de qualquer caractere de
                             <strong>$str</strong> que não possa ser codificado com <strong>$toEncoding</strong>. Se especificado,
                             deve representar um único caractere na codificação de destino.

<comment>Return:</comment>
  <info>string|false</info>  Retorna a string convertida ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mb_convert_encoding()</strong>
   * <strong>iconv()</strong>


id: UI\Area
type: class
doc:
<comment>Description:</comment>
  An Area represents a canvas which can be used to draw, and respond to mouse and key events.


id: UI\Area::Alt
type: constant
doc:
<comment>Description:</comment>
  Shall be set in the modifiers passed to key and mouse events when the ALT key is active


id: UI\Area::Ctrl
type: constant
doc:
<comment>Description:</comment>
  Shall be set in the modifiers passed to key and mouse events when the CTRL key is active


id: UI\Area::Shift
type: constant
doc:
<comment>Description:</comment>
  Shall be set in the modifiers passed to key and mouse events when the SHIFT key is active


id: UI\Area::onDraw
type: function
doc:
<comment>Description:</comment>
  Draw Callback
  
  Shall be invoked when this Area requires redrawing

<comment>Param:</comment>
  <info>UI\Draw\Pen</info>  <strong>$pen</strong>        A Pen suitable for drawing in this Area
  <info>UI\Size</info>      <strong>$areaSize</strong>   The size of the Area
  <info>UI\Point</info>     <strong>$clipPoint</strong>  The clip point of the Area
  <info>UI\Size</info>      <strong>$clipSize</strong>   The clip size of the Area


id: UI\Area::onKey
type: function
doc:
<comment>Description:</comment>
  Key Callback
  
  Shall be executed on key events

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>    The key pressed
  <info>int</info>     <strong>$ext</strong>    The extended key pressed
  <info>int</info>     <strong>$flags</strong>  Event modifiers


id: UI\Area::onMouse
type: function
doc:
<comment>Description:</comment>
  Mouse Callback
  
  Shall be executed on mouse events

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$areaPoint</strong>  The co-ordinates of the event
  <info>UI\Size</info>   <strong>$areaSize</strong>   The size of the area of the event
  <info>int</info>       <strong>$flags</strong>      Event modifiers


id: UI\Area::scrollTo
type: function
doc:
<comment>Description:</comment>
  Area Scroll
  
  Scroll this Area

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>  The point to scroll to
  <info>UI\Size</info>   <strong>$size</strong>   The size of the scroll pane


id: UI\Area::setSize
type: function
doc:
<comment>Description:</comment>
  Set Size
  
  Sets the size of this Area

<comment>Param:</comment>
  <info>UI\Size</info>  <strong>$size</strong>  The new size


id: UI\Control::getParent
type: function
doc:
<comment>Description:</comment>
  Get Parent Control
  
  Shall return the parent Control

<comment>Return:</comment>
  <info>UI\Control</info>  


id: UI\Control::getTopLevel
type: function
doc:
<comment>Description:</comment>
  Get Top Level
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>int</info>  


id: UI\Control::isEnabled
type: function
doc:
<comment>Description:</comment>
  Determine if Control is enabled
  
  Shall detect if this Control is enabled

<comment>Return:</comment>
  <info>bool</info>  


id: UI\Control::isVisible
type: function
doc:
<comment>Description:</comment>
  Determine if Control is visible
  
  Shall detect if this Control is visible

<comment>Return:</comment>
  <info>bool</info>  


id: UI\Control::setParent
type: function
doc:
<comment>Description:</comment>
  Set Parent Control
  
  Shall set the parent Control of this Control

<comment>Param:</comment>
  <info>UI\Control</info>  <strong>$parent</strong>  The parent Control


id: UI\Controls\Box::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Box
  
  Shall construct a new box

<comment>Param:</comment>
  <info>int</info>  <strong>$orientation</strong>  Box::Horizontal or Box::Vertical


id: UI\Controls\Box::append
type: function
doc:
<comment>Description:</comment>
  Append Control
  
  Shall append the given control to this Box

<comment>Param:</comment>
  <info>Control</info>  <strong>$control</strong>   The control to append
  <info>bool</info>     <strong>$stretchy</strong>  Set true to stretch the control

<comment>Return:</comment>
  <info>int</info>  Shall return the index of the appended control, may be 0


id: UI\Controls\Box::delete
type: function
doc:
<comment>Description:</comment>
  Delete Control
  
  Shall delete the control at the given index from this Box

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index of the control to delete

<comment>Return:</comment>
  <info>bool</info>  Indication of success


id: UI\Controls\Box::getOrientation
type: function
doc:
<comment>Description:</comment>
  Get Orientation
  
  Shall retrieve the orientation of this Box

<comment>Return:</comment>
  <info>int</info>  


id: UI\Controls\Box::isPadded
type: function
doc:
<comment>Description:</comment>
  Padding Detection
  
  Shall detect if padding is enabled on this Box

<comment>Return:</comment>
  <info>bool</info>  


id: UI\Controls\Box::setPadded
type: function
doc:
<comment>Description:</comment>
  Set Padding
  
  Shall enable or disable padding on this Box

<comment>Param:</comment>
  <info>bool</info>  <strong>$padded</strong>  


id: UI\Controls\Button::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Button
  
  Shall construct a new Button

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text (label) for this Button


id: UI\Controls\Button::getText
type: function
doc:
<comment>Description:</comment>
  Get Text
  
  Shall retrieve the text (label) for this Button

<comment>Return:</comment>
  <info>string</info>  The current text (label)


id: UI\Controls\Button::setText
type: function
doc:
<comment>Description:</comment>
  Set Text
  
  Shall set the text (label) for this Button

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The new text (label)


id: UI\Controls\Check::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Check
  
  Shall construct a new Check

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text (label) for the Check box


id: UI\Controls\Check::getText
type: function
doc:
<comment>Description:</comment>
  Get Text
  
  Shall return the text (label) for this Check

<comment>Return:</comment>
  <info>string</info>  The current text (label)


id: UI\Controls\Check::isChecked
type: function
doc:
<comment>Description:</comment>
  Checked Detection
  
  Shall detect the status of this Check

<comment>Return:</comment>
  <info>bool</info>  


id: UI\Controls\Check::onToggle
type: function
doc:
<comment>Description:</comment>
  Toggle Callback
  
  Shall be executed when the status of this Check is changed


id: UI\Controls\Check::setChecked
type: function
doc:
<comment>Description:</comment>
  Set Checked
  
  Shall change the status of this Check

<comment>Param:</comment>
  <info>bool</info>  <strong>$checked</strong>  The new status


id: UI\Controls\Check::setText
type: function
doc:
<comment>Description:</comment>
  Set Text
  
  Shall set the text (label) for this Check

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The new text (label)


id: UI\Controls\ColorButton
type: class
doc:
<comment>Description:</comment>
  A Color Button is a button which displays a color picker when clicked


id: UI\Controls\ColorButton::getColor
type: function
doc:
<comment>Description:</comment>
  Get Color
  
  Shall retrieve the currently selected Color

<comment>Return:</comment>
  <info>UI\Color</info>  


id: UI\Controls\ColorButton::onChange
type: function
doc:
<comment>Description:</comment>
  Change Handler
  
  Shall be executed when the selected Color is changed


id: UI\Controls\ColorButton::setColor
type: function
doc:
<comment>Description:</comment>
  Set Color
  
  Shall set the currently selected Color

<comment>Param:</comment>
  <info>UI\Draw\Color</info>  <strong>$color</strong>  The new color


id: UI\Controls\Combo
type: class
doc:
<comment>Description:</comment>
  A Combo control represents a list of options, like the familiar select HTML element.


id: UI\Controls\Combo::append
type: function
doc:
<comment>Description:</comment>
  Append Option
  
  Append an option to this Combo

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text for the new option


id: UI\Controls\Combo::getSelected
type: function
doc:
<comment>Description:</comment>
  Get Selected Option
  
  Shall retrieve the index of the option selected in this Combo

<comment>Return:</comment>
  <info>int</info>  


id: UI\Controls\Combo::onSelected
type: function
doc:
<comment>Description:</comment>
  Selected Handler
  
  Shall be executed when an option is selected in this Combo


id: UI\Controls\Combo::setSelected
type: function
doc:
<comment>Description:</comment>
  Set Selected Option
  
  Shall set the currently selected option in this Combo

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index of the option to select


id: UI\Controls\EditableCombo
type: class
doc:
<comment>Description:</comment>
  An Editable Combo is a Combo which allows the user to enter custom options


id: UI\Controls\EditableCombo::append
type: function
doc:
<comment>Description:</comment>
  Append Option
  
  Shall append a new option to this Editable Combo

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text for the new option


id: UI\Controls\EditableCombo::getText
type: function
doc:
<comment>Description:</comment>
  Get Text
  
  Get the value of the currently selected option in this Editable Combo

<comment>Return:</comment>
  <info>string</info>  


id: UI\Controls\EditableCombo::onChange
type: function
doc:
<comment>Description:</comment>
  Change Handler
  
  Shall be executed when the value of this Editable Combobox changes


id: UI\Controls\EditableCombo::setText
type: function
doc:
<comment>Description:</comment>
  Set Text
  
  Shall set the text of the currently selected option in this Editable Combo

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The new text


id: UI\Controls\Entry
type: class
doc:
<comment>Description:</comment>
  An Entry is a text entry control, suitable for entering plain text, passwords, or search terms.


id: UI\Controls\Entry::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Entry
  
  Construct a new entry of the given type

<comment>Param:</comment>
  <info>int</info>  <strong>$type</strong>  Entry::Normal, Entry::Password, or Entry::Search


id: UI\Controls\Entry::getText
type: function
doc:
<comment>Description:</comment>
  Get Text
  
  Shall return the current text from this Entry

<comment>Return:</comment>
  <info>string</info>  The current text


id: UI\Controls\Entry::isReadOnly
type: function
doc:
<comment>Description:</comment>
  Detect Read Only
  
  Shall detect if this Entry is read only

<comment>Return:</comment>
  <info>bool</info>  


id: UI\Controls\Entry::onChange
type: function
doc:
<comment>Description:</comment>
  Change Handler
  
  Shall be executed when the text in this Entry changes


id: UI\Controls\Entry::setReadOnly
type: function
doc:
<comment>Description:</comment>
  Set Read Only
  
  Shall enable or disable read only for this Entry

<comment>Param:</comment>
  <info>bool</info>  <strong>$readOnly</strong>  


id: UI\Controls\Entry::setText
type: function
doc:
<comment>Description:</comment>
  Set Text
  
  Shall set the text for this Entry

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The new text


id: UI\Controls\Form
type: class
doc:
<comment>Description:</comment>
  A Form is a control which allows the arrangement of other controls into a familiar layout (the
  form).


id: UI\Controls\Form::append
type: function
doc:
<comment>Description:</comment>
  Append Control
  
  Shall append the control to the form, and set the label

<comment>Param:</comment>
  <info>string</info>      <strong>$label</strong>     The text for the label
  <info>UI\Control</info>  <strong>$control</strong>   A control
  <info>bool</info>        <strong>$stretchy</strong>  Should be set true to stretch the control

<comment>Return:</comment>
  <info>int</info>  Shall return the index of the appended control, may be 0


id: UI\Controls\Form::delete
type: function
doc:
<comment>Description:</comment>
  Delete Control
  
  Shall delete the control at the given index in this Form

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index of the control to remove

<comment>Return:</comment>
  <info>bool</info>  Indication of succcess


id: UI\Controls\Form::isPadded
type: function
doc:
<comment>Description:</comment>
  Padding Detection
  
  Shall detect if padding is enabled on this Form

<comment>Return:</comment>
  <info>bool</info>  


id: UI\Controls\Form::setPadded
type: function
doc:
<comment>Description:</comment>
  Set Padding
  
  Shall enable or disable padding on this Form

<comment>Param:</comment>
  <info>bool</info>  <strong>$padded</strong>  


id: UI\Controls\Grid
type: class
doc:
<comment>Description:</comment>
  A Grid is a control which is allows the arrangement of children into a grid


id: UI\Controls\Grid::append
type: function
doc:
<comment>Description:</comment>
  Append Control
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>UI\Control</info>  <strong>$control</strong>  The Control to append
  <info>int</info>         <strong>$left</strong>     
  <info>int</info>         <strong>$top</strong>      
  <info>int</info>         <strong>$xspan</strong>    
  <info>int</info>         <strong>$yspan</strong>    
  <info>bool</info>        <strong>$hexpand</strong>  
  <info>int</info>         <strong>$halign</strong>   
  <info>bool</info>        <strong>$vexpand</strong>  
  <info>int</info>         <strong>$valign</strong>   


id: UI\Controls\Grid::isPadded
type: function
doc:
<comment>Description:</comment>
  Padding Detection
  
  Shall detect if padding is enabled on this Grid

<comment>Return:</comment>
  <info>bool</info>  


id: UI\Controls\Grid::setPadded
type: function
doc:
<comment>Description:</comment>
  Set Padding
  
  Shall enable or disable padding for this Grid

<comment>Param:</comment>
  <info>bool</info>  <strong>$padding</strong>  


id: UI\Controls\Group::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Group
  
  Shall construct a new Group with the given title

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  The text for the title label


id: UI\Controls\Group::append
type: function
doc:
<comment>Description:</comment>
  Append Control
  
  Shall append a control to this Group

<comment>Param:</comment>
  <info>UI\Control</info>  <strong>$control</strong>  The control to append


id: UI\Controls\Group::getTitle
type: function
doc:
<comment>Description:</comment>
  Get Title
  
  Shall return the current title for this Group

<comment>Return:</comment>
  <info>string</info>  The current title


id: UI\Controls\Group::hasMargin
type: function
doc:
<comment>Description:</comment>
  Margin Detection
  
  Shall detect if this Group has a margin

<comment>Return:</comment>
  <info>bool</info>  


id: UI\Controls\Group::setMargin
type: function
doc:
<comment>Description:</comment>
  Set Margin
  
  Shall enable or disable margins for this Group

<comment>Param:</comment>
  <info>bool</info>  <strong>$margin</strong>  


id: UI\Controls\Group::setTitle
type: function
doc:
<comment>Description:</comment>
  Set Title
  
  Shall set the title for this Group

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  The text for the new title


id: UI\Controls\Label
type: class
doc:
<comment>Description:</comment>
  A Label is a single line of text, meant to identify, for the user, some element of the interface.


id: UI\Controls\Label::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Label
  
  Shall construct a new Label

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text for this label


id: UI\Controls\Label::getText
type: function
doc:
<comment>Description:</comment>
  Get Text
  
  Shall return the current text for this Label
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>string</info>  


id: UI\Controls\Label::setText
type: function
doc:
<comment>Description:</comment>
  Set Text
  
  Shall set the text for this Label

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The new text


id: UI\Controls\MultilineEntry
type: class
doc:
<comment>Description:</comment>
  A Multiline Entry is a text entry control able to hold multiple lines of text, with or without
  wrapping.


id: UI\Controls\MultilineEntry::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Multiline Entry
  
  Shall construct a new Multiline Entry of the given type

<comment>Param:</comment>
  <info>int</info>  <strong>$type</strong>  MultilineEntry::Wrap or MultilineEntry::NoWrap


id: UI\Controls\MultilineEntry::append
type: function
doc:
<comment>Description:</comment>
  Append Text
  
  Shall append the given text to the text in this Multiline Entry

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text to append


id: UI\Controls\MultilineEntry::getText
type: function
doc:
<comment>Description:</comment>
  Get Text
  
  Shall return the text in this Multiline Entry

<comment>Return:</comment>
  <info>string</info>  


id: UI\Controls\MultilineEntry::isReadOnly
type: function
doc:
<comment>Description:</comment>
  Read Only Detection
  
  Shall detect if this Multiline Entry is read only

<comment>Return:</comment>
  <info>bool</info>  


id: UI\Controls\MultilineEntry::onChange
type: function
doc:
<comment>Description:</comment>
  Change Handler
  
  Shall be executed when the text in this Multiline Entry is changed


id: UI\Controls\MultilineEntry::setReadOnly
type: function
doc:
<comment>Description:</comment>
  Set Read Only
  
  Shall enable or disable read only on this Multiline Entry

<comment>Param:</comment>
  <info>bool</info>  <strong>$readOnly</strong>  


id: UI\Controls\MultilineEntry::setText
type: function
doc:
<comment>Description:</comment>
  Set Text
  
  Shall set the text in this Multiline Entry

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The new text


id: UI\Controls\Picker
type: class
doc:
<comment>Description:</comment>
  A Picker represents a button which when clicked presents a native Date/Time/DateTime Picker
  interface to the user.


id: UI\Controls\Picker::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Picker
  
  Construct a new Picker of the given type

<comment>Param:</comment>
  <info>int</info>  <strong>$type</strong>  Picker::Date, Picker::Time, or Picker::DateTime


id: UI\Controls\Progress
type: class
doc:
<comment>Description:</comment>
  A Progress control is a familiar Progress bar: It represents progress as a percentage, with a
  possible range of 0 to 100 (inclusive).


id: UI\Controls\Progress::getValue
type: function
doc:
<comment>Description:</comment>
  Get Value
  
  Shall retrieve the current value of this Progress bar

<comment>Return:</comment>
  <info>int</info>  


id: UI\Controls\Progress::setValue
type: function
doc:
<comment>Description:</comment>
  Set Value
  
  Shall set the value for this Progress bar

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  An integer between 0 and 100 (inclusive)


id: UI\Controls\Radio::append
type: function
doc:
<comment>Description:</comment>
  Append Option
  
  Shall append a new option to this Radio

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text (label) for the option


id: UI\Controls\Radio::getSelected
type: function
doc:
<comment>Description:</comment>
  Get Selected Option
  
  Shall retrieve the index of the currently selected option in this Radio

<comment>Return:</comment>
  <info>int</info>  


id: UI\Controls\Radio::onSelected
type: function
doc:
<comment>Description:</comment>
  Selected Handler
  
  Shall be executed when the option selected in this Radio changes


id: UI\Controls\Radio::setSelected
type: function
doc:
<comment>Description:</comment>
  Set Selected Option
  
  Shall set the currently selected option in this Radio

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index of the option to select


id: UI\Controls\Separator
type: class
doc:
<comment>Description:</comment>
  A Separator represents a control separator, it has no other function.


id: UI\Controls\Separator::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Separator
  
  Shall construct a new Separator of the given type

<comment>Param:</comment>
  <info>int</info>  <strong>$type</strong>  Separator::Horizonal or Separator::Vertical


id: UI\Controls\Slider
type: class
doc:
<comment>Description:</comment>
  A Slider is a control which represents a range, and a current value in the range. The sliding
  element of the control (sometimes called the "thumb") reflects the value, and can be adjusted
  within the range.


id: UI\Controls\Slider::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Slider
  
  Construct a new Slider with the given range

<comment>Param:</comment>
  <info>int</info>  <strong>$min</strong>  The minimum allowed value
  <info>int</info>  <strong>$max</strong>  The maximum allowed value


id: UI\Controls\Slider::getValue
type: function
doc:
<comment>Description:</comment>
  Get Value
  
  Get the value from this Slider

<comment>Return:</comment>
  <info>int</info>  


id: UI\Controls\Slider::onChange
type: function
doc:
<comment>Description:</comment>
  Change Handler
  
  Shall be executed when the value of this Slider changes


id: UI\Controls\Slider::setValue
type: function
doc:
<comment>Description:</comment>
  Set Value
  
  Shall set the value for this Slider

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  The new value


id: UI\Controls\Spin
type: class
doc:
<comment>Description:</comment>
  A Spin box is a text box with an up-down control which changes the integer value in the box,
  within a defined range


id: UI\Controls\Spin::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Spin
  
  Constructs a new Spin with the given range

<comment>Param:</comment>
  <info>int</info>  <strong>$min</strong>  The minimum value allowed
  <info>int</info>  <strong>$max</strong>  The maximum value allowed


id: UI\Controls\Spin::getValue
type: function
doc:
<comment>Description:</comment>
  Get Value
  
  Get the value in this Spin

<comment>Return:</comment>
  <info>int</info>  


id: UI\Controls\Spin::onChange
type: function
doc:
<comment>Description:</comment>
  Change Handler
  
  Shall be executed when the value in this Spin changes


id: UI\Controls\Spin::setValue
type: function
doc:
<comment>Description:</comment>
  Set Value
  
  Set the value in this Spin

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  The new value


id: UI\Controls\Tab
type: class
doc:
<comment>Description:</comment>
  A Tab can contain many pages of Controls, each with a title, each selectable by the user.


id: UI\Controls\Tab::append
type: function
doc:
<comment>Description:</comment>
  Append Page
  
  Append a new page to this Tab

<comment>Param:</comment>
  <info>string</info>      <strong>$name</strong>     The name for the new page
  <info>UI\Control</info>  <strong>$control</strong>  The control for the new page

<comment>Return:</comment>
  <info>int</info>  Shall return the index of the appended control, may be 0


id: UI\Controls\Tab::delete
type: function
doc:
<comment>Description:</comment>
  Delete Page
  
  Shall remove the selected page from this Tab

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index of the page to remove

<comment>Return:</comment>
  <info>bool</info>  Indication of success


id: UI\Controls\Tab::hasMargin
type: function
doc:
<comment>Description:</comment>
  Margin Detection
  
  Shall detect if the given page has a margin.

<comment>Param:</comment>
  <info>int</info>  <strong>$page</strong>  The index of the page

<comment>Return:</comment>
  <info>bool</info>  


id: UI\Controls\Tab::insertAt
type: function
doc:
<comment>Description:</comment>
  Insert Page
  
  Shall insert a new page into this Tab

<comment>Param:</comment>
  <info>string</info>      <strong>$name</strong>     The name for the new page
  <info>int</info>         <strong>$page</strong>     The index to perform the insertion before
  <info>UI\Control</info>  <strong>$control</strong>  The control for the new page


id: UI\Controls\Tab::pages
type: function
doc:
<comment>Description:</comment>
  Page Count
  
  Shall return the number of pages in this Tab

<comment>Return:</comment>
  <info>int</info>  The number of pages in this Tab


id: UI\Controls\Tab::setMargin
type: function
doc:
<comment>Description:</comment>
  Set Margin
  
  Shall enable or disable margins on the selected page

<comment>Param:</comment>
  <info>int</info>   <strong>$page</strong>    The page to select
  <info>bool</info>  <strong>$margin</strong>  Margin switch


id: UI\Draw\Brush::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Brush
  
  Shall construct a solid brush using the given color

<comment>Param:</comment>
  <info>UI\Draw\Color</info>  <strong>$color</strong>  Can be a UI\Draw\Color or RRGGBBAA


id: UI\Draw\Brush::getColor
type: function
doc:
<comment>Description:</comment>
  Get Color
  
  Shall return a UI\Draw\Color for this brush

<comment>Return:</comment>
  <info>UI\Draw\Color</info>  The current color of the brush


id: UI\Draw\Brush::setColor
type: function
doc:
<comment>Description:</comment>
  Set Color
  
  Shall set the color of this brush to the color provided

<comment>Param:</comment>
  <info>UI\Draw\Color</info>  <strong>$color</strong>  Can be a UI\Draw\Color or RRGGBBAA

<comment>Return:</comment>
  <info>void</info>  


id: UI\Draw\Brush\Gradient::addStop
type: function
doc:
<comment>Description:</comment>
  Stop Manipulation
  
  Shall at a stop of the given color at the given position

<comment>Param:</comment>
  <info>float</info>          <strong>$position</strong>  The position for the new stop
  <info>UI\Draw\Color</info>  <strong>$color</strong>     The color for the new stop, may be UI\Draw\Color or RRGGBBAA

<comment>Return:</comment>
  <info>int</info>  Total number of stops


id: UI\Draw\Brush\Gradient::delStop
type: function
doc:
<comment>Description:</comment>
  Stop Manipulation
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  

<comment>Return:</comment>
  <info>int</info>  Total number of stops


id: UI\Draw\Brush\Gradient::setStop
type: function
doc:
<comment>Description:</comment>
  Stop Manipulation

<comment>Param:</comment>
  <info>int</info>            <strong>$index</strong>     The index of the stop to set
  <info>float</info>          <strong>$position</strong>  The position for the stop
  <info>UI\Draw\Color</info>  <strong>$color</strong>     The color for the stop, may be UI\Draw\Color or RRGGBBAA

<comment>Return:</comment>
  <info>bool</info>  Indication of success


id: UI\Draw\Brush\LinearGradient::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a Linear Gradient
  
  Shall construct a new linear gradient

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$start</strong>  
  <info>UI\Point</info>  <strong>$end</strong>    


id: UI\Draw\Brush\RadialGradient::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Radial Gradient
  
  Shall construct a new radial gradient

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$start</strong>   
  <info>UI\Point</info>  <strong>$outer</strong>   
  <info>float</info>     <strong>$radius</strong>  


id: UI\Draw\Color
type: class
doc:
<comment>Description:</comment>
  Represents RGBA colours, individual channels are accessible via public properties.


id: UI\Draw\Color::__construct
type: function
doc:
<comment>Description:</comment>
  Construct new Color
  
  Shall construct a new color

<comment>Param:</comment>
  <info>UI\Draw\Color</info>  <strong>$color</strong>  May be UI\Draw\Color or RRGGBBAA


id: UI\Draw\Color::getChannel
type: function
doc:
<comment>Description:</comment>
  Color Manipulation
  
  Shall retrieve the value for a channel

<comment>Param:</comment>
  <info>int</info>  <strong>$channel</strong>  Constant channel identity

<comment>Return:</comment>
  <info>float</info>  The current value of the requested channel


id: UI\Draw\Color::setChannel
type: function
doc:
<comment>Description:</comment>
  Color Manipulation
  
  Shall set the selected channel to the given value

<comment>Param:</comment>
  <info>int</info>    <strong>$channel</strong>  Constant channel identity
  <info>float</info>  <strong>$value</strong>    The new value for the selected channel

<comment>Return:</comment>
  <info>void</info>  


id: UI\Draw\Matrix::isInvertible
type: function
doc:
<comment>Description:</comment>
  Invertible Detection
  
  Shall detect if this Matrix may be inverted

<comment>Return:</comment>
  <info>bool</info>  


id: UI\Draw\Matrix::multiply
type: function
doc:
<comment>Description:</comment>
  Multiply Matrix
  
  Shall multiply this matrix with the given matrix

<comment>Return:</comment>
  <info>UI\Draw\Matrix</info>  The new Matrix


id: UI\Draw\Matrix::rotate
type: function
doc:
<comment>Description:</comment>
  Rotate Matrix
  
  Shall rotate this Matrix

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>   
  <info>float</info>     <strong>$amount</strong>  


id: UI\Draw\Matrix::scale
type: function
doc:
<comment>Description:</comment>
  Scale Matrix
  
  Shall scale this Matrix

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$center</strong>  
  <info>UI\Point</info>  <strong>$point</strong>   


id: UI\Draw\Matrix::skew
type: function
doc:
<comment>Description:</comment>
  Skew Matrix
  
  Shall skew this Matrix

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>   
  <info>UI\Point</info>  <strong>$amount</strong>  


id: UI\Draw\Matrix::translate
type: function
doc:
<comment>Description:</comment>
  Translate Matrix
  
  Shall translate this Matrix

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>  


id: UI\Draw\Path
type: class
doc:
<comment>Description:</comment>
  A Draw Path guides a Draw Pen, telling the Pen where to draw on an Area.


id: UI\Draw\Path::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Path
  
  Shall construct a new path in the given mode

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  Path::Winding or Path::Alternate


id: UI\Draw\Path::addRectangle
type: function
doc:
<comment>Description:</comment>
  Draw a Rectangle
  
  Shall map the path of a rectangle of the given size, at the given point

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>  The point to begin the shape
  <info>UI\Size</info>   <strong>$size</strong>   The size of the rectangle


id: UI\Draw\Path::arcTo
type: function
doc:
<comment>Description:</comment>
  Draw an Arc
  
  Shall map the path for an arc

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>     The point to begin mapping
  <info>float</info>     <strong>$radius</strong>    The radius of the arc
  <info>float</info>     <strong>$angle</strong>     The angle of the arc
  <info>float</info>     <strong>$sweep</strong>     The sweep of the arc
  <info>float</info>     <strong>$negative</strong>  


id: UI\Draw\Path::bezierTo
type: function
doc:
<comment>Description:</comment>
  Draw Bezier Curve
  
  Shall draw a bezier curve

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>     The point at which to begin mapping
  <info>float</info>     <strong>$radius</strong>    The radius of the curve
  <info>float</info>     <strong>$angle</strong>     The angle of the curve
  <info>float</info>     <strong>$sweep</strong>     The sweep of the curve
  <info>float</info>     <strong>$negative</strong>  


id: UI\Draw\Path::lineTo
type: function
doc:
<comment>Description:</comment>
  Draw a Line
  
  Shall map the path for a line

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>     The point to begin mapping
  <info>float</info>     <strong>$radius</strong>    
  <info>float</info>     <strong>$angle</strong>     
  <info>float</info>     <strong>$sweep</strong>     
  <info>float</info>     <strong>$negative</strong>  


id: UI\Draw\Path::newFigure
type: function
doc:
<comment>Description:</comment>
  Draw Figure
  
  Shall map a new figure at the given point

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>  The point to begin mapping


id: UI\Draw\Path::newFigureWithArc
type: function
doc:
<comment>Description:</comment>
  Draw Figure with Arc

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>     
  <info>float</info>     <strong>$radius</strong>    
  <info>float</info>     <strong>$angle</strong>     
  <info>float</info>     <strong>$sweep</strong>     
  <info>float</info>     <strong>$negative</strong>  


id: UI\Draw\Pen
type: class
doc:
<comment>Description:</comment>
  The Pen is passed to the Area Draw event handler, it is used for clipping, filling, stroking, and
  writing to Draw Paths.


id: UI\Draw\Pen::clip
type: function
doc:
<comment>Description:</comment>
  Clip a Path
  
  Shall clip the given Path

<comment>Param:</comment>
  <info>UI\Draw\Path</info>  <strong>$path</strong>  The path to clip


id: UI\Draw\Pen::fill
type: function
doc:
<comment>Description:</comment>
  Fill a Path
  
  Shall fill the given path

<comment>Param:</comment>
  <info>UI\Draw\Path</info>   <strong>$path</strong>  The path to fill
  <info>UI\Draw\Brush</info>  <strong>$with</strong>  The color or brush to fill with


id: UI\Draw\Pen::stroke
type: function
doc:
<comment>Description:</comment>
  Stroke a Path
  
  Shall stroke the given path

<comment>Param:</comment>
  <info>UI\Draw\Path</info>    <strong>$path</strong>    The path to stroke
  <info>UI\Draw\Brush</info>   <strong>$with</strong>    The color or brush to stroke with
  <info>UI\Draw\Stroke</info>  <strong>$stroke</strong>  The configuration of the stroke


id: UI\Draw\Pen::transform
type: function
doc:
<comment>Description:</comment>
  Matrix Transform
  
  Shall perform matrix transformation

<comment>Param:</comment>
  <info>UI\Draw\Matrix</info>  <strong>$matrix</strong>  The matrix to use


id: UI\Draw\Pen::write
type: function
doc:
<comment>Description:</comment>
  Draw Text at Point
  
  Shall draw the given text layout at the given point

<comment>Param:</comment>
  <info>UI\Point</info>             <strong>$point</strong>   The point to perform the drawing
  <info>UI\Draw\Text\Layout</info>  <strong>$layout</strong>  The layout of the text to draw


id: UI\Draw\Stroke::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Stroke
  
  Shall construct a new Stroke

<comment>Param:</comment>
  <info>int</info>    <strong>$cap</strong>         UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, or UI\Draw\Line\Cap::Square
  <info>int</info>    <strong>$join</strong>        UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, or
                      UI\Draw\Line\Join::Bevel
  <info>float</info>  <strong>$thickness</strong>   The thickness of the stroke
  <info>float</info>  <strong>$miterLimit</strong>  Miter limit (default is sensible for all supported platforms)


id: UI\Draw\Stroke::getCap
type: function
doc:
<comment>Description:</comment>
  Get Line Cap
  
  Shall retrieve the line cap setting of this Stroke

<comment>Return:</comment>
  <info>int</info>  UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, or UI\Draw\Line\Cap::Square


id: UI\Draw\Stroke::getJoin
type: function
doc:
<comment>Description:</comment>
  Get Line Join
  
  Shall retrieve the line join setting of this Stroke

<comment>Return:</comment>
  <info>int</info>  UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, or UI\Draw\Line\Join::Bevel


id: UI\Draw\Stroke::getMiterLimit
type: function
doc:
<comment>Description:</comment>
  Get Miter Limit
  
  Shall retrieve the miter limit of this Stroke

<comment>Return:</comment>
  <info>float</info>  The current miter limit


id: UI\Draw\Stroke::getThickness
type: function
doc:
<comment>Description:</comment>
  Get Thickness
  
  Shall retrieve the thickness of this Stroke

<comment>Return:</comment>
  <info>float</info>  The current thickness


id: UI\Draw\Stroke::setCap
type: function
doc:
<comment>Description:</comment>
  Set Line Cap
  
  Shall set the line cap setting for this Stroke

<comment>Param:</comment>
  <info>int</info>  <strong>$cap</strong>  UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, or UI\Draw\Line\Cap::Square


id: UI\Draw\Stroke::setJoin
type: function
doc:
<comment>Description:</comment>
  Set Line Join
  
  Shall set the line join setting for this Stroke

<comment>Param:</comment>
  <info>int</info>  <strong>$join</strong>  UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, or UI\Draw\Line\Join::Bevel


id: UI\Draw\Stroke::setMiterLimit
type: function
doc:
<comment>Description:</comment>
  Set Miter Limit
  
  Set the miter limit for this Stroke

<comment>Param:</comment>
  <info>float</info>  <strong>$limit</strong>  The new limit


id: UI\Draw\Stroke::setThickness
type: function
doc:
<comment>Description:</comment>
  Set Thickness
  
  Shall set the thickness for this Stroke

<comment>Param:</comment>
  <info>float</info>  <strong>$thickness</strong>  The new thickness


id: UI\Draw\Text\Font::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Font
  
  Shall construct a new Font using the given descriptor

<comment>Param:</comment>
  <info>UI\Draw\Text\Font\Descriptor</info>  <strong>$descriptor</strong>  The descriptor for the Font


id: UI\Draw\Text\Font\Descriptor::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Font Descriptor
  
  Shall construct a new Font Descriptor

<comment>Param:</comment>
  <info>string</info>  <strong>$family</strong>   The name of a valid family of fonts
  <info>float</info>   <strong>$size</strong>     The preferred size
  <info>int</info>     <strong>$weight</strong>   UI\Draw\Text\Font\Weight constant
  <info>int</info>     <strong>$italic</strong>   UI\Draw\Text\Font\Italic constant
  <info>int</info>     <strong>$stretch</strong>  UI\Draw\Text\Font\Stretch constant


id: UI\Draw\Text\Font\Descriptor::getFamily
type: function
doc:
<comment>Description:</comment>
  Get Font Family
  
  Shall return the requested font family

<comment>Return:</comment>
  <info>string</info>  


id: UI\Draw\Text\Font\Descriptor::getItalic
type: function
doc:
<comment>Description:</comment>
  Style Detection
  
  Shall return constant setting

<comment>Return:</comment>
  <info>int</info>  


id: UI\Draw\Text\Font\Descriptor::getSize
type: function
doc:
<comment>Description:</comment>
  Size Detection
  
  Shall return the requested size

<comment>Return:</comment>
  <info>float</info>  


id: UI\Draw\Text\Font\Descriptor::getStretch
type: function
doc:
<comment>Description:</comment>
  Style Detection
  
  Shall return requested stretch

<comment>Return:</comment>
  <info>int</info>  


id: UI\Draw\Text\Font\Descriptor::getWeight
type: function
doc:
<comment>Description:</comment>
  Weight Detection
  
  Shall return requested weight

<comment>Return:</comment>
  <info>int</info>  


id: UI\Draw\Text\Font\fontFamilies
type: function
doc:
<comment>Description:</comment>
  Retrieve Font Families
  
  Returns an array of valid font families for the current system

<comment>Return:</comment>
  <info>array</info>  Returns an <info>array</info> of valid font families for the current system.


id: UI\Draw\Text\Layout
type: class
doc:
<comment>Description:</comment>
  A Text Layout represents the layout of text which will be drawn by the Pen


id: UI\Draw\Text\Layout::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Text Layout
  
  Shall construct a new Text Layout

<comment>Param:</comment>
  <info>string</info>             <strong>$text</strong>   The text for the layout
  <info>UI\Draw\Text\Font</info>  <strong>$font</strong>   The font to use for writing
  <info>float</info>              <strong>$width</strong>  The width of the layout


id: UI\Draw\Text\Layout::setColor
type: function
doc:
<comment>Description:</comment>
  Set Color
  
  Shall set the Color for all of, or a range of the text in the Layout

<comment>Param:</comment>
  <info>UI\Draw\Color</info>  <strong>$color</strong>  The color to use
  <info>int</info>            <strong>$start</strong>  The starting character
  <info>int</info>            <strong>$end</strong>    The ending character, by default the end of the string


id: UI\Draw\Text\Layout::setWidth
type: function
doc:
<comment>Description:</comment>
  Set Width
  
  Shall set the width of this Text Layout

<comment>Param:</comment>
  <info>float</info>  <strong>$width</strong>  The new width


id: UI\Executor
type: class
doc:
<comment>Description:</comment>
  This facility schedules repetitive execution of a callback, useful for animations and other such
  activities.


id: UI\Executor::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Executor
  
  Shall construct an executor with the given interval, will not start executing until main loop is
  entered

<comment>Param:</comment>
  <info>int</info>  <strong>$seconds</strong>       Seconds between executions
  <info>int</info>  <strong>$microseconds</strong>  Microseconds between executions


id: UI\Executor::kill
type: function
doc:
<comment>Description:</comment>
  Stop Executor
  
  Shall stop an executor, the executor cannot be restarted

<comment>Return:</comment>
  <info>void</info>  


id: UI\Executor::onExecute
type: function
doc:
<comment>Description:</comment>
  Execution Callback
  
  Shall be repetitively queued for execution in the main thread

<comment>Return:</comment>
  <info>void</info>  


id: UI\Executor::setInterval
type: function
doc:
<comment>Description:</comment>
  Interval Manipulation
  
  Shall set the new interval. An interval of 0 will pause the executor until a new interval has been
  set

<comment>Param:</comment>
  <info>int</info>  <strong>$seconds</strong>       
  <info>int</info>  <strong>$microseconds</strong>  

<comment>Return:</comment>
  <info>bool</info>  Indication of success


id: UI\Menu
type: class
doc:
<comment>Description:</comment>
  Menus must be constructed before the first Window, and can be shown on any Window


id: UI\Menu::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Menu
  
  Shall construct a new Menu

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name (text) for the menu


id: UI\Menu::append
type: function
doc:
<comment>Description:</comment>
  Append Menu Item
  
  Shall append a new Menu Item

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name (text) for the new item
  <info>string</info>  <strong>$type</strong>  The type for the new item

<comment>Return:</comment>
  <info>UI\MenuItem</info>  A constructed object of the given type


id: UI\Menu::appendAbout
type: function
doc:
<comment>Description:</comment>
  Append About Menu Item
  
  Shall append an About menu item

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  The type for the new item

<comment>Return:</comment>
  <info>UI\MenuItem</info>  A constructed About menu item of the given type


id: UI\Menu::appendCheck
type: function
doc:
<comment>Description:</comment>
  Append Checkable Menu Item
  
  Shall append a checkable menu item

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name (text) for the new item
  <info>string</info>  <strong>$type</strong>  The type for the new item

<comment>Return:</comment>
  <info>UI\MenuItem</info>  A constructed checkable menu item of the given type


id: UI\Menu::appendPreferences
type: function
doc:
<comment>Description:</comment>
  Append Preferences Menu Item
  
  Shall append a Preferences menu item

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  The type for the new item

<comment>Return:</comment>
  <info>UI\MenuItem</info>  A constructed Preferences menu item of the given type


id: UI\Menu::appendQuit
type: function
doc:
<comment>Description:</comment>
  Append Quit Menu Item
  
  Shall append a Quit menu item

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  The type for the new item

<comment>Return:</comment>
  <info>UI\MenuItem</info>  A constructed Quit menu item of the given type


id: UI\MenuItem::isChecked
type: function
doc:
<comment>Description:</comment>
  Detect Checked
  
  Shall detect if this Menu Item is checked

<comment>Return:</comment>
  <info>bool</info>  


id: UI\MenuItem::onClick
type: function
doc:
<comment>Description:</comment>
  On Click Callback
  
  Shall be executed when this Menu Item is clicked


id: UI\MenuItem::setChecked
type: function
doc:
<comment>Description:</comment>
  Set Checked
  
  Shall set the checked status of this Menu Item

<comment>Param:</comment>
  <info>bool</info>  <strong>$checked</strong>  The new status


id: UI\Point
type: class
doc:
<comment>Description:</comment>
  Points are used throughout UI to represent co-ordinates on a screen, control, or area.


id: UI\Point::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Point
  
  Construct a new Point using new co-ordinates

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  The new X co-ordinate
  <info>float</info>  <strong>$y</strong>  The new Y co-ordinate


id: UI\Point::at
type: function
doc:
<comment>Description:</comment>
  Size Coercion
  
  Shall return a UI\Point object where x and y are equal to those supplied, either in float or
  UI\Size form

<comment>Param:</comment>
  <info>float</info>    <strong>$point</strong>  The value for x and y
  <info>UI\Size</info>  <strong>$size</strong>   The Size to convert

<comment>Return:</comment>
  <info>UI\Point</info>  The resulting Point


id: UI\Point::getX
type: function
doc:
<comment>Description:</comment>
  Retrieves X
  
  Retrieves the X co-ordinate

<comment>Return:</comment>
  <info>float</info>  The current X co-ordinate


id: UI\Point::getY
type: function
doc:
<comment>Description:</comment>
  Retrieves Y
  
  Retrieves the Y co-ordinate

<comment>Return:</comment>
  <info>float</info>  The current Y co-ordinate


id: UI\Point::setX
type: function
doc:
<comment>Description:</comment>
  Set X
  
  Set the X co-ordinate

<comment>Param:</comment>
  <info>float</info>  <strong>$point</strong>  The new X co-ordinate


id: UI\Point::setY
type: function
doc:
<comment>Description:</comment>
  Set Y
  
  Set the Y co-ordinate

<comment>Param:</comment>
  <info>float</info>  <strong>$point</strong>  The new Y co-ordinate


id: UI\Size
type: class
doc:
<comment>Description:</comment>
  Sizes are used throughout UI to represent the size of a screen, control, or area.


id: UI\Size::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Size
  
  Construct a new Size using new width and height

<comment>Param:</comment>
  <info>float</info>  <strong>$width</strong>   The new width
  <info>float</info>  <strong>$height</strong>  The new height


id: UI\Size::getHeight
type: function
doc:
<comment>Description:</comment>
  Retrieves Height
  
  Retrieves the Height

<comment>Return:</comment>
  <info>float</info>  The current Height


id: UI\Size::getWidth
type: function
doc:
<comment>Description:</comment>
  Retrives Width
  
  Retrieves the Width

<comment>Return:</comment>
  <info>float</info>  The current Width


id: UI\Size::of
type: function
doc:
<comment>Description:</comment>
  Point Coercion
  
  Shall return a UI\Size object where width and height are equal to those supplied, either in float
  or UI\Point form

<comment>Param:</comment>
  <info>float</info>     <strong>$size</strong>   The value for width and height
  <info>UI\Point</info>  <strong>$point</strong>  The Point to convert

<comment>Return:</comment>
  <info>UI\Size</info>  The resulting Size


id: UI\Size::setHeight
type: function
doc:
<comment>Description:</comment>
  Set Height
  
  Set new Height

<comment>Param:</comment>
  <info>float</info>  <strong>$size</strong>  The new Height


id: UI\Size::setWidth
type: function
doc:
<comment>Description:</comment>
  Set Width
  
  Set new Width

<comment>Param:</comment>
  <info>float</info>  <strong>$size</strong>  The new Width


id: UI\Window::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Window
  
  Shall construct a new Window

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  The title of the Window
  <info>Size</info>    <strong>$size</strong>   The size of the Window
  <info>bool</info>    <strong>$menu</strong>   Menu switch


id: UI\Window::add
type: function
doc:
<comment>Description:</comment>
  Add a Control
  
  Shall add a Control to this Window

<comment>Param:</comment>
  <info>UI\Control</info>  <strong>$control</strong>  The Control to add


id: UI\Window::error
type: function
doc:
<comment>Description:</comment>
  Show Error Box
  
  Shall show an error box

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  The title of the error box
  <info>string</info>  <strong>$msg</strong>    The message for the error box


id: UI\Window::getSize
type: function
doc:
<comment>Description:</comment>
  Get Window Size
  
  Shall return the size of this Window

<comment>Return:</comment>
  <info>UI\Size</info>  


id: UI\Window::getTitle
type: function
doc:
<comment>Description:</comment>
  Get Title
  
  Shall retrieve the title of this Window

<comment>Return:</comment>
  <info>string</info>  


id: UI\Window::hasBorders
type: function
doc:
<comment>Description:</comment>
  Border Detection
  
  Shall detect if borders are used on this Window

<comment>Return:</comment>
  <info>bool</info>  


id: UI\Window::hasMargin
type: function
doc:
<comment>Description:</comment>
  Margin Detection
  
  Shall detect if margins are used on this Window

<comment>Return:</comment>
  <info>bool</info>  


id: UI\Window::isFullScreen
type: function
doc:
<comment>Description:</comment>
  Full Screen Detection
  
  Shall detect if this Window us using the whole screen

<comment>Return:</comment>
  <info>bool</info>  


id: UI\Window::msg
type: function
doc:
<comment>Description:</comment>
  Show Message Box
  
  Shall show a message box

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  The title of the message box
  <info>string</info>  <strong>$msg</strong>    The message


id: UI\Window::onClosing
type: function
doc:
<comment>Description:</comment>
  Closing Callback
  
  Should gracefully destroy this Window

<comment>Return:</comment>
  <info>int</info>  


id: UI\Window::open
type: function
doc:
<comment>Description:</comment>
  Open Dialog
  
  Shall show an open file dialog

<comment>Return:</comment>
  <info>string</info>  Returns the name of the file selected for opening


id: UI\Window::save
type: function
doc:
<comment>Description:</comment>
  Save Dialog
  
  Shall show a save dialog

<comment>Return:</comment>
  <info>string</info>  Returns the file name selecting for saving


id: UI\Window::setBorders
type: function
doc:
<comment>Description:</comment>
  Border Use
  
  Shall enable or disable the use of borders on this Window

<comment>Param:</comment>
  <info>bool</info>  <strong>$borders</strong>  


id: UI\Window::setFullScreen
type: function
doc:
<comment>Description:</comment>
  Full Screen Use
  
  Shall enable or disable the use of the full screen for this Window
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>bool</info>  <strong>$full</strong>  


id: UI\Window::setMargin
type: function
doc:
<comment>Description:</comment>
  Margin Use
  
  Shall enable or disable the use of margins for this Window

<comment>Param:</comment>
  <info>bool</info>  <strong>$margin</strong>  


id: UI\Window::setSize
type: function
doc:
<comment>Description:</comment>
  Set Size
  
  Shall set the size of this Window

<comment>Param:</comment>
  <info>UI\Size</info>  <strong>$size</strong>  


id: UI\Window::setTitle
type: function
doc:
<comment>Description:</comment>
  Window Title
  
  Shall set the title for this Window

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  The new title


id: UI\quit
type: function
doc:
<comment>Description:</comment>
  Quit UI Loop
  
  Shall cause the main loop to be exited

<comment>Return:</comment>
  <info>void</info>  


id: UI\run
type: function
doc:
<comment>Description:</comment>
  Enter UI Loop
  
  Shall cause PHP to enter into the main loop, by default control will not be returned to the caller

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Set UI\Loop to return control, and UI\Wait to return control after waiting

<comment>Return:</comment>
  <info>void</info>  


id: UnitEnum
type: class
doc:
<comment>Description:</comment>
  A interface <class>UnitEnum</class> é aplicada automaticamente a todas as enumerações pelo motor do PHP. Não pode
  ser implementada por classes definidas pelo usuário. Enumerações não podem substituir seus
  métodos, já que implementações padrão são fornecidas pelo motor. Está disponível apenas para
  verificações de tipo.


id: UnitEnum::cases
type: function
doc:
<comment>Description:</comment>
  Gera uma lista de casos de uma enumeração
  
  Este método irá retornar um array de todos os casos de uma enumeração, em ordem de declaração.

<comment>Return:</comment>
  <info>array</info>  Um array de todos os casos definidos desta enumeração, em ordem de declaração.


id: V8Js
type: class
doc:
<comment>Description:</comment>
  This is the core class for V8Js extension. Each instance created from this class has own context
  in which all JavaScript is compiled and executed.
  
  See <strong>V8Js::__construct()</strong> for more information.


id: V8Js::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new V8Js object
  
  Constructs a new <class>V8Js</class> object.

<comment>Param:</comment>
  <info>string</info>  <strong>$object_name</strong>                 The name of the object passed to Javascript.
  <info>array</info>   <strong>$variables</strong>                   Map of PHP variables that will be available in Javascript.
                                       Must be an associative <info>array</info> in format <return>array("name-for-js"
                                       =&gt; "name-of-php-variable")</return>. Defaults to empty array.
  <info>array</info>   <strong>$extensions</strong>                  List of extensions registered using <strong>V8Js::registerExtension()</strong>
                                       which should be available  in the Javascript context of the
                                       created <class>V8Js</class> object.  Extensions registered to be enabled
                                       automatically do not need to be listed in this array. Also if
                                       an extension has dependencies, those dependencies can be
                                       omitted as well. Defaults to empty array.
                                       
                                       Extensions registered to be enabled automatically do not need
                                       to be listed in this array. Also if an extension has
                                       dependencies, those dependencies can be omitted as well.
                                       Defaults to empty array.
  <info>bool</info>    <strong>$report_uncaught_exceptions</strong>  Controls whether uncaught Javascript exceptions are reported
                                       immediately or not. Defaults to <info>true</info>. If set to <info>false</info> the
                                       uncaught exception can be accessed using
                                       <strong>V8Js::getPendingException()</strong>.


id: V8Js::executeString
type: function
doc:
<comment>Description:</comment>
  Execute a string as Javascript code
  
  Compiles and executes the string passed with <strong>$script</strong> as Javascript code.

<comment>Param:</comment>
  <info>string</info>  <strong>$script</strong>      The code string to be executed.
  <info>string</info>  <strong>$identifier</strong>  Identifier string for the executed code. Used for debugging.
  <info>int</info>     <strong>$flags</strong>       Execution flags. This value must be one of the <return>V8Js::FLAG_*</return> constants,
                       defaulting to <info>V8Js::FLAG_NONE</info>. <info>V8Js::FLAG_NONE</info>: no flags
                       <info>V8Js::FLAG_FORCE_ARRAY</info>: forces all Javascript objects passed to PHP to be
                       associative arrays
                       
                       <info>V8Js::FLAG_NONE</info>: no flags
                       
                       <info>V8Js::FLAG_FORCE_ARRAY</info>: forces all Javascript objects passed to PHP to be
                       associative arrays

<comment>Return:</comment>
  <info>mixed</info>  Returns the last variable instantiated in the Javascript code converted to matching PHP
         variable type.


id: V8Js::getExtensions
type: function
doc:
<comment>Description:</comment>
  Return an array of registered extensions
  
  This function returns array of Javascript extensions registered using <strong>V8Js::registerExtension()</strong>.

<comment>Return:</comment>
  <info>array</info>  Returns an array of registered extensions or an empty array if there are none.


id: V8Js::getPendingException
type: function
doc:
<comment>Description:</comment>
  Return pending uncaught Javascript exception
  
  Returns any pending uncaught Javascript exception as <class>V8JsException</class> left from earlier
  <strong>V8Js::executeString()</strong> call(s).

<comment>Return:</comment>
  <info>V8JsException</info>  Either <class>V8JsException</class> or <info>null</info>.


id: V8Js::registerExtension
type: function
doc:
<comment>Description:</comment>
  Register Javascript extensions for V8Js
  
  Registers passed Javascript <strong>$script</strong> as extension to be used in <class>V8Js</class> contexts.

<comment>Param:</comment>
  <info>string</info>  <strong>$extension_name</strong>  Name of the extension to be registered.
  <info>string</info>  <strong>$script</strong>          The Javascript code to be registered.
  <info>array</info>   <strong>$dependencies</strong>    Array of extension names the extension to be registered depends on. Any
                           such extension is enabled automatically when this extension is loaded.
                           All extensions, including the dependencies, must be registered before any
                           <class>V8Js</class> are created which use them.
                           
                           All extensions, including the dependencies, must be registered before any
                           <class>V8Js</class> are created which use them.
  <info>bool</info>    <strong>$auto_enable</strong>     If set to <info>true</info>, the extension will be enabled automatically in all <class>V8Js</class>
                           contexts.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if extension was registered successfully, <info>false</info> otherwise.


id: V8JsException::getJsFileName
type: function
doc:
<comment>Description:</comment>
  The getJsFileName purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>string</info>  


id: V8JsException::getJsLineNumber
type: function
doc:
<comment>Description:</comment>
  The getJsLineNumber purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>int</info>  


id: V8JsException::getJsSourceLine
type: function
doc:
<comment>Description:</comment>
  The getJsSourceLine purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>string</info>  


id: V8JsException::getJsTrace
type: function
doc:
<comment>Description:</comment>
  The getJsTrace purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>string</info>  


id: VARCMP_GT
type: constant
doc:
<comment>Description:</comment>
  The left <return>bstr</return> is greater than right  <return>bstr</return>.


id: VARCMP_LT
type: constant
doc:
<comment>Description:</comment>
  The left <return>bstr</return> is less than right  <return>bstr</return>.


id: VAR_REPRESENTATION_SINGLE_LINE
type: constant
doc:
<comment>Description:</comment>
  <strong>var_representation()</strong> flag indicating that newlines  should not be used for whitespace in variable
  representations.


id: VAR_REPRESENTATION_UNESCAPED
type: constant
doc:
<comment>Description:</comment>
  <strong>var_representation()</strong> flag indicating that strings should be encoded as single quoted strings with
  unescaped control characters.


id: VT_ARRAY
type: constant
doc:
<comment>Description:</comment>
  If the type indicator is combined with  <info>VT_ARRAY</info> by an OR operator, the value is a pointer to a
  <return>SAFEARRAY</return>. <info>VT_ARRAY</info>  can use the OR with the following data types: <info>VT_I1</info>,  <info>VT_UI1</info>, <info>VT_I2</info>, <info>VT_UI2</info>,
  <info>VT_I4</info>, <info>VT_UI4</info>, <info>VT_INT</info>,  <info>VT_UINT</info>, <info>VT_R4</info>, <info>VT_R8</info>,  <info>VT_BOOL</info>, <info>VT_DECIMAL</info>, <info>VT_ERROR</info>,  <info>VT_CY</info>, <info>VT_DATE</info>,
  <info>VT_BSTR</info>,  <info>VT_DISPATCH</info>, <info>VT_UNKNOWN</info> and  <info>VT_VARIANT</info>.


id: VT_BYREF
type: constant
doc:
<comment>Description:</comment>
  If the type indicator is combined with <info>VT_BYREF</info>  by an OR operator, the value is a reference.
  Reference types are  interpreted as a reference to data, similar to the reference type in  C++.


id: VT_DATE
type: constant
doc:
<comment>Description:</comment>
  A 64-bit floating point number representing the number of days  (not seconds) since December 31,
  1899. For example,  <return>January 1, 1900</return>, is 2.0, <return>January 2, 1900</return>,  is 3.0, and so on). This is stored
  in the same representation as  <info>VT_R8</info>.


id: VT_EMPTY
type: constant
doc:
<comment>Description:</comment>
  A property with a type indicator of <info>VT_EMPTY</info> has  no data associated with it; that is, the size of
  the value is zero.


id: VT_ERROR
type: constant
doc:
<comment>Description:</comment>
  Error code; containing the status code associated with the  error.


id: VT_I8
type: constant
doc:
<comment>Description:</comment>
  8-byte signed integer value.
  
  Available as of PHP 7.0.0 (x64 only).


id: VT_UI8
type: constant
doc:
<comment>Description:</comment>
  8-byte unsigned integer.
  
  Available as of PHP 7.0.0 (x64 only).


id: VT_VARIANT
type: constant
doc:
<comment>Description:</comment>
  A type indicator followed by the corresponding value.  <info>VT_VARIANT</info> can be used only with  <info>VT_BYREF</info>.


id: VarnishAdmin::__construct
type: function
doc:
<comment>Description:</comment>
  VarnishAdmin constructor

<comment>Param:</comment>
  <info>array</info>  <strong>$args</strong>  Configuration arguments. The possible keys are:
                


id: VarnishAdmin::auth
type: function
doc:
<comment>Description:</comment>
  Authenticate on a varnish instance

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: VarnishAdmin::ban
type: function
doc:
<comment>Description:</comment>
  Ban URLs using a VCL expression

<comment>Param:</comment>
  <info>string</info>  <strong>$vcl_regex</strong>  Varnish VCL expression. It's based on the varnish ban command.

<comment>Return:</comment>
  <info>int</info>  Returns the varnish command status.


id: VarnishAdmin::banUrl
type: function
doc:
<comment>Description:</comment>
  Ban an URL using a VCL expression

<comment>Param:</comment>
  <info>string</info>  <strong>$vcl_regex</strong>  URL regular expression in PCRE compatible syntax. It's based on the ban.url
                      varnish command.

<comment>Return:</comment>
  <info>int</info>  Returns the varnish command status.


id: VarnishAdmin::clearPanic
type: function
doc:
<comment>Description:</comment>
  Clear varnish instance panic messages

<comment>Return:</comment>
  <info>int</info>  Returns the varnish command status.


id: VarnishAdmin::connect
type: function
doc:
<comment>Description:</comment>
  Connect to a varnish instance administration interface

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: VarnishAdmin::disconnect
type: function
doc:
<comment>Description:</comment>
  Disconnect from a varnish instance administration interface

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: VarnishAdmin::getPanic
type: function
doc:
<comment>Description:</comment>
  Get the last panic message on a varnish instance

<comment>Return:</comment>
  <info>string</info>  Returns the last panic message on the current varnish instance.


id: VarnishAdmin::getParams
type: function
doc:
<comment>Description:</comment>
  Fetch current varnish instance configuration parameters

<comment>Return:</comment>
  <info>array</info>  Returns an array with the varnish configuration parameters.


id: VarnishAdmin::isRunning
type: function
doc:
<comment>Description:</comment>
  Check if the varnish slave process is currently running

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: VarnishAdmin::setCompat
type: function
doc:
<comment>Description:</comment>
  Set the class compat configuration param

<comment>Param:</comment>
  <info>int</info>  <strong>$compat</strong>  Varnish compatibility option.

<comment>Return:</comment>
  <info>void</info>  


id: VarnishAdmin::setHost
type: function
doc:
<comment>Description:</comment>
  Set the class host configuration param

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>  Connection host configuration parameter.

<comment>Return:</comment>
  <info>void</info>  


id: VarnishAdmin::setIdent
type: function
doc:
<comment>Description:</comment>
  Set the class ident configuration param

<comment>Param:</comment>
  <info>string</info>  <strong>$ident</strong>  Connection ident configuration parameter.

<comment>Return:</comment>
  <info>void</info>  


id: VarnishAdmin::setParam
type: function
doc:
<comment>Description:</comment>
  Set configuration param on the current varnish instance

<comment>Param:</comment>
  <info>string</info>      <strong>$name</strong>   Varnish configuration param name.
  <info>string|int</info>  <strong>$value</strong>  Varnish configuration param value.

<comment>Return:</comment>
  <info>int</info>  Returns the varnish command status.


id: VarnishAdmin::setPort
type: function
doc:
<comment>Description:</comment>
  Set the class port configuration param

<comment>Param:</comment>
  <info>int</info>  <strong>$port</strong>  Connection port configuration parameter.

<comment>Return:</comment>
  <info>void</info>  


id: VarnishAdmin::setSecret
type: function
doc:
<comment>Description:</comment>
  Set the class secret configuration param

<comment>Param:</comment>
  <info>string</info>  <strong>$secret</strong>  Connection secret configuration parameter.

<comment>Return:</comment>
  <info>void</info>  


id: VarnishAdmin::setTimeout
type: function
doc:
<comment>Description:</comment>
  Set the class timeout configuration param

<comment>Param:</comment>
  <info>int</info>  <strong>$timeout</strong>  Connection timeout configuration parameter.

<comment>Return:</comment>
  <info>void</info>  


id: VarnishAdmin::start
type: function
doc:
<comment>Description:</comment>
  Start varnish worker process

<comment>Return:</comment>
  <info>int</info>  Returns the varnish command status.


id: VarnishAdmin::stop
type: function
doc:
<comment>Description:</comment>
  Stop varnish worker process

<comment>Return:</comment>
  <info>int</info>  Returns the varnish command status.


id: VarnishLog::__construct
type: function
doc:
<comment>Description:</comment>
  Varnishlog constructor

<comment>Param:</comment>
  <info>array</info>  <strong>$args</strong>  Configuration arguments. The possible keys are:
                


id: VarnishLog::getLine
type: function
doc:
<comment>Description:</comment>
  Get next log line

<comment>Return:</comment>
  <info>array</info>  Returns an array with the log line data.


id: VarnishLog::getTagName
type: function
doc:
<comment>Description:</comment>
  Get the log tag string representation by its index

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Log tag index.

<comment>Return:</comment>
  <info>string</info>  Returns the log tag name as <info>string</info>.


id: VarnishStat::__construct
type: function
doc:
<comment>Description:</comment>
  VarnishStat constructor

<comment>Param:</comment>
  <info>array</info>  <strong>$args</strong>  Configuration arguments. The possible keys are:
                


id: VarnishStat::getSnapshot
type: function
doc:
<comment>Description:</comment>
  Get the current varnish instance statistics snapshot

<comment>Return:</comment>
  <info>array</info>  Array with the varnish statistic snapshot. The array keys are identical to that in the
         varnishstat tool.


id: Volatile
type: class
doc:
<comment>Description:</comment>
  The <class>Volatile</class> class is new to pthreads v3. Its introduction is a consequence of the new
  immutability semantics of <class>Threaded</class> members of <class>Threaded</class> classes. The <class>Volatile</class> class enables for
  mutability of its <class>Threaded</class> members, and is also used to store PHP arrays in <class>Threaded</class> contexts.


id: Vtiful\Kernel\Excel::__construct
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel constructor
  
  <class>Vtiful\Kernel\Excel</class> constructor, create a class object.

<comment>Param:</comment>
  <info>array</info>  <strong>$config</strong>  XLSX file export configuration


id: Vtiful\Kernel\Excel::addSheet
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel addSheet
  
  Create a new worksheet in the xlsx file.

<comment>Param:</comment>
  <info>string</info>  <strong>$sheetName</strong>  Worksheet name

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::autoFilter
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel autoFilter
  
  Add autofilter to a worksheet.

<comment>Param:</comment>
  <info>string</info>  <strong>$scope</strong>  Cell start and end coordinate string.

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::constMemory
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel constMemory
  
  Write a large file with constant memory usage.

<comment>Param:</comment>
  <info>string</info>  <strong>$fileName</strong>   XLSX file name
  <info>string</info>  <strong>$sheetName</strong>  Worksheet name

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::data
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel data
  
  Write a data in the worksheet.

<comment>Param:</comment>
  <info>array</info>  <strong>$data</strong>  worksheet data

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::fileName
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel fileName
  
  Create a brand new xlsx file and create a worksheet.

<comment>Param:</comment>
  <info>string</info>  <strong>$fileName</strong>   XLSX file name
  <info>string</info>  <strong>$sheetName</strong>  Worksheet name

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::getHandle
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel getHandle
  
  Get the xlsx text resource handle.

<comment>Return:</comment>
  <info>unknown</info>  Resource


id: Vtiful\Kernel\Excel::header
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel header
  
  Write a header in the worksheet.

<comment>Param:</comment>
  <info>array</info>  <strong>$headerData</strong>  worksheet header data

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::insertFormula
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel insertFormula
  
  Insert calculation formula.

<comment>Param:</comment>
  <info>int</info>     <strong>$row</strong>      cell row
  <info>int</info>     <strong>$column</strong>   cell column
  <info>string</info>  <strong>$formula</strong>  formula string

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::insertImage
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel insertImage
  
  Insert a local image into the cell.

<comment>Param:</comment>
  <info>int</info>     <strong>$row</strong>             cell row
  <info>int</info>     <strong>$column</strong>          cell column
  <info>string</info>  <strong>$localImagePath</strong>  local image path

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::insertText
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel insertText
  
  Write text in a cell.

<comment>Param:</comment>
  <info>int</info>               <strong>$row</strong>     cell row
  <info>int</info>               <strong>$column</strong>  cell column
  <info>int|float|string</info>  <strong>$data</strong>    data to be written
  <info>string</info>            <strong>$format</strong>  String format

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::mergeCells
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel mergeCells
  
  Merge Cells.

<comment>Param:</comment>
  <info>string</info>  <strong>$scope</strong>  cell start and end coordinate strings
  <info>string</info>  <strong>$data</strong>   string data

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::output
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel output
  
  Output xlsx file to disk.

<comment>Return:</comment>
  <info>unknown</info>  XLSX file path;


id: Vtiful\Kernel\Excel::setColumn
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel setColumn
  
  Set the format of the column.

<comment>Param:</comment>
  <info>string</info>    <strong>$range</strong>   cell start and end coordinate strings
  <info>float</info>     <strong>$width</strong>   column width
  <info>resource</info>  <strong>$format</strong>  cell format resource

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::setRow
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel setRow
  
  Set the format of the column.

<comment>Param:</comment>
  <info>string</info>    <strong>$range</strong>   cell start and end coordinate strings
  <info>float</info>     <strong>$height</strong>  row height
  <info>resource</info>  <strong>$format</strong>  cell format resource

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Format::align
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Format align
  
  set cell align

<comment>Param:</comment>
  <info>resource</info>  <strong>$handle</strong>  xlsx file handle
  <info>int</info>       <strong>$style</strong>   <class>Vtiful\Kernel\Format</class> constant

<comment>Return:</comment>
  <info>unknown</info>  Resource


id: Vtiful\Kernel\Format::bold
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Format bold
  
  <class>Vtiful\Kernel\Format</class> bold format

<comment>Param:</comment>
  <info>resource</info>  <strong>$handle</strong>  xlsx file handle

<comment>Return:</comment>
  <info>unknown</info>  Resource


id: Vtiful\Kernel\Format::italic
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Format italic
  
  <class>Vtiful\Kernel\Format</class> italic format

<comment>Param:</comment>
  <info>resource</info>  <strong>$handle</strong>  xlsx file handle

<comment>Return:</comment>
  <info>unknown</info>  Resource


id: Vtiful\Kernel\Format::underline
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Format underline
  
  <class>Vtiful\Kernel\Format</class> underline format

<comment>Param:</comment>
  <info>resource</info>  <strong>$handle</strong>  xlsx file handle
  <info>int</info>       <strong>$style</strong>   <class>Vtiful\Kernel\Format</class> constant

<comment>Return:</comment>
  <info>unknown</info>  Resource


id: WIN32_ABOVE_NORMAL_PRIORITY_CLASS
type: constant
doc:
<comment>Description:</comment>
  Process that has priority above WIN32_NORMAL_PRIORITY_CLASS but below WIN32_HIGH_PRIORITY_CLASS.


id: WIN32_BELOW_NORMAL_PRIORITY_CLASS
type: constant
doc:
<comment>Description:</comment>
  Process that has priority above WIN32_IDLE_PRIORITY_CLASS but below WIN32_NORMAL_PRIORITY_CLASS.


id: WIN32_ERROR_ACCESS_DENIED
type: constant
doc:
<comment>Description:</comment>
  The handle to the SCM database does not have the appropriate access rights.


id: WIN32_ERROR_DEPENDENT_SERVICES_RUNNING
type: constant
doc:
<comment>Description:</comment>
  0x0000041B
  
  The service cannot be stopped because other running services are dependent on it.


id: WIN32_ERROR_DUPLICATE_SERVICE_NAME
type: constant
doc:
<comment>Description:</comment>
  The display name already exists in the service control manager database either as a service name
  or as another display name.


id: WIN32_ERROR_FAILED_SERVICE_CONTROLLER_CONNECT
type: constant
doc:
<comment>Description:</comment>
  This error is returned if the program is being run as a console application rather than as a
  service. If the program will be run as a console application for debugging purposes, structure it
  such that service-specific code is not called.


id: WIN32_ERROR_INSUFFICIENT_BUFFER
type: constant
doc:
<comment>Description:</comment>
  0x0000007A
  
  The buffer is too small for the service status structure. Nothing was written to the structure.


id: WIN32_ERROR_INVALID_DATA
type: constant
doc:
<comment>Description:</comment>
  0x0000000D
  
  The specified service status structure is invalid.


id: WIN32_ERROR_INVALID_HANDLE
type: constant
doc:
<comment>Description:</comment>
  The handle to the specified service control manager database is invalid.


id: WIN32_ERROR_INVALID_LEVEL
type: constant
doc:
<comment>Description:</comment>
  0x0000007C
  
  The InfoLevel parameter contains an unsupported value.


id: WIN32_ERROR_INVALID_SERVICE_ACCOUNT
type: constant
doc:
<comment>Description:</comment>
  The user account name specified in the <strong>$user</strong> parameter does not exist. See <strong>win32_create_service()</strong>.


id: WIN32_ERROR_INVALID_SERVICE_CONTROL
type: constant
doc:
<comment>Description:</comment>
  0x0000041C
  
  The requested control code is not valid, or it is unacceptable to the service.


id: WIN32_ERROR_SERVICE_CANNOT_ACCEPT_CTRL
type: constant
doc:
<comment>Description:</comment>
  The requested control code cannot be sent to the service because the state of the service is
  <info>WIN32_SERVICE_STOPPED</info>, <info>WIN32_SERVICE_START_PENDING</info>, or <info>WIN32_SERVICE_STOP_PENDING</info>.


id: WIN32_ERROR_SERVICE_DEPENDENCY_DELETED
type: constant
doc:
<comment>Description:</comment>
  The service depends on a service that does not exist or has been marked for deletion.


id: WIN32_ERROR_SERVICE_DEPENDENCY_FAIL
type: constant
doc:
<comment>Description:</comment>
  0x0000042C
  
  The service depends on another service that has failed to start.


id: WIN32_ERROR_SERVICE_LOGON_FAILED
type: constant
doc:
<comment>Description:</comment>
  0x0000042D
  
  The service did not start due to a logon failure. This error occurs if the service is configured
  to run under an account that does not have the "Log on as a service" right.


id: WIN32_ERROR_SERVICE_REQUEST_TIMEOUT
type: constant
doc:
<comment>Description:</comment>
  0x0000041D
  
  The process for the service was started, but it did not call StartServiceCtrlDispatcher, or the
  thread that called StartServiceCtrlDispatcher may be blocked in a control handler function.


id: WIN32_ERROR_SERVICE_SPECIFIC_ERROR
type: constant
doc:
<comment>Description:</comment>
  0x0000042A
  
  The service has returned a service-specific error code.


id: WIN32_ERROR_SHUTDOWN_IN_PROGRESS
type: constant
doc:
<comment>Description:</comment>
  0x0000045B
  
  The system is shutting down; this function cannot be called.


id: WIN32_HIGH_PRIORITY_CLASS
type: constant
doc:
<comment>Description:</comment>
  Process that performs time-critical tasks that must be executed immediately. The threads of the
  process preempt the threads of normal or idle priority class processes. An example is the Task
  List, which must respond quickly when called by the user, regardless of the load on the operating
  system. Use extreme care when using the high-priority class, because a high-priority class
  application can use nearly all available CPU time.


id: WIN32_IDLE_PRIORITY_CLASS
type: constant
doc:
<comment>Description:</comment>
  Process whose threads run only when the system is idle. The threads of the process are preempted
  by the threads of any process running in a higher priority class. An example is a screen saver.
  The idle-priority class is inherited by child processes.


id: WIN32_REALTIME_PRIORITY_CLASS
type: constant
doc:
<comment>Description:</comment>
  Process that has the highest possible priority. The threads of the process preempt the threads of
  all other processes, including operating system processes performing important tasks. For example,
  a real-time process that executes for more than a very brief interval can cause disk caches not to
  flush or cause the mouse to be unresponsive.


id: WIN32_SERVICE_ACCEPT_HARDWAREPROFILECHANGE
type: constant
doc:
<comment>Description:</comment>
  The service is notified when the computer's hardware profile has changed. This enables the system
  to send  <info>WIN32_SERVICE_CONTROL_HARDWAREPROFILECHANGE</info>  notifications to the service.


id: WIN32_SERVICE_ACCEPT_NETBINDCHANGE
type: constant
doc:
<comment>Description:</comment>
  The service is a network component that can accept changes in its  binding without being stopped
  and restarted. This control code allows the service to receive  <info>WIN32_SERVICE_CONTROL_NETBINDADD</info>,
  <info>WIN32_SERVICE_CONTROL_NETBINDREMOVE</info>,  <info>WIN32_SERVICE_CONTROL_NETBINDENABLE</info>, and
  <info>WIN32_SERVICE_CONTROL_NETBINDDISABLE</info> notifications.


id: WIN32_SERVICE_ACCEPT_PARAMCHANGE
type: constant
doc:
<comment>Description:</comment>
  The service can reread its startup parameters without being stopped and restarted. This control
  code allows the service to receive  <info>WIN32_SERVICE_CONTROL_PARAMCHANGE</info> notifications.


id: WIN32_SERVICE_ACCEPT_PAUSE_CONTINUE
type: constant
doc:
<comment>Description:</comment>
  The service can be paused and continued. This control code allows the service to receive
  <info>WIN32_SERVICE_CONTROL_PAUSE</info> and <info>WIN32_SERVICE_CONTROL_CONTINUE</info> notifications.


id: WIN32_SERVICE_ACCEPT_POWEREVENT
type: constant
doc:
<comment>Description:</comment>
  The service is notified when the computer's power status has changed. This enables the system to
  send  <info>WIN32_SERVICE_CONTROL_POWEREVENT</info> notifications  to the service.


id: WIN32_SERVICE_ACCEPT_PRESHUTDOWN
type: constant
doc:
<comment>Description:</comment>
  The service can perform preshutdown tasks. This control code enables the service to receive
  <info>WIN32_SERVICE_CONTROL_PRESHUTDOWN</info> notifications. This value is not supported by Windows Server
  2003 and Windows XP/2000.


id: WIN32_SERVICE_ACCEPT_SESSIONCHANGE
type: constant
doc:
<comment>Description:</comment>
  The service is notified when the computer's session status has changed. This enables the system to
  send  <info>WIN32_SERVICE_CONTROL_SESSIONCHANGE</info> notifications  to the service. Windows 2000:  This value
  is not supported


id: WIN32_SERVICE_ACCEPT_SHUTDOWN
type: constant
doc:
<comment>Description:</comment>
  The service is notified when system shutdown occurs. This control code allows the service to
  receive <info>WIN32_SERVICE_CONTROL_SHUTDOWN</info> notifications.


id: WIN32_SERVICE_ACCEPT_STOP
type: constant
doc:
<comment>Description:</comment>
  The service can be stopped. This control code allows the service to receive
  <info>WIN32_SERVICE_CONTROL_STOP</info> notifications.


id: WIN32_SERVICE_ACCEPT_TIMECHANGE
type: constant
doc:
<comment>Description:</comment>
  The service is notified when the system time has changed. This enables the system to send
  <info>WIN32_SERVICE_CONTROL_TIMECHANGE</info> notifications to the service. Windows Server 2008, Windows Vista,
  Windows Server 2003,  and Windows XP/2000:  This control code is not supported.


id: WIN32_SERVICE_ACCEPT_TRIGGEREVENT
type: constant
doc:
<comment>Description:</comment>
  The service is notified when an event for which the service has registered occurs. This enables
  the system to send  <info>WIN32_SERVICE_CONTROL_TRIGGEREVENT</info> notifications to the service. Windows
  Server 2008, Windows Vista, Windows Server 2003,  and Windows XP/2000:  This control code is not
  supported.


id: WIN32_SERVICE_AUTO_START
type: constant
doc:
<comment>Description:</comment>
  A service started automatically by the service control manager during system startup.


id: WIN32_SERVICE_BOOT_START
type: constant
doc:
<comment>Description:</comment>
  A device driver started by the system loader. This value is valid only for driver services.


id: WIN32_SERVICE_CONTROL_INTERROGATE
type: constant
doc:
<comment>Description:</comment>
  Notifies a service that it should report its current status information to the service control
  manager.


id: WIN32_SERVICE_CONTROL_NETBINDADD
type: constant
doc:
<comment>Description:</comment>
  Notifies a network service that there is a new component for binding.


id: WIN32_SERVICE_CONTROL_NETBINDDISABLE
type: constant
doc:
<comment>Description:</comment>
  0x0000000A
  
  Notifies a network service that one of its bindings has been disabled.


id: WIN32_SERVICE_CONTROL_NETBINDENABLE
type: constant
doc:
<comment>Description:</comment>
  Notifies a network service that a disabled binding has been enabled.


id: WIN32_SERVICE_CONTROL_NETBINDREMOVE
type: constant
doc:
<comment>Description:</comment>
  Notifies a network service that a component for binding has been removed.


id: WIN32_SERVICE_CONTROL_PRESHUTDOWN
type: constant
doc:
<comment>Description:</comment>
  0x0000000F
  
  Notifies a service that the system will be shutting down. A service that handles this notification
  blocks system shutdown until the service stops or the preshutdown time-out interval expires. This
  value is not supported by Windows Server 2003 and Windows XP/2000.


id: WIN32_SERVICE_CONTROL_SHUTDOWN
type: constant
doc:
<comment>Description:</comment>
  Notifies a service that the system is shutting down so the service can perform cleanup tasks. If a
  service accepts this control code, it must stop after it performs its cleanup tasks. After the SCM
  sends this control code, it will not send other control codes to the service.


id: WIN32_SERVICE_DEMAND_START
type: constant
doc:
<comment>Description:</comment>
  A service started by the service control manager when a process calls the StartService function.


id: WIN32_SERVICE_DISABLED
type: constant
doc:
<comment>Description:</comment>
  A service that cannot be started. Attempts to start the service result in the error code
  <info>WIN32_ERROR_SERVICE_DISABLED</info>.


id: WIN32_SERVICE_ERROR_CRITICAL
type: constant
doc:
<comment>Description:</comment>
  The startup program logs the error in the event log, if possible. If the last-known-good
  configuration is being started, the startup  operation fails. Otherwise, the system is restarted
  with the  last-known good configuration.


id: WIN32_SERVICE_ERROR_IGNORE
type: constant
doc:
<comment>Description:</comment>
  The startup program ignores the error and continues the startup operation.


id: WIN32_SERVICE_ERROR_NORMAL
type: constant
doc:
<comment>Description:</comment>
  The startup program logs the error in the event log but continues the startup operation.


id: WIN32_SERVICE_ERROR_SEVERE
type: constant
doc:
<comment>Description:</comment>
  The startup program logs the error in the event log. If the last-known-good configuration is being
  started, the startup  operation continues. Otherwise, the system is restarted with the
  last-known-good configuration.


id: WIN32_SERVICE_INTERACTIVE_PROCESS
type: constant
doc:
<comment>Description:</comment>
  The service can interact with the desktop. This option is not available on Windows Vista or later.


id: WIN32_SERVICE_RUNS_IN_SYSTEM_PROCESS
type: constant
doc:
<comment>Description:</comment>
  The service runs in a system process that must always be running.


id: WIN32_SERVICE_SYSTEM_START
type: constant
doc:
<comment>Description:</comment>
  A device driver started by the IoInitSystem function. This value is valid only for driver
  services.


id: WIN32_SERVICE_WIN32_OWN_PROCESS_INTERACTIVE
type: constant
doc:
<comment>Description:</comment>
  The service runs in its own process and can interact with the desktop. This option is not
  available on Windows Vista or later.


id: WSDL_CACHE_BOTH
type: constant
doc:
<comment>Description:</comment>
  Specifies use of both on-disk and in-memory WSDL caches when used in the soap.wsdl_cache
  configuration option or the <return>wsdl_cache</return> option to SoapClient::__construct and
  SoapServer::__construct.


id: WSDL_CACHE_DISK
type: constant
doc:
<comment>Description:</comment>
  Specifies use of the on-disk WSDL cache only when used in the soap.wsdl_cache configuration option
  or the <return>wsdl_cache</return> option to SoapClient::__construct and SoapServer::__construct.


id: WSDL_CACHE_MEMORY
type: constant
doc:
<comment>Description:</comment>
  Specifies use of the in-memory WSDL cache only when used in the soap.wsdl_cache configuration
  option or the <return>wsdl_cache</return> option to SoapClient::__construct and SoapServer::__construct.


id: WSDL_CACHE_NONE
type: constant
doc:
<comment>Description:</comment>
  Disables the WSDL cache when used in the soap.wsdl_cache configuration option or the <return>wsdl_cache</return>
  option to SoapClient::__construct and SoapServer::__construct.


id: Warning::__construct
type: function
doc:
<comment>Description:</comment>
  Warning constructor
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.


id: WeakMap
type: class
doc:
<comment>Description:</comment>
  Um <class>WeakMap</class> é um mapa (ou dicionário) que aceita objetos como chaves. Entretanto, diferentemente do
  objeto similar <class>SplObjectStorage</class>, um objeto em uma chave de um <class>WeakMap</class> não contribui com a contagem
  de referência do objeto. Isto é, se em algum ponto a única referência restante a um objeto é a
  chave de um <class>WeakMap</class>, o objeto sofrerá uma coleta de lixo e será removido do <class>WeakMap</class>. Seu caso de
  uso primário é construir caches de dados derivados de um objeto que não precisam durar mais que o
  objeto.
  
  <class>WeakMap</class> implementa ArrayAccess, Iterator e Countable, por isso na maioria dos casos pode ser usado
  da mesma forma que um array associativo.


id: WeakMap::count
type: function
doc:
<comment>Description:</comment>
  Conta o número de entradas ativas no mapa
  
  Conta o número de entradas ativas no mapa.

<comment>Return:</comment>
  <info>int</info>  Retorna o número de entradas ativas no mapa.


id: WeakMap::getIterator
type: function
doc:
<comment>Description:</comment>
  Obtém um iderador externo
  
  Retorna um iterador externo.

<comment>Return:</comment>
  <info>Iterator</info>  Uma instância de um objeto que implementa a classe <class>Iterator</class> ou <class>Traversable</class>


id: WeakMap::offsetExists
type: function
doc:
<comment>Description:</comment>
  Verifica se um certo objeto está no mapa
  
  Verifica se o objeto informado está referenciado no mapa.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  Objeto a ser verificado.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> se o objeto estiver contido no mapa, <info>false</info> caso contrário.


id: WeakMap::offsetGet
type: function
doc:
<comment>Description:</comment>
  Retorna o valor apontado por um certo objeto
  
  Retorna o valor apontado por um certo objeto.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  Algum objeto contido como chave em um mapa.

<comment>Return:</comment>
  <info>mixed</info>  Retorna o valor associado ao objeto passado como argumento, <info>null</info> caso contrário.


id: WeakMap::offsetSet
type: function
doc:
<comment>Description:</comment>
  Atualiza o mapa com um novo par chave-valor
  
  Atualiza o mapa com um novo par chave-valor. Se a chave já existia no mapa, o valor antigo é
  substituído pelo novo.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  O objeto que serve como chava no par chave-valor.
  <info>mixed</info>   <strong>$value</strong>   O dado arbitrário que serve como valor no par chave-valor..

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.


id: WeakMap::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Remove uma entrada do mapa
  
  Remove uma entrada do mapa.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  O objeto chave a ser removido do mapa.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.


id: WeakReference
type: class
doc:
<comment>Description:</comment>
  Referências fracas permitem que o programador mantenha uma referência a um objeto que não impede
  que o objeto seja destruído. Eles são úteis para implementar estruturas como cache.
  
  <class>WeakReference</class>s não podem ser serializadas.


id: WeakReference::__construct
type: function
doc:
<comment>Description:</comment>
  Construtor que desabilita a instanciação
  
  Este método existe apenas para desabilitar a instanciação da classe <class>WeakReference</class>. Referências
  fracas devem ser instanciadas com o método factory WeakReference::create.

<comment>See Also:</comment>
   * WeakReference::create


id: WeakReference::create
type: function
doc:
<comment>Description:</comment>
  Cria uma nova referência fraca
  
  Cria uma nova <class>WeakReference</class>.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  O objeto a ser fracamente referenciado.

<comment>Return:</comment>
  <info>WeakReference</info>  Retorna o objeto instanciado recentemente.


id: WeakReference::get
type: function
doc:
<comment>Description:</comment>
  Obtém um objeto fracamente referenciado
  
  Obtém um objeto fracamente referenciado. Se o objeto já tiver sido destruído, <info>null</info> é retornado.

<comment>Return:</comment>
  <info>object|null</info>  Retorna o <info>object</info> referenciado ou <info>null</info> se o objeto tiver sido destruído.


id: Worker
type: class
doc:
<comment>Description:</comment>
  Worker Threads have a persistent context, as such should be used over Threads in most cases.
  
  When a Worker is started, the run method will be executed, but the Thread will not leave until one
  of the following conditions are met:
  
  the Worker goes out of scope (no more references remain)
  
  the programmer calls shutdown
  
  the script dies
  
  This means the programmer can reuse the context throughout execution; placing objects on the stack
  of the Worker will cause the Worker to execute the stacked objects run method.


id: Worker::collect
type: function
doc:
<comment>Description:</comment>
  Collect references to completed tasks
  
  Allows the worker to collect references determined to be garbage by the optionally given
  collector.

<comment>Param:</comment>
  <info>Callable</info>  <strong>$collector</strong>  A Callable collector that returns a boolean on whether the task can be
                        collected or not. Only in rare cases should a custom collector need to be
                        used.

<comment>Return:</comment>
  <info>int</info>  The number of remaining tasks on the worker's stack to be collected.


id: Worker::getStacked
type: function
doc:
<comment>Description:</comment>
  Gets the remaining stack size
  
  Returns the number of tasks left on the stack

<comment>Return:</comment>
  <info>int</info>  Returns the number of tasks currently waiting to be executed by the worker


id: Worker::isShutdown
type: function
doc:
<comment>Description:</comment>
  State Detection
  
  Whether the worker has been shutdown or not.

<comment>Return:</comment>
  <info>bool</info>  Returns whether the worker has been shutdown or not.


id: Worker::shutdown
type: function
doc:
<comment>Description:</comment>
  Shutdown the worker
  
  Shuts down the worker after executing all of the stacked tasks.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: Worker::stack
type: function
doc:
<comment>Description:</comment>
  Stacking work
  
  Appends the new work to the stack of the referenced worker.

<comment>Param:</comment>
  <info>Threaded</info>  <strong>$work</strong>  A <class>Threaded</class> object to be executed by the worker.

<comment>Return:</comment>
  <info>int</info>  The new size of the stack.


id: Worker::unstack
type: function
doc:
<comment>Description:</comment>
  Unstacking work
  
  Removes the first task (the oldest one) in the stack.

<comment>Return:</comment>
  <info>int</info>  The new size of the stack.


id: XATTR_ROOT
type: constant
doc:
<comment>Description:</comment>
  Edita atributo no namespace do administrador. Requer privilégios de root.


id: XDIFF_PATCH_NORMAL
type: constant
doc:
<comment>Description:</comment>
  This flag indicates that <strong>xdiff_string_patch()</strong> and <strong>xdiff_file_patch()</strong> functions should create
  result by applying patch to original content thus creating newer version of file. This is the
  default mode of operation.


id: XDIFF_PATCH_REVERSE
type: constant
doc:
<comment>Description:</comment>
  This flag indicated that <strong>xdiff_string_patch()</strong> and <strong>xdiff_file_patch()</strong> functions should create
  result by reversing patch changed from newer content thus creating original version.


id: XMLDiff\Base
type: class
doc:
<comment>Description:</comment>
  Base abstract class for all the comparsion classes in the extension.


id: XMLDiff\Base::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor
  
  Base constructor for all the worker classes in the xmldiff extension.

<comment>Param:</comment>
  <info>string</info>  <strong>$nsname</strong>  Custom namespace name for the diff document. The default namespace is
                   http://www.locus.cz/diffmark and that's enough to avoid namespace conflicts. Use
                   this parameter if you want to change it for some reason.


id: XMLDiff\Base::diff
type: function
doc:
<comment>Description:</comment>
  Produce diff of two XML documents
  
  Abstract diff method to be implemented by inheriting classes.
  
  The basic purpose of this method is to produce diff of the two documents. The param order matters
  and will produce different output.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$from</strong>  Source XML document.
  <info>mixed</info>  <strong>$to</strong>    Target XML document.

<comment>Return:</comment>
  <info>mixed</info>  Implementation dependent.


id: XMLDiff\Base::merge
type: function
doc:
<comment>Description:</comment>
  Produce new XML document based on diff
  
  Abstract merge method to be implemented by inheriting classes.
  
  Basically the method purpose is to produce a new XML document based on the diff information.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$src</strong>   Source XML document.
  <info>mixed</info>  <strong>$diff</strong>  Document produced by the diff method.

<comment>Return:</comment>
  <info>mixed</info>  Implementation dependent.


id: XMLDiff\DOM::diff
type: function
doc:
<comment>Description:</comment>
  Diff two DOMDocument objects
  
  Diff two DOMDocument instances and produce the new one containing the diff information.

<comment>Param:</comment>
  <info>DOMDocument</info>  <strong>$from</strong>  Source DOMDocument object.
  <info>DOMDocument</info>  <strong>$to</strong>    Target DOMDocument object.

<comment>Return:</comment>
  <info>DOMDocument</info>  DOMDocument with the diff information or NULL.


id: XMLDiff\DOM::merge
type: function
doc:
<comment>Description:</comment>
  Produce merged DOMDocument
  
  Create new DOMDocument based on the diff.

<comment>Param:</comment>
  <info>DOMDocument</info>  <strong>$src</strong>   Source DOMDocument object.
  <info>DOMDocument</info>  <strong>$diff</strong>  DOMDocument object containing the diff information.

<comment>Return:</comment>
  <info>DOMDocument</info>  Merged DOMDocument or NULL.


id: XMLDiff\File::diff
type: function
doc:
<comment>Description:</comment>
  Diff two XML files
  
  Diff two local XML files and produce string with the diff information.

<comment>Param:</comment>
  <info>string</info>  <strong>$from</strong>  Path to the source document.
  <info>string</info>  <strong>$to</strong>    Path to the target document.

<comment>Return:</comment>
  <info>string</info>  String with the XML document containing the diff information or NULL.


id: XMLDiff\File::merge
type: function
doc:
<comment>Description:</comment>
  Produce merged XML document
  
  Create new XML document based on diffs and source document.

<comment>Param:</comment>
  <info>string</info>  <strong>$src</strong>   Path to the source XML document.
  <info>string</info>  <strong>$diff</strong>  Path to the XML document with the diff information.

<comment>Return:</comment>
  <info>string</info>  String with the new XML document or NULL.


id: XMLDiff\Memory::diff
type: function
doc:
<comment>Description:</comment>
  Diff two XML documents
  
  Diff two strings containing XML documents and produce the diff information.

<comment>Param:</comment>
  <info>string</info>  <strong>$from</strong>  Source XML document.
  <info>string</info>  <strong>$to</strong>    Target XML document.

<comment>Return:</comment>
  <info>string</info>  String with the XML document containing the diff information or NULL.


id: XMLDiff\Memory::merge
type: function
doc:
<comment>Description:</comment>
  Produce merged XML document
  
  Create new XML document based on diffs and source document.

<comment>Param:</comment>
  <info>string</info>  <strong>$src</strong>   Source XML document.
  <info>string</info>  <strong>$diff</strong>  XML document containing diff information.

<comment>Return:</comment>
  <info>string</info>  String with the new XML document or NULL.


id: XMLParser
type: class
doc:
<comment>Description:</comment>
  A fully opaque class which replaces <return>xml</return> resources as of PHP 8.0.0.


id: XMLReader
type: class
doc:
<comment>Description:</comment>
  The XMLReader extension is an XML Pull parser. The reader acts as a  cursor going forward on the
  document stream and stopping at each node  on the way.


id: XMLReader::XML
type: function
doc:
<comment>Description:</comment>
  Set the data containing the XML to parse
  
  Set the data containing the XML to parse.

<comment>Param:</comment>
  <info>string</info>       <strong>$source</strong>    String containing the XML to be parsed.
  <info>string|null</info>  <strong>$encoding</strong>  The document encoding or <info>null</info>.
  <info>int</info>          <strong>$flags</strong>     A bitmask of the LIBXML_*  constants.

<comment>Return:</comment>
  <info>bool|XMLReader</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha. If called statically,
                  returns an <class>XMLReader</class> ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLReader::open
   * XMLReader::close


id: XMLReader::close
type: function
doc:
<comment>Description:</comment>
  Close the XMLReader input
  
  Closes the input the XMLReader object is currently parsing.

<comment>Return:</comment>
  <info>true</info>  Sempre retorna <info>true</info>.

<comment>See Also:</comment>
   * XMLReader::open
   * XMLReader::xml


id: XMLReader::expand
type: function
doc:
<comment>Description:</comment>
  Returns a copy of the current node as a DOM object
  
  This method copies the current node and returns the appropriate DOM object.

<comment>Param:</comment>
  <info>DOMNode|null</info>  <strong>$baseNode</strong>  A <class>DOMNode</class> defining the target <class>DOMDocument</class> for the created DOM object.

<comment>Return:</comment>
  <info>DOMNode|false</info>  The resulting <class>DOMNode</class> or <info>false</info> on error.


id: XMLReader::getAttribute
type: function
doc:
<comment>Description:</comment>
  Get the value of a named attribute
  
  Returns the value of a named attribute or <info>null</info> if the attribute does not exist or not positioned
  on an element node.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name of the attribute.

<comment>Return:</comment>
  <info>string|null</info>  The value of the attribute, or <info>null</info> if no attribute with the given <strong>$name</strong> is found or
               not positioned on an element node.

<comment>See Also:</comment>
   * XMLReader::getAttributeNo
   * XMLReader::getAttributeNs


id: XMLReader::getAttributeNo
type: function
doc:
<comment>Description:</comment>
  Get the value of an attribute by index
  
  Returns the value of an attribute based on its position or an  empty string if attribute does not
  exist or not positioned on  an element node.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The position of the attribute.

<comment>Return:</comment>
  <info>string|null</info>  The value of the attribute, or <info>null</info> if no attribute exists at <strong>$index</strong> or is not
               positioned on the element.

<comment>See Also:</comment>
   * XMLReader::getAttribute
   * XMLReader::getAttributeNs


id: XMLReader::getAttributeNs
type: function
doc:
<comment>Description:</comment>
  Get the value of an attribute by localname and URI
  
  Returns the value of an attribute by name and namespace URI or an empty  string if attribute does
  not exist or not positioned on an element node.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>       The local name.
  <info>string</info>  <strong>$namespace</strong>  The namespace URI.

<comment>Return:</comment>
  <info>string|null</info>  The value of the attribute, or <info>null</info> if no attribute with the given <strong>$name</strong> and
               <strong>$namespace</strong> is found or not positioned of element.

<comment>See Also:</comment>
   * XMLReader::getAttribute
   * XMLReader::getAttributeNo


id: XMLReader::getParserProperty
type: function
doc:
<comment>Description:</comment>
  Indicates if specified property has been set
    
  
  Indicates if specified property has been set.

<comment>Param:</comment>
  <info>int</info>  <strong>$property</strong>  One of the parser option  constants.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLReader::setParserProperty


id: XMLReader::isValid
type: function
doc:
<comment>Description:</comment>
  Indicates if the parsed document is valid
  
  Returns a boolean indicating if the document being parsed is currently valid.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLReader::setParserProperty
   * XMLReader::setRelaxNGSchema
   * XMLReader::setRelaxNGSchemaSource
   * XMLReader::setSchema


id: XMLReader::lookupNamespace
type: function
doc:
<comment>Description:</comment>
  Lookup namespace for a prefix
  
  Lookup in scope namespace for a given prefix.

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>  String containing the prefix.

<comment>Return:</comment>
  <info>string|null</info>  The value of the namespace, or <info>null</info> if no namespace exists.


id: XMLReader::moveToAttribute
type: function
doc:
<comment>Description:</comment>
  Move cursor to a named attribute
  
  Positions cursor on the named attribute.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name of the attribute.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLReader::moveToElement
   * XMLReader::moveToAttributeNo
   * XMLReader::moveToAttributeNs
   * XMLReader::moveToFirstAttribute


id: XMLReader::moveToAttributeNo
type: function
doc:
<comment>Description:</comment>
  Move cursor to an attribute by index
  
  Positions cursor on attribute based on its position.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The position of the attribute.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLReader::moveToElement
   * XMLReader::moveToAttribute
   * XMLReader::moveToAttributeNs
   * XMLReader::moveToFirstAttribute


id: XMLReader::moveToAttributeNs
type: function
doc:
<comment>Description:</comment>
  Move cursor to a named attribute
  
  Positions cursor on the named attribute in specified namespace.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>       The local name.
  <info>string</info>  <strong>$namespace</strong>  The namespace URI.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLReader::moveToElement
   * XMLReader::moveToAttribute
   * XMLReader::moveToAttributeNo
   * XMLReader::moveToFirstAttribute


id: XMLReader::moveToElement
type: function
doc:
<comment>Description:</comment>
  Position cursor on the parent Element of current Attribute
  
  Moves cursor to the parent Element of current Attribute.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if successful and <info>false</info> if it fails or not positioned on  Attribute when this
        method is called.

<comment>See Also:</comment>
   * XMLReader::moveToAttribute
   * XMLReader::moveToAttributeNo
   * XMLReader::moveToAttributeNs
   * XMLReader::moveToFirstAttribute


id: XMLReader::moveToFirstAttribute
type: function
doc:
<comment>Description:</comment>
  Position cursor on the first Attribute
  
  Moves cursor to the first Attribute.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLReader::moveToElement
   * XMLReader::moveToAttribute
   * XMLReader::moveToAttributeNo
   * XMLReader::moveToAttributeNs
   * XMLReader::moveToNextAttribute


id: XMLReader::moveToNextAttribute
type: function
doc:
<comment>Description:</comment>
  Position cursor on the next Attribute
  
  Moves cursor to the next Attribute if positioned on an Attribute or  moves to first attribute if
  positioned on an Element.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLReader::moveToElement
   * XMLReader::moveToAttribute
   * XMLReader::moveToAttributeNo
   * XMLReader::moveToAttributeNs
   * XMLReader::moveToFirstAttribute


id: XMLReader::next
type: function
doc:
<comment>Description:</comment>
  Move cursor to next node skipping all subtrees
  
  Positions cursor on the next node skipping all subtrees. If no such node exists, the cursor is
  moved to the end of the document.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$name</strong>  The name of the next node to move to.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLReader::moveToNextAttribute
   * XMLReader::moveToElement
   * XMLReader::moveToAttribute


id: XMLReader::open
type: function
doc:
<comment>Description:</comment>
  Set the URI containing the XML to parse
  
  Set the URI containing the XML document to be parsed.

<comment>Param:</comment>
  <info>string</info>       <strong>$uri</strong>       URI pointing to the document.
  <info>string|null</info>  <strong>$encoding</strong>  The document encoding or <info>null</info>.
  <info>int</info>          <strong>$flags</strong>     A bitmask of the LIBXML_*  constants.

<comment>Return:</comment>
  <info>bool|XMLReader</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha. If called statically,
                  returns an <class>XMLReader</class> ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLReader::xml
   * XMLReader::close


id: XMLReader::read
type: function
doc:
<comment>Description:</comment>
  Move to next node in document
  
  Moves cursor to the next node in the document.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLReader::moveToElement
   * XMLReader::moveToAttribute
   * XMLReader::next


id: XMLReader::readInnerXml
type: function
doc:
<comment>Description:</comment>
  Retrieve XML from current node
  
  Reads the contents of the current node, including child nodes and markup.

<comment>Return:</comment>
  <info>string</info>  Returns the contents of the current node as a string. Empty string on failure.

<comment>See Also:</comment>
   * <strong>XMLReader::readString()</strong>
   * <strong>XMLReader::readOuterXml()</strong>
   * <strong>XMLReader::expand()</strong>


id: XMLReader::readOuterXml
type: function
doc:
<comment>Description:</comment>
  Retrieve XML from current node, including itself
  
  Reads the contents of the current node, including the node itself.

<comment>Return:</comment>
  <info>string</info>  Returns the contents of current node, including itself, as a string. Empty string on
          failure.

<comment>See Also:</comment>
   * <strong>XMLReader::readString()</strong>
   * <strong>XMLReader::readInnerXml()</strong>
   * <strong>XMLReader::expand()</strong>


id: XMLReader::readString
type: function
doc:
<comment>Description:</comment>
  Reads the contents of the current node as a string
  
  Reads the contents of the current node as a string.

<comment>Return:</comment>
  <info>string</info>  Returns the content of the current node as a string. Empty string on failure.

<comment>See Also:</comment>
   * <strong>XMLReader::readOuterXml()</strong>
   * <strong>XMLReader::readInnerXml()</strong>
   * <strong>XMLReader::expand()</strong>


id: XMLReader::setParserProperty
type: function
doc:
<comment>Description:</comment>
  Set parser options
  
  Set parser options. The options must be set after XMLReader::open or  XMLReader::xml are called
  and before  the first XMLReader::read call.

<comment>Param:</comment>
  <info>int</info>   <strong>$property</strong>  One of the parser option  constants.
  <info>bool</info>  <strong>$value</strong>     If set to <info>true</info> the option will be enabled otherwise will  be disabled.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: XMLReader::setRelaxNGSchema
type: function
doc:
<comment>Description:</comment>
  Set the filename or URI for a RelaxNG Schema
  
  Set the filename or URI for the RelaxNG Schema to use for validation.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$filename</strong>  filename or URI pointing to a RelaxNG Schema.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLReader::setRelaxNGSchemaSource
   * XMLReader::setSchema
   * XMLReader::isValid


id: XMLReader::setRelaxNGSchemaSource
type: function
doc:
<comment>Description:</comment>
  Set the data containing a RelaxNG Schema
  
  Set the data containing a RelaxNG Schema to use for validation.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$source</strong>  String containing the RelaxNG Schema.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLReader::setRelaxNGSchema
   * XMLReader::setSchema
   * XMLReader::isValid


id: XMLReader::setSchema
type: function
doc:
<comment>Description:</comment>
  Validate document against XSD
  
  Use W3C XSD schema to validate the document as it is processed. Activation is only possible before
  the first Read().

<comment>Param:</comment>
  <info>string|null</info>  <strong>$filename</strong>  The filename of the XSD schema.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLReader::setRelaxNGSchema
   * XMLReader::setRelaxNGSchemaSource
   * XMLReader::isValid


id: XMLWriter::endAttribute
type: function
doc:
<comment>Description:</comment>
  End attribute
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Ends the current attribute.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Apenas para chamadas procedurais.
                      A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é retornado de
                      uma chamada a <strong>xmlwriter_open_uri()</strong> ou <strong>xmlwriter_open_memory()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::startAttribute
   * XMLWriter::startAttributeNs
   * XMLWriter::writeAttribute
   * XMLWriter::writeAttributeNs


id: XMLWriter::endCdata
type: function
doc:
<comment>Description:</comment>
  End current CDATA
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Ends the current CDATA section.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Apenas para chamadas procedurais.
                      A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é retornado de
                      uma chamada a <strong>xmlwriter_open_uri()</strong> ou <strong>xmlwriter_open_memory()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::startCdata
   * XMLWriter::writeCdata


id: XMLWriter::endComment
type: function
doc:
<comment>Description:</comment>
  Create end comment
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Ends the current comment.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Apenas para chamadas procedurais.
                      A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é retornado de
                      uma chamada a <strong>xmlwriter_open_uri()</strong> ou <strong>xmlwriter_open_memory()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::startComment
   * XMLWriter::writeComment


id: XMLWriter::endDocument
type: function
doc:
<comment>Description:</comment>
  End current document
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Ends the current document.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Apenas para chamadas procedurais.
                      A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é retornado de
                      uma chamada a <strong>xmlwriter_open_uri()</strong> ou <strong>xmlwriter_open_memory()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::startDocument


id: XMLWriter::endDtd
type: function
doc:
<comment>Description:</comment>
  End current DTD
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Ends the DTD of the document.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Apenas para chamadas procedurais.
                      A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é retornado de
                      uma chamada a <strong>xmlwriter_open_uri()</strong> ou <strong>xmlwriter_open_memory()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::startDtd
   * XMLWriter::writeDtd


id: XMLWriter::endDtdAttlist
type: function
doc:
<comment>Description:</comment>
  End current DTD AttList
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Ends the current DTD attribute list.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Apenas para chamadas procedurais.
                      A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é retornado de
                      uma chamada a <strong>xmlwriter_open_uri()</strong> ou <strong>xmlwriter_open_memory()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::startDtdAttlist
   * XMLWriter::writeDtdAttlist


id: XMLWriter::endDtdElement
type: function
doc:
<comment>Description:</comment>
  End current DTD element
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Ends the current DTD element.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Apenas para chamadas procedurais.
                      A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é retornado de
                      uma chamada a <strong>xmlwriter_open_uri()</strong> ou <strong>xmlwriter_open_memory()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::startDtdElement
   * XMLWriter::writeDtdElement


id: XMLWriter::endDtdEntity
type: function
doc:
<comment>Description:</comment>
  End current DTD Entity
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Ends the current DTD entity.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Apenas para chamadas procedurais.
                      A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é retornado de
                      uma chamada a <strong>xmlwriter_open_uri()</strong> ou <strong>xmlwriter_open_memory()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::startDtdEntity
   * XMLWriter::writeDtdEntity


id: XMLWriter::endElement
type: function
doc:
<comment>Description:</comment>
  End current element
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Ends the current element.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Apenas para chamadas procedurais.
                      A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é retornado de
                      uma chamada a <strong>xmlwriter_open_uri()</strong> ou <strong>xmlwriter_open_memory()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::startElement
   * XMLWriter::writeElement


id: XMLWriter::endPi
type: function
doc:
<comment>Description:</comment>
  End current PI
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Ends the current processing instruction.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Apenas para chamadas procedurais.
                      A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é retornado de
                      uma chamada a <strong>xmlwriter_open_uri()</strong> ou <strong>xmlwriter_open_memory()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::startPi
   * XMLWriter::writePi


id: XMLWriter::flush
type: function
doc:
<comment>Description:</comment>
  Flush current buffer
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Flushes the current buffer.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Apenas para chamadas procedurais.
                      A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é retornado de
                      uma chamada a <strong>xmlwriter_open_uri()</strong> ou <strong>xmlwriter_open_memory()</strong>.
  <info>bool</info>       <strong>$empty</strong>   Whether to empty the buffer or not. Default is <info>true</info>.

<comment>Return:</comment>
  <info>string|int</info>  If you opened the writer in memory, this function returns the generated XML buffer,
              Else, if using URI, this function will write the buffer and return the number of
              written bytes.


id: XMLWriter::fullEndElement
type: function
doc:
<comment>Description:</comment>
  End current element
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  End the current xml element. Writes an end tag even if the element is empty.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Apenas para chamadas procedurais.
                      A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é retornado de
                      uma chamada a <strong>xmlwriter_open_uri()</strong> ou <strong>xmlwriter_open_memory()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::endElement


id: XMLWriter::openMemory
type: function
doc:
<comment>Description:</comment>
  Create new xmlwriter using memory for string output
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Creates a new <class>XMLWriter</class> using memory for string output.

<comment>Return:</comment>
  <info>bool</info>  Estilo orientado a objetos: Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.
        
        Estilo procedural: Returns a new <class>XMLWriter</class> for later use with the xmlwriter functions on
        success,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::openUri


id: XMLWriter::openUri
type: function
doc:
<comment>Description:</comment>
  Create new xmlwriter using source uri for output
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Creates a new <class>XMLWriter</class> using  <strong>$uri</strong> for the output.

<comment>Param:</comment>
  <info>string</info>  <strong>$uri</strong>  The URI of the resource for the output.

<comment>Return:</comment>
  <info>bool</info>  Estilo orientado a objetos: Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.
        
        Estilo procedural: Returns a new <class>XMLWriter</class> instance for later use with the xmlwriter
        functions on success,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::openMemory


id: XMLWriter::outputMemory
type: function
doc:
<comment>Description:</comment>
  Returns current buffer
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Returns the current buffer.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Apenas para chamadas procedurais.
                      A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é retornado de
                      uma chamada a <strong>xmlwriter_open_uri()</strong> ou <strong>xmlwriter_open_memory()</strong>.
  <info>bool</info>       <strong>$flush</strong>   Whether to flush the output buffer or not. Default is <info>true</info>.

<comment>Return:</comment>
  <info>string</info>  Returns the current buffer as a string.

<comment>See Also:</comment>
   * XMLWriter::flush


id: XMLWriter::setIndent
type: function
doc:
<comment>Description:</comment>
  Toggle indentation on/off
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Toggles indentation on or off.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Apenas para chamadas procedurais.
                      A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é retornado de
                      uma chamada a <strong>xmlwriter_open_uri()</strong> ou <strong>xmlwriter_open_memory()</strong>.
  <info>bool</info>       <strong>$enable</strong>  Whether indentation is enabled.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::setIndentString


id: XMLWriter::setIndentString
type: function
doc:
<comment>Description:</comment>
  Set string used for indenting
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Sets the string which will be used to indent each element/attribute of the resulting xml.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>       Apenas para chamadas procedurais.
                           A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é
                           retornado de uma chamada a <strong>xmlwriter_open_uri()</strong> ou
                           <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$indentation</strong>  The indentation string.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::setIndent


id: XMLWriter::startAttribute
type: function
doc:
<comment>Description:</comment>
  Create start attribute
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Starts an attribute.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Apenas para chamadas procedurais.
                      A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é retornado de
                      uma chamada a <strong>xmlwriter_open_uri()</strong> ou <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$name</strong>    The attribute name.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::startAttributeNs
   * XMLWriter::endAttribute
   * XMLWriter::writeAttribute
   * XMLWriter::writeAttributeNs


id: XMLWriter::startAttributeNs
type: function
doc:
<comment>Description:</comment>
  Create start namespaced attribute
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Starts a namespaced attribute.

<comment>Param:</comment>
  <info>XMLWriter</info>    <strong>$writer</strong>     Apenas para chamadas procedurais.
                           A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é
                           retornado de uma chamada a <strong>xmlwriter_open_uri()</strong> ou
                           <strong>xmlwriter_open_memory()</strong>.
  <info>string|null</info>  <strong>$prefix</strong>     The namespace prefix.
  <info>string</info>       <strong>$name</strong>       The attribute name.
  <info>string|null</info>  <strong>$namespace</strong>  The namespace URI. If <strong>$namespace</strong> is <info>null</info>, the namespace declaration will
                           be omitted.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::startAttribute
   * XMLWriter::endAttribute
   * XMLWriter::writeAttribute
   * XMLWriter::writeAttributeNs


id: XMLWriter::startCdata
type: function
doc:
<comment>Description:</comment>
  Create start CDATA tag
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Starts a CDATA.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Apenas para chamadas procedurais.
                      A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é retornado de
                      uma chamada a <strong>xmlwriter_open_uri()</strong> ou <strong>xmlwriter_open_memory()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::endCdata
   * XMLWriter::writeCdata


id: XMLWriter::startComment
type: function
doc:
<comment>Description:</comment>
  Create start comment
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Starts a comment.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Apenas para chamadas procedurais.
                      A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é retornado de
                      uma chamada a <strong>xmlwriter_open_uri()</strong> ou <strong>xmlwriter_open_memory()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::endComment
   * XMLWriter::writeComment


id: XMLWriter::startDocument
type: function
doc:
<comment>Description:</comment>
  Create document tag
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Starts a document.

<comment>Param:</comment>
  <info>XMLWriter</info>    <strong>$writer</strong>      Apenas para chamadas procedurais.
                            A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é
                            retornado de uma chamada a <strong>xmlwriter_open_uri()</strong> ou
                            <strong>xmlwriter_open_memory()</strong>.
  <info>string|null</info>  <strong>$version</strong>     The version number of the document as part of the XML declaration.
  <info>string|null</info>  <strong>$encoding</strong>    The encoding of the document as part of the XML declaration.
  <info>string|null</info>  <strong>$standalone</strong>  <return>yes</return> or <return>no</return>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::endDocument


id: XMLWriter::startDtd
type: function
doc:
<comment>Description:</comment>
  Create start DTD tag
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Starts a DTD.

<comment>Param:</comment>
  <info>XMLWriter</info>    <strong>$writer</strong>         Apenas para chamadas procedurais.
                               A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é
                               retornado de uma chamada a <strong>xmlwriter_open_uri()</strong> ou
                               <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>       <strong>$qualifiedName</strong>  The qualified name of the document type to create.
  <info>string|null</info>  <strong>$publicId</strong>       The external subset public identifier.
  <info>string|null</info>  <strong>$systemId</strong>       The external subset system identifier.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::endDtd
   * XMLWriter::writeDtd


id: XMLWriter::startDtdAttlist
type: function
doc:
<comment>Description:</comment>
  Create start DTD AttList
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Starts a DTD attribute list.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Apenas para chamadas procedurais.
                      A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é retornado de
                      uma chamada a <strong>xmlwriter_open_uri()</strong> ou <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$name</strong>    The attribute list name.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::endDtdAttlist
   * XMLWriter::writeDtdAttlist


id: XMLWriter::startDtdElement
type: function
doc:
<comment>Description:</comment>
  Create start DTD element
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Starts a DTD element.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>         Apenas para chamadas procedurais.
                             A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é
                             retornado de uma chamada a <strong>xmlwriter_open_uri()</strong> ou
                             <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$qualifiedName</strong>  The qualified name of the document type to create.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::endDtdElement
   * XMLWriter::writeDtdElement


id: XMLWriter::startDtdEntity
type: function
doc:
<comment>Description:</comment>
  Create start DTD Entity
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Starts a DTD entity.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>   Apenas para chamadas procedurais.
                       A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é retornado
                       de uma chamada a <strong>xmlwriter_open_uri()</strong> ou <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$name</strong>     The name of the entity.
  <info>bool</info>       <strong>$isParam</strong>  

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::endDtdEntity
   * XMLWriter::writeDtdEntity


id: XMLWriter::startElement
type: function
doc:
<comment>Description:</comment>
  Create start element tag
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Starts an element.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Apenas para chamadas procedurais.
                      A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é retornado de
                      uma chamada a <strong>xmlwriter_open_uri()</strong> ou <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$name</strong>    The element name.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::endElement
   * XMLWriter::writeElement


id: XMLWriter::startElementNs
type: function
doc:
<comment>Description:</comment>
  Create start namespaced element tag
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Starts a namespaced element.

<comment>Param:</comment>
  <info>XMLWriter</info>    <strong>$writer</strong>     Apenas para chamadas procedurais.
                           A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é
                           retornado de uma chamada a <strong>xmlwriter_open_uri()</strong> ou
                           <strong>xmlwriter_open_memory()</strong>.
  <info>string|null</info>  <strong>$prefix</strong>     The namespace prefix. If <strong>$prefix</strong> is <info>null</info>, the namespace will be omitted.
  <info>string</info>       <strong>$name</strong>       The element name.
  <info>string|null</info>  <strong>$namespace</strong>  The namespace URI. If <strong>$namespace</strong> is <info>null</info>, the namespace declaration will
                           be omitted.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::endElement
   * XMLWriter::writeElementNs


id: XMLWriter::startPi
type: function
doc:
<comment>Description:</comment>
  Create start PI tag
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Starts a processing instruction tag.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Apenas para chamadas procedurais.
                      A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é retornado de
                      uma chamada a <strong>xmlwriter_open_uri()</strong> ou <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$target</strong>  The target of the processing instruction.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::endPi
   * XMLWriter::writePi


id: XMLWriter::text
type: function
doc:
<comment>Description:</comment>
  Write text
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Writes a text.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>   Apenas para chamadas procedurais.
                       A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é retornado
                       de uma chamada a <strong>xmlwriter_open_uri()</strong> ou <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$content</strong>  The contents of the text. The characters <return>\<</return>, <return>&gt;</return>, <return>&</return> and <return>"</return> are written as entity references (i.e. , , and , respectively). All other characters including <return>'</return> are written literally. To write the special XML characters literally, or to write literal entity references, <strong>xmlwriter_write_raw()</strong> has to be used.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: XMLWriter::writeAttribute
type: function
doc:
<comment>Description:</comment>
  Write full attribute
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Writes a full attribute.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Apenas para chamadas procedurais.
                      A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é retornado de
                      uma chamada a <strong>xmlwriter_open_uri()</strong> ou <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$name</strong>    The name of the attribute.
  <info>string</info>     <strong>$value</strong>   The value of the attribute.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::writeAttributeNs
   * XMLWriter::startAttribute
   * XMLWriter::startAttributeNs
   * XMLWriter::endAttribute


id: XMLWriter::writeAttributeNs
type: function
doc:
<comment>Description:</comment>
  Write full namespaced attribute
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Writes a full namespaced attribute.

<comment>Param:</comment>
  <info>XMLWriter</info>    <strong>$writer</strong>     Apenas para chamadas procedurais.
                           A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é
                           retornado de uma chamada a <strong>xmlwriter_open_uri()</strong> ou
                           <strong>xmlwriter_open_memory()</strong>.
  <info>string|null</info>  <strong>$prefix</strong>     The namespace prefix. If <strong>$prefix</strong> is <info>null</info>, the namespace will be omitted.
  <info>string</info>       <strong>$name</strong>       The attribute name.
  <info>string|null</info>  <strong>$namespace</strong>  The namespace URI. If <strong>$namespace</strong> is <info>null</info>, the namespace declaration will
                           be omitted.
  <info>string</info>       <strong>$value</strong>      The attribute value.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::writeAttribute
   * XMLWriter::startAttribute
   * XMLWriter::startAttributeNs
   * XMLWriter::endAttribute


id: XMLWriter::writeCdata
type: function
doc:
<comment>Description:</comment>
  Write full CDATA tag
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Writes a full CDATA.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>   Apenas para chamadas procedurais.
                       A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é retornado
                       de uma chamada a <strong>xmlwriter_open_uri()</strong> ou <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$content</strong>  The contents of the CDATA.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::startCdata
   * XMLWriter::endCdata


id: XMLWriter::writeComment
type: function
doc:
<comment>Description:</comment>
  Write full comment tag
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Writes a full comment.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>   Apenas para chamadas procedurais.
                       A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é retornado
                       de uma chamada a <strong>xmlwriter_open_uri()</strong> ou <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$content</strong>  The contents of the comment.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::startComment
   * XMLWriter::endComment


id: XMLWriter::writeDtd
type: function
doc:
<comment>Description:</comment>
  Write full DTD tag
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Writes a full DTD.

<comment>Param:</comment>
  <info>XMLWriter</info>    <strong>$writer</strong>    Apenas para chamadas procedurais.
                          A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é
                          retornado de uma chamada a <strong>xmlwriter_open_uri()</strong> ou
                          <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>       <strong>$name</strong>      The DTD name.
  <info>string|null</info>  <strong>$publicId</strong>  The external subset public identifier.
  <info>string|null</info>  <strong>$systemId</strong>  The external subset system identifier.
  <info>string|null</info>  <strong>$content</strong>   The content of the DTD.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::startDtd
   * XMLWriter::endDtd


id: XMLWriter::writeDtdAttlist
type: function
doc:
<comment>Description:</comment>
  Write full DTD AttList tag
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Writes a DTD attribute list.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>   Apenas para chamadas procedurais.
                       A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é retornado
                       de uma chamada a <strong>xmlwriter_open_uri()</strong> ou <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$name</strong>     The name of the DTD attribute list.
  <info>string</info>     <strong>$content</strong>  The content of the DTD attribute list.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::startDtdAttlist
   * XMLWriter::endDtdAttlist


id: XMLWriter::writeDtdElement
type: function
doc:
<comment>Description:</comment>
  Write full DTD element tag
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Writes a full DTD element.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>   Apenas para chamadas procedurais.
                       A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é retornado
                       de uma chamada a <strong>xmlwriter_open_uri()</strong> ou <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$name</strong>     The name of the DTD element.
  <info>string</info>     <strong>$content</strong>  The content of the element.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::startDtdElement
   * XMLWriter::endDtdElement


id: XMLWriter::writeDtdEntity
type: function
doc:
<comment>Description:</comment>
  Write full DTD Entity tag
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Writes a full DTD entity.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>   Apenas para chamadas procedurais.
                       A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é retornado
                       de uma chamada a <strong>xmlwriter_open_uri()</strong> ou <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$name</strong>     The name of the entity.
  <info>string</info>     <strong>$content</strong>  The content of the entity.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::startDtdEntity
   * XMLWriter::endDtdEntity


id: XMLWriter::writeElement
type: function
doc:
<comment>Description:</comment>
  Write full element tag
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Writes a full element tag.

<comment>Param:</comment>
  <info>XMLWriter</info>    <strong>$writer</strong>   Apenas para chamadas procedurais.
                         A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é retornado
                         de uma chamada a <strong>xmlwriter_open_uri()</strong> ou <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>       <strong>$name</strong>     The element name.
  <info>string|null</info>  <strong>$content</strong>  The element contents.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::startElement
   * XMLWriter::endElement
   * XMLWriter::writeElementNs


id: XMLWriter::writeElementNs
type: function
doc:
<comment>Description:</comment>
  Write full namespaced element tag
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Writes a full namespaced element tag.

<comment>Param:</comment>
  <info>XMLWriter</info>    <strong>$writer</strong>     Apenas para chamadas procedurais.
                           A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é
                           retornado de uma chamada a <strong>xmlwriter_open_uri()</strong> ou
                           <strong>xmlwriter_open_memory()</strong>.
  <info>string|null</info>  <strong>$prefix</strong>     The namespace prefix. If <strong>$prefix</strong> is <info>null</info>, the namespace will be omitted.
  <info>string</info>       <strong>$name</strong>       The element name.
  <info>string|null</info>  <strong>$namespace</strong>  The namespace URI. If <strong>$namespace</strong> is <info>null</info>, the namespace declaration will
                           be omitted.
  <info>string|null</info>  <strong>$content</strong>    The element contents.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::startElementNs
   * XMLWriter::endElement
   * XMLWriter::writeElement


id: XMLWriter::writePi
type: function
doc:
<comment>Description:</comment>
  Writes a PI
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Writes a processing instruction.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>   Apenas para chamadas procedurais.
                       A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é retornado
                       de uma chamada a <strong>xmlwriter_open_uri()</strong> ou <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$target</strong>   The target of the processing instruction.
  <info>string</info>     <strong>$content</strong>  The content of the processing instruction.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::startPi
   * XMLWriter::endPi


id: XMLWriter::writeRaw
type: function
doc:
<comment>Description:</comment>
  Write a raw XML text
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Writes a raw xml text.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>   Apenas para chamadas procedurais.
                       A instância de <class>XMLWriter</class> que está sendo modificada. Este objeto é retornado
                       de uma chamada a <strong>xmlwriter_open_uri()</strong> ou <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$content</strong>  The text string to write.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * XMLWriter::text


id: XML_SAX_IMPL
type: constant
doc:
<comment>Description:</comment>
  Holds the SAX implementation method. Can be <return>libxml</return> or <return>expat</return>.


id: XSLTProcessor::__construct
type: function
doc:
<comment>Description:</comment>
  Cria um novo objeto XSLTProcessor
  
  Cria um novo objeto <class>XSLTProcessor</class>.


id: XSLTProcessor::getParameter
type: function
doc:
<comment>Description:</comment>
  Obtém o valor de um parâmetro
  
  Obtém um parâmetro se anteriormente definido por <strong>XSLTProcessor::setParameter()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$namespace</strong>  O namespace URI do parâmetro XSLT.
  <info>string</info>  <strong>$name</strong>       O nome local do parâmetro XSLT.

<comment>Return:</comment>
  <info>string|false</info>  O valor do parâmetro (em string), ou <info>false</info> se não estiver definido.

<comment>See Also:</comment>
   * <strong>XSLTProcessor::setParameter()</strong>
   * <strong>XSLTProcessor::removeParameter()</strong>


id: XSLTProcessor::getSecurityPrefs
type: function
doc:
<comment>Description:</comment>
  Obtém as preferências de segurança
  
  Obtém as preferências de segurança.

<comment>Return:</comment>
  <info>int</info>  Uma máscara de bits consistindo da combinação de <info>XSL_SECPREF_READ_FILE</info>,
       <info>XSL_SECPREF_WRITE_FILE</info>, <info>XSL_SECPREF_CREATE_DIRECTORY</info>, <info>XSL_SECPREF_READ_NETWORK</info> e
       <info>XSL_SECPREF_WRITE_NETWORK</info>.


id: XSLTProcessor::hasExsltSupport
type: function
doc:
<comment>Description:</comment>
  Verifica se o PHP tem suporte a EXSLT
  
  Este método verifica se o PHP foi construído com a biblioteca EXSLT.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: XSLTProcessor::importStylesheet
type: function
doc:
<comment>Description:</comment>
  Importa folha de estilos
  
  Este método importa a folha de estilos no <class>XSLTProcessor</class> para transformações.

<comment>Param:</comment>
  <info>object</info>  <strong>$stylesheet</strong>  A folha de estilos importada como um objeto <class>DOMDocument</class> ou <class>SimpleXMLElement</class>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: XSLTProcessor::registerPHPFunctions
type: function
doc:
<comment>Description:</comment>
  Habilita o uso de funções do PHP como funções XSLT
  
  Este método habilita o uso de funções PHP como funções XSLT nas folhas de estilo XSL.

<comment>Param:</comment>
  <info>array|string|null</info>  <strong>$functions</strong>  Use este parâmetro para permitir que apenas certas funções sejam
                                 chamadas a partir do XSLT.
                                 
                                 Este parâmetro pode ser uma string (nome de função) ou um array de
                                 funções.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.


id: XSLTProcessor::removeParameter
type: function
doc:
<comment>Description:</comment>
  Remove parâmetro
  
  Remove um parâmetro, se definido. Isto irá fazer o processador usar o valor padrão para o
  parâmetro como especificado no stylesheet.

<comment>Param:</comment>
  <info>string</info>  <strong>$namespace</strong>  A URI de espaço de nomes do parâmetro XSLT.
  <info>string</info>  <strong>$name</strong>       O nome local do parâmetro XSLT.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>XSLTProcessor::setParameter()</strong>
   * <strong>XSLTProcessor::getParameter()</strong>


id: XSLTProcessor::setParameter
type: function
doc:
<comment>Description:</comment>
  Define um valor para um parâmetro
  
  Define o valor para um ou mais parâmetros para ser usados em transformações subsequentes com
  <class>XSLTProcessor</class>. Se o parâmetro não existir na folha de estilos, ele será ignorado.

<comment>Param:</comment>
  <info>string</info>  <strong>$namespace</strong>  A URI de espaço de nomes do parâmetro XSLT.
  <info>string</info>  <strong>$name</strong>       O nome local do parâmetro XSLT.
  <info>string</info>  <strong>$value</strong>      O novo valor do parâmetro XSLT.
  <info>array</info>   <strong>$options</strong>    Um array de pares <return>name =&gt; value</return>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>XSLTProcessor::getParameter()</strong>
   * <strong>XSLTProcessor::removeParameter()</strong>


id: XSLTProcessor::setProfiling
type: function
doc:
<comment>Description:</comment>
  Define o arquivo de saída de perfil
  
  Define o arquivo para o qual serão gravadas informações de perfil ao processar uma folha de
  estilos.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$filename</strong>  Caminho para o arquivo onde serão gravadas as informações de perfil.

<comment>Return:</comment>
  <info>true</info>  Sempre retorna <info>true</info>.


id: XSLTProcessor::setSecurityPrefs
type: function
doc:
<comment>Description:</comment>
  Define preferências de segurança
  
  Define as preferências de segurança.

<comment>Param:</comment>
  <info>int</info>  <strong>$preferences</strong>  As novas preferências de segurança. As constantes seguidas podem ser unidas
                     pela operação binária OR: <info>XSL_SECPREF_READ_FILE</info>, <info>XSL_SECPREF_WRITE_FILE</info>,
                     <info>XSL_SECPREF_CREATE_DIRECTORY</info>, <info>XSL_SECPREF_READ_NETWORK</info> e
                     <info>XSL_SECPREF_WRITE_NETWORK</info>. Alternativamente, <info>XSL_SECPREF_NONE</info> ou
                     <info>XSL_SECPREF_DEFAULT</info> podem ser passadas.

<comment>Return:</comment>
  <info>int</info>  Retorna as preferências de segurança antigas..


id: XSLTProcessor::transformToDoc
type: function
doc:
<comment>Description:</comment>
  Transforma em um documento
  
  Transforma o nó de origem em um documento (ex.: <class>DOMDocument</class>) aplicando a folha de estilos
  fornecida pelo método <strong>XSLTProcessor::importStylesheet()</strong>.

<comment>Param:</comment>
  <info>object</info>       <strong>$document</strong>     O objeto <class>DOMDocument</class>, <class>SimpleXMLElement</class>, ou outro compatível com libxml
                             a ser transformado.
  <info>string|null</info>  <strong>$returnClass</strong>  Este parâmetro opcional pode ser usado para que
                             XSLTProcessor::transformToDoc retorne um objeto da classe especificada.
                             Esta classe deve estender ou ser da mesma classe de <strong>$document</strong>.

<comment>Return:</comment>
  <info>object|false</info>  O documento resultante ou <info>false</info> em caso de erro.

<comment>See Also:</comment>
   * <strong>XSLTProcessor::transformToUri()</strong>
   * <strong>XSLTProcessor::transformToXml()</strong>


id: XSLTProcessor::transformToURI
type: function
doc:
<comment>Description:</comment>
  Transforma em URI
  
  Transforma o nó de origem em uma URI aplicando a folha de estilos fornecida pelo método
  <strong>XSLTProcessor::importStylesheet()</strong>.

<comment>Param:</comment>
  <info>object</info>  <strong>$document</strong>  O objeto <class>DOMDocument</class> ou <class>SimpleXMLElement</class> a ser transformado.
  <info>string</info>  <strong>$uri</strong>       A URI alvo para a transformação.

<comment>Return:</comment>
  <info>int</info>  Retorna o número de bytes escritos ou <info>false</info> se um erro ocorrer.

<comment>See Also:</comment>
   * <strong>XSLTProcessor::transformToDoc()</strong>
   * <strong>XSLTProcessor::transformToXml()</strong>


id: XSLTProcessor::transformToXml
type: function
doc:
<comment>Description:</comment>
  Transforma em XML
  
  Transforma o nó de origem em uma string aplicando a folha de estilos fornecida pelo método
  <strong>xsltprocessor::importStylesheet()</strong>.

<comment>Param:</comment>
  <info>object</info>  <strong>$document</strong>  O objeto <class>DOMDocument</class> ou <class>SimpleXMLElement</class> a ser transformado.

<comment>Return:</comment>
  <info>string|null|false</info>  O resultado da transformação como uma string ou <info>false</info> em caso de erro.

<comment>See Also:</comment>
   * <strong>XSLTProcessor::transformToDoc()</strong>
   * <strong>XSLTProcessor::transformToUri()</strong>


id: XSL_SECPREF_DEFAULT
type: constant
doc:
<comment>Description:</comment>
  Proíbe todo acesso de gravação, ou seja, uma máscara de bits de <info>XSL_SECPREF_WRITE_NETWORK</info> |
  <info>XSL_SECPREF_CREATE_DIRECTORY</info> | <info>XSL_SECPREF_WRITE_FILE</info>.


id: Yac::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor
  
  prefix is used to prepended to keys, this could be used to avoiding conflicts between apps.

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>  <info>string</info> prefix


id: Yac::__get
type: function
doc:
<comment>Description:</comment>
  Getter
  
  Retrieve values from cache

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  <info>string</info> key

<comment>Return:</comment>
  <info>mixed</info>  mixed on success, <info>null</info> on failure


id: Yac::__set
type: function
doc:
<comment>Description:</comment>
  Setter
  
  store a item into cache

<comment>Param:</comment>
  <info>string</info>  <strong>$keys</strong>   <info>string</info> key
  <info>mixed</info>   <strong>$value</strong>  mixed value, All php value type could be stored except resource

<comment>Return:</comment>
  <info>mixed</info>  Always return the value self


id: Yac::add
type: function
doc:
<comment>Description:</comment>
  Store into cache
  
  Added a item into cache.

<comment>Param:</comment>
  <info>string</info>  <strong>$keys</strong>   <info>string</info> key
  <info>mixed</info>   <strong>$value</strong>  mixed value, All php value type could be stored except resource
  <info>int</info>     <strong>$ttl</strong>    expire time

<comment>Return:</comment>
  <info>bool</info>  <info>bool</info>, <info>true</info> on success, <info>false</info> on failure  Yac::add may fail if cas lock could not obtain, so,
        if you need the value to be stored properly, you may write codes like: Make sure the item is
        storedset("key", "vale)); ]]>
        
        Yac::add may fail if cas lock could not obtain, so, if you need the value to be stored
        properly, you may write codes like: Make sure the item is storedset("key", "vale)); ]]>


id: Yac::delete
type: function
doc:
<comment>Description:</comment>
  Remove items from cache
  
  remove items from cache

<comment>Param:</comment>
  <info>string|array</info>  <strong>$keys</strong>  string key, or array of multiple keys to be removed
  <info>int</info>           <strong>$ttl</strong>   if delay is set, delete will mark the items to be invalid in ttl second.

<comment>Return:</comment>
  <info>bool</info>  


id: Yac::dump
type: function
doc:
<comment>Description:</comment>
  Dump cache
  
  Dump values stored in cache

<comment>Param:</comment>
  <info></info>  <strong>$num</strong>  Maximum number of items should be returned

<comment>Return:</comment>
  <info>mixed</info>  mixed


id: Yac::flush
type: function
doc:
<comment>Description:</comment>
  Flush the cache
  
  Remove all cached values

<comment>Return:</comment>
  <info>bool</info>  bool, always true


id: Yac::get
type: function
doc:
<comment>Description:</comment>
  Retrieve values from cache
  
  Retrieve values from cache

<comment>Param:</comment>
  <info>string|array</info>  <strong>$key</strong>  <info>string</info> keys, or <info>array</info> of multiple keys.
  <info>int</info>           <strong>$cas</strong>  if not <info>null</info>, it will be set to the retrieved item's cas.

<comment>Return:</comment>
  <info>mixed</info>  mixed on success, false on failure


id: Yac::info
type: function
doc:
<comment>Description:</comment>
  Status of cache
  
  Get status of cache system

<comment>Return:</comment>
  <info>array</info>  Return an array, consistent with: "memory_size", "slots_memory_size", "values_memory_size",
         "segment_size", "segment_num", "miss", "hits", "fails", "kicks", "recycles", "slots_size",
         "slots_used"


id: Yac::set
type: function
doc:
<comment>Description:</comment>
  Store into cache
  
  Add a item into cache, it the key is already exists, override it.

<comment>Param:</comment>
  <info>string</info>  <strong>$keys</strong>   <info>string</info> key
  <info>mixed</info>   <strong>$value</strong>  mixed value, All php value type could be stored except resource
  <info>int</info>     <strong>$ttl</strong>    expire time

<comment>Return:</comment>
  <info>bool</info>  the value self


id: Yaconf
type: class
doc:
<comment>Description:</comment>
  Yaconf is a configurations container, it parses INIT files, stores the result in PHP when PHP is
  started, the result lives  with the whole PHP lifecycle.


id: Yaconf::get
type: function
doc:
<comment>Description:</comment>
  Retrieve a item

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>           Configuration key, the key looks like "filename.key", or
                          "filename.sectionName,key".
  <info>mixed</info>   <strong>$default_value</strong>  if the key doesn't exists, Yaconf::get will return this as result.

<comment>Return:</comment>
  <info>mixed</info>  Returns configuration result(string or array) if the key exists, return default_value if
         not.


id: Yaconf::has
type: function
doc:
<comment>Description:</comment>
  Determine if a item exists

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  

<comment>Return:</comment>
  <info>bool</info>  


id: Yaf_Action_Abstract
type: class
doc:
<comment>Description:</comment>
  A action can be defined in a separate file in Yaf(see <class>Yaf_Controller_Abstract</class>). that is a action
  method can also be a <class>Yaf_Action_Abstract</class> class.
  
  Since there should be a entry point which can be called by Yaf,  you must implement the abstract
  method Yaf_Action_Abstract::execute in your custom action class.


id: Yaf_Action_Abstract::execute
type: function
doc:
<comment>Description:</comment>
  Action entry point
  
  user should always define this method for a action, this is the entry point of an action.
  Yaf_Action_Abstract::execute may have agruments.  The value retrived from the request is not safe.
  you should do some filtering work before you use it.
  
  The value retrived from the request is not safe. you should do some filtering work before you use
  it.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$args</strong>  

<comment>Return:</comment>
  <info>mixed</info>  

<comment>See Also:</comment>
   * 


id: Yaf_Action_Abstract::getController
type: function
doc:
<comment>Description:</comment>
  Retrieve controller object
  
  retrieve current controller object.

<comment>Return:</comment>
  <info>Yaf_Controller_Abstract</info>  <class>Yaf_Controller_Abstract</class> instance


id: Yaf_Action_Abstract::getControllerName
type: function
doc:
<comment>Description:</comment>
  Get controller name
  
  get the controller's name

<comment>Return:</comment>
  <info>string</info>  <info>string</info>, controller name


id: Yaf_Application
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_Application</class> provides a bootstrapping facility  for applications which provides reusable
  resources, common- and  module-based bootstrap classes and dependency checking.
  
  <class>Yaf_Application</class> implements the singleton pattern, and <class>Yaf_Application</class> can not be serialized or
  unserialized which will cause problem when you try  to use PHPUnit to write some test case for
  Yaf.  You may use @backupGlobals annotation of PHPUnit to control the  backup and restore
  operations for global variables. thus can solve  this problem.
  
  <class>Yaf_Application</class> implements the singleton pattern, and <class>Yaf_Application</class> can not be serialized or
  unserialized which will cause problem when you try  to use PHPUnit to write some test case for
  Yaf.
  
  You may use @backupGlobals annotation of PHPUnit to control the  backup and restore operations for
  global variables. thus can solve  this problem.


id: Yaf_Application::__construct
type: function
doc:
<comment>Description:</comment>
  Yaf_Application constructor
  
  Instance a <class>Yaf_Application</class>.

<comment>Param:</comment>
  <info>mixed</info>   <strong>$config</strong>   A ini config file path, or a config array
                    
                    If is a ini config file, there should be a section named as the one defined by
                    yaf.environ, which is "product" by default.  If you use a ini configuration file
                    as your applicatioin's config container. you would open the yaf.cache_config to
                    improve performance.
                    
                    If you use a ini configuration file as your applicatioin's config container. you
                    would open the yaf.cache_config to improve performance.
                    
                    And the config entry(and there default value) list blow: A ini config file
                    example
  <info>string</info>  <strong>$envrion</strong>  Which section will be loaded as the final config

<comment>See Also:</comment>
   * <class>Yaf_Config_Ini</class>


id: Yaf_Application::app
type: function
doc:
<comment>Description:</comment>
  Retrieve an Application instance
  
  Retrieve the <class>Yaf_Application</class> instance. Alternatively, we also could use
  Yaf_Dispatcher::getApplication.

<comment>Return:</comment>
  <info>mixed</info>  A Yaf_Application instance, if no Yaf_Application was initialized before, <info>null</info> will be
         returned.

<comment>See Also:</comment>
   * Yaf_Dispatcher::getApplication


id: Yaf_Application::bootstrap
type: function
doc:
<comment>Description:</comment>
  Call bootstrap
  
  Run a Bootstrap, all the methods defined in the Bootstrap and named with prefix "_init" will be
  called according to their declaration order, if the parameter bootstrap is not supplied, Yaf will
  look for a Bootstrap under application.directory.

<comment>Param:</comment>
  <info>Yaf_Bootstrap_Abstract</info>  <strong>$bootstrap</strong>  A <class>Yaf_Bootstrap_Abstract</class> instance

<comment>Return:</comment>
  <info>void</info>  <class>Yaf_Application</class> instance

<comment>See Also:</comment>
   * <class>Yaf_Bootstrap_Abstract</class>


id: Yaf_Application::clearLastError
type: function
doc:
<comment>Description:</comment>
  Clear the last error info

<comment>Return:</comment>
  <info>Yaf_Application</info>  


id: Yaf_Application::environ
type: function
doc:
<comment>Description:</comment>
  Retrive environ
  
  Retrive environ which was defined in yaf.environ which has a default value "product".

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Application::execute
type: function
doc:
<comment>Description:</comment>
  Execute a callback
  
  This method is typically used to run Yaf_Application in a crontab work. Make the crontab work can
  also use the autoloader and Bootstrap mechanism.

<comment>Param:</comment>
  <info>callable</info>  <strong>$entry</strong>  a valid callback
  <info>string</info>    <strong>$args</strong>   parameters will pass to the callback

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Application::getAppDirectory
type: function
doc:
<comment>Description:</comment>
  Get the application directory

<comment>Param:</comment>
  <info></info>  <strong>$directory</strong>  

<comment>Return:</comment>
  <info>Yaf_Application</info>  


id: Yaf_Application::getConfig
type: function
doc:
<comment>Description:</comment>
  Retrive the config instance

<comment>Return:</comment>
  <info>Yaf_Config_Abstract</info>  A <class>Yaf_Config_Abstract</class> instance


id: Yaf_Application::getDispatcher
type: function
doc:
<comment>Description:</comment>
  Get Yaf_Dispatcher instance

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  


id: Yaf_Application::getLastErrorMsg
type: function
doc:
<comment>Description:</comment>
  Get message of the last occurred error

<comment>Return:</comment>
  <info>string</info>  


id: Yaf_Application::getLastErrorNo
type: function
doc:
<comment>Description:</comment>
  Get code of last occurred error

<comment>Return:</comment>
  <info>int</info>  


id: Yaf_Application::getModules
type: function
doc:
<comment>Description:</comment>
  Get defined module names
  
  Get the modules list defined in config, if no one defined, there will always be a module named
  "Index".

<comment>Return:</comment>
  <info>array</info>  


id: Yaf_Application::run
type: function
doc:
<comment>Description:</comment>
  Start Yaf_Application
  
  Run a Yaf_Application, let the Yaf_Application accept a request and route this request, dispatch
  to controller/action and render response. Finally, return the response to the client.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Application::setAppDirectory
type: function
doc:
<comment>Description:</comment>
  Change the application directory

<comment>Param:</comment>
  <info>string</info>  <strong>$directory</strong>  

<comment>Return:</comment>
  <info>Yaf_Application</info>  


id: Yaf_Bootstrap_Abstract
type: class
doc:
<comment>Description:</comment>
  Bootstrap is a mechanism used to do some initial config before a Application run.
  
  User may define their own Bootstrap class by inheriting <class>Yaf_Bootstrap_Abstract</class>
  
  Any method declared in Bootstrap class with leading "_init", will be called by
  Yaf_Application::bootstrap one by one  according to their defined order.


id: Yaf_Config_Abstract::get
type: function
doc:
<comment>Description:</comment>
  Getter
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>mixed</info>  


id: Yaf_Config_Abstract::readonly
type: function
doc:
<comment>Description:</comment>
  Find a config whether readonly
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>bool</info>  


id: Yaf_Config_Abstract::set
type: function
doc:
<comment>Description:</comment>
  Setter
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>Yaf_Config_Abstract</info>  


id: Yaf_Config_Abstract::toArray
type: function
doc:
<comment>Description:</comment>
  Cast to array
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>array</info>  


id: Yaf_Config_Ini
type: class
doc:
<comment>Description:</comment>
  Yaf_Config_Ini enables developers to store configuration data in a familiar INI format and read
  them in the application by using nested object property syntax. The INI format is specialized to
  provide both the ability to have a hierarchy of configuration data keys and inheritance between
  configuration data sections. Configuration data hierarchies are supported by separating the keys
  with the dot or period character ("."). A section may extend or inherit from another section by
  following the section name with a colon character (":") and the name of the section from which
  data are to be inherited.      Yaf_Config_Ini utilizes the » parse_ini_file() PHP function. Please
  review this documentation to be aware of its specific behaviors, which propagate to
  Yaf_Config_Ini, such as how the special values of "<info>true</info>", "<info>false</info>", "yes", "no", and "<info>null</info>" are
  handled.
  
  Yaf_Config_Ini utilizes the » parse_ini_file() PHP function. Please review this documentation to
  be aware of its specific behaviors, which propagate to Yaf_Config_Ini, such as how the special
  values of "<info>true</info>", "<info>false</info>", "yes", "no", and "<info>null</info>" are handled.


id: Yaf_Config_Ini::__construct
type: function
doc:
<comment>Description:</comment>
  Yaf_Config_Ini constructor
  
  <class>Yaf_Config_Ini</class> constructor

<comment>Param:</comment>
  <info>string</info>  <strong>$config_file</strong>  path to an INI configure file
  <info>string</info>  <strong>$section</strong>      which section in that INI file you want to be parsed


id: Yaf_Config_Ini::__get
type: function
doc:
<comment>Description:</comment>
  Retrieve a element
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Config_Ini::__isset
type: function
doc:
<comment>Description:</comment>
  Determine if a key is exists
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Config_Ini::__set
type: function
doc:
<comment>Description:</comment>
  The __set purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   
  <info>mixed</info>   <strong>$value</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Config_Ini::count
type: function
doc:
<comment>Description:</comment>
  Count all elements in Yaf_Config.ini
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Config_Ini::current
type: function
doc:
<comment>Description:</comment>
  Retrieve the current value
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Config_Ini::key
type: function
doc:
<comment>Description:</comment>
  Fetch current element's key
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Config_Ini::next
type: function
doc:
<comment>Description:</comment>
  Advance the internal pointer
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Config_Ini::offsetExists
type: function
doc:
<comment>Description:</comment>
  The offsetExists purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Config_Ini::offsetGet
type: function
doc:
<comment>Description:</comment>
  The offsetGet purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Config_Ini::offsetSet
type: function
doc:
<comment>Description:</comment>
  The offsetSet purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   
  <info>string</info>  <strong>$value</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Config_Ini::offsetUnset
type: function
doc:
<comment>Description:</comment>
  The offsetUnset purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Config_Ini::readonly
type: function
doc:
<comment>Description:</comment>
  The readonly purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Config_Ini::rewind
type: function
doc:
<comment>Description:</comment>
  The rewind purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Config_Ini::toArray
type: function
doc:
<comment>Description:</comment>
  Return config as a PHP array
  
  Returns a PHP array from the <class>Yaf_Config_Ini</class>

<comment>Return:</comment>
  <info>array</info>  


id: Yaf_Config_Ini::valid
type: function
doc:
<comment>Description:</comment>
  The valid purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Config_Simple::__construct
type: function
doc:
<comment>Description:</comment>
  The __construct purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>array</info>  <strong>$configs</strong>   
  <info>bool</info>   <strong>$readonly</strong>  


id: Yaf_Config_Simple::__get
type: function
doc:
<comment>Description:</comment>
  The __get purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Config_Simple::__isset
type: function
doc:
<comment>Description:</comment>
  The __isset purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Config_Simple::__set
type: function
doc:
<comment>Description:</comment>
  The __set purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   
  <info>string</info>  <strong>$value</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Config_Simple::count
type: function
doc:
<comment>Description:</comment>
  The count purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Config_Simple::current
type: function
doc:
<comment>Description:</comment>
  The current purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Config_Simple::key
type: function
doc:
<comment>Description:</comment>
  The key purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Config_Simple::next
type: function
doc:
<comment>Description:</comment>
  The next purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Config_Simple::toArray
type: function
doc:
<comment>Description:</comment>
  Returns a PHP array
  
  Returns a PHP array from the <class>Yaf_Config_Simple</class>

<comment>Return:</comment>
  <info>array</info>  


id: Yaf_Controller_Abstract
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_Controller_Abstract</class> is the heart of Yaf's  system. MVC stands for Model-View-Controller and is
  a design pattern  targeted at separating application logic from display logic.
  
  Every custom controller shall inherit <class>Yaf_Controller_Abstract</class>.
  
  You will find that you can not define __construct function for your custom controller, thus,
  <class>Yaf_Controller_Abstract</class> provides a magic method: Yaf_Controller_Abstract::init.
  
  If you have defined a init() method in your custom controller, it will be called as long as the
  controller was instantiated.
  
  Action may have arguments, when a request coming, if there are the same name variable in the
  request parameters(see Yaf_Request_Abstract::getParam) after routed,  Yaf will pass them to the
  action method (see Yaf_Action_Abstract::execute).  These arguments are directly fetched without
  filtering, it should be  carefully processed before use them.
  
  These arguments are directly fetched without filtering, it should be  carefully processed before
  use them.


id: Yaf_Controller_Abstract::__construct
type: function
doc:
<comment>Description:</comment>
  Yaf_Controller_Abstract constructor
  
  Yaf_Controller_Abstract::__construct is final, which means it can not be overridden. You may want
  to see Yaf_Controller_Abstract::init instead.

<comment>See Also:</comment>
   * Yaf_Controller_Abstract::init


id: Yaf_Controller_Abstract::display
type: function
doc:
<comment>Description:</comment>
  The display purpose

<comment>Param:</comment>
  <info>string</info>  <strong>$tpl</strong>         
  <info>array</info>   <strong>$parameters</strong>  

<comment>Return:</comment>
  <info>bool</info>  


id: Yaf_Controller_Abstract::forward
type: function
doc:
<comment>Description:</comment>
  Forward to another action
  
  forward current execution process to other action.  this method doesn't switch to the destination
  action immediately, it will take place after current flow finish.
  
  this method doesn't switch to the destination action immediately, it will take place after current
  flow finish.

<comment>Param:</comment>
  <info>string</info>  <strong>$module</strong>      destination module name, if NULL was given, then default module name is
                       assumed
  <info>string</info>  <strong>$controller</strong>  destination controller name
  <info>string</info>  <strong>$action</strong>      destination action name
  <info>array</info>   <strong>$paramters</strong>   calling arguments

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * Yaf_Request_Abstrace::getParam


id: Yaf_Controller_Abstract::getInvokeArg
type: function
doc:
<comment>Description:</comment>
  The getInvokeArg purpose

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Controller_Abstract::getInvokeArgs
type: function
doc:
<comment>Description:</comment>
  The getInvokeArgs purpose

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Controller_Abstract::getModuleName
type: function
doc:
<comment>Description:</comment>
  Get module name
  
  get the controller's module name

<comment>Return:</comment>
  <info>string</info>  


id: Yaf_Controller_Abstract::getName
type: function
doc:
<comment>Description:</comment>
  Get self name
  
  get the controller's name

<comment>Return:</comment>
  <info>string</info>  <info>string</info>, controller name


id: Yaf_Controller_Abstract::getRequest
type: function
doc:
<comment>Description:</comment>
  Retrieve current request object
  
  retrieve current request object

<comment>Return:</comment>
  <info>Yaf_Request_Abstract</info>  <class>Yaf_Request_Abstract</class> instance


id: Yaf_Controller_Abstract::getResponse
type: function
doc:
<comment>Description:</comment>
  Retrieve current response object
  
  retrieve current response object

<comment>Return:</comment>
  <info>Yaf_Response_Abstract</info>  <class>Yaf_Response_Abstract</class> instance


id: Yaf_Controller_Abstract::getView
type: function
doc:
<comment>Description:</comment>
  Retrieve the view engine
  
  retrieve view engine

<comment>Return:</comment>
  <info>Yaf_View_Interface</info>  


id: Yaf_Controller_Abstract::getViewpath
type: function
doc:
<comment>Description:</comment>
  The getViewpath purpose

<comment>Return:</comment>
  <info>string</info>  


id: Yaf_Controller_Abstract::init
type: function
doc:
<comment>Description:</comment>
  Controller initializer
  
  Yaf_Controller_Abstract::__construct is final, which means users can not override it. but users
  can define Yaf_Controller_Abstract::init, which will be called after controller object is
  instantiated.

<comment>Return:</comment>
  <info>void</info>  

<comment>See Also:</comment>
   * Yaf_Controller_Abstract::__construct


id: Yaf_Controller_Abstract::initView
type: function
doc:
<comment>Description:</comment>
  The initView purpose

<comment>Param:</comment>
  <info>array</info>  <strong>$options</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Controller_Abstract::redirect
type: function
doc:
<comment>Description:</comment>
  Redirect to a URL
  
  redirect to a URL by sending a 302 header

<comment>Param:</comment>
  <info>string</info>  <strong>$url</strong>  a location URL

<comment>Return:</comment>
  <info>bool</info>  bool


id: Yaf_Controller_Abstract::render
type: function
doc:
<comment>Description:</comment>
  Render view template

<comment>Param:</comment>
  <info>string</info>  <strong>$tpl</strong>         
  <info>array</info>   <strong>$parameters</strong>  

<comment>Return:</comment>
  <info>string</info>  


id: Yaf_Controller_Abstract::setViewpath
type: function
doc:
<comment>Description:</comment>
  The setViewpath purpose

<comment>Param:</comment>
  <info>string</info>  <strong>$view_directory</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Dispatcher
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_Dispatcher</class> purpose is to initialize  the request environment, route the incoming request, and
  then dispatch any discovered actions; it aggregates any responses and returns them  when the
  process is complete.
  
  <class>Yaf_Dispatcher</class> also implements the Singleton pattern,  meaning only a single instance of it may be
  available at any given time. This allows it to also act as a registry on which the other objects
  in the dispatch process may draw.


id: Yaf_Dispatcher::autoRender
type: function
doc:
<comment>Description:</comment>
  Switch on/off autorendering
  
  <class>Yaf_Dispatcher</class> will render automatically after  dispatches a incoming request, you can prevent the
  rendering by calling this method with <strong>$flag</strong> <info>true</info>  you can simply return <info>false</info> in a action to
  prevent the auto-rendering of that action
  
  you can simply return <info>false</info> in a action to prevent the auto-rendering of that action

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  bool  since 2.2.0, if this parameter is not given, then the current state will be
               returned
               
               since 2.2.0, if this parameter is not given, then the current state will be returned

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  


id: Yaf_Dispatcher::catchException
type: function
doc:
<comment>Description:</comment>
  Switch on/off exception catching
  
  While the application.dispatcher.throwException is On(you can also calling to
  Yaf_Dispatcher::throwException(TRUE) to enable it),  Yaf will throw Exception when error occurs
  instead of trigger error.
  
  then if you enable Yaf_Dispatcher::catchException(also can enabled by set
  application.dispatcher.catchException),  all uncaught Exceptions will be caught by
  ErrorController::error if you have defined one.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  bool

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  

<comment>See Also:</comment>
   * Yaf_Dispatcher::throwException
   * Yaf_Dispatcher::setErrorHandler


id: Yaf_Dispatcher::disableView
type: function
doc:
<comment>Description:</comment>
  Disable view rendering
  
  disable view engine, used in some app that user will output by theirself  you can simply return
  <info>false</info> in a action to prevent the auto-rendering of that action
  
  you can simply return <info>false</info> in a action to prevent the auto-rendering of that action

<comment>Return:</comment>
  <info>bool</info>  


id: Yaf_Dispatcher::dispatch
type: function
doc:
<comment>Description:</comment>
  Dispatch a request
  
  This method does the heavy work of the <class>Yaf_Dispatcher</class>. It take a request object.
  
  The dispatch process has three distinct events: RoutingDispatchingResponse Routing takes place
  exactly once, using the values in the request object when <strong>Yaf_Dispatcher::dispatch()</strong> is called.
  Dispatching takes place in a loop; a request may either indicate multiple actions to dispatch, or
  the controller or a plugin may reset the request object to force additional actions to
  dispatch(see <class>Yaf_Plugin_Abstract</class>. When all is done, the  <class>Yaf_Dispatcher</class> returns a response.

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>  <strong>$request</strong>  

<comment>Return:</comment>
  <info>Yaf_Response_Abstract</info>  


id: Yaf_Dispatcher::enableView
type: function
doc:
<comment>Description:</comment>
  Enable view rendering

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  


id: Yaf_Dispatcher::flushInstantly
type: function
doc:
<comment>Description:</comment>
  Switch on/off the instant flushing

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  bool  since 2.2.0, if this parameter is not given, then the current state will be
               returned
               
               since 2.2.0, if this parameter is not given, then the current state will be returned

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  


id: Yaf_Dispatcher::getApplication
type: function
doc:
<comment>Description:</comment>
  Retrieve the application
  
  Retrieve the <class>Yaf_Application</class> instance. same as Yaf_Application::app.

<comment>Return:</comment>
  <info>Yaf_Application</info>  

<comment>See Also:</comment>
   * Yaf_Application::app


id: Yaf_Dispatcher::getDefaultAction
type: function
doc:
<comment>Description:</comment>
  Retrive the default action name
  
  get the default action name

<comment>Return:</comment>
  <info>string</info>  <info>string</info>, default action name, default is "index"


id: Yaf_Dispatcher::getDefaultController
type: function
doc:
<comment>Description:</comment>
  Retrive the default controller name
  
  get the default controller name

<comment>Return:</comment>
  <info>string</info>  <info>string</info>, default controller name, default is "Index"


id: Yaf_Dispatcher::getDefaultModule
type: function
doc:
<comment>Description:</comment>
  Retrive the default module name
  
  get the default module name

<comment>Return:</comment>
  <info>string</info>  <info>string</info>, module name, default is "Index"


id: Yaf_Dispatcher::getInstance
type: function
doc:
<comment>Description:</comment>
  Retrive the dispatcher instance

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  


id: Yaf_Dispatcher::getRequest
type: function
doc:
<comment>Description:</comment>
  Retrive the request instance

<comment>Return:</comment>
  <info>Yaf_Request_Abstract</info>  


id: Yaf_Dispatcher::getRouter
type: function
doc:
<comment>Description:</comment>
  Retrive router instance

<comment>Return:</comment>
  <info>Yaf_Router</info>  


id: Yaf_Dispatcher::initView
type: function
doc:
<comment>Description:</comment>
  Initialize view and return it

<comment>Param:</comment>
  <info>string</info>  <strong>$templates_dir</strong>  
  <info>array</info>   <strong>$options</strong>        

<comment>Return:</comment>
  <info>Yaf_View_Interface</info>  


id: Yaf_Dispatcher::registerPlugin
type: function
doc:
<comment>Description:</comment>
  Register a plugin
  
  Register a plugin(see <class>Yaf_Plugin_Abstract</class>). Generally, we register plugins in Bootstrap(see
  <class>Yaf_Bootstrap_Abstract</class>).

<comment>Param:</comment>
  <info>Yaf_Plugin_Abstract</info>  <strong>$plugin</strong>  

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  

<comment>See Also:</comment>
   * <class>Yaf_Plugin_Abstract</class>
   * <class>Yaf_Bootstrap_Abstract</class>


id: Yaf_Dispatcher::returnResponse
type: function
doc:
<comment>Description:</comment>
  The returnResponse purpose

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  


id: Yaf_Dispatcher::setDefaultAction
type: function
doc:
<comment>Description:</comment>
  Change default action name

<comment>Param:</comment>
  <info>string</info>  <strong>$action</strong>  

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  


id: Yaf_Dispatcher::setDefaultController
type: function
doc:
<comment>Description:</comment>
  Change default controller name

<comment>Param:</comment>
  <info>string</info>  <strong>$controller</strong>  

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  


id: Yaf_Dispatcher::setDefaultModule
type: function
doc:
<comment>Description:</comment>
  Change default module name

<comment>Param:</comment>
  <info>string</info>  <strong>$module</strong>  

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  


id: Yaf_Dispatcher::setErrorHandler
type: function
doc:
<comment>Description:</comment>
  Set error handler
  
  Set error handler for Yaf. when application.dispatcher.throwException is off, Yaf will trigger
  catchable error while unexpected errors occurred.
  
  Thus, this error handler will be called while the error raise.

<comment>Param:</comment>
  <info>call</info>  <strong>$callback</strong>     A callable callback
  <info>int</info>   <strong>$error_types</strong>  

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  

<comment>See Also:</comment>
   * Yaf_Dispatcher::throwException
   * Yaf_Application::getLastErrorNo
   * Yaf_Application::getLastErrorMsg


id: Yaf_Dispatcher::setRequest
type: function
doc:
<comment>Description:</comment>
  The setRequest purpose

<comment>Param:</comment>
  <info></info>  <strong>$plugin</strong>  

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  


id: Yaf_Dispatcher::setView
type: function
doc:
<comment>Description:</comment>
  Set a custom view engine
  
  This method provides a solution if you want use a custom view engine instead of <class>Yaf_View_Simple</class>

<comment>Param:</comment>
  <info>Yaf_View_Interface</info>  <strong>$view</strong>  A <class>Yaf_View_Interface</class> instance

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  

<comment>See Also:</comment>
   * <class>Yaf_View_Interface</class>
   * <class>Yaf_View_Simple</class>


id: Yaf_Dispatcher::throwException
type: function
doc:
<comment>Description:</comment>
  Switch on/off exception throwing
  
  Switch on/off exception throwing while unexpected error occurring. When this is on, Yaf will
  throwing exceptions instead of triggering catchable errors.
  
  You can also use  application.dispatcher.throwException to achieve the  same purpose.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  bool

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  

<comment>See Also:</comment>
   * Yaf_Dispatcher::catchException
   * <class>Yaf_Exception</class>


id: Yaf_Exception::__construct
type: function
doc:
<comment>Description:</comment>
  The __construct purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.


id: Yaf_Exception::getPrevious
type: function
doc:
<comment>Description:</comment>
  The getPrevious purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Loader
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_Loader</class> introduces a comprehensive autoloading solution for Yaf.
  
  The first time an instance of <class>Yaf_Application</class> is retrieved,  <class>Yaf_Loader</class> will instance a singleton,
  and registers itself with spl_autoload.  You retrieve an instance using the
  Yaf_Loader::getInstance
  
  <class>Yaf_Loader</class> attempt to load a class only one shot, if failed, depend on yaf.use_spl_auload, if this
  config is On Yaf_Loader::autoload will return  <info>false</info>, thus give the chance to other autoload
  function. if it is Off  (by default), Yaf_Loader::autoload will return  <info>true</info>, and more important
  is that a very useful warning will be triggered  (very useful to find out why a class could not be
  loaded).   Please keep yaf.use_spl_autoload Off unless there is some library have their own
  autoload mechanism and impossible to rewrite it.
  
  Please keep yaf.use_spl_autoload Off unless there is some library have their own autoload
  mechanism and impossible to rewrite it.
  
  By default, <class>Yaf_Loader</class> assume all library (class defined script) store in the global library
  directory, which is defined in the php.ini(yaf.library).
  
  If you want <class>Yaf_Loader</class> search some classes(libraries) in the local class directory(which is
  defined in application.ini, and by default, it is application.directory . "/library"),  you should
  register the class prefix using the Yaf_Loader::registerLocalNameSpace
  
  Let's see some examples(assuming APPLICATION_PATH is application.directory): Config example
   Assuming the following local name space is registered: Register
  localnamespaceregisterLocalNameSpace(array("Foo", "Bar")); }
  ?>
  ]]>
   Then the autoload examples: Load class example // APPLICATION_PATH/library/Foo/Bar/Test.php 
  class GLO_Name  => // /global_dir/Glo/Name.php 
  class BarNon_Test // /global_dir/Barnon/Test.php
  ]]>
   Load namespace class example // APPLICATION_PATH/library/Foo/Bar/Dummy.php
  
  class \FooBar\Bar\Dummy => // /global_dir/FooBar/Bar/Dummy.php
  ]]>
  
  You may noticed that all the folder with the first letter capitalized, you can make them lowercase
  by set yaf.lowcase_path = On in php.ini
  
  <class>Yaf_Loader</class> is also designed to load the MVC classes, and the rule is: MVC class loading example
  // APPLICATION_PATH/controllers/
  
  Model Classes =>
  // APPLICATION_PATH/models/
  
  Plugin Classes =>
  // APPLICATION_PATH/plugins/
  ]]>
   Yaf identify a class's suffix(this is by default, you can also change to the prefix by change the
  configure yaf.name_suffix) to decide whether it is a MVC class: MVC class distinctions //
  ***Controller
  
  Model Classes => // ***Model
  
  Plugin Classes => // ***Plugin
  ]]>
   some examples: MVC loading example // APPLICATION_PATH/models/Data.php
  
  class DummyPlugin => // APPLICATION_PATH/plugins/Dummy.php
  
  class A_B_TestModel => // APPLICATION_PATH/models/A/B/Test.php
  ]]>
    As of 2.1.18, Yaf supports Controllers autoloading for user script side, (which means the
  autoloading triggered by user php script, eg: access a controller static property in Bootstrap or
  Plugins), but autoloader only try to locate controller class script under the default module
  folder, which is "APPLICATION_PATH/controllers/".  also, the directory will be affected by
  yaf.lowcase_path.
  
  As of 2.1.18, Yaf supports Controllers autoloading for user script side, (which means the
  autoloading triggered by user php script, eg: access a controller static property in Bootstrap or
  Plugins), but autoloader only try to locate controller class script under the default module
  folder, which is "APPLICATION_PATH/controllers/".


id: Yaf_Loader::autoload
type: function
doc:
<comment>Description:</comment>
  The autoload purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Loader::clearLocalNamespace
type: function
doc:
<comment>Description:</comment>
  The clearLocalNamespace purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Loader::getInstance
type: function
doc:
<comment>Description:</comment>
  The getInstance purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Loader::getLibraryPath
type: function
doc:
<comment>Description:</comment>
  Get the library path
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>Yaf_Loader</info>  


id: Yaf_Loader::getLocalNamespace
type: function
doc:
<comment>Description:</comment>
  Retrive all register namespaces info
  
  get registered namespaces info

<comment>Return:</comment>
  <info>array</info>  <info>array</info>


id: Yaf_Loader::getNamespacePath
type: function
doc:
<comment>Description:</comment>
  Retieve path of a registered namespace
  
  retrieve path of a registered namespace

<comment>Param:</comment>
  <info></info>  <strong>$namespace</strong>  a string of namespace.

<comment>Return:</comment>
  <info>string</info>  <info>string</info> path, if the namespace is not registered, then <info>null</info> default library will be
          returned


id: Yaf_Loader::import
type: function
doc:
<comment>Description:</comment>
  The import purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Loader::isLocalName
type: function
doc:
<comment>Description:</comment>
  The isLocalName purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Loader::registerLocalNamespace
type: function
doc:
<comment>Description:</comment>
  Register local class prefix
  
  Register local class prefix name, <class>Yaf_Loader</class> search classes in two library directories, the one is
  configured via application.library.directory(in application.ini) which is called local libraray
  directory; the other is configured via yaf.library (in php.ini) which is callled global library
  directory, since it can be shared by many applications in the same server.
  
  When an autloading is trigger, <class>Yaf_Loader</class> will determine which library directory should be
  searched in by exame the prefix name of the missed classname.
   If the prefix name is registered as a localnamespack then look for it in local library directory,
  otherwise look for it in global library directory.  If yaf.library is not configured, then the
  global library directory is assumed to be the local library directory. in that case, all
  autoloading will look for local library directory.
   But if you want your Yaf application be strong, then always register your own classes as local
  classes.
  
  If yaf.library is not configured, then the global library directory is assumed to be the local
  library directory. in that case, all autoloading will look for local library directory.
   But if you want your Yaf application be strong, then always register your own classes as local
  classes.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$prefix</strong>  a string or a array of class name prefix. all class prefix with these prefix will
                  be loaded in local library path.

<comment>Return:</comment>
  <info>void</info>  bool


id: Yaf_Loader::registerNamespace
type: function
doc:
<comment>Description:</comment>
  Register namespace with searching path
  
  Register a namespace with searching path, <class>Yaf_Loader</class> searchs classes under this namespace in path,
  the one is also could be  configureded via  application.library.directory.namespace(in
  application.ini);
  
   Yaf still think underline as folder separator. 
  
  Yaf still think underline as folder separator.

<comment>Param:</comment>
  <info></info>        <strong>$namespace</strong>  a string of namespace, or a array of namespaces with paths.
  <info>string</info>  <strong>$path</strong>       a string of path, it is better to use abosolute path here for performance

<comment>Return:</comment>
  <info>bool</info>  bool


id: Yaf_Loader::setLibraryPath
type: function
doc:
<comment>Description:</comment>
  Change the library path
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>Yaf_Loader</info>  


id: Yaf_Plugin_Abstract
type: class
doc:
<comment>Description:</comment>
  Plugins allow for easy extensibility and customization of the framework.
  
  Plugins are classes. The actual class definition will vary based on the component -- you may need
  to implement this interface, but the fact  remains that the plugin is itself a class.
  
  A plugin could be loaded into Yaf by using Yaf_Dispatcher::registerPlugin,  after registering, All
  the methods which the plugin implemented according to this interface, will be called at the proper
  time.


id: Yaf_Plugin_Abstract::dispatchLoopShutdown
type: function
doc:
<comment>Description:</comment>
  The dispatchLoopShutdown purpose
  
  This is the latest hook in Yaf plugin hook system, if a custom plugin implement this method, then
  it will be called after the dispatch loop finished.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>   <strong>$request</strong>   
  <info>Yaf_Response_Abstract</info>  <strong>$response</strong>  

<comment>Return:</comment>
  <info>void</info>  

<comment>See Also:</comment>
   * Yaf_Plugin_Abstract::routerStartup
   * Yaf_Plugin_Abstract::routerShutdown
   * Yaf_Plugin_Abstract::dispatchLoopStartup
   * Yaf_Plugin_Abstract::preDispatch
   * Yaf_Plugin_Abstract::postDispatch


id: Yaf_Plugin_Abstract::dispatchLoopStartup
type: function
doc:
<comment>Description:</comment>
  Hook before dispatch loop

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>   <strong>$request</strong>   
  <info>Yaf_Response_Abstract</info>  <strong>$response</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Plugin_Abstract::postDispatch
type: function
doc:
<comment>Description:</comment>
  The postDispatch purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>   <strong>$request</strong>   
  <info>Yaf_Response_Abstract</info>  <strong>$response</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Plugin_Abstract::preDispatch
type: function
doc:
<comment>Description:</comment>
  The preDispatch purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>   <strong>$request</strong>   
  <info>Yaf_Response_Abstract</info>  <strong>$response</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Plugin_Abstract::preResponse
type: function
doc:
<comment>Description:</comment>
  The preResponse purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>   <strong>$request</strong>   
  <info>Yaf_Response_Abstract</info>  <strong>$response</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Plugin_Abstract::routerShutdown
type: function
doc:
<comment>Description:</comment>
  The routerShutdown purpose
  
  This hook will be trigged after the route process finished, this hook is usually used for login
  check.

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>   <strong>$request</strong>   
  <info>Yaf_Response_Abstract</info>  <strong>$response</strong>  

<comment>Return:</comment>
  <info>void</info>  

<comment>See Also:</comment>
   * Yaf_Plugin_Abstract::routerStartup
   * Yaf_Plugin_Abstract::dispatchLoopStartup
   * Yaf_Plugin_Abstract::preDispatch
   * Yaf_Plugin_Abstract::postDispatch
   * Yaf_Plugin_Abstract::dispatchLoopShutdown


id: Yaf_Plugin_Abstract::routerStartup
type: function
doc:
<comment>Description:</comment>
  RouterStartup hook
  
  This is the earliest hook in Yaf plugin hook system, if a custom plugin implement this method,
  then it will be called before routing a request.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>   <strong>$request</strong>   
  <info>Yaf_Response_Abstract</info>  <strong>$response</strong>  

<comment>Return:</comment>
  <info>void</info>  

<comment>See Also:</comment>
   * Yaf_Plugin_Abstract::routerShutdown
   * Yaf_Plugin_Abstract::dispatchLoopStartup
   * Yaf_Plugin_Abstract::preDispatch
   * Yaf_Plugin_Abstract::postDispatch
   * Yaf_Plugin_Abstract::dispatchLoopShutdown


id: Yaf_Registry
type: class
doc:
<comment>Description:</comment>
  All methods of <class>Yaf_Registry</class> declared as static, making it unversally accessible. This provides the
  ability to get or set any custom data from anyway in your code as necessary.


id: Yaf_Registry::del
type: function
doc:
<comment>Description:</comment>
  Remove an item from registry
  
  Remove an item from registry

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Registry::get
type: function
doc:
<comment>Description:</comment>
  Retrieve an item from registry
  
  Retrieve an item from registry

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  

<comment>Return:</comment>
  <info>mixed</info>  


id: Yaf_Registry::has
type: function
doc:
<comment>Description:</comment>
  Check whether an item exists
  
  Check whether an item exists

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  

<comment>Return:</comment>
  <info>bool</info>  


id: Yaf_Registry::set
type: function
doc:
<comment>Description:</comment>
  Add an item into registry
  
  Add an item into registry

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   
  <info>string</info>  <strong>$value</strong>  

<comment>Return:</comment>
  <info>bool</info>  


id: Yaf_Request_Abstract::clearParams
type: function
doc:
<comment>Description:</comment>
  Remove all params
  
  Remove all params set by router, or Yaf_Request_Abstract::setParam

<comment>Return:</comment>
  <info>bool</info>  <info>bool</info>

<comment>See Also:</comment>
   * Yaf_Request_Abstract::isHead
   * Yaf_Request_Abstract::isGet
   * Yaf_Request_Abstract::isPost
   * Yaf_Request_Abstract::isPut
   * Yaf_Request_Abstract::isOptions
   * Yaf_Request_Abstract::isXmlHTTPRequest


id: Yaf_Request_Abstract::getActionName
type: function
doc:
<comment>Description:</comment>
  The getActionName purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Request_Abstract::getBaseUri
type: function
doc:
<comment>Description:</comment>
  The getBaseUri purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Request_Abstract::getControllerName
type: function
doc:
<comment>Description:</comment>
  The getControllerName purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Request_Abstract::getEnv
type: function
doc:
<comment>Description:</comment>
  Retrieve ENV varialbe
  
  Retrieve ENV variable

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>     the variable name
  <info>string</info>  <strong>$default</strong>  if this parameter is provide, this will be returned if the varialbe can not be
                    found

<comment>Return:</comment>
  <info>void</info>  Returns string

<comment>See Also:</comment>
   * Yaf_Request_Abstract::getServer
   * Yaf_Request_Abstract::getParam


id: Yaf_Request_Abstract::getException
type: function
doc:
<comment>Description:</comment>
  The getException purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Request_Abstract::getLanguage
type: function
doc:
<comment>Description:</comment>
  Retrieve client's preferred language

<comment>Return:</comment>
  <info>void</info>  Returns a string


id: Yaf_Request_Abstract::getMethod
type: function
doc:
<comment>Description:</comment>
  Retrieve the request method

<comment>Return:</comment>
  <info>string</info>  Return a string, like "POST", "GET" etc.

<comment>See Also:</comment>
   * Yaf_Request_Abstract::isHead
   * Yaf_Request_Abstract::isCli
   * Yaf_Request_Abstract::isPost
   * Yaf_Request_Abstract::isPut
   * Yaf_Request_Abstract::isOptions
   * Yaf_Request_Abstract::isXmlHTTPRequest


id: Yaf_Request_Abstract::getModuleName
type: function
doc:
<comment>Description:</comment>
  The getModuleName purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Request_Abstract::getParam
type: function
doc:
<comment>Description:</comment>
  Retrieve calling parameter

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>     
  <info>string</info>  <strong>$default</strong>  

<comment>Return:</comment>
  <info>mixed</info>  

<comment>See Also:</comment>
   * Yaf_Request_Abstract::setParam


id: Yaf_Request_Abstract::getParams
type: function
doc:
<comment>Description:</comment>
  Retrieve all calling parameters

<comment>Return:</comment>
  <info>array</info>  

<comment>See Also:</comment>
   * Yaf_Request_Abstract::setParam


id: Yaf_Request_Abstract::getRequestUri
type: function
doc:
<comment>Description:</comment>
  The getRequestUri purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Request_Abstract::getServer
type: function
doc:
<comment>Description:</comment>
  Retrieve SERVER variable
  
  Retrieve SERVER variable

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>     the variable name
  <info>string</info>  <strong>$default</strong>  if this parameter is provide, this will be returned if the variable can not be
                    found

<comment>Return:</comment>
  <info>void</info>  

<comment>See Also:</comment>
   * Yaf_Request_Abstract::getParam
   * Yaf_Request_Abstract::getEnv


id: Yaf_Request_Abstract::isCli
type: function
doc:
<comment>Description:</comment>
  Determine if request is CLI request

<comment>Return:</comment>
  <info>bool</info>  bolean

<comment>See Also:</comment>
   * Yaf_Request_Abstract::isHead
   * Yaf_Request_Abstract::isGet
   * Yaf_Request_Abstract::isPost
   * Yaf_Request_Abstract::isPut
   * Yaf_Request_Abstract::isOptions
   * Yaf_Request_Abstract::isXmlHTTPRequest


id: Yaf_Request_Abstract::isDispatched
type: function
doc:
<comment>Description:</comment>
  Determin if the request is dispatched

<comment>Return:</comment>
  <info>bool</info>  boolean

<comment>See Also:</comment>
   * Yaf_Dispatcher::dispatch


id: Yaf_Request_Abstract::isGet
type: function
doc:
<comment>Description:</comment>
  Determine if request is GET request

<comment>Return:</comment>
  <info>bool</info>  boolean

<comment>See Also:</comment>
   * Yaf_Request_Abstract::isHead
   * Yaf_Request_Abstract::isCli
   * Yaf_Request_Abstract::isPost
   * Yaf_Request_Abstract::isPut
   * Yaf_Request_Abstract::isOptions
   * Yaf_Request_Abstract::isXmlHTTPRequest


id: Yaf_Request_Abstract::isHead
type: function
doc:
<comment>Description:</comment>
  Determine if request is HEAD request

<comment>Return:</comment>
  <info>bool</info>  boolean

<comment>See Also:</comment>
   * Yaf_Request_Abstract::isGet
   * Yaf_Request_Abstract::isCli
   * Yaf_Request_Abstract::isPost
   * Yaf_Request_Abstract::isPut
   * Yaf_Request_Abstract::isOptions
   * Yaf_Request_Abstract::isXmlHTTPRequest


id: Yaf_Request_Abstract::isOptions
type: function
doc:
<comment>Description:</comment>
  Determine if request is OPTIONS request

<comment>Return:</comment>
  <info>bool</info>  boolean


id: Yaf_Request_Abstract::isPost
type: function
doc:
<comment>Description:</comment>
  Determine if request is POST request

<comment>Return:</comment>
  <info>bool</info>  boolean

<comment>See Also:</comment>
   * Yaf_Request_Abstract::isGet
   * Yaf_Request_Abstract::isCli
   * Yaf_Request_Abstract::isHead
   * Yaf_Request_Abstract::isPut
   * Yaf_Request_Abstract::isOptions
   * Yaf_Request_Abstract::isXmlHTTPRequest


id: Yaf_Request_Abstract::isPut
type: function
doc:
<comment>Description:</comment>
  Determine if request is PUT request

<comment>Return:</comment>
  <info>bool</info>  boolean

<comment>See Also:</comment>
   * Yaf_Request_Abstract::isHead
   * Yaf_Request_Abstract::isCli
   * Yaf_Request_Abstract::isPost
   * Yaf_Request_Abstract::isGet
   * Yaf_Request_Abstract::isOptions
   * Yaf_Request_Abstract::isXmlHTTPRequest


id: Yaf_Request_Abstract::isRouted
type: function
doc:
<comment>Description:</comment>
  Determin if request has been routed

<comment>Return:</comment>
  <info>bool</info>  boolean


id: Yaf_Request_Abstract::isXmlHttpRequest
type: function
doc:
<comment>Description:</comment>
  Determine if request is AJAX request

<comment>Return:</comment>
  <info>bool</info>  boolean

<comment>See Also:</comment>
   * Yaf_Request_Abstract::isHead
   * Yaf_Request_Abstract::isCli
   * Yaf_Request_Abstract::isPost
   * Yaf_Request_Abstract::isPut
   * Yaf_Request_Abstract::isOptions
   * Yaf_Request_Abstract::isGet


id: Yaf_Request_Abstract::setActionName
type: function
doc:
<comment>Description:</comment>
  Set action name
  
  set action name to request, this is usually used by custom router to set route result controller
  name.

<comment>Param:</comment>
  <info>string</info>  <strong>$action</strong>       <info>string</info>, action name, it should in lower case style, like "index" or
                        "foo_bar"
  <info>bool</info>    <strong>$format_name</strong>  this is introduced in Yaf 3.2.0, by default Yaf will format the name into
                        lower case style, if this is set to <info>false</info> , Yaf will set the original name
                        to request.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Request_Abstract::setBaseUri
type: function
doc:
<comment>Description:</comment>
  Set base URI
  
  Set base URI, base URI is used when doing routing, in routing phase request URI is used to route a
  request,  while base URI is used to skip the leadding part(base URI) of request URI.
   That is, if comes a request with request URI a/b/c, then if you set base URI to "a/b", only "/c"
  will be used in routing phase.  generally, you don't need to set this, Yaf will determine it
  automatically.
  
  generally, you don't need to set this, Yaf will determine it automatically.

<comment>Param:</comment>
  <info>string</info>  <strong>$uir</strong>  base URI

<comment>Return:</comment>
  <info>bool</info>  bool


id: Yaf_Request_Abstract::setControllerName
type: function
doc:
<comment>Description:</comment>
  Set controller name
  
  set controller name to request, this is usually used by custom router to set route result
  controller name.

<comment>Param:</comment>
  <info>string</info>  <strong>$controller</strong>   <info>string</info>, controller name, this should be in camel style, like "Index" or
                        "Foo_Bar"
  <info>bool</info>    <strong>$format_name</strong>  this is introduced in Yaf 3.2.0, by default Yaf will format the name into
                        camel mode, if this is set to <info>false</info> , Yaf will set the original name to
                        request.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Request_Abstract::setDispatched
type: function
doc:
<comment>Description:</comment>
  The setDispatched purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Request_Abstract::setModuleName
type: function
doc:
<comment>Description:</comment>
  Set module name
  
  set module name to request, this is usually used by custom router to set route result module name.

<comment>Param:</comment>
  <info>string</info>  <strong>$module</strong>       <info>string</info> module name, it should be in camel style, like "Index" or "Foo_Bar"
  <info>bool</info>    <strong>$format_name</strong>  this is introduced in Yaf 3.2.0, by default Yaf will format the name into
                        camel mode, if this is set to <info>false</info> , Yaf will set the original name to
                        request.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Request_Abstract::setParam
type: function
doc:
<comment>Description:</comment>
  Set a calling parameter to a request
  
  Set a parameter to request, which can be retrieved by Yaf_Request_Abstract::getParam

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   
  <info>string</info>  <strong>$value</strong>  

<comment>Return:</comment>
  <info>bool</info>  

<comment>See Also:</comment>
   * Yaf_Request_Abstract::getParam
   * Yaf_Request_Abstract::getParams


id: Yaf_Request_Abstract::setRequestUri
type: function
doc:
<comment>Description:</comment>
  The setRequestUri purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$uir</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Request_Abstract::setRouted
type: function
doc:
<comment>Description:</comment>
  The setRouted purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$flag</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Request_Http
type: class
doc:
<comment>Description:</comment>
  Any request from client is initialized as a <class>Yaf_Request_Http</class>. you can get the request information
  like, uri query and  post parameters via methods of this class.  For security, $_GET/$_POST are
  readonly in Yaf, which means if you set a value to these global variables, you can not get it from
  Yaf_Request_Http::getQuery or Yaf_Request_Http::getPost.   But there do is some usage need such
  feature, like unit testing. thus Yaf can be built with --enable-yaf-debug, which will allow Yaf
  read the value user set via script.  in such case, Yaf will throw a E_STRICT warning to remind you
  about that:  Strict Standards: you are running yaf in debug mode
  
  For security, $_GET/$_POST are readonly in Yaf, which means if you set a value to these global
  variables, you can not get it from Yaf_Request_Http::getQuery or Yaf_Request_Http::getPost.
  
  But there do is some usage need such feature, like unit testing. thus Yaf can be built with
  --enable-yaf-debug, which will allow Yaf read the value user set via script.
  
  in such case, Yaf will throw a E_STRICT warning to remind you about that:  Strict Standards: you
  are running yaf in debug mode


id: Yaf_Request_Http::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor of Yaf_Request_Http
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.


id: Yaf_Request_Http::get
type: function
doc:
<comment>Description:</comment>
  Retrieve variable from client
  
  Retrieve variable from client, this method will search the <strong>$name</strong> in request pramas, if the name is
  not found, then will search in POST, GET, Cookie, Server

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>     the variable name
  <info>string</info>  <strong>$default</strong>  if this parameter is provide, this will be returned if the varialbe can not be
                    found

<comment>Return:</comment>
  <info>mixed</info>  

<comment>See Also:</comment>
   * Yaf_Request_Http::getQuery
   * Yaf_Request_Http::getPost
   * Yaf_Request_Http::getCookie
   * Yaf_Request_Http::getRaw
   * Yaf_Request_Abstract::getServer
   * Yaf_Request_Abstract::getParam


id: Yaf_Request_Http::getCookie
type: function
doc:
<comment>Description:</comment>
  Retrieve Cookie variable
  
  Retrieve Cookie variable

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>     the cookie name
  <info>string</info>  <strong>$default</strong>  if this parameter is provide, this will be returned if the cookie can not be
                    found

<comment>Return:</comment>
  <info>mixed</info>  

<comment>See Also:</comment>
   * Yaf_Request_Http::get
   * Yaf_Request_Http::getQuery
   * Yaf_Request_Http::getPost
   * Yaf_Request_Http::getRaw
   * Yaf_Request_Abstract::getServer
   * Yaf_Request_Abstract::getParam


id: Yaf_Request_Http::getFiles
type: function
doc:
<comment>Description:</comment>
  The getFiles purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Request_Http::getPost
type: function
doc:
<comment>Description:</comment>
  Retrieve POST variable
  
  Retrieve POST variable

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>     the variable name
  <info>string</info>  <strong>$default</strong>  if this parameter is provide, this will be returned if the varialbe can not be
                    found

<comment>Return:</comment>
  <info>mixed</info>  

<comment>See Also:</comment>
   * Yaf_Request_Http::get
   * Yaf_Request_Http::getQuery
   * Yaf_Request_Http::getCookie
   * Yaf_Request_Http::getRaw
   * Yaf_Request_Abstract::getServer
   * Yaf_Request_Abstract::getParam


id: Yaf_Request_Http::getQuery
type: function
doc:
<comment>Description:</comment>
  Fetch a query parameter
  
  Retrieve GET variable

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>     the variable name
  <info>string</info>  <strong>$default</strong>  if this parameter is provide, this will be returned if the variable can not be
                    found

<comment>Return:</comment>
  <info>mixed</info>  

<comment>See Also:</comment>
   * Yaf_Request_Http::get
   * Yaf_Request_Http::getPost
   * Yaf_Request_Http::getCookie
   * Yaf_Request_Http::getRaw
   * Yaf_Request_Abstract::getServer
   * Yaf_Request_Abstract::getParam


id: Yaf_Request_Http::getRaw
type: function
doc:
<comment>Description:</comment>
  Retrieve Raw request body
  
  Retrieve Raw request body

<comment>Return:</comment>
  <info>mixed</info>  Return string on success, FALSE on failure.

<comment>See Also:</comment>
   * Yaf_Request_Http::get
   * Yaf_Request_Http::getPost
   * Yaf_Request_Http::getCookie
   * Yaf_Request_Http::getQuery
   * Yaf_Request_Abstract::getServer
   * Yaf_Request_Abstract::getParam


id: Yaf_Request_Http::getRequest
type: function
doc:
<comment>Description:</comment>
  The getRequest purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Request_Http::isXmlHttpRequest
type: function
doc:
<comment>Description:</comment>
  Determin if request is Ajax Request
  
  Check the request whether it is a Ajax Request.  This method depends on the request header:
  HTTP_X_REQUESTED_WITH, some Javascript library doesn't set this header while doing Ajax request
  
  This method depends on the request header: HTTP_X_REQUESTED_WITH, some Javascript library doesn't
  set this header while doing Ajax request

<comment>Return:</comment>
  <info>bool</info>  boolean


id: Yaf_Request_Simple
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_Request_Simple</class> is particularlly used for test puporse. ie. simulate some espacial request
  under CLI mode.


id: Yaf_Request_Simple::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor of Yaf_Request_Simple
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.


id: Yaf_Request_Simple::get
type: function
doc:
<comment>Description:</comment>
  The get purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Request_Simple::getCookie
type: function
doc:
<comment>Description:</comment>
  The getCookie purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Request_Simple::getPost
type: function
doc:
<comment>Description:</comment>
  The getPost purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Request_Simple::getQuery
type: function
doc:
<comment>Description:</comment>
  The getQuery purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Request_Simple::isXmlHttpRequest
type: function
doc:
<comment>Description:</comment>
  Determin if request is AJAX request

<comment>Return:</comment>
  <info>void</info>  Always returns false for <class>Yaf_Request_Simple</class>

<comment>See Also:</comment>
   * Yaf_Request_Abstract::isXmlHTTPRequest
   * Yaf_Request_Http::isXmlHTTPRequest


id: Yaf_Response_Abstract::__destruct
type: function
doc:
<comment>Description:</comment>
  The __destruct purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.


id: Yaf_Response_Abstract::__toString
type: function
doc:
<comment>Description:</comment>
  Retrieve all bodys as string

<comment>Return:</comment>
  <info>string</info>  


id: Yaf_Response_Abstract::appendBody
type: function
doc:
<comment>Description:</comment>
  Append to response body
  
  Append a content to a exists content block

<comment>Param:</comment>
  <info></info>        <strong>$body</strong>  content string
  <info>string</info>  <strong>$key</strong>   the content key, you can set a content with a key, if you don't specific, then
                 Yaf_Response_Abstract::DEFAULT_BODY will be used  this parameter is introduced as
                 of 2.2.0
                 
                 this parameter is introduced as of 2.2.0

<comment>Return:</comment>
  <info>bool</info>  bool

<comment>See Also:</comment>
   * <class>Yaf_Config_Ini</class>
   * Yaf_Response_Abstract::getBody
   * Yaf_Response_Abstract::setBody
   * Yaf_Response_Abstract::prependBody
   * Yaf_Response_Abstract::clearBody


id: Yaf_Response_Abstract::clearBody
type: function
doc:
<comment>Description:</comment>
  Discard all exists response body
  
  Clear existsed content

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  the content key, if you don't specific, then all contents will be cleared.  this
                parameter is introduced as of 2.2.0
                
                this parameter is introduced as of 2.2.0

<comment>Return:</comment>
  <info>bool</info>  

<comment>See Also:</comment>
   * Yaf_Response_Abstract::setBody
   * Yaf_Response_Abstract::appendBody
   * Yaf_Response_Abstract::prependBody
   * Yaf_Response_Abstract::getBody


id: Yaf_Response_Abstract::clearHeaders
type: function
doc:
<comment>Description:</comment>
  Discard all set headers

<comment>Return:</comment>
  <info>void</info>  

<comment>See Also:</comment>
   * Yaf_Response_Abstract::getHeader
   * Yaf_Response_Abstract::setHeader


id: Yaf_Response_Abstract::getBody
type: function
doc:
<comment>Description:</comment>
  Retrieve a exists content
  
  Retrieve a exists content

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  the content key, if you don't specific, then Yaf_Response_Abstract::DEFAULT_BODY
                will be used. if you pass in a <info>null</info>, then all contents will be returned as a array
                this parameter is introduced as of 2.2.0
                
                this parameter is introduced as of 2.2.0

<comment>Return:</comment>
  <info>mixed</info>  

<comment>See Also:</comment>
   * Yaf_Response_Abstract::setBody
   * Yaf_Response_Abstract::appendBody
   * Yaf_Response_Abstract::prependBody
   * Yaf_Response_Abstract::clearBody


id: Yaf_Response_Abstract::getHeader
type: function
doc:
<comment>Description:</comment>
  The getHeader purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  

<comment>See Also:</comment>
   * Yaf_Response_Abstract::setHeader
   * Yaf_Response_Abstract::cleanHeaders


id: Yaf_Response_Abstract::prependBody
type: function
doc:
<comment>Description:</comment>
  The prependBody purpose
  
  prepend a content to a exists content block

<comment>Param:</comment>
  <info></info>        <strong>$body</strong>  content string
  <info>string</info>  <strong>$key</strong>   the content key, you can set a content with a key, if you don't specific, then
                 Yaf_Response_Abstract::DEFAULT_BODY will be used  this parameter is introduced as
                 of 2.2.0
                 
                 this parameter is introduced as of 2.2.0

<comment>Return:</comment>
  <info>bool</info>  bool

<comment>See Also:</comment>
   * Yaf_Response_Abstract::getBody
   * Yaf_Response_Abstract::setBody
   * Yaf_Response_Abstract::appendBody
   * Yaf_Response_Abstract::clearBody


id: Yaf_Response_Abstract::response
type: function
doc:
<comment>Description:</comment>
  Send response
  
  send response

<comment>Return:</comment>
  <info>void</info>  

<comment>See Also:</comment>
   * Yaf_Response_Abstract::setBody
   * Yaf_Response_Abstract::clearBody


id: Yaf_Response_Abstract::setAllHeaders
type: function
doc:
<comment>Description:</comment>
  The setAllHeaders purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Response_Abstract::setBody
type: function
doc:
<comment>Description:</comment>
  Set content to response
  
  Set content to response

<comment>Param:</comment>
  <info></info>        <strong>$body</strong>  content string
  <info>string</info>  <strong>$key</strong>   the content key, you can set a content with a key, if you don't specific, then
                 Yaf_Response_Abstract::DEFAULT_BODY will be used  this parameter is introduced as
                 of 2.2.0
                 
                 this parameter is introduced as of 2.2.0

<comment>Return:</comment>
  <info>bool</info>  

<comment>See Also:</comment>
   * Yaf_Response_Abstract::getBody
   * Yaf_Response_Abstract::appendBody
   * Yaf_Response_Abstract::prependBody
   * Yaf_Response_Abstract::clearBody


id: Yaf_Response_Abstract::setHeader
type: function
doc:
<comment>Description:</comment>
  Set reponse header
  
  Used to send a HTTP header

<comment>Return:</comment>
  <info>bool</info>  

<comment>See Also:</comment>
   * Yaf_Response_Abstract::getHeader
   * Yaf_Response_Abstract::cleanHeaders


id: Yaf_Response_Abstract::setRedirect
type: function
doc:
<comment>Description:</comment>
  The setRedirect purpose

<comment>Param:</comment>
  <info>string</info>  <strong>$url</strong>  address redircted to

<comment>Return:</comment>
  <info>bool</info>  


id: Yaf_Route_Interface
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_Route_Interface</class> used for developer defined their custom route.


id: Yaf_Route_Interface::assemble
type: function
doc:
<comment>Description:</comment>
  Assemble a request
  
  this method returns a url according to the argument info, and append query strings to the url
  according to the argument query.
  
  a route should implement this method according to its own route rules, and do a reverse progress.

<comment>Param:</comment>
  <info>array</info>  <strong>$info</strong>   
  <info>array</info>  <strong>$query</strong>  

<comment>Return:</comment>
  <info>string</info>  


id: Yaf_Route_Interface::route
type: function
doc:
<comment>Description:</comment>
  Route a request
  
  Yaf_Route_Interface::route is the only method that a custom route should implement.  since of
  2.3.0, there is another method should also be implemented, see Yaf_Route_Interface::assemble.
  
  since of 2.3.0, there is another method should also be implemented, see
  Yaf_Route_Interface::assemble.
  
  if this method return <info>true</info>, then the route process will be end. otherwise, <class>Yaf_Router</class> will call
  next route in the route stack to route request.
  
  This method would set the route result to the parameter request, by calling
  Yaf_Request_Abstract::setControllerName, Yaf_Request_Abstract::setActionName and
  Yaf_Request_Abstract::setModuleName.
  
  This method should also call Yaf_Request_Abstract::setRouted to make the request routed at last.

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>  <strong>$request</strong>  A <class>Yaf_Request_Abstract</class> instance.

<comment>Return:</comment>
  <info>bool</info>  


id: Yaf_Route_Map
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_Route_Map</class> is a built-in route, it simply convert a URI endpoint (that part of the URI which
  comes after the base URI: see Yaf_Request_Abstract::setBaseUri) to a controller name or action
  name(depends on the parameter passed to Yaf_Route_Map::__construct) in following rule: A =&gt;
  controller A. A/B/C =&gt; controller A_B_C. A/B/C/D/E =&gt; controller A_B_C_D_E.
  
  If the second parameter of Yaf_Route_Map::__construct is specified, then only the part before
  delimiter of URI will used to routing, the part after it is used to routing request parameters
  (see the example section of Yaf_Route_Map::__construct).


id: Yaf_Route_Map::__construct
type: function
doc:
<comment>Description:</comment>
  The __construct purpose

<comment>Param:</comment>
  <info>string</info>  <strong>$controller_prefer</strong>  Whether the result should considering as controller or action
  <info>string</info>  <strong>$delimiter</strong>          

<comment>See Also:</comment>
   * Yaf_Router::addRoute
   * <class>Yaf_Route_Static</class>
   * <class>Yaf_Route_Supervar</class>
   * <class>Yaf_Route_Simple</class>
   * <class>Yaf_Route_Regex</class>
   * <class>Yaf_Route_Rewrite</class>


id: Yaf_Route_Map::assemble
type: function
doc:
<comment>Description:</comment>
  Assemble a url
  
  Assemble a url.

<comment>Param:</comment>
  <info>array</info>  <strong>$info</strong>   
  <info>array</info>  <strong>$query</strong>  

<comment>Return:</comment>
  <info>string</info>  Returns <info>string</info> on success or <info>null</info> on failure.


id: Yaf_Route_Map::route
type: function
doc:
<comment>Description:</comment>
  The route purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>  <strong>$request</strong>  

<comment>Return:</comment>
  <info>bool</info>  


id: Yaf_Route_Regex
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_Route_Regex</class> is the most flexible route among the Yaf built-in routes.


id: Yaf_Route_Regex::__construct
type: function
doc:
<comment>Description:</comment>
  Yaf_Route_Regex constructor

<comment>Param:</comment>
  <info>string</info>  <strong>$match</strong>    A complete Regex pattern, will be used to match a request uri, if doesn't
                    matched, <class>Yaf_Route_Regex</class> will return <info>false</info>.
  <info>array</info>   <strong>$route</strong>    When the match pattern matches the request uri, <class>Yaf_Route_Regex</class> will use this to
                    decide which m/c/a to routed.
                    
                    either of m/c/a in this array is optianl, if you don't assgian a specific value,
                    it will be routed to default.
  <info>array</info>   <strong>$map</strong>      A array to assign name to the captrues in the match result.
  <info>array</info>   <strong>$verify</strong>   
  <info>string</info>  <strong>$reverse</strong>  a string, used to assemble url, see Yaf_Route_Regex::assemble.  this parameter
                    is introduced in 2.3.0
                    
                    this parameter is introduced in 2.3.0

<comment>See Also:</comment>
   * Yaf_Router::addRoute
   * Yaf_Router::addConfig
   * <class>Yaf_Route_Static</class>
   * <class>Yaf_Route_Supervar</class>
   * <class>Yaf_Route_Simple</class>
   * <class>Yaf_Route_Rewrite</class>
   * <class>Yaf_Route_Map</class>


id: Yaf_Route_Regex::assemble
type: function
doc:
<comment>Description:</comment>
  Assemble a url
  
  Assemble a url.

<comment>Param:</comment>
  <info>array</info>  <strong>$info</strong>   
  <info>array</info>  <strong>$query</strong>  

<comment>Return:</comment>
  <info>string|null</info>  Returns <info>string</info> on success or <info>null</info> on failure.


id: Yaf_Route_Regex::route
type: function
doc:
<comment>Description:</comment>
  The route purpose
  
  Route a incoming request.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>  <strong>$request</strong>  

<comment>Return:</comment>
  <info>bool</info>  If the pattern given by the first parameter of  Yaf_Route_Regex::_construct matche the
        request uri, return <info>true</info>, otherwise return <info>false</info>.


id: Yaf_Route_Rewrite
type: class
doc:
<comment>Description:</comment>
  For usage, please see the example section of Yaf_Route_Rewrite::__construct


id: Yaf_Route_Rewrite::__construct
type: function
doc:
<comment>Description:</comment>
  Yaf_Route_Rewrite constructor

<comment>Param:</comment>
  <info>string</info>  <strong>$match</strong>   A pattern, will be used to match a request uri, if it doesn't match,
                   <class>Yaf_Route_Rewrite</class> will return <info>false</info>.
                   
                   You can use :name style to name segments matched, and use * to match the rest of
                   the URL segments.
  <info>array</info>   <strong>$route</strong>   When the match pattern matches the request uri, <class>Yaf_Route_Rewrite</class> will use this
                   to decide which module/controller/action is the destination.
                   
                   Either of module/controller/action in this array is optional, if you don't assign
                   a specific value, it will be routed to default.
  <info>array</info>   <strong>$verify</strong>  

<comment>See Also:</comment>
   * Yaf_Router::addRoute
   * Yaf_Router::addConfig
   * <class>Yaf_Route_Static</class>
   * <class>Yaf_Route_Supervar</class>
   * <class>Yaf_Route_Simple</class>
   * <class>Yaf_Route_Regex</class>
   * <class>Yaf_Route_Map</class>


id: Yaf_Route_Rewrite::assemble
type: function
doc:
<comment>Description:</comment>
  Assemble a url
  
  Assemble a url.

<comment>Param:</comment>
  <info>array</info>  <strong>$info</strong>   
  <info>array</info>  <strong>$query</strong>  

<comment>Return:</comment>
  <info>string</info>  Returns <info>string</info>.


id: Yaf_Route_Rewrite::route
type: function
doc:
<comment>Description:</comment>
  The route purpose

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>  <strong>$request</strong>  

<comment>Return:</comment>
  <info>bool</info>  


id: Yaf_Route_Simple
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_Route_Simple</class> will match the query string, and find the route info.
  
  all you need to do is tell <class>Yaf_Route_Simple</class> what key in the $_GET is module, what key is
  controller, and what key is action.
  
  Yaf_Route_Simple::route will always return <info>true</info>, so it is important put <class>Yaf_Route_Simple</class> in the
  front of the Route stack, otherwise all the other routes will not be called.


id: Yaf_Route_Simple::__construct
type: function
doc:
<comment>Description:</comment>
  Yaf_Route_Simple constructor
  
  <class>Yaf_Route_Simple</class> will get route info from query string. and the parameters of this constructor
  will used as keys while searching for the route info in $_GET.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$module_name</strong>      The key name of the module info.
  <info>string</info>  <strong>$controller_name</strong>  the key name of the controller info.
  <info>string</info>  <strong>$action_name</strong>      the key name of the action info.

<comment>Return:</comment>
  <info>unknown</info>  Always return <info>true</info>.

<comment>See Also:</comment>
   * Yaf_Route_Supervar::route
   * Yaf_Route_Static::route
   * Yaf_Route_Regex::route
   * Yaf_Route_Rewrite::route
   * Yaf_Route_Map::route


id: Yaf_Route_Simple::assemble
type: function
doc:
<comment>Description:</comment>
  Assemble a url
  
  Assemble a url.

<comment>Param:</comment>
  <info>array</info>  <strong>$info</strong>   
  <info>array</info>  <strong>$query</strong>  

<comment>Return:</comment>
  <info>string</info>  Returns a <info>string</info>.


id: Yaf_Route_Simple::route
type: function
doc:
<comment>Description:</comment>
  Route a request
  
  see Yaf_Route_Simple::__construct
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>  <strong>$request</strong>  

<comment>Return:</comment>
  <info>bool</info>  always be <info>true</info>

<comment>See Also:</comment>
   * Yaf_Route_Supervar::route
   * Yaf_Route_Static::route
   * Yaf_Route_Regex::route
   * Yaf_Route_Rewrite::route
   * Yaf_Route_Map::route


id: Yaf_Route_Static
type: class
doc:
<comment>Description:</comment>
  Defaultly, <class>Yaf_Router</class> only have a <class>Yaf_Route_Static</class> as its default route.
  
  And <class>Yaf_Route_Static</class> is designed to handle the 80% requirement.
  
  please *NOTE* that it is unnecessary to instance a <class>Yaf_Route_Static</class>, also  unecesary to add it
  into <class>Yaf_Router</class>'s routes stack, since there is always be one in <class>Yaf_Router</class>'s routes stack, and
  always be called at the last time.


id: Yaf_Route_Static::match
type: function
doc:
<comment>Description:</comment>
  The match purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$uri</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Route_Static::route
type: function
doc:
<comment>Description:</comment>
  Route a request
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>  <strong>$request</strong>  

<comment>Return:</comment>
  <info>bool</info>  always be <info>true</info>

<comment>See Also:</comment>
   * Yaf_Route_Supervar::route
   * Yaf_Route_Simple::route
   * Yaf_Route_Regex::route
   * Yaf_Route_Rewrite::route
   * Yaf_Route_Map::route


id: Yaf_Route_Supervar::__construct
type: function
doc:
<comment>Description:</comment>
  The __construct purpose
  
  <class>Yaf_Route_Supervar</class> is similar with <class>Yaf_Route_Static</class>, the difference is <class>Yaf_Route_Supervar</class> will
  look for path info in query string, and the parameter supervar_name is the key.

<comment>Param:</comment>
  <info>string</info>  <strong>$supervar_name</strong>  The name of key.

<comment>See Also:</comment>
   * Yaf_Router::addRoute
   * Yaf_Router::addConfig
   * <class>Yaf_Route_Static</class>
   * <class>Yaf_Route_Regex</class>
   * <class>Yaf_Route_Simple</class>
   * <class>Yaf_Route_Rewrite</class>
   * <class>Yaf_Route_Map</class>


id: Yaf_Route_Supervar::route
type: function
doc:
<comment>Description:</comment>
  The route purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>  <strong>$request</strong>  

<comment>Return:</comment>
  <info>bool</info>  If there is a key(which was defined in Yaf_Route_Supervar::__construct) in $_GET, return
        <info>true</info>. otherwise return <info>false</info>.


id: Yaf_Router
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_Router</class> is the standard framework router. Routing is the process of taking a URI endpoint (that
  part of the URI which comes after the base URI: see Yaf_Request_Abstract::setBaseUri) and
  decomposing it into parameters to determine which module, controller, and action of that
  controller should receive the request. This values of the module, controller, action and other
  parameters are packaged into a <class>Yaf_Request_Abstract</class> object which is then processed by
  <class>Yaf_Dispatcher</class>. Routing occurs only once: when the request is initially received and before the
  first controller is dispatched.
   <class>Yaf_Router</class> is designed to allow for mod_rewrite-like functionality using pure PHP structures. It
  is very loosely based on Ruby on Rails routing and does not require any prior knowledge of
  webserver URL rewriting. It is designed to work with a single Apache mod_rewrite rule (one of):
  Rewrite rule for Apache or (preferred): Rewrite rule for Apache If using Lighttpd, the following
  rewrite rule is valid: Rewrite rule for Lighttpd "/index.php?$1",
  ".*\.(js|ico|gif|jpg|png|css|html)$" => "$0", "" => "/index.php"
  )
  ]]> If using Nginx, use the following rewrite rule: Rewrite rule for Nginx


id: Yaf_Router::addConfig
type: function
doc:
<comment>Description:</comment>
  Add config-defined routes into Router
  
  Add routes defined by configs into <class>Yaf_Router</class>'s route stack

<comment>Return:</comment>
  <info>bool</info>  An <class>Yaf_Config_Abstract</class> instance, which should contains one or more valid route configs

<comment>See Also:</comment>
   * Yaf_Router::addRoute
   * <class>Yaf_Route_Static</class>
   * <class>Yaf_Route_Supervar</class>
   * <class>Yaf_Route_Simple</class>
   * <class>Yaf_Route_Regex</class>
   * <class>Yaf_Route_Rewrite</class>
   * <class>Yaf_Route_Map</class>


id: Yaf_Router::addRoute
type: function
doc:
<comment>Description:</comment>
  Add new Route into Router
  
  defaultly, Yaf_Router using a <class>Yaf_Route_Static</class> as its defualt route. you can add new routes into
  router's route stack by calling this method.
  
  the newer route will be called before the older(route stack), and if the newer router return <info>true</info>,
  the router process will be end. otherwise, the older one will be called.

<comment>Return:</comment>
  <info>bool</info>  

<comment>See Also:</comment>
   * Yaf_Router::addConfig
   * <class>Yaf_Route_Static</class>
   * <class>Yaf_Route_Supervar</class>
   * <class>Yaf_Route_Simple</class>
   * <class>Yaf_Route_Regex</class>
   * <class>Yaf_Route_Rewrite</class>
   * <class>Yaf_Route_Map</class>


id: Yaf_Router::getCurrentRoute
type: function
doc:
<comment>Description:</comment>
  Get the effective route name
  
  Get the name of the route which is effective in the route process.  You should call this method
  after the route process finished, since before that, this method will always return <info>null</info>.
  
  You should call this method after the route process finished, since before that, this method will
  always return <info>null</info>.

<comment>Return:</comment>
  <info>string</info>  String, the name of the effective route.

<comment>See Also:</comment>
   * <class>Yaf_Bootstrap_Abstract</class>
   * <class>Yaf_Plugin_Abstract</class>
   * Yaf_Router::addRoute


id: Yaf_Router::getRoute
type: function
doc:
<comment>Description:</comment>
  Retrieve a route by name
  
  Retrieve a route by name, see also Yaf_Router::getCurrentRoute

<comment>Return:</comment>
  <info>Yaf_Route_Interface</info>  

<comment>See Also:</comment>
   * <class>Yaf_Bootstrap_Abstract</class>
   * <class>Yaf_Plugin_Abstract</class>
   * Yaf_Router::addRoute
   * Yaf_Router::getCurrentRoute


id: Yaf_Router::getRoutes
type: function
doc:
<comment>Description:</comment>
  Retrieve registered routes
  
  Retrieve registered routes

<comment>Return:</comment>
  <info>mixed</info>  


id: Yaf_Router::route
type: function
doc:
<comment>Description:</comment>
  The route purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>bool</info>  


id: Yaf_Session::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor of Yaf_Session
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.


id: Yaf_Session::__unset
type: function
doc:
<comment>Description:</comment>
  The __unset purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Session::del
type: function
doc:
<comment>Description:</comment>
  The del purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Session::has
type: function
doc:
<comment>Description:</comment>
  The has purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_Session::start
type: function
doc:
<comment>Description:</comment>
  The start purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_View_Interface
type: class
doc:
<comment>Description:</comment>
  Yaf provides a ability for developers to use custom view engine instead of built-in engine which
  is <class>Yaf_View_Simple</class>. There  is a example to explain how to do this, please see
  Yaf_Dispatcher::setView.


id: Yaf_View_Interface::assign
type: function
doc:
<comment>Description:</comment>
  Assign value to View engine
  
  Assigan values to View engine, then the value can access directly by name in template.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   
  <info>string</info>  <strong>$value</strong>  

<comment>Return:</comment>
  <info>bool</info>  


id: Yaf_View_Interface::display
type: function
doc:
<comment>Description:</comment>
  Render and output a template
  
  Render a template and output the result immediately.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$tpl</strong>       
  <info>array</info>   <strong>$tpl_vars</strong>  

<comment>Return:</comment>
  <info>bool</info>  


id: Yaf_View_Interface::getScriptPath
type: function
doc:
<comment>Description:</comment>
  The getScriptPath purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_View_Interface::render
type: function
doc:
<comment>Description:</comment>
  Render a template
  
  Render a template and return the result.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$tpl</strong>       
  <info>array</info>   <strong>$tpl_vars</strong>  

<comment>Return:</comment>
  <info>string</info>  


id: Yaf_View_Interface::setScriptPath
type: function
doc:
<comment>Description:</comment>
  The setScriptPath purpose
  
  Set the templates base directory, this is usually called by <class>Yaf_Dispatcher</class>
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$template_dir</strong>  A absolute path to the template directory, by default, <class>Yaf_Dispatcher</class> use
                         application.directory . "/views" as this paramter.

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_View_Simple
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_View_Simple</class> is the built-in template engine in Yaf, it is a simple but fast template engine,
  and only support PHP script template.


id: Yaf_View_Simple::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor of Yaf_View_Simple

<comment>Param:</comment>
  <info>string</info>  <strong>$template_dir</strong>  The base directory of the templates,  by default,  it is APPLICATOIN .
                         "/views" for Yaf.
  <info>array</info>   <strong>$options</strong>       


id: Yaf_View_Simple::__get
type: function
doc:
<comment>Description:</comment>
  Retrieve assigned variable
  
  Retrieve assigned varaiable  parameter can be empty since 2.1.11 
  
  parameter can be empty since 2.1.11

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  the assigned variable name
                 
                 if this is empty, all assigned variables will be returned

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_View_Simple::__isset
type: function
doc:
<comment>Description:</comment>
  The __isset purpose

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Yaf_View_Simple::__set
type: function
doc:
<comment>Description:</comment>
  Set value to engine
  
  This is a alternative and easier way to  Yaf_View_Simple::assign.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   A string value name.
  <info>mixed</info>   <strong>$value</strong>  Mixed value.

<comment>Return:</comment>
  <info>void</info>  

<comment>See Also:</comment>
   * Yaf_View_Simple::assignRef
   * Yaf_View_Interface::assign


id: Yaf_View_Simple::assign
type: function
doc:
<comment>Description:</comment>
  Assign values
  
  assign variable to view engine

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   A string or an array.
                  
                  if is string, then the next argument $value is required.
  <info>mixed</info>   <strong>$value</strong>  mixed value

<comment>Return:</comment>
  <info>bool</info>  

<comment>See Also:</comment>
   * Yaf_View_Simple::assignRef
   * Yaf_View_Interface::clear
   * Yaf_View_Simple::__set


id: Yaf_View_Simple::assignRef
type: function
doc:
<comment>Description:</comment>
  The assignRef purpose
  
  unlike Yaf_View_Simple::assign, this method assign a ref value to engine.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   A string name which will be used to access the value in the tempalte.
  <info>mixed</info>   <strong>$value</strong>  mixed value

<comment>Return:</comment>
  <info>bool</info>  

<comment>See Also:</comment>
   * Yaf_View_Simple::assign
   * Yaf_View_Simple::__set


id: Yaf_View_Simple::clear
type: function
doc:
<comment>Description:</comment>
  Clear Assigned values
  
  clear assigned variable

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  assigned variable name
                 
                 if empty, will clear all assigned variables

<comment>Return:</comment>
  <info>bool</info>  

<comment>See Also:</comment>
   * Yaf_View_Simple::assignRef
   * Yaf_View_Interface::assign
   * Yaf_View_Simple::__set


id: Yaf_View_Simple::display
type: function
doc:
<comment>Description:</comment>
  Render and display
  
  Render a template and display the result instantly.

<comment>Param:</comment>
  <info>string</info>  <strong>$tpl</strong>       
  <info>array</info>   <strong>$tpl_vars</strong>  

<comment>Return:</comment>
  <info>bool</info>  


id: Yaf_View_Simple::eval
type: function
doc:
<comment>Description:</comment>
  Render template
  
  Render a string tempalte and return the result.

<comment>Param:</comment>
  <info>string</info>  <strong>$tpl_content</strong>  string template
  <info>array</info>   <strong>$tpl_vars</strong>     

<comment>Return:</comment>
  <info>string</info>  


id: Yaf_View_Simple::getScriptPath
type: function
doc:
<comment>Description:</comment>
  Get templates directory

<comment>Return:</comment>
  <info>string</info>  


id: Yaf_View_Simple::render
type: function
doc:
<comment>Description:</comment>
  Render template
  
  Render a template and return the result.

<comment>Param:</comment>
  <info>string</info>  <strong>$tpl</strong>       
  <info>array</info>   <strong>$tpl_vars</strong>  

<comment>Return:</comment>
  <info>string</info>  


id: Yaf_View_Simple::setScriptPath
type: function
doc:
<comment>Description:</comment>
  Set tempaltes directory

<comment>Param:</comment>
  <info>string</info>  <strong>$template_dir</strong>  

<comment>Return:</comment>
  <info>bool</info>  


id: Yar_Client::__call
type: function
doc:
<comment>Description:</comment>
  Call service
  
  Issue a call to remote RPC method.

<comment>Param:</comment>
  <info>string</info>  <strong>$method</strong>      Remote RPC method name.
  <info>array</info>   <strong>$parameters</strong>  Parameters.

<comment>Return:</comment>
  <info>void</info>  

<comment>See Also:</comment>
   * Yar_Client::setOpt


id: Yar_Client::__construct
type: function
doc:
<comment>Description:</comment>
  Create a client
  
  Create a <class>Yar_Client</class> to a <class>Yar_Server</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$url</strong>  Yar Server URL.

<comment>Return:</comment>
  <info>unknown</info>  <class>Yar_Client</class> instance.

<comment>See Also:</comment>
   * Yar_Client::__call
   * Yar_Client::setOpt


id: Yar_Client::setOpt
type: function
doc:
<comment>Description:</comment>
  Set calling contexts

<comment>Param:</comment>
  <info>int</info>    <strong>$name</strong>   it can be: <info>YAR_OPT_PACKAGER</info>, <info>YAR_OPT_PERSISTENT</info> (Need server support),
                 <info>YAR_OPT_TIMEOUT</info>, <info>YAR_OPT_CONNECT_TIMEOUT</info>, <info>YAR_OPT_HEADER</info> (as of 2.0.4),
                 <info>YAR_OPT_PROXY</info> (as of 2.2.0)
  <info>mixed</info>  <strong>$value</strong>  

<comment>Return:</comment>
  <info>Yar_Client|false</info>  Returns $this on success ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * Yar_Client::__call


id: Yar_Client_Exception::getType
type: function
doc:
<comment>Description:</comment>
  Retrieve exception's type

<comment>Return:</comment>
  <info>string</info>  Returns <return>"Yar_Exception_Client"</return>.

<comment>See Also:</comment>
   * Yaf_Server_Exception::getType


id: Yar_Concurrent_Client::call
type: function
doc:
<comment>Description:</comment>
  Register a concurrent call
  
  Register a RPC call, but won't sent it immediately, it will be send while further call to
  Yar_Concurrent_Client::loop

<comment>Param:</comment>
  <info>string</info>    <strong>$uri</strong>         The RPC server URI(http, tcp)
  <info>string</info>    <strong>$method</strong>      Service name(aka the method name)
  <info>array</info>     <strong>$parameters</strong>  Parameters
  <info>callable</info>  <strong>$callback</strong>    A function callback, which will be called while the response return.

<comment>Return:</comment>
  <info>int</info>  An unique id, can be used to identified which call it is.

<comment>See Also:</comment>
   * Yar_Concurrent_Client::loop
   * Yar_Concurrent_Client::reset
   * Yar_Server::__construct
   * Yar_Server::handle


id: Yar_Concurrent_Client::loop
type: function
doc:
<comment>Description:</comment>
  Send all calls
  
  Send all registed remote RPC calls.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>        If this callback is set, then Yar will call this callback after all
                             calls are sent and before any response return, with a $callinfo NULL.
                             
                             Then, if user didn't specify callback when registering concurrent call,
                             this callback will be used to handle response, otherwise, the callback
                             specified while registering will be used.
  <info>callable</info>  <strong>$error_callback</strong>  If this callback is set, then Yar will call this callback while error
                             occurred.

<comment>Return:</comment>
  <info>bool</info>  

<comment>See Also:</comment>
   * Yar_Concurrent_Client::call
   * Yar_Concurrent_Client::reset
   * Yar_Server::__construct
   * Yar_Server::handle


id: Yar_Concurrent_Client::reset
type: function
doc:
<comment>Description:</comment>
  Clean all registered calls
  
  Clean all registered calls

<comment>Return:</comment>
  <info>bool</info>  

<comment>See Also:</comment>
   * Yar_Concurrent_Client::call
   * Yar_Concurrent_Client::loop
   * Yar_Server::__construct
   * Yar_Server::handle


id: Yar_Server::__construct
type: function
doc:
<comment>Description:</comment>
  Register a server
  
  Set up a Yar HTTP RPC Server, All the public methods of $obj will be register as a RPC service.

<comment>Param:</comment>
  <info>Object</info>  <strong>$obj</strong>  An Object, all public methods of its will be registered as RPC services.

<comment>Return:</comment>
  <info>unknown</info>  An instance of <class>Yar_Server</class>.

<comment>See Also:</comment>
   * Yar_Server::handle


id: Yar_Server::handle
type: function
doc:
<comment>Description:</comment>
  Start RPC Server
  
  Start a RPC HTTP server, and ready for accpet RPC requests.  Usual RPC calls will be issued as
  HTTP POST requests. If a HTTP GET request is issued to the uri, the service information (commented
  section above) will be printed on the page
  
  Usual RPC calls will be issued as HTTP POST requests. If a HTTP GET request is issued to the uri,
  the service information (commented section above) will be printed on the page

<comment>Return:</comment>
  <info>bool</info>  boolean

<comment>See Also:</comment>
   * Yar_Server::__construct


id: Yar_Server_Exception
type: class
doc:
<comment>Description:</comment>
  If service threw exceptions, A Yar_Server_Exception will be threw in client side.


id: Yar_Server_Exception::getType
type: function
doc:
<comment>Description:</comment>
  Retrieve exception's type
  
  Get the exception original type threw by server

<comment>Return:</comment>
  <info>string</info>  string

<comment>See Also:</comment>
   * 


id: ZEND_ACC_CLASS
type: constant
doc:
<comment>Description:</comment>
  Dummy registered for consistency, the default kind of class entry. Removed as of uopz 5.0.0.


id: ZEND_ADD_INTERFACE
type: constant
doc:
<comment>Description:</comment>
  Invoked upon composure, receives the class the interface is being added to as the first argument,
  and the name of the interface as the second argument


id: ZEND_ADD_TRAIT
type: constant
doc:
<comment>Description:</comment>
  Invoked upon composure, receives the class the trait is being added to as the first argument, and
  the name of the trait as the second argument


id: ZEND_EXIT
type: constant
doc:
<comment>Description:</comment>
  Invoked by exit() and die(), receives no arguments. Return boolean <info>true</info> to exit, <info>false</info> to continue


id: ZEND_FETCH_CLASS
type: constant
doc:
<comment>Description:</comment>
  Invoked upon composure, receives the class the name of the class being fetched as the only
  argument


id: ZEND_INSTANCEOF
type: constant
doc:
<comment>Description:</comment>
  Invoked by instanceof operator, receives the object being verified as the first argument, and the
  name of the class which that object should be as the second argument


id: ZEND_NEW
type: constant
doc:
<comment>Description:</comment>
  Invoked by object construction, receives the class of object being created as the only argument


id: ZEND_THROW
type: constant
doc:
<comment>Description:</comment>
  Invoked by the throw construct, receives the class of exception being thrown as the only argument


id: ZMQ::CTXOPT_MAX_SOCKETS
type: constant
doc:
<comment>Description:</comment>
  O número máximo de sockets para o contexto. Disponível se compilado em versão igual ou superior a
  3.x da ZeroMQ (Valor: <info>int</info>)


id: ZMQ::ERR_EAGAIN
type: constant
doc:
<comment>Description:</comment>
  Impleca que a operação será bloqueante caso ZMQ::MODE_DONTWAIT seja usada


id: ZMQ::ERR_EFSM
type: constant
doc:
<comment>Description:</comment>
  A operação não pode ser executada porque o socket não está em um estado válido


id: ZMQ::MODE_NOBLOCK
type: constant
doc:
<comment>Description:</comment>
  Define a operação como não bloqueante. Constante obsoleta, use ZMQ::MODE_DONTWAIT


id: ZMQ::SOCKET_DEALER
type: constant
doc:
<comment>Description:</comment>
  Um socket extendido de requisição que equilibra a carga para todos os clientes conectados


id: ZMQ::SOCKET_ROUTER
type: constant
doc:
<comment>Description:</comment>
  Um socket de resposta extendido que pode rotear respostas para os solicitantes


id: ZMQ::SOCKET_STREAM
type: constant
doc:
<comment>Description:</comment>
  Usado para enviar e receber dados via TCP de um cliente não ØMQ. Disponível se compilado em versão
  igual ou superior a 4.x da ZeroMQ (Valor: <info>int</info>)


id: ZMQ::SOCKET_XPUB
type: constant
doc:
<comment>Description:</comment>
  Similar ao SOCKET_PUB, exceto que é possível receber subscrições como mensagens. A mensagem de
  subscrição é 0 (não subscrever) ou 1 (subscrever) seguido por um tópico.


id: ZMQ::SOCKET_XSUB
type: constant
doc:
<comment>Description:</comment>
  Similar ao SOCKET_SUB, exceto que é possível enviar subscrições como mensagens. Consulte
  SOCKET_XPUB para saber o formato.


id: ZMQ::SOCKOPT_BACKLOG
type: constant
doc:
<comment>Description:</comment>
  A opção SOCKOPT_BACKLOG define o comprimento máximo da fila de conexões de clientes para o socket
  especificado; isso só se aplica a transportes orientados a conexão. (Valor: <info>int</info>)


id: ZMQ::SOCKOPT_DELAY_ATTACH_ON_CONNECT
type: constant
doc:
<comment>Description:</comment>
  Define uma string CIDR para comparar com as conexões TCP de entrada. Disponível se compilado em
  versão igual ou superior a 3.x da ZeroMQ (Valor: <info>string</info>)


id: ZMQ::SOCKOPT_HWM
type: constant
doc:
<comment>Description:</comment>
  O marcador High Water Mark (HWM) para as mensagens que entram e saem,  é um marcador de limite  do
  número máximo de mensagens que a ØMQ enfileira na memória para um cliente qualquer ao qual o
  socket especificado esteja se comunicando. Definir esta opção em um socket afetará apenas as
  conexões feitas após a configuração da opção. Na ZeroMQ 3.x esta opção é um wrapper para a
  configuração de SNDHWM e RCVHWM. (Valor: <info>int</info>).


id: ZMQ::SOCKOPT_IPV4ONLY
type: constant
doc:
<comment>Description:</comment>
  Desabilita o suporte ao IPV6 caso o valor seja 1. Disponível se compilado em versão igual ou
  superior a 3.x da ZeroMQ (Valor: <info>int</info>)


id: ZMQ::SOCKOPT_IPV6
type: constant
doc:
<comment>Description:</comment>
  Habilita o protocolo IPV6. Disponível se compilado em versão igual ou superior a 4.0 da ZeroMQ
  (Valor: <info>string</info>)


id: ZMQ::SOCKOPT_LAST_ENDPOINT
type: constant
doc:
<comment>Description:</comment>
  Recupera o último destino conectado - para o uso com as portas * coringa. Disponível se compilado
  em versão igual ou superior a 3.x da ZeroMQ (Valor: <info>string</info>)


id: ZMQ::SOCKOPT_LINGER
type: constant
doc:
<comment>Description:</comment>
  O tempo de permanência após fechamento do socket. Especifica por quanto tempo o socket fica
  bloqueado enquanto tenta dar vazão às mensagens depois que ele tenha sido fechado (Valor: <info>int</info>)


id: ZMQ::SOCKOPT_MAXMSGSIZE
type: constant
doc:
<comment>Description:</comment>
  Limita o tamanho máximo da mensagem de entrada. O valor -1 significa que não há limite. Disponível
  se compilado em versão igual ou superior a 3.x da ZeroMQ (Valor: <info>int</info>)


id: ZMQ::SOCKOPT_MCAST_LOOP
type: constant
doc:
<comment>Description:</comment>
  Controla o retorno do multicast (Valor: <info>int</info> &gt;= 0)


id: ZMQ::SOCKOPT_RATE
type: constant
doc:
<comment>Description:</comment>
  Define a taxa de envio para sockets multicast (pgm) (Valor: <info>int</info> &gt;= 0)


id: ZMQ::SOCKOPT_RCVBUF
type: constant
doc:
<comment>Description:</comment>
  Define o tamanho do buffer do kernel de recepção (Valor: <info>int</info> &gt;= 0)


id: ZMQ::SOCKOPT_RCVHWM
type: constant
doc:
<comment>Description:</comment>
  A opção ZMQ_RCVHWM define o limite HWM para as mensagens de entrada no socket especificado.
  Disponível se compilado na versão 3.x ou maior da ZeroMQ (Valor: <info>int</info>).


id: ZMQ::SOCKOPT_RCVTIMEO
type: constant
doc:
<comment>Description:</comment>
  Define o tempo limite para a operação de recepção no socket. O valor -1 indica que não há limite.
  Disponível se compilado em versão igual ou superior a 3.x da ZeroMQ (Valor: <info>int</info>)


id: ZMQ::SOCKOPT_RECONNECT_IVL
type: constant
doc:
<comment>Description:</comment>
  Define o intervalo de reconexão inicial (Valor: <info>int</info> &gt;= 0)


id: ZMQ::SOCKOPT_RECONNECT_IVL_MAX
type: constant
doc:
<comment>Description:</comment>
  Define o intervalo máximo de reconexão (Valor: <info>int</info> &gt;= 0)


id: ZMQ::SOCKOPT_RECOVERY_IVL
type: constant
doc:
<comment>Description:</comment>
  Define o intervalo de recuperação multicast (Valor: <info>int</info> &gt;= 0)


id: ZMQ::SOCKOPT_ROUTER_RAW
type: constant
doc:
<comment>Description:</comment>
  Define o modo raw (sem processamento) para o ROUTER, quando passado o valor 1. No modo raw,  ao
  usar um socket TCP, a leitura e escrita dos dados será realizada sem o processamento do ZeroMQ.
  Disponível se compilado em versão igual ou superior a 4.0 da ZeroMQ (Valor: <info>string</info>)


id: ZMQ::SOCKOPT_SNDBUF
type: constant
doc:
<comment>Description:</comment>
  Define o tamanho do buffer do kernel de transmissão (Valor: <info>int</info> &gt;= 0)


id: ZMQ::SOCKOPT_SNDHWM
type: constant
doc:
<comment>Description:</comment>
  A opção ZMQ_SNDHWM define o limite HWM para as mensagens de saída no socket especificado.
  Disponível se compilado na versão 3.x ou maior da ZeroMQ (Valor: <info>int</info>).


id: ZMQ::SOCKOPT_SNDTIMEO
type: constant
doc:
<comment>Description:</comment>
  Define o tempo limite para a operação de envio no socket. O valor -1 indica que não há limite.
  Disponível se compilado em versão igual ou superior a 3.x da ZeroMQ (Valor: <info>int</info>)


id: ZMQ::SOCKOPT_SUBSCRIBE
type: constant
doc:
<comment>Description:</comment>
  Estabelece um filtro de mensagens. Válido para o socket subscrito (Valor: <info>string</info>)


id: ZMQ::SOCKOPT_TCP_KEEPALIVE_CNT
type: constant
doc:
<comment>Description:</comment>
  Contador para os pacotes TCp keepalive. Disponível se compilado em versão igual ou superior a 3.x
  da ZeroMQ (Valor: <info>int</info>)


id: ZMQ::SOCKOPT_TCP_KEEPALIVE_IDLE
type: constant
doc:
<comment>Description:</comment>
  Tempo de ociosidade para os pacotes TCP keepalive. Disponível se compilado em versão igual ou
  superior a 3.x da ZeroMQ (Valor: <info>int</info>)


id: ZMQ::SOCKOPT_TCP_KEEPALIVE_INTVL
type: constant
doc:
<comment>Description:</comment>
  Intervalo para os pacotes TCP keepalive. Disponível se compilado em versão igual ou superior a 3.x
  da ZeroMQ (Valor: <info>int</info>)


id: ZMQ::SOCKOPT_TYPE
type: constant
doc:
<comment>Description:</comment>
  Obtém o tipo de socket. Válido para o método getSockOpt (Valor: <info>int</info>)


id: ZMQ::SOCKOPT_UNSUBSCRIBE
type: constant
doc:
<comment>Description:</comment>
  Remove um filtro de mensagens. Válido para o socket subscrito (Valor: <info>string</info>)


id: ZMQ::SOCKOPT_XPUB_VERBOSE
type: constant
doc:
<comment>Description:</comment>
  Define que a opção XPUB deve receber uma mensagem de aplicação em cada instância de subscrição.
  Disponível se compilado em versão igual ou superior a 3.x da ZeroMQ (Valor: <info>string</info>)


id: ZMQ::__construct
type: function
doc:
<comment>Description:</comment>
  Construtor da classe ZMQ
  
  Um construtor privado para prevenir a inicialização direta. Esta classe abriga as constantes para
  a extensão ZMQ.


id: ZMQContext::__construct
type: function
doc:
<comment>Description:</comment>
  Constrói um novo objeto ZMQContext
  
  Constrói um novo contexto ZMQ. O contexto é usado para inicializar os sockets. Um contexto
  persistente é necessário para inicializar sockets persistentes.

<comment>Param:</comment>
  <info>int</info>   <strong>$io_threads</strong>     Número de threads de I/O no contexto.
  <info>bool</info>  <strong>$is_persistent</strong>  Indica se o contexto é persistente. Um contexto persistente é armazenado ao
                        longo de várias requisições e é um requisito para os sockets persistentes.


id: ZMQContext::getOpt
type: function
doc:
<comment>Description:</comment>
  Obtém uma opção de contexto
  
  Retorna o valor de uma opção de contexto.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  Um interiro representando a opção. Consulte as constentes <info>ZMQ::CTXOPT_*</info>.

<comment>Return:</comment>
  <info>mixed</info>  Retorna tanto uma <info>string</info> quanto um <info>int</info> dependendo do parâmetro <strong>$key</strong>. Lança uma exceção
         ZMQContextException caso haja erro.


id: ZMQContext::getSocket
type: function
doc:
<comment>Description:</comment>
  Cria um novo socket
  
  Um atalho para criar sockets a partir de um contexto. Se o contexto não for persistente, o
  parâmetro <strong>$persistent_id</strong> é ignorado e o socket continua sendo não persistente. o parâmetro
  <strong>$on_new_socket</strong> é chamado apenas quando uma nova estrutura de socket for criada.

<comment>Param:</comment>
  <info>int</info>       <strong>$type</strong>           Uma constante <info>ZMQ::SOCKET_*</info> que especifica o tipo do socket.
  <info>string</info>    <strong>$persistent_id</strong>  Se o parâmetro <strong>$persistent_id</strong> for especificado, o socket será
                            persistente ao longo de várias requisições.
  <info>callable</info>  <strong>$on_new_socket</strong>  Uma função de retorno que é executada quando uma nova estrutura de
                            socket é criada. Essa função não é invocada se uma conexão persistente
                            for reusada. A função de retorno tem um ZMQSocket e um persistent_id
                            como argumentos.

<comment>Return:</comment>
  <info>ZMQSocket</info>  Retorna um objeto <class>ZMQSocket</class>.


id: ZMQContext::isPersistent
type: function
doc:
<comment>Description:</comment>
  Retorna se o contexto é persistente
  
  Retorna se o contexto é persistente. É necessário um contexto persistente para uma conexão
  persistente pois cada socket é alocado a partir de um contexto.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> se o contexto for persistente e <info>false</info> caso contrário.


id: ZMQContext::setOpt
type: function
doc:
<comment>Description:</comment>
  Define uma opção de socket
  
  Define uma opção de contexto ZMQ. O tipo do parâmetro <strong>$value</strong> depende do parâmetro <strong>$key</strong>. Consulte
  os Tipos de Constantes ZMQ para mais informações.

<comment>Param:</comment>
  <info>int</info>    <strong>$key</strong>    Uma das constantes <info>ZMQ::CTXOPT_*</info>.
  <info>mixed</info>  <strong>$value</strong>  O valor do parâmetro.

<comment>Return:</comment>
  <info>ZMQContext</info>  Retorna o objeto atual. Lança uma exceção do tipo ZMQContextException caso haja erro.


id: ZMQDevice::__construct
type: function
doc:
<comment>Description:</comment>
  Constrói um novo dispositivo
  
  "Dispositivos ØMQ podem itermediar endereços, serviços, filas, ou qualquer outra abstração que se
  deseje definir sobre a mensagem e as camadas de socket." -- zguide

<comment>Param:</comment>
  <info>ZMQSocket</info>  <strong>$frontend</strong>  Parametro de entrada dos dispositivos. Geralmente de onde as mensagens estão
                        vindo.
  <info>ZMQSocket</info>  <strong>$backend</strong>   Parâmetro de destino dos dispositivos. Geralmente para onde as mensagens
                        estão indo.
  <info>ZMQSocket</info>  <strong>$listener</strong>  Um socket ouvinte (listener), que recebe uma cópia de todas as mensagens
                        indo em ambas direções. O tipo desse socket deve ser SUB, PULL ou DEALER.

<comment>Return:</comment>
  <info>unknown</info>  A chamada para este método prepara o dispositivo. Geralmente os dispositivos são
           processos se longa execução, assim, executar esse método a partir de um script interativo
           não é recomendado. Esse método lança uma exceção ZMQDeviceException caso o dispositivo
           não possa ser inicializado.


id: ZMQDevice::getIdleTimeout
type: function
doc:
<comment>Description:</comment>
  Obtém o tempo limite de inatividade
  
  Obtém o valor do tempo limite de inatividade do retorno. Adicionado na versão 1.0.0 da extensão
  ZMQ.

<comment>Return:</comment>
  <info>ZMQDevice</info>  Esse método retorna o valor do tempo limite de inatividade do retorno.


id: ZMQDevice::getTimerTimeout
type: function
doc:
<comment>Description:</comment>
  Obtém o tempo limite do temporizador
  
  Obtém o valor do tempo limite do temporizador. Adicionado na versão 1.0.0 da extensão ZMQ.

<comment>Return:</comment>
  <info>ZMQDevice</info>  Este método retorna o valor do tempo limite do temporizador.


id: ZMQDevice::run
type: function
doc:
<comment>Description:</comment>
  Executa o novo dispositivo
  
  Executa o dispositivo.

<comment>Return:</comment>
  <info>void</info>  A chamada para este método ficará bloqueada até que o dispositivo seja executado. Não é
        recomendado que os dispositivos sejam usados a partir de scripts interativos. Caso haja
        falha, esse método lançará uma exceção ZMQDeviceException.


id: ZMQDevice::setIdleCallback
type: function
doc:
<comment>Description:</comment>
  Define a função de retorno de inatividade
  
  Define a função de retorno de inatividade. Se o tempo limite de inatividade for definido, a função
  de retorno será chamada se a consulta interna ficar sem eventos durante o tempo limite. Se a
  função de retorno retornar falso ou um valor que seja avaliado para falso, o dispositivo é
  interrompido.
   A assinatura da função de retorno é cb_func(mixed $user_data).

<comment>Param:</comment>
  <info>callable</info>  <strong>$cb_func</strong>    A função de retorno que será invocada de o dispositivo ficar inativo.
                        Retornando falso ou um valor que avalia para falso dessa função causará a
                        interrupção do dispositivo.
  <info>int</info>       <strong>$timeout</strong>    Com que frequência invocar a função de retorno em milissegundos. A função de
                        retorno de inatividade é invocada periodicamente quando não há atividade no
                        dispositivo. O valor do tempo limite garante que haverá no mínimo essa
                        quantidade de milissegundos entre as chamadas à função de retorno.
  <info>mixed</info>     <strong>$user_data</strong>  Dados adicionais passados para a função de retorno.

<comment>Return:</comment>
  <info>ZMQDevice</info>  Em caso de sucesso, esse método retorna o objeto atual.


id: ZMQDevice::setIdleTimeout
type: function
doc:
<comment>Description:</comment>
  Define o tempo limite de inatividade
  
  Define o tempo limite da função de retorno de inatividade. A função de retorno de inatividade é
  invocada periodicamente quando o dispositivo está ocioso.

<comment>Param:</comment>
  <info>int</info>  <strong>$timeout</strong>  O valor do tempo limite da função de retorno de inatividade.

<comment>Return:</comment>
  <info>ZMQDevice</info>  Caso haja sucesso, esse método retorna o objeto atual.


id: ZMQDevice::setTimerCallback
type: function
doc:
<comment>Description:</comment>
  Define a função de retorno do temporizador
  
  Define a função de retorno do temporizador. A função de retorno do temporizados será invocada após
  a passagem do tempo limite. A diferença entre as funções de retorno de inatividade e do
  temporizador é que a função de retorno por inatividade é invocada apenas quando o dispositivo está
  ocioso.
   A assinatura da função de retorno é cb_func(mized $user_data). Adicionada à extensão ZMQ na
  versão 1.1.0.

<comment>Param:</comment>
  <info>callable</info>  <strong>$cb_func</strong>    Função de retorno que será invocada quando o dispositido estiver ocioso.
                        Retornando falso ou um valor que avalie para falso nessa função causará a
                        interrupção do dispositivo.
  <info>int</info>       <strong>$timeout</strong>    Com que frequência invocar a função de retorno em milissegundos. A função de
                        retorno de inatividade é invocada periodicamente quando não há atividade no
                        dispositivo. O valor do tempo limite garante que haverá no mínimo essa
                        quantidade de milissegundos entre as chamadas à função de retorno.
  <info>mixed</info>     <strong>$user_data</strong>  Dados adicionais pasados para a função de retorno.

<comment>Return:</comment>
  <info>ZMQDevice</info>  Em caso de sucesso, esse método retorna o objeto atual.


id: ZMQDevice::setTimerTimeout
type: function
doc:
<comment>Description:</comment>
  Define o tempo limite do temporizador
  
  Define o tempo limite da função de retorno do temporizador. A função de retorno do temporizador é
  invocada periodicamente caso o mesmo seja definido. Adicionada à extensão ZMQ na versão 1.1.0.

<comment>Param:</comment>
  <info>int</info>  <strong>$timeout</strong>  O valor do tempo limite da função de retorno do temporizador.

<comment>Return:</comment>
  <info>ZMQDevice</info>  Em caso de sucesso, esse método retorna o objeto atual.


id: ZMQPoll::add
type: function
doc:
<comment>Description:</comment>
  Adiciona o item na lista de pesquisa
  
  Adiciona um novo item na lista de pesquisa e retorna o id interno do item adicionado. O item pode
  ser removido da lista através da string de identificação retornada.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$entry</strong>  Um objeto ZMQSocket ou um recurso de fluxo (stream) PHP
  <info>int</info>    <strong>$type</strong>   Define para qual atividade o socket será consultado. Consulte as constantes
                 <info>ZMQ::POLL_IN</info> e <info>ZMQ::POLL_OUT</info>.

<comment>Return:</comment>
  <info>string</info>  Retorna uma string de identificação do item adicionado, que pode ser usada posteriormente
          para remover o item. Lança uma exceção ZMQPollException caso haja erro.


id: ZMQPoll::clear
type: function
doc:
<comment>Description:</comment>
  Limpa a lista de consulta
  
  Exclui todos os elementos da lista de consulta.

<comment>Return:</comment>
  <info>ZMQPoll</info>  Retorna o objeto atual.


id: ZMQPoll::count
type: function
doc:
<comment>Description:</comment>
  Conta os itens na lista de consulta
  
  Conta os itens na lista de consulta.

<comment>Return:</comment>
  <info>int</info>  Retorna um <info>int</info> representando a quantidade de itens na lista de consulta.


id: ZMQPoll::getLastErrors
type: function
doc:
<comment>Description:</comment>
  Obtém erros da consulta
  
  Retorna os ids dos objetos que tiveram erro na última consulta.

<comment>Return:</comment>
  <info>array</info>  Retorna um array contendo os ids dos itens que tiveram erro na última consulta. Um arrau
         vazio é retornado se não houveram erros.


id: ZMQPoll::poll
type: function
doc:
<comment>Description:</comment>
  Consulta os itens
  
  Consulta os itens na lista de pesquisa atual. Os itens de leitura e escrita são retornados nos
  parâmetros <strong>$readable</strong> e <strong>$writable</strong>. A função <strong>ZMQPoll::getLastErrors()</strong> pode ser usada para verificar
  se houveram erros.

<comment>Param:</comment>
  <info>array</info>  <strong>$readable</strong>  Um array (vetor) onde os ZMQSockets de leitura ou recursos de fluxo (streams)
                    PHP são retornados. O array será esvaziado no início da operação.
  <info>array</info>  <strong>$writable</strong>  Um array (vetor) onde os ZMQSockets de escrita ou recursos de fluxo (streams)
                    PHP são retornados. O array será esvaziado no início da operação.
  <info>int</info>    <strong>$timeout</strong>   O tempo limite de execução da operação. -1 significa que a pesquisa espera até
                    pelo menos um item entre em atividade. Note que a partir da versão 1.0.0 o tempo
                    limite de consulta é definido em milissegundos, em vez de microsegundos.

<comment>Return:</comment>
  <info>int</info>  Retorna um inteiro representando a quantidade de itens com atividades.


id: ZMQPoll::remove
type: function
doc:
<comment>Description:</comment>
  Remove um item da lista de consulta
  
  Remove o item da lista de consulta. O parâmetro <strong>$item</strong> pode ser um objeto ZMQSocket, um recurso de
  fluxo (stream) ou o id retornado pelo método <strong>ZMQPoll::add()</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$item</strong>  O objeto ZMQSocket, recurso de fluxo (stream) ou a <info>string</info> id do item.

<comment>Return:</comment>
  <info>bool</info>  Retorna verdadeiro caso o item tenha sido removido e falso caso o objeto com o id informado
        não existe na lista de pesquisa.


id: ZMQSocket::__construct
type: function
doc:
<comment>Description:</comment>
  Constrói um novo ZMQSocket
  
  Constrói um objeto ZMQSocket. O parâmetro <strong>$persistent_id</strong> pode ser usado para alocar um socket
  persistente. Um socket persistente deve ser alocado a partir de um contexto persistente e
  permanece conectado ao longo de várias requisições. O parâmetro <strong>$persistent_id</strong> pode ser usado para
  chamar novamente o mesmo socket ao longo de várias requisições. O parâmetro <strong>$on_new_socket</strong> é
  chamado apenas quando uma nova instância de socket for criada.

<comment>Param:</comment>
  <info>ZMQContext</info>  <strong>$context</strong>        Um objeto ZMQContext.
  <info>int</info>         <strong>$type</strong>           O tipo do socket. Consulte as constantes <info>ZMQ::SOCKET_*</info>.
  <info>string</info>      <strong>$persistent_id</strong>  Se o parâmetro <strong>$persistent_id</strong> for especificado, o socket será
                              persistente ao longo de várias requisições. Se o parâmetro <strong>$context</strong>
                              não for persistente, o socket volta para o modo não persistente.
  <info>callable</info>    <strong>$on_new_socket</strong>  Uma finção de retorno que é executada quando uma nova instância de
                              socket é criada. Essa função não é invocada se a conexão em uso for
                              persistente e estiver sendo reusada.


id: ZMQSocket::bind
type: function
doc:
<comment>Description:</comment>
  Associa o socket
  
  Associa o socket a um destino. O destino é definido no formato <return>transport://address</return>, onde transport
  é um dos seguintes itens: inproc, ipc, tcp, pgm or epgm.

<comment>Param:</comment>
  <info>string</info>  <strong>$dsn</strong>    O destino que será associado, por exemplo <return>transport://address</return>.
  <info>bool</info>    <strong>$force</strong>  Tenta associar ao destino mesmo que o socket já tenha sido associado ao destino
                  informado.

<comment>Return:</comment>
  <info>ZMQSocket</info>  Retorna o objeto atual. Lança um aexceção ZMQSocketException caso haja erro.


id: ZMQSocket::connect
type: function
doc:
<comment>Description:</comment>
  Conecta o socket
  
  Conecta o socket ao destino remoto. O destino é definido no formato <return>transport://address</return>, onde
  transporte é um dos seguintes itens: inproc, ipc, tcp, pgm or epgm.

<comment>Param:</comment>
  <info>string</info>  <strong>$dsn</strong>    O destino da conexão, por exemplo <return>transport://address</return>.
  <info>bool</info>    <strong>$force</strong>  Tenta conectar mesmo se o socket já foi conectado a um dado destino.

<comment>Return:</comment>
  <info>ZMQSocket</info>  Retorna o objeto atual.


id: ZMQSocket::disconnect
type: function
doc:
<comment>Description:</comment>
  Desconecta um socket
  
  Desconecta o socket de um destino remoto previamente conectado. O destino é definido no formato
  <return>transport://address</return> onde transporte é um dos itens a seguir: inproc, ipc, tcp, pgm or epgm.

<comment>Param:</comment>
  <info>string</info>  <strong>$dsn</strong>  O destino conectado, por exemplo <return>transport://address</return>.

<comment>Return:</comment>
  <info>ZMQSocket</info>  Retorna o objeto atual. Lança uma exceção ZMQSocketException caso haja erro.


id: ZMQSocket::getEndpoints
type: function
doc:
<comment>Description:</comment>
  Obtém uma lista de destinos
  
  Retorna uma lista de destinos onde aos quais o socket está connectado ou associado.

<comment>Return:</comment>
  <info>array</info>  Retorna um vetor (array) contendo elementos 'bind' (associados) e 'connect' (conectados).


id: ZMQSocket::getPersistentId
type: function
doc:
<comment>Description:</comment>
  Obtém o id persistente
  
  Retorna o id do socket persistente.

<comment>Return:</comment>
  <info>string</info>  Retorna a string com o id persistente atribuído ao objeto e <info>null</info> caso o socket não seja
          persistente.


id: ZMQSocket::getSockOpt
type: function
doc:
<comment>Description:</comment>
  Obtém a opção do socket
  
  Retorna o valor de uma opção de socket.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  Um inteiro representando a opção. Consulte as constantes <info>ZMQ::SOCKOPT_*</info>.

<comment>Return:</comment>
  <info>mixed</info>  Retorna tanto uma <info>string</info> ou um <info>int</info> dependendo do parâmetro <strong>$key</strong>. Lança uma exceção
         ZMQSocketException caso haja erro.


id: ZMQSocket::getSocketType
type: function
doc:
<comment>Description:</comment>
  Retorna o tipo de socket
  
  Retorna o tipo de socket.

<comment>Return:</comment>
  <info>int</info>  Retorna um inteiro representando o tipo do socket. O inteiro pode ser comparado com as
       constantes <info>ZMQ::SOCKET_*</info>.


id: ZMQSocket::isPersistent
type: function
doc:
<comment>Description:</comment>
  Se o socket é persistente
  
  Verifica se o socket é persistente

<comment>Return:</comment>
  <info>bool</info>  Retorna um <info>bool</info> baseado caso o socket seja persistente ou não.


id: ZMQSocket::recv
type: function
doc:
<comment>Description:</comment>
  Recebe uma mensagem
  
  Recebe uma mensagem a partir de um socket. Por padrão a recepção será bloqueada até que uma
  mensagem esteja disponível a menos que a constante <info>ZMQ::MODE_DONTWAIT</info> seja usada. A constante
  <info>ZMQ::SOCKOPT_RCVMORE</info> pode ser usada para receber mensagens de múltiplas partes. Consulte
  <strong>ZMQSocket::setSockOpt()</strong> para mais informações.

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  Passa indicadores para a recepção de mensagens de múltiplas partes ou operações não
              bloqueantes. Consulte as constantes <info>ZMQ::MODE_*</info>.

<comment>Return:</comment>
  <info>string</info>  Retorna a mensagem. Se <info>ZMQ::MODE_DONTWAIT</info> for usada e a operação for bloqueante, <info>false</info>
          deve ser retornado.


id: ZMQSocket::recvMulti
type: function
doc:
<comment>Description:</comment>
  Recebe uma mensagem de partes múltiplas
  
  Recebe um array de mensagem de múltiplas partes de um socket. Por padrão a recepção será bloqueada
  até que uma mensagem esteja disponível, a menos que a constante <info>ZMQ::MODE_NOBLOCK</info> seja usada.

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  Passa indicadores de modo para receber mensagens com várias partes ou operações não
              bloqueantes. Consulte as constantes <info>ZMQ::MODE_*</info>.

<comment>Return:</comment>
  <info>array</info>  Retorna o array de partes da mensagem. Lança uma exceção ZMQSocketException caso haja erro.
         Se a constante <info>ZMQ::MODE_NOBLOCK</info> for usada e a operação seja bloqueada, <info>bool</info> falso será
         retornado.


id: ZMQSocket::send
type: function
doc:
<comment>Description:</comment>
  Envia uma mensagem
  
  Envia uma mensagem usando o socket. A operação pode bloquear, a menos que a constante
  <info>ZMQ::MODE_NOBLOCK</info> seja usada.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  A mensagem a ser enviada.
  <info>int</info>     <strong>$mode</strong>     Passa um indicador para receber mensagens com várias partes ou operações não
                    bloqueantes. Consulte as constantes <info>ZMQ::MODE_*</info>.

<comment>Return:</comment>
  <info>ZMQSocket</info>  Retorna o objeto atual. Lança uma exceção ZMQSocketException caso haja erro. Se a
             constante <info>ZMQ::MODE_NOBLOCK</info> for usada e a operação bloquear, <info>bool</info> falso será retornado.


id: ZMQSocket::sendmulti
type: function
doc:
<comment>Description:</comment>
  Envia uma mensagem de múltiplas partes
  
  Envia uma mensagem com várias partes usando o socket. A operação pode bloquear, exceto caso
  <info>ZMQ::MODE_NOBLOCK</info> seja usada.

<comment>Param:</comment>
  <info>array</info>  <strong>$message</strong>  A mensagem a ser enviada - um vetor (array) de strings
  <info>int</info>    <strong>$mode</strong>     Passe indicadores mode para receber mensagens com múltiplas partes ou operações
                   não bloqueantes. Consulte as constantes <info>ZMQ::MODE_*</info>.

<comment>Return:</comment>
  <info>ZMQSocket</info>  Retorna o objeto atual. Lança uma exceção ZMQSocketException caso haja erro. Se a
             constante <info>ZMQ::MODE_NOBLOCK</info> for usada e a operação bloqueie, <info>bool</info> falso será retornado.


id: ZMQSocket::setSockOpt
type: function
doc:
<comment>Description:</comment>
  Define uma opção de socket
  
  Define uma opção para o socket ZMQ. O tipo do parâmetro <strong>$value</strong> depende do parâmetro <strong>$key</strong>. Consulte
  Tipos de Constantes ZMQ para mais informações.

<comment>Param:</comment>
  <info>int</info>    <strong>$key</strong>    Uma das constantes <info>ZMQ::SOCKOPT_*</info>.
  <info>mixed</info>  <strong>$value</strong>  O valor do parâmetro.

<comment>Return:</comment>
  <info>ZMQSocket</info>  Retorna o objeto atual. Lança uma exceção ZMQSocketException caso haja erro.


id: ZMQSocket::unbind
type: function
doc:
<comment>Description:</comment>
  Desvincula o socket
  
  Desassocia o socket de um destino. O destino é definido no formato <return>transport://address</return> onde
  "transporte" é um dos seguintes: inproc, ipc, tcp, pgm or epgm.

<comment>Param:</comment>
  <info>string</info>  <strong>$dsn</strong>  O destino associado anteriormente. Por exemplo <return>transport://address</return>.

<comment>Return:</comment>
  <info>ZMQSocket</info>  Retorna o objeto atual. Lança uma ZMQSocketException em caso de erro.


id: ZipArchive::AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE
type: constant
doc:
<comment>Description:</comment>
  Don't remove file if archive is empty. Available as of PHP 8.3.0 and PECL zip 1.22.0,
  respectively, if built against libzip ≥ 1.10.0.


id: ZipArchive::AFL_IS_TORRENTZIP
type: constant
doc:
<comment>Description:</comment>
  Current archive is torrentzipped. Available as of PHP 8.3.0 and PECL zip 1.22.0, respectively, if
  built against libzip ≥ 1.10.0.


id: ZipArchive::AFL_RDONLY
type: constant
doc:
<comment>Description:</comment>
  Archive is read only, cannot be cleared. Available as of PHP 8.3.0 and PECL zip 1.22.0,
  respectively, if built against libzip ≥ 1.10.0.


id: ZipArchive::AFL_WANT_TORRENTZIP
type: constant
doc:
<comment>Description:</comment>
  Write archive in torrentzip format. Available as of PHP 8.3.0 and PECL zip 1.22.0, respectively,
  if built against libzip ≥ 1.10.0.


id: ZipArchive::CHECKCONS
type: constant
doc:
<comment>Description:</comment>
  Perform additional consistency checks on the archive, and error if they fail.


id: ZipArchive::CM_LZMA2
type: constant
doc:
<comment>Description:</comment>
  LZMA2 algorithm. Available as of PHP 7.4.3 and PECL zip 1.16.0, respectively, if built against
  libzip ≥ 1.6.0.


id: ZipArchive::CM_XZ
type: constant
doc:
<comment>Description:</comment>
  XZ algorithm. Available as of PHP 7.4.3 and PECL zip 1.16.1, respectively, if built against libzip
  ≥ 1.6.0.


id: ZipArchive::CM_ZSTD
type: constant
doc:
<comment>Description:</comment>
  Zstandard algorithm. Available as of PHP 8.0.0 and PECL zip 1.19.1, respectively, if built against
  libzip ≥ 1.8.0.


id: ZipArchive::EM_AES_128
type: constant
doc:
<comment>Description:</comment>
  AES 128 encryption. Available as of PHP 7.2.0 and PECL zip 1.14.0, respectively, if built against
  libzip ≥ 1.2.0.


id: ZipArchive::EM_AES_192
type: constant
doc:
<comment>Description:</comment>
  AES 192 encryption. Available as of PHP 7.2.0 and PECL zip 1.14.0, respectively, if built against
  libzip ≥ 1.2.0.


id: ZipArchive::EM_AES_256
type: constant
doc:
<comment>Description:</comment>
  AES 256 encryption. Available as of PHP 7.2.0 and PECL zip 1.14.0, respectively, if built against
  libzip ≥ 1.2.0.


id: ZipArchive::EM_NONE
type: constant
doc:
<comment>Description:</comment>
  No encryption. Available as of PHP 7.2.0 and PECL zip 1.14.0, respectively.


id: ZipArchive::EM_TRAD_PKWARE
type: constant
doc:
<comment>Description:</comment>
  Traditional PKWARE encryption. Available as of PHP 8.0.0 and PECL zip 1.19.0, respectively.


id: ZipArchive::EM_UNKNOWN
type: constant
doc:
<comment>Description:</comment>
  Unknown encryption algorithm. Available as of PHP 8.0.0 and PECL zip 1.19.0, respectively.


id: ZipArchive::ER_CANCELLED
type: constant
doc:
<comment>Description:</comment>
  Operation cancelled. Available as of PHP 7.4.3 and PECL zip 1.16.1, respectively, if built against
  libzip ≥ 1.6.0.


id: ZipArchive::ER_COMPRESSED_DATA
type: constant
doc:
<comment>Description:</comment>
  Compressed data invalid. Available as of PHP 7.4.3 and PECL zip 1.16.1, respectively, if built
  against libzip ≥ 1.6.0.


id: ZipArchive::ER_DATA_LENGTH
type: constant
doc:
<comment>Description:</comment>
  Unexpected length of data. Available as of PHP 8.3.0 and PECL zip 1.22.0, respectively, if built
  against libzip ≥ 1.10.0.


id: ZipArchive::ER_ENCRNOTSUPP
type: constant
doc:
<comment>Description:</comment>
  Encryption method not supported. Available as of PHP 7.4.3 and PECL zip 1.16.1, respectively.


id: ZipArchive::ER_INUSE
type: constant
doc:
<comment>Description:</comment>
  Resource still in use. Available as of PHP 7.4.3 and PECL zip 1.16.1, respectively, if built
  against libzip ≥ 1.0.0.


id: ZipArchive::ER_NOPASSWD
type: constant
doc:
<comment>Description:</comment>
  No password provided. Available as of PHP 7.4.3 and PECL zip 1.16.1, respectively.


id: ZipArchive::ER_NOT_ALLOWED
type: constant
doc:
<comment>Description:</comment>
  Not allowed in torrentzip. Available as of PHP 8.3.0 and PECL zip 1.22.0, respectively, if built
  against libzip ≥ 1.10.0.


id: ZipArchive::ER_OPNOTSUPP
type: constant
doc:
<comment>Description:</comment>
  Operation not supported. Available as of PHP 7.4.3 and PECL zip 1.16.1, respectively, if built
  against libzip ≥ 1.0.0.


id: ZipArchive::ER_RDONLY
type: constant
doc:
<comment>Description:</comment>
  Read-only archive. Available as of PHP 7.4.3 and PECL zip 1.16.1, respectively.


id: ZipArchive::ER_TELL
type: constant
doc:
<comment>Description:</comment>
  Tell error. Available as of PHP 7.4.3 and PECL zip 1.16.1, respectively, if built against libzip ≥
  1.0.0.


id: ZipArchive::ER_WRONGPASSWD
type: constant
doc:
<comment>Description:</comment>
  Wrong password provided. Available as of PHP 7.4.3 and PECL zip 1.16.1, respectively.


id: ZipArchive::FL_CENTRAL
type: constant
doc:
<comment>Description:</comment>
  In central directory. Available as of PHP 8.0.0 and PECL zip 1.18.0.


id: ZipArchive::FL_ENCRYPTED
type: constant
doc:
<comment>Description:</comment>
  Read encrypted data (implies FL_COMPRESSED). Available as of PHP 8.0.0 and PECL zip 1.18.0.


id: ZipArchive::FL_OPEN_FILE_NOW
type: constant
doc:
<comment>Description:</comment>
  Open the file when added instead of waiting for archive to be closed. Be aware of file descriptors
  consumption. Available as of PHP 8.3.0 and PECL zip 1.22.1.


id: ZipArchive::FL_OVERWRITE
type: constant
doc:
<comment>Description:</comment>
  If file with name exists, overwrite (replace) it. Available as of PHP 8.0.0 and PECL zip 1.18.0.


id: ZipArchive::FL_RECOMPRESS
type: constant
doc:
<comment>Description:</comment>
  Force recompression of data. Available as of PHP 8.0.0 and PECL zip 1.18.0. Deprecated as of PHP
  8.3.0 and PECL zip 1.22.1, will be removed in a future version of libzip.


id: ZipArchive::LENGTH_TO_END
type: constant
doc:
<comment>Description:</comment>
  Use file size, if the file grows additionnal data is ignored, if the file shrinks an error is
  raised (<info>ZipArchive::ER_DATA_LENGTH</info>). Available as of PHP 8.3.0 and PECL zip 1.22.2.


id: ZipArchive::LENGTH_UNCHECKED
type: constant
doc:
<comment>Description:</comment>
  Use all available data. Available as of PHP 8.3.0 and PECL zip 1.22.2, if built against libzip ≥
  1.10.1.


id: ZipArchive::LIBZIP_VERSION
type: constant
doc:
<comment>Description:</comment>
  Zip library version. Available as of PHP 7.4.3 and PECL zip 1.16.0.


id: ZipArchive::OVERWRITE
type: constant
doc:
<comment>Description:</comment>
  If archive exists, ignore its current contents. In other words, handle it the same way as an empty
  archive.


id: ZipArchive::RDONLY
type: constant
doc:
<comment>Description:</comment>
  Open archive in read only mode. Available as of PHP 7.4.3 and PECL zip 1.17.1, respectively, if
  built against libzip ≥ 1.0.0.


id: ZipArchive::addEmptyDir
type: function
doc:
<comment>Description:</comment>
  Add a new directory
  
  Adds an empty directory in the archive.

<comment>Param:</comment>
  <info>string</info>  <strong>$dirname</strong>  The directory to add.
  <info>int</info>     <strong>$flags</strong>    Bitmask consisting of <info>ZipArchive::FL_ENC_GUESS</info>, <info>ZipArchive::FL_ENC_UTF_8</info>,
                    <info>ZipArchive::FL_ENC_CP437</info>. The behaviour of these constants is described on the
                    ZIP constants page.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: ZipArchive::addFile
type: function
doc:
<comment>Description:</comment>
  Adds a file to a ZIP archive from the given path
  
  Adds a file to a ZIP archive from a given path.
  
  Para portabilidade máxima, é recomendável sempre usar barras normais (<return>/</return>) como separador de
  diretório em nomes de arquivos ZIP.

<comment>Param:</comment>
  <info>string</info>  <strong>$filepath</strong>   The path to the file to add.
  <info>string</info>  <strong>$entryname</strong>  If supplied and not empty, this is the local name inside the ZIP archive that
                      will override the <strong>$filepath</strong>.
  <info>int</info>     <strong>$start</strong>      For partial copy, start position.
  <info>int</info>     <strong>$length</strong>     For partial copy, length to be copied, if <info>ZipArchive::LENGTH_TO_END</info> (0) the
                      file size is used, if <info>ZipArchive::LENGTH_UNCHECKED</info> the whole file is used
                      (starting from <strong>$start</strong>).
  <info>int</info>     <strong>$flags</strong>      Bitmask consisting of <info>ZipArchive::FL_OVERWRITE</info>, <info>ZipArchive::FL_ENC_GUESS</info>,
                      <info>ZipArchive::FL_ENC_UTF_8</info>, <info>ZipArchive::FL_ENC_CP437</info>,
                      <info>ZipArchive::FL_OPEN_FILE_NOW</info>. The behaviour of these constants is described on
                      the ZIP constants page.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * ZipArchive::replaceFile


id: ZipArchive::addFromString
type: function
doc:
<comment>Description:</comment>
  Add a file to a ZIP archive using its contents
  
  Add a file to a ZIP archive using its contents.
  
  Para portabilidade máxima, é recomendável sempre usar barras normais (<return>/</return>) como separador de
  diretório em nomes de arquivos ZIP.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>     The name of the entry to create.
  <info>string</info>  <strong>$content</strong>  The contents to use to create the entry. It is used in a binary safe mode.
  <info>int</info>     <strong>$flags</strong>    Bitmask consisting of <info>ZipArchive::FL_OVERWRITE</info>, <info>ZipArchive::FL_ENC_GUESS</info>,
                    <info>ZipArchive::FL_ENC_UTF_8</info>, <info>ZipArchive::FL_ENC_CP437</info>. The behaviour of these
                    constants is described on the ZIP constants page.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: ZipArchive::addGlob
type: function
doc:
<comment>Description:</comment>
  Add files from a directory by glob pattern
  
  Add files from a directory which match the glob <strong>$pattern</strong>.
  
  Para portabilidade máxima, é recomendável sempre usar barras normais (<return>/</return>) como separador de
  diretório em nomes de arquivos ZIP.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  A <strong>glob()</strong> pattern against which files will be matched.
  <info>int</info>     <strong>$flags</strong>    A bit mask of <return>glob()</return> flags.
  <info>array</info>   <strong>$options</strong>  An associative array of options. Available options are: <return>"add_path"</return> Prefix to
                    prepend when translating to the local path of the file within the archive. This
                    is applied after any remove operations defined by the <return>"remove_path"</return> or
                    <return>"remove_all_path"</return> options. <return>"remove_path"</return> Prefix to remove from matching file
                    paths before adding to the archive. <return>"remove_all_path"</return><info>true</info> to use the file name
                    only and add to the root of the archive. <return>"flags"</return> Bitmask consisting of
                    <info>ZipArchive::FL_OVERWRITE</info>, <info>ZipArchive::FL_ENC_GUESS</info>, <info>ZipArchive::FL_ENC_UTF_8</info>,
                    <info>ZipArchive::FL_ENC_CP437</info>, <info>ZipArchive::FL_OPEN_FILE_NOW</info>. The behaviour of these
                    constants is described on the ZIP constants page. <return>"comp_method"</return> Compression
                    method, one of the <info>ZipArchive::CM_*</info> constants, see ZIP constants page.
                    <return>"comp_flags"</return> Compression level. <return>"enc_method"</return> Encryption method, one of the
                    <info>ZipArchive::EM_*</info> constants, see ZIP constants page. <return>"enc_password"</return> Password used
                    for encryption.
                    
                    <return>"add_path"</return>
                    
                    Prefix to prepend when translating to the local path of the file within the
                    archive. This is applied after any remove operations defined by the
                    <return>"remove_path"</return> or <return>"remove_all_path"</return> options.
                    
                    <return>"remove_path"</return>
                    
                    Prefix to remove from matching file paths before adding to the archive.
                    
                    <return>"remove_all_path"</return>
                    
                    <info>true</info> to use the file name only and add to the root of the archive.
                    
                    <return>"flags"</return>
                    
                    Bitmask consisting of <info>ZipArchive::FL_OVERWRITE</info>, <info>ZipArchive::FL_ENC_GUESS</info>,
                    <info>ZipArchive::FL_ENC_UTF_8</info>, <info>ZipArchive::FL_ENC_CP437</info>,
                    <info>ZipArchive::FL_OPEN_FILE_NOW</info>. The behaviour of these constants is described on
                    the ZIP constants page.
                    
                    <return>"comp_method"</return>
                    
                    Compression method, one of the <info>ZipArchive::CM_*</info> constants, see ZIP constants
                    page.
                    
                    <return>"comp_flags"</return>
                    
                    Compression level.
                    
                    <return>"enc_method"</return>
                    
                    Encryption method, one of the <info>ZipArchive::EM_*</info> constants, see ZIP constants
                    page.
                    
                    <return>"enc_password"</return>
                    
                    Password used for encryption.

<comment>Return:</comment>
  <info>array|false</info>  An <info>array</info> of added files on success  ou <info>false</info> em caso de falha

<comment>See Also:</comment>
   * ZipArchive::addFile
   * ZipArchive::addPattern


id: ZipArchive::addPattern
type: function
doc:
<comment>Description:</comment>
  Add files from a directory by PCRE pattern
  
  Add files from a directory which match the regular expression <strong>$pattern</strong>. The operation is not
  recursive. The pattern will be matched against the file name only.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  A PCRE pattern against which files will be matched.
  <info>string</info>  <strong>$path</strong>     The directory that will be scanned. Defaults to the current working directory.
  <info>array</info>   <strong>$options</strong>  An associative array of options accepted by ZipArchive::addGlob.

<comment>Return:</comment>
  <info>array|false</info>  An <info>array</info> of added files on success  ou <info>false</info> em caso de falha

<comment>See Also:</comment>
   * ZipArchive::addFile
   * ZipArchive::addGlob


id: ZipArchive::clearError
type: function
doc:
<comment>Description:</comment>
  Clear the status error message, system and/or zip messages
  
  Clear the status error message, system and/or zip messages.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * ZipArchive::getStatusString


id: ZipArchive::close
type: function
doc:
<comment>Description:</comment>
  Close the active archive (opened or newly created)
  
  Close opened or created archive and save changes. This method is automatically called at the end
  of the script.
  
  If the archive contains no files, the file is completely removed by default (no empty archive is
  written) according to the value of the <info>ZipArchive::AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE</info>
  global flag.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * ZipArchive::setArchiveFlag


id: ZipArchive::count
type: function
doc:
<comment>Description:</comment>
  Counts the number of files in the archive

<comment>Return:</comment>
  <info>int</info>  Returns the number of files in the archive.


id: ZipArchive::deleteIndex
type: function
doc:
<comment>Description:</comment>
  Delete an entry in the archive using its index
  
  Delete an entry in the archive using its index.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Index of the entry to delete.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: ZipArchive::deleteName
type: function
doc:
<comment>Description:</comment>
  Delete an entry in the archive using its name
  
  Delete an entry in the archive using its name.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Name of the entry to delete.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: ZipArchive::extractTo
type: function
doc:
<comment>Description:</comment>
  Extract the archive contents
  
  Extract the complete archive or the given files to the specified destination.
  
  The default permissions for extracted files and directories give the widest possible access. This
  can be restricted by setting the current umask, which can be changed using <strong>umask()</strong>.
  
  For security reasons, the original permissions are not restored. For an example of how to restore
  them, see the code sample on the ZipArchive::getExternalAttributesIndex page.

<comment>Param:</comment>
  <info>string</info>             <strong>$pathto</strong>  Location where to extract the files.
  <info>array|string|null</info>  <strong>$files</strong>   The entries to extract. It accepts either a single entry name or an
                              array of names.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: ZipArchive::getArchiveComment
type: function
doc:
<comment>Description:</comment>
  Returns the Zip archive comment
  
  Returns the Zip archive comment.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  If flags is set to <info>ZipArchive::FL_UNCHANGED</info>, the original unchanged comment is
               returned.

<comment>Return:</comment>
  <info>string|false</info>  Returns the Zip archive comment ou <info>false</info> em caso de falha.


id: ZipArchive::getArchiveFlag
type: function
doc:
<comment>Description:</comment>
  Returns the value of a Zip archive global flag
  
  Returns a Zip archive global flag value.

<comment>Param:</comment>
  <info>int</info>  <strong>$flag</strong>   The global flag to retrieve, among <return>AFL_*</return> constants:
               <info>ZipArchive::AFL_RDONLY</info><info>ZipArchive::AFL_IS_TORRENTZIP</info><info>ZipArchive::AFL_WANT_TORRENTZIP</info><info>ZipArchive::AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE</info>
               
               <info>ZipArchive::AFL_RDONLY</info>
               
               <info>ZipArchive::AFL_IS_TORRENTZIP</info>
               
               <info>ZipArchive::AFL_WANT_TORRENTZIP</info>
               
               <info>ZipArchive::AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE</info>
  <info>int</info>  <strong>$flags</strong>  If flags is set to <info>ZipArchive::FL_UNCHANGED</info>, the original unchanged flag is returned.

<comment>Return:</comment>
  <info>int</info>  Returns 1 if flag is set for archive, 0 if not, and -1 if an error occurred.

<comment>See Also:</comment>
   * ZipArchive::setArchiveFlag


id: ZipArchive::getCommentIndex
type: function
doc:
<comment>Description:</comment>
  Returns the comment of an entry using the entry index
  
  Returns the comment of an entry using the entry index.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Index of the entry
  <info>int</info>  <strong>$flags</strong>  If flags is set to <info>ZipArchive::FL_UNCHANGED</info>, the original unchanged comment is
               returned.

<comment>Return:</comment>
  <info>string|false</info>  Returns the comment on success ou <info>false</info> em caso de falha.


id: ZipArchive::getCommentName
type: function
doc:
<comment>Description:</comment>
  Returns the comment of an entry using the entry name
  
  Returns the comment of an entry using the entry name.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   Name of the entry
  <info>int</info>     <strong>$flags</strong>  If flags is set to <info>ZipArchive::FL_UNCHANGED</info>, the original unchanged comment is
                  returned.

<comment>Return:</comment>
  <info>string|false</info>  Returns the comment on success ou <info>false</info> em caso de falha.


id: ZipArchive::getExternalAttributesIndex
type: function
doc:
<comment>Description:</comment>
  Retrieve the external attributes of an entry defined by its index
  
  Retrieve the external attributes of an entry defined by its index.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Index of the entry.
  <info>int</info>  <strong>$opsys</strong>  On success, receive the operating system code defined by one of the
               ZipArchive::OPSYS_ constants.
  <info>int</info>  <strong>$attr</strong>   On success, receive the external attributes. Value depends on operating system.
  <info>int</info>  <strong>$flags</strong>  If flags is set to <info>ZipArchive::FL_UNCHANGED</info>, the original unchanged attributes are
               returned.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: ZipArchive::getExternalAttributesName
type: function
doc:
<comment>Description:</comment>
  Retrieve the external attributes of an entry defined by its name
  
  Retrieve the external attributes of an entry defined by its name.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   Name of the entry.
  <info>int</info>     <strong>$opsys</strong>  On success, receive the operating system code defined by one of the
                  ZipArchive::OPSYS_ constants.
  <info>int</info>     <strong>$attr</strong>   On success, receive the external attributes. Value depends on operating system.
  <info>int</info>     <strong>$flags</strong>  If flags is set to <info>ZipArchive::FL_UNCHANGED</info>, the original unchanged attributes are
                  returned.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: ZipArchive::getFromIndex
type: function
doc:
<comment>Description:</comment>
  Returns the entry contents using its index
  
  Returns the entry contents using its index.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Index of the entry
  <info>int</info>  <strong>$len</strong>    The length to be read from the entry. If <return>0</return>, then the entire entry is read.
  <info>int</info>  <strong>$flags</strong>  The flags to use to open the archive. the following values may be ORed to it.
               <info>ZipArchive::FL_UNCHANGED</info><info>ZipArchive::FL_COMPRESSED</info>
               
               <info>ZipArchive::FL_UNCHANGED</info>
               
               <info>ZipArchive::FL_COMPRESSED</info>

<comment>Return:</comment>
  <info>string|false</info>  Returns the contents of the entry on success ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * ZipArchive::getFromName


id: ZipArchive::getFromName
type: function
doc:
<comment>Description:</comment>
  Returns the entry contents using its name
  
  Returns the entry contents using its name.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   Name of the entry
  <info>int</info>     <strong>$len</strong>    The length to be read from the entry. If <return>0</return>, then the entire entry is read.
  <info>int</info>     <strong>$flags</strong>  The flags to use to find the entry. The following values may be ORed.
                  <info>ZipArchive::FL_UNCHANGED</info><info>ZipArchive::FL_COMPRESSED</info><info>ZipArchive::FL_NOCASE</info>
                  
                  <info>ZipArchive::FL_UNCHANGED</info>
                  
                  <info>ZipArchive::FL_COMPRESSED</info>
                  
                  <info>ZipArchive::FL_NOCASE</info>

<comment>Return:</comment>
  <info>string|false</info>  Returns the contents of the entry on success ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * ZipArchive::getFromIndex


id: ZipArchive::getNameIndex
type: function
doc:
<comment>Description:</comment>
  Returns the name of an entry using its index
  
  Returns the name of an entry using its index.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Index of the entry.
  <info>int</info>  <strong>$flags</strong>  If flags is set to <info>ZipArchive::FL_UNCHANGED</info>, the original unchanged name is returned.

<comment>Return:</comment>
  <info>string|false</info>  Returns the name on success ou <info>false</info> em caso de falha.


id: ZipArchive::getStatusString
type: function
doc:
<comment>Description:</comment>
  Returns the status error message, system and/or zip messages
  
  Returns the status error message, system and/or zip messages.

<comment>Return:</comment>
  <info>string</info>  Returns a <info>string</info> with the status message.


id: ZipArchive::getStream
type: function
doc:
<comment>Description:</comment>
  Get a file handler to the entry defined by its name (read only)
  
  Get a file handler to the entry defined by its name. For now, it only supports read operations.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name of the entry to use.

<comment>Return:</comment>
  <info>resource|false</info>  Returns a file pointer (resource) on success ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * ZipArchive::getStreamIndex
   * ZipArchive::getStreamName
   * Compression Streams


id: ZipArchive::getStreamIndex
type: function
doc:
<comment>Description:</comment>
  Get a file handler to the entry defined by its index (read only)
  
  Get a file handler to the entry defined by its index. For now, it only supports read operations.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Index of the entry
  <info>int</info>  <strong>$flags</strong>  If flags is set to <info>ZipArchive::FL_UNCHANGED</info>, the original unchanged stream is
               returned.

<comment>Return:</comment>
  <info>resource|false</info>  Returns a file pointer (resource) on success ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * ZipArchive::getStreamName


id: ZipArchive::getStreamName
type: function
doc:
<comment>Description:</comment>
  Get a file handler to the entry defined by its name (read only)
  
  Get a file handler to the entry defined by its name. For now, it only supports read operations.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   The name of the entry to use.
  <info>int</info>     <strong>$flags</strong>  If flags is set to <info>ZipArchive::FL_UNCHANGED</info>, the original unchanged stream is
                  returned.

<comment>Return:</comment>
  <info>resource|false</info>  Returns a file pointer (resource) on success ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * ZipArchive::getStreamIndex


id: ZipArchive::isCompressionMethodSupported
type: function
doc:
<comment>Description:</comment>
  Check if a compression method is supported by libzip
  
  Check if a compression method is supported by libzip.

<comment>Param:</comment>
  <info>int</info>   <strong>$method</strong>  The compression method, one of the <info>ZipArchive::CM_*</info> constants.
  <info>bool</info>  <strong>$enc</strong>     If <info>true</info> check for compression, else check for decompression.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * ZipArchive::setCompressionIndex
   * ZipArchive::setCompressionName


id: ZipArchive::isEncryptionMethodSupported
type: function
doc:
<comment>Description:</comment>
  Check if a encryption method is supported by libzip
  
  Check if a compression method is supported by libzip.

<comment>Param:</comment>
  <info>int</info>   <strong>$method</strong>  The encryption method, one of the <info>ZipArchive::EM_*</info> constants.
  <info>bool</info>  <strong>$enc</strong>     If <info>true</info> check for encryption, else check for decryption.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * ZipArchive::setEncryptionIndex
   * ZipArchive::setEncryptionName


id: ZipArchive::locateName
type: function
doc:
<comment>Description:</comment>
  Returns the index of the entry in the archive
  
  Locates an entry using its name.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   The name of the entry to look up
  <info>int</info>     <strong>$flags</strong>  The flags are specified by ORing the following values, or 0 for none of them.
                  <info>ZipArchive::FL_NOCASE</info><info>ZipArchive::FL_NODIR</info>
                  
                  <info>ZipArchive::FL_NOCASE</info>
                  
                  <info>ZipArchive::FL_NODIR</info>

<comment>Return:</comment>
  <info>int|false</info>  Returns the index of the entry on success ou <info>false</info> em caso de falha.


id: ZipArchive::open
type: function
doc:
<comment>Description:</comment>
  Open a ZIP file archive
  
  Opens a new or existing zip archive for reading, writing or modifying.
  
  Since libzip 1.6.0, an empty file is not a valid archive any longer.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The file name of the ZIP archive to open.
  <info>int</info>     <strong>$flags</strong>     The mode to use to open the archive.
                     <info>ZipArchive::OVERWRITE</info><info>ZipArchive::CREATE</info><info>ZipArchive::RDONLY</info><info>ZipArchive::EXCL</info><info>ZipArchive::CHECKCONS</info>
                     
                     <info>ZipArchive::OVERWRITE</info>
                     
                     <info>ZipArchive::CREATE</info>
                     
                     <info>ZipArchive::RDONLY</info>
                     
                     <info>ZipArchive::EXCL</info>
                     
                     <info>ZipArchive::CHECKCONS</info>

<comment>Return:</comment>
  <info>bool|int</info>  Returns <info>true</info> on success, <info>false</info> or one of the following error codes on error:
            <info>ZipArchive::ER_EXISTS</info>File already exists.<info>ZipArchive::ER_INCONS</info>Zip archive
            inconsistent.<info>ZipArchive::ER_INVAL</info>Invalid argument.<info>ZipArchive::ER_MEMORY</info>Malloc
            failure.<info>ZipArchive::ER_NOENT</info>No such file.<info>ZipArchive::ER_NOZIP</info>Not a zip
            archive.<info>ZipArchive::ER_OPEN</info>Can't open file.<info>ZipArchive::ER_READ</info>Read
            error.<info>ZipArchive::ER_SEEK</info>Seek error.
            
            File already exists.
            
            Zip archive inconsistent.
            
            Invalid argument.
            
            Malloc failure.
            
            No such file.
            
            Not a zip archive.
            
            Can't open file.
            
            Read error.
            
            Seek error.


id: ZipArchive::registerCancelCallback
type: function
doc:
<comment>Description:</comment>
  Register a callback to allow cancellation during archive close.
  
  Register a <strong>$callback</strong> function to allow cancellation during archive close.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  If this function return 0 operation will continue, other value it will be
                       cancelled.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * ZipArchive::registerProgressCallback


id: ZipArchive::registerProgressCallback
type: function
doc:
<comment>Description:</comment>
  Register a callback to provide updates during archive close.
  
  Register a <strong>$callback</strong> function to provide updates during archive close.

<comment>Param:</comment>
  <info>float</info>     <strong>$rate</strong>      Change between each call of the callback (from 0.0 to 1.0).
  <info>callable</info>  <strong>$callback</strong>  This function will receive the current <strong>$state</strong> as a <info>float</info> (from 0.0 to 1.0).

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * ZipArchive::registerCancelCallback


id: ZipArchive::renameIndex
type: function
doc:
<comment>Description:</comment>
  Renames an entry defined by its index
  
  Renames an entry defined by its index.

<comment>Param:</comment>
  <info>int</info>     <strong>$index</strong>     Index of the entry to rename.
  <info>string</info>  <strong>$new_name</strong>  New name.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: ZipArchive::renameName
type: function
doc:
<comment>Description:</comment>
  Renames an entry defined by its name
  
  Renames an entry defined by its name.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>      Name of the entry to rename.
  <info>string</info>  <strong>$new_name</strong>  New name.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: ZipArchive::replaceFile
type: function
doc:
<comment>Description:</comment>
  Replace file in ZIP archive with a given path
  
  Replace file in ZIP archive with a given path.
  
  Para portabilidade máxima, é recomendável sempre usar barras normais (<return>/</return>) como separador de
  diretório em nomes de arquivos ZIP.

<comment>Param:</comment>
  <info>string</info>  <strong>$filepath</strong>  The path to the file to add.
  <info>int</info>     <strong>$index</strong>     The index of the file to be replaced, its name is unchanged.
  <info>int</info>     <strong>$start</strong>     For partial copy, start position.
  <info>int</info>     <strong>$length</strong>    For partial copy, length to be copied, if <info>ZipArchive::LENGTH_TO_END</info> (0) the
                     file size is used, if <info>ZipArchive::LENGTH_UNCHECKED</info> the whole file is used
                     (starting from <strong>$start</strong>).
  <info>int</info>     <strong>$flags</strong>     Bitmask consisting of <info>ZipArchive::FL_ENC_GUESS</info>, <info>ZipArchive::FL_ENC_UTF_8</info>,
                     <info>ZipArchive::FL_ENC_CP437</info>, <info>ZipArchive::FL_OPEN_FILE_NOW</info>. The behaviour of these
                     constants is described on the ZIP constants page.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * ZipArchive::addFile


id: ZipArchive::setArchiveComment
type: function
doc:
<comment>Description:</comment>
  Set the comment of a ZIP archive
  
  Set the comment of a ZIP archive.

<comment>Param:</comment>
  <info>string</info>  <strong>$comment</strong>  The contents of the comment.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: ZipArchive::setArchiveFlag
type: function
doc:
<comment>Description:</comment>
  Set a global flag of a ZIP archive
  
  Set a global flag of a ZIP archive.

<comment>Param:</comment>
  <info>int</info>  <strong>$flag</strong>   The global flag to change, among <return>AFL_*</return> constants.
               <info>ZipArchive::AFL_WANT_TORRENTZIP</info><info>ZipArchive::AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE</info>
               
               <info>ZipArchive::AFL_WANT_TORRENTZIP</info>
               
               <info>ZipArchive::AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE</info>
  <info>int</info>  <strong>$value</strong>  The new value of the flag.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * ZipArchive::getArchiveFlag


id: ZipArchive::setCommentIndex
type: function
doc:
<comment>Description:</comment>
  Set the comment of an entry defined by its index
  
  Set the comment of an entry defined by its index.

<comment>Param:</comment>
  <info>int</info>     <strong>$index</strong>    Index of the entry.
  <info>string</info>  <strong>$comment</strong>  The contents of the comment.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: ZipArchive::setCommentName
type: function
doc:
<comment>Description:</comment>
  Set the comment of an entry defined by its name
  
  Set the comment of an entry defined by its name.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>     Name of the entry.
  <info>string</info>  <strong>$comment</strong>  The contents of the comment.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: ZipArchive::setCompressionIndex
type: function
doc:
<comment>Description:</comment>
  Set the compression method of an entry defined by its index
  
  Set the compression method of an entry defined by its index.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>      Index of the entry.
  <info>int</info>  <strong>$method</strong>     The compression method, one of the <info>ZipArchive::CM_*</info> constants.
  <info>int</info>  <strong>$compflags</strong>  Compression level.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: ZipArchive::setCompressionName
type: function
doc:
<comment>Description:</comment>
  Set the compression method of an entry defined by its name
  
  Set the compression method of an entry defined by its name.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>       Name of the entry.
  <info>int</info>     <strong>$method</strong>     The compression method, one of the <info>ZipArchive::CM_*</info> constants.
  <info>int</info>     <strong>$compflags</strong>  Compression level.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: ZipArchive::setEncryptionIndex
type: function
doc:
<comment>Description:</comment>
  Set the encryption method of an entry defined by its index
  
  Set the encryption method of an entry defined by its index.

<comment>Param:</comment>
  <info>int</info>          <strong>$index</strong>     Index of the entry.
  <info>int</info>          <strong>$method</strong>    The encryption method defined by one of the ZipArchive::EM_ constants.
  <info>string|null</info>  <strong>$password</strong>  Optional password, default used when missing.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * ZipArchive::setPassword
   * ZipArchive::setEncryptionName


id: ZipArchive::setEncryptionName
type: function
doc:
<comment>Description:</comment>
  Set the encryption method of an entry defined by its name
  
  Set the encryption method of an entry defined by its name.

<comment>Param:</comment>
  <info>string</info>       <strong>$name</strong>      Name of the entry.
  <info>int</info>          <strong>$method</strong>    The encryption method defined by one of the ZipArchive::EM_ constants.
  <info>string|null</info>  <strong>$password</strong>  Optional password, default used when missing.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * ZipArchive::setPassword
   * ZipArchive::setEncryptionIndex


id: ZipArchive::setExternalAttributesIndex
type: function
doc:
<comment>Description:</comment>
  Set the external attributes of an entry defined by its index
  
  Set the external attributes of an entry defined by its index.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Index of the entry.
  <info>int</info>  <strong>$opsys</strong>  The operating system code defined by one of the ZipArchive::OPSYS_ constants.
  <info>int</info>  <strong>$attr</strong>   The external attributes. Value depends on operating system.
  <info>int</info>  <strong>$flags</strong>  Optional flags. Currently unused.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: ZipArchive::setExternalAttributesName
type: function
doc:
<comment>Description:</comment>
  Set the external attributes of an entry defined by its name
  
  Set the external attributes of an entry defined by its name.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   Name of the entry.
  <info>int</info>     <strong>$opsys</strong>  The operating system code defined by one of the ZipArchive::OPSYS_ constants.
  <info>int</info>     <strong>$attr</strong>   The external attributes. Value depends on operating system.
  <info>int</info>     <strong>$flags</strong>  Optional flags. Currently unused.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: ZipArchive::setMtimeIndex
type: function
doc:
<comment>Description:</comment>
  Set the modification time of an entry defined by its index
  
  Set the modification time of an entry defined by its index.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>      Index of the entry.
  <info>int</info>  <strong>$timestamp</strong>  The modification time (unix timestamp) of the file.
  <info>int</info>  <strong>$flags</strong>      Optional flags, unused for now.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * ZipArchive::setMtimeName


id: ZipArchive::setMtimeName
type: function
doc:
<comment>Description:</comment>
  Set the modification time of an entry defined by its name
  
  Set the modification time of an entry defined by its name.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>       Name of the entry.
  <info>int</info>     <strong>$timestamp</strong>  The modification time (unix timestamp) of the file.
  <info>int</info>     <strong>$flags</strong>      Optional flags, unused for now.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * ZipArchive::setMtimeIndex


id: ZipArchive::setPassword
type: function
doc:
<comment>Description:</comment>
  Set the password for the active archive
  
  Sets the password for the active archive.

<comment>Param:</comment>
  <info>string</info>  <strong>$password</strong>  The password to be used for the archive.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * ZipArchive::setEncryptionIndex
   * ZipArchive::setEncryptionName


id: ZipArchive::statIndex
type: function
doc:
<comment>Description:</comment>
  Get the details of an entry defined by its index
  
  The  function  obtains  information  about the entry defined by its index.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Index of the entry
  <info>int</info>  <strong>$flags</strong>  <info>ZipArchive::FL_UNCHANGED</info> may be ORed to it to request information  about  the
               original  file  in  the archive, ignoring any changes made.

<comment>Return:</comment>
  <info>array|false</info>  Returns an array containing the entry details ou <info>false</info> em caso de falha.


id: ZipArchive::statName
type: function
doc:
<comment>Description:</comment>
  Get the details of an entry defined by its name
  
  The function obtains information about the entry defined by its name.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   Name of the entry
  <info>int</info>     <strong>$flags</strong>  The flags argument specifies how the name lookup should be done. Also,
                  <info>ZipArchive::FL_UNCHANGED</info> may be ORed to it to request information  about  the
                  original  file  in  the archive, ignoring any changes made.
                  <info>ZipArchive::FL_NOCASE</info><info>ZipArchive::FL_NODIR</info><info>ZipArchive::FL_UNCHANGED</info>
                  
                  <info>ZipArchive::FL_NOCASE</info>
                  
                  <info>ZipArchive::FL_NODIR</info>
                  
                  <info>ZipArchive::FL_UNCHANGED</info>

<comment>Return:</comment>
  <info>array|false</info>  Returns an array containing the entry details  ou <info>false</info> em caso de falha.


id: ZipArchive::unchangeAll
type: function
doc:
<comment>Description:</comment>
  Undo all changes done in the archive
  
  Undo all changes done in the archive.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: ZipArchive::unchangeArchive
type: function
doc:
<comment>Description:</comment>
  Revert all global changes done in the archive
  
  Revert all global changes to the archive.  For now, this only reverts archive comment changes.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: ZipArchive::unchangeIndex
type: function
doc:
<comment>Description:</comment>
  Revert all changes done to an entry at the given index
  
  Revert all changes done to an entry at the given index.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Index of the entry.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: ZipArchive::unchangeName
type: function
doc:
<comment>Description:</comment>
  Revert all changes done to an entry with the given name
  
  Revert all changes done to an entry.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Name of the entry.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: Zookeeper::APIERROR
type: constant
doc:
<comment>Description:</comment>
  This is never thrown by the server, it shouldn't be used other than to indicate a range.
  Specifically error codes greater than this value are API errors (while values less than this
  indicate a Zookeeper::SYSTEMERROR).


id: Zookeeper::CHANGED_EVENT
type: constant
doc:
<comment>Description:</comment>
  A node has changed
  
  This is only generated by watches on nodes. These watches are set using Zookeeper::exists and
  Zookeeper::get.


id: Zookeeper::CHILD_EVENT
type: constant
doc:
<comment>Description:</comment>
  A change as occurred in the list of children
  
  This is only generated by watches on the child list of a node. These watches are set using
  Zookeeper::getChildren.


id: Zookeeper::CREATED_EVENT
type: constant
doc:
<comment>Description:</comment>
  A node has been created
  
  This is only generated by watches on non-existent nodes. These watches are set using
  Zookeeper::exists.


id: Zookeeper::DELETED_EVENT
type: constant
doc:
<comment>Description:</comment>
  A node has been deleted
  
  This is only generated by watches on nodes. These watches are set using Zookeeper::exists and
  Zookeeper::get.


id: Zookeeper::EPHEMERAL
type: constant
doc:
<comment>Description:</comment>
  If Zookeeper::EPHEMERAL flag is set, the node will automatically get removed if the client session
  goes away.


id: Zookeeper::NEWCONFIGNOQUORUM
type: constant
doc:
<comment>Description:</comment>
  No quorum of new config is connected and up-to-date with the leader of last committed config - try
  invoking reconfiguration after new servers are connected and synced.
  
  Available as of ZooKeeper 3.5.0


id: Zookeeper::NOTWATCHING_EVENT
type: constant
doc:
<comment>Description:</comment>
  A watch has been removed
  
  This is generated when the server for some reason, probably a resource constraint, will no longer
  watch a node for a client.


id: Zookeeper::RECONFIGDISABLED
type: constant
doc:
<comment>Description:</comment>
  Attempts to perform a reconfiguration operation when reconfiguration feature is disabled.


id: Zookeeper::RECONFIGINPROGRESS
type: constant
doc:
<comment>Description:</comment>
  Reconfiguration requested while another reconfiguration is currently in progress. This is
  currently not supported. Please retry.
  
  Available as of ZooKeeper 3.5.0


id: Zookeeper::SEQUENCE
type: constant
doc:
<comment>Description:</comment>
  If the Zookeeper::SEQUENCE flag is set, a unique monotonically increasing sequence number is
  appended to the path name. The sequence number is always fixed length of 10 digits, 0 padded.


id: Zookeeper::SESSION_EVENT
type: constant
doc:
<comment>Description:</comment>
  A session has been lost
  
  This is generated when a client loses contact or reconnects with a server.


id: Zookeeper::SYSTEMERROR
type: constant
doc:
<comment>Description:</comment>
  This is never thrown by the server, it shouldn't be used other than to indicate a range.
  Specifically error codes greater than this value, but lesser than Zookeeper::APIERROR, are system
  errors.


id: Zookeeper::__construct
type: function
doc:
<comment>Description:</comment>
  Create a handle to used communicate with zookeeper
  
  This method creates a new handle and a zookeeper session that corresponds to that handle. Session
  establishment is asynchronous, meaning that the session should not be considered established until
  (and unless) an event of state ZOO_CONNECTED_STATE is received.

<comment>Param:</comment>
  <info>string</info>    <strong>$host</strong>          comma separated host:port pairs, each corresponding to a zk server. e.g.
                           "127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002"
  <info>callable</info>  <strong>$watcher_cb</strong>    the global watcher callback function. When notifications are triggered
                           this function will be invoked.
  <info>int</info>       <strong>$recv_timeout</strong>  the timeout for this session, only valid if the connections is currently
                           connected (ie. last watcher state is ZOO_CONNECTED_STATE).

<comment>See Also:</comment>
   * Zookeeper::connect
   * <class>ZookeeperException</class>


id: Zookeeper::addAuth
type: function
doc:
<comment>Description:</comment>
  Specify application credentials
  
  The application calls this function to specify its credentials for purposes of authentication. The
  server will use the security provider specified by the scheme parameter to authenticate the client
  connection. If the authentication request has failed: - the server connection is dropped. - the
  watcher is called with the ZOO_AUTH_FAILED_STATE value as the state parameter.

<comment>Param:</comment>
  <info>string</info>    <strong>$scheme</strong>         The id of authentication scheme. Natively supported: "digest"
                            password-based authentication
  <info>string</info>    <strong>$cert</strong>           Application credentials. The actual value depends on the scheme.
  <info>callable</info>  <strong>$completion_cb</strong>  The routine to invoke when the request completes. One of the following
                            result codes may be passed into the completion callback: - ZOK operation
                            completed successfully - ZAUTHFAILED authentication failed

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * Zookeeper::create
   * Zookeeper::setAcl
   * Zookeeper::getAcl
   * ZooKeeper States
   * <class>ZookeeperException</class>


id: Zookeeper::close
type: function
doc:
<comment>Description:</comment>
  Close the zookeeper handle and free up any resources

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * Zookeeper::__construct
   * Zookeeper::connect
   * <class>ZookeeperException</class>


id: Zookeeper::connect
type: function
doc:
<comment>Description:</comment>
  Create a handle to used communicate with zookeeper
  
  This method creates a new handle and a zookeeper session that corresponds to that handle. Session
  establishment is asynchronous, meaning that the session should not be considered established until
  (and unless) an event of state ZOO_CONNECTED_STATE is received.

<comment>Param:</comment>
  <info>string</info>    <strong>$host</strong>          Comma separated host:port pairs, each corresponding to a zk server. e.g.
                           "127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002"
  <info>callable</info>  <strong>$watcher_cb</strong>    The global watcher callback function. When notifications are triggered
                           this function will be invoked.
  <info>int</info>       <strong>$recv_timeout</strong>  The timeout for this session, only valid if the connections is currently
                           connected (ie. last watcher state is ZOO_CONNECTED_STATE).

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * Zookeeper::__construct
   * <class>ZookeeperException</class>


id: Zookeeper::create
type: function
doc:
<comment>Description:</comment>
  Create a node synchronously
  
  This method will create a node in ZooKeeper. A node can only be created if it does not already
  exists. The Create Flags affect the creation of nodes. If ZOO_EPHEMERAL flag is set, the node will
  automatically get removed if the client session goes away. If the ZOO_SEQUENCE flag is set, a
  unique monotonically increasing sequence number is appended to the path name.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>   The name of the node. Expressed as a file name with slashes separating ancestors
                  of the node.
  <info>string</info>  <strong>$value</strong>  The data to be stored in the node.
  <info>array</info>   <strong>$acls</strong>   The initial ACL of the node. The ACL must not be null or empty.
  <info>int</info>     <strong>$flags</strong>  this parameter can be set to 0 for normal create or an OR of the Create Flags

<comment>Return:</comment>
  <info>string</info>  Returns the path of the new node (this might be different than the supplied path because
          of the ZOO_SEQUENCE flag) on success, and false on failure.

<comment>See Also:</comment>
   * Zookeeper::delete
   * Zookeeper::getChildren
   * ZooKeeper Permissions
   * <class>ZookeeperException</class>


id: Zookeeper::delete
type: function
doc:
<comment>Description:</comment>
  Delete a node in zookeeper synchronously

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>     The name of the node. Expressed as a file name with slashes separating ancestors
                    of the node.
  <info>int</info>     <strong>$version</strong>  The expected version of the node. The function will fail if the actual version
                    of the node does not match the expected version. If -1 is used the version check
                    will not take place.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * Zookeeper::create
   * Zookeeper::getChildren
   * <class>ZookeeperException</class>


id: Zookeeper::exists
type: function
doc:
<comment>Description:</comment>
  Checks the existence of a node in zookeeper synchronously

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>        The name of the node. Expressed as a file name with slashes separating
                         ancestors of the node.
  <info>callable</info>  <strong>$watcher_cb</strong>  if nonzero, a watch will be set at the server to notify the client if the
                         node changes. The watch will be set even if the node does not

<comment>Return:</comment>
  <info>array</info>  Returns the value of stat for the path if the given node exists, otherwise false.

<comment>See Also:</comment>
   * Zookeeper::get
   * <class>ZookeeperException</class>


id: Zookeeper::get
type: function
doc:
<comment>Description:</comment>
  Gets the data associated with a node synchronously

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>        The name of the node. Expressed as a file name with slashes separating
                         ancestors of the node.
  <info>callable</info>  <strong>$watcher_cb</strong>  If nonzero, a watch will be set at the server to notify the client if the
                         node changes.
  <info>array</info>     <strong>$stat</strong>        If not NULL, will hold the value of stat for the path on return.
  <info>int</info>       <strong>$max_size</strong>    Max size of the data. If 0 is used, this method will return the whole data.

<comment>Return:</comment>
  <info>string</info>  Returns the data on success, and false on failure.

<comment>See Also:</comment>
   * Zookeeper::set
   * <class>ZookeeperException</class>


id: Zookeeper::getAcl
type: function
doc:
<comment>Description:</comment>
  Gets the acl associated with a node synchronously

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  The name of the node. Expressed as a file name with slashes separating ancestors of
                 the node.

<comment>Return:</comment>
  <info>array</info>  Return acl array on success and false on failure.

<comment>See Also:</comment>
   * Zookeeper::create
   * Zookeeper::setAcl
   * ZooKeeper Permissions
   * <class>ZookeeperException</class>


id: Zookeeper::getChildren
type: function
doc:
<comment>Description:</comment>
  Lists the children of a node synchronously

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>        The name of the node. Expressed as a file name with slashes separating
                         ancestors of the node.
  <info>callable</info>  <strong>$watcher_cb</strong>  If nonzero, a watch will be set at the server to notify the client if the
                         node changes.

<comment>Return:</comment>
  <info>array</info>  Returns an array with children paths on success, and false on failure.

<comment>See Also:</comment>
   * Zookeeper::create
   * Zookeeper::delete
   * <class>ZookeeperException</class>


id: Zookeeper::getClientId
type: function
doc:
<comment>Description:</comment>
  Return the client session id, only valid if the connections is currently connected (ie. last
  watcher
  state is ZOO_CONNECTED_STATE)

<comment>Return:</comment>
  <info>int</info>  Returns the client session id on success, and false on failure.

<comment>See Also:</comment>
   * Zookeeper::__construct
   * Zookeeper::connect
   * Zookeeper::getState
   * ZooKeeper States
   * <class>ZookeeperException</class>


id: Zookeeper::getConfig
type: function
doc:
<comment>Description:</comment>
  Get instance of ZookeeperConfig

<comment>Return:</comment>
  <info>ZookeeperConfig</info>  Returns instance of <class>ZookeeperConfig</class>.

<comment>See Also:</comment>
   * <class>ZookeeperConfig</class>


id: Zookeeper::getRecvTimeout
type: function
doc:
<comment>Description:</comment>
  Return the timeout for this session, only valid if the connections is currently connected (ie.
  last
  watcher state is ZOO_CONNECTED_STATE). This value may change after a server re-connect

<comment>Return:</comment>
  <info>int</info>  Returns the timeout for this session on success, and false on failure.

<comment>See Also:</comment>
   * Zookeeper::__construct
   * Zookeeper::connect
   * <class>ZookeeperException</class>


id: Zookeeper::getState
type: function
doc:
<comment>Description:</comment>
  Get the state of the zookeeper connection

<comment>Return:</comment>
  <info>int</info>  Returns the state of zookeeper connection on success, and false on failure.

<comment>See Also:</comment>
   * Zookeeper::__construct
   * Zookeeper::connect
   * Zookeeper::getClientId
   * ZooKeeper States
   * <class>ZookeeperException</class>


id: Zookeeper::isRecoverable
type: function
doc:
<comment>Description:</comment>
  Checks if the current zookeeper connection state can be recovered
  
  The application must close the handle and try to reconnect.

<comment>Return:</comment>
  <info>bool</info>  Returns true/false on success, and false on failure.

<comment>See Also:</comment>
   * Zookeeper::__construct
   * Zookeeper::connect
   * Zookeeper::getClientId
   * ZooKeeper States
   * <class>ZookeeperException</class>


id: Zookeeper::set
type: function
doc:
<comment>Description:</comment>
  Sets the data associated with a node

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>     The name of the node. Expressed as a file name with slashes separating ancestors
                    of the node.
  <info>string</info>  <strong>$value</strong>    The data to be stored in the node.
  <info>int</info>     <strong>$version</strong>  The expected version of the node. The function will fail if the actual version
                    of the node does not match the expected version. If -1 is used the version check
                    will not take place.
  <info>array</info>   <strong>$stat</strong>     If not NULL, will hold the value of stat for the path on return.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * Zookeeper::create
   * Zookeeper::get
   * <class>ZookeeperException</class>


id: Zookeeper::setAcl
type: function
doc:
<comment>Description:</comment>
  Sets the acl associated with a node synchronously

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>     The name of the node. Expressed as a file name with slashes separating ancestors
                    of the node.
  <info>int</info>     <strong>$version</strong>  The expected version of the path.
  <info>array</info>   <strong>$acl</strong>      The acl to be set on the path.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * Zookeeper::create
   * Zookeeper::getAcl
   * ZooKeeper Permissions
   * <class>ZookeeperException</class>


id: Zookeeper::setDebugLevel
type: function
doc:
<comment>Description:</comment>
  Sets the debugging level for the library

<comment>Param:</comment>
  <info>int</info>  <strong>$logLevel</strong>  ZooKeeper log level constants.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * ZooKeeper Log Levels
   * <class>ZookeeperException</class>


id: Zookeeper::setDeterministicConnOrder
type: function
doc:
<comment>Description:</comment>
  Enable/disable quorum endpoint order randomization
  
  If passed a true value, will make the client connect to quorum peers in the order as specified in
  the zookeeper_init() call. A false value causes zookeeper_init() to permute the peer endpoints
  which is good for more even client connection distribution among the quorum peers. ZooKeeper C
  Client uses false by default.

<comment>Param:</comment>
  <info>bool</info>  <strong>$yesOrNo</strong>  Disable/enable quorum endpoint order randomization.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * Zookeeper::__construct
   * Zookeeper::connect
   * <class>ZookeeperException</class>


id: Zookeeper::setLogStream
type: function
doc:
<comment>Description:</comment>
  Sets the stream to be used by the library for logging
  
  The zookeeper library uses stderr as its default log stream. Application must make sure the stream
  is writable. Passing in NULL resets the stream to its default value (stderr).

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  The stream to be used by the library for logging.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * Zookeeper::setDebugLevel
   * <class>ZookeeperException</class>


id: Zookeeper::setWatcher
type: function
doc:
<comment>Description:</comment>
  Set a watcher function

<comment>Param:</comment>
  <info>callable</info>  <strong>$watcher_cb</strong>  A watch will be set at the server to notify the client if the node changes.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * Zookeeper::exists
   * Zookeeper::get
   * <class>ZookeeperException</class>


id: ZookeeperConfig::add
type: function
doc:
<comment>Description:</comment>
  Add servers to the ensemble

<comment>Param:</comment>
  <info>string</info>  <strong>$members</strong>  Comma separated list of servers to be added to the ensemble. Each has a
                    configuration line for a server to be added (as would appear in a configuration
                    file), only for maj. quorums.
  <info>int</info>     <strong>$version</strong>  The expected version of the node. The function will fail if the actual version
                    of the node does not match the expected version. If -1 is used the version check
                    will not take place.
  <info>array</info>   <strong>$stat</strong>     If not NULL, will hold the value of stat for the path on return.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * ZookeeperConfig::get
   * ZookeeperConfig::set
   * ZookeeperConfig::remove
   * <class>ZookeeperException</class>


id: ZookeeperConfig::get
type: function
doc:
<comment>Description:</comment>
  Gets the last committed configuration of the ZooKeeper cluster as it is known to the server to
  which
  the client is connected, synchronously

<comment>Param:</comment>
  <info>callable</info>  <strong>$watcher_cb</strong>  If nonzero, a watch will be set at the server to notify the client if the
                         node changes.
  <info>array</info>     <strong>$stat</strong>        If not NULL, will hold the value of stat for the path on return.

<comment>Return:</comment>
  <info>string</info>  Returns the configuration string on success, and false on failure.

<comment>See Also:</comment>
   * ZookeeperConfig::set
   * ZookeeperConfig::add
   * ZookeeperConfig::remove
   * <class>ZookeeperException</class>


id: ZookeeperConfig::remove
type: function
doc:
<comment>Description:</comment>
  Remove servers from the ensemble

<comment>Param:</comment>
  <info>string</info>  <strong>$id_list</strong>  Comma separated list of server IDs to be removed from the ensemble. Each has an
                    id of a server to be removed, only for maj. quorums.
  <info>int</info>     <strong>$version</strong>  The expected version of the node. The function will fail if the actual version
                    of the node does not match the expected version. If -1 is used the version check
                    will not take place.
  <info>array</info>   <strong>$stat</strong>     If not NULL, will hold the value of stat for the path on return.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * ZookeeperConfig::get
   * ZookeeperConfig::add
   * ZookeeperConfig::set
   * <class>ZookeeperException</class>


id: ZookeeperConfig::set
type: function
doc:
<comment>Description:</comment>
  Change ZK cluster ensemble membership and roles of ensemble peers

<comment>Param:</comment>
  <info>string</info>  <strong>$members</strong>  Comma separated list of new membership (e.g., contents of a membership
                    configuration file) - for use only with a non-incremental reconfiguration.
  <info>int</info>     <strong>$version</strong>  The expected version of the node. The function will fail if the actual version
                    of the node does not match the expected version. If -1 is used the version check
                    will not take place.
  <info>array</info>   <strong>$stat</strong>     If not NULL, will hold the value of stat for the path on return.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * ZookeeperConfig::get
   * ZookeeperConfig::add
   * ZookeeperConfig::remove
   * <class>ZookeeperException</class>


id: ZookeeperMarshallingException
type: class
doc:
<comment>Description:</comment>
  The ZooKeeper exception (while marshalling or unmarshalling data) handling class.


id: ZookeeperNoNodeException
type: class
doc:
<comment>Description:</comment>
  The ZooKeeper exception (when node does not exist) handling class.


id: __CLASS__
type: constant
doc:
<comment>Description:</comment>
  O nome da classe. O nome da classe inclui o namespace em que foi declarada (por exemplo, <return>Foo\Bar</return>).
  Quando usada em um método de trait, __CLASS__ é o nome da classe em que o trait for usado.


id: __DIR__
type: constant
doc:
<comment>Description:</comment>
  O diretório do arquivo. Se usada dentro de um include, o diretório do arquivo incluído será
  retornado. Isso é equivalente a <return>dirname(__FILE__)</return>. O nome do diretório não possui barra no final,
  a menos que seja o diretório raiz.


id: __FILE__
type: constant
doc:
<comment>Description:</comment>
  O caminho completo e o nome do arquivo com links simbólicos resolvidos. Se usada dentro de um
  include, o nome do arquivo incluído será retornado.


id: __FUNCTION__
type: constant
doc:
<comment>Description:</comment>
  O nome da função ou <return>{closure}</return> para funções anônimas.


id: __TRAIT__
type: constant
doc:
<comment>Description:</comment>
  O nome do trait. O nome do trait inclui o namespace em que foi declarado (por exemplo, <return>Foo\Bar</return>).


id: __autoload
type: function
doc:
<comment>Description:</comment>
  Tenta carregar uma classe indefinida
  
  Pode-se definir esta função para habilitar carregamento automático de classes.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  Nome da classe a ser carregada

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * <strong>spl_autoload_register()</strong>


id: __halt_compiler
type: function
doc:
<comment>Description:</comment>
  Para a execução do compilador
    
  
  Para a execução do compilador. Pode ser útil para embutir dados em scripts PHP, como os arquivos
  de instalação.
  
  A posição do byte do início dos dados pode ser determinada pela constante <info>__COMPILER_HALT_OFFSET__</info>
  que é definida somente se houver uma função <strong>__halt_compiler()</strong> presente no arquivo.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.


id: abs
type: function
doc:
<comment>Description:</comment>
  Valor absoluto
  
  Retorna o valor absoluto de <strong>$num</strong>.

<comment>Param:</comment>
  <info>int|float</info>  <strong>$num</strong>  O valor numérico a processar

<comment>Return:</comment>
  <info>int|float</info>  O valor absoluto de <strong>$num</strong>. Se o argumento <strong>$num</strong> for do tipo <info>float</info>, o número retornado
             também será <info>float</info>, caso contrário será <info>int</info> (pois <info>float</info> normalmente tem uma faixa de
             valores maior que <info>int</info>).

<comment>See Also:</comment>
   * <strong>gmp_abs()</strong>
   * <strong>gmp_sign()</strong>


id: acos
type: function
doc:
<comment>Description:</comment>
  Arco cosseno
  
  Retorna o arco cosseno de <strong>$num</strong> em radianos. <strong>acos()</strong> é a função inversa de <strong>cos()</strong>, o que significa
  que $num == cos(acos($num)) para qualquer valor de <strong>$num</strong> que esteja no domínio de <strong>acos()</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  O argumento a processar

<comment>Return:</comment>
  <info>float</info>  O arco cosseno de <strong>$num</strong> em radianos.

<comment>See Also:</comment>
   * <strong>cos()</strong>
   * <strong>acosh()</strong>
   * <strong>asin()</strong>
   * <strong>atan()</strong>


id: acosh
type: function
doc:
<comment>Description:</comment>
  Arco cosseno hiperbólico
  
  Retorna o arco cosseno hiperbólico de <strong>$num</strong>, isto é, o valor cujo cosseno hiperbólico é <strong>$num</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  O valor a processar

<comment>Return:</comment>
  <info>float</info>  O arco cosseno hiperbólico de <strong>$num</strong>

<comment>See Also:</comment>
   * <strong>cosh()</strong>
   * <strong>acos()</strong>
   * <strong>asinh()</strong>
   * <strong>atanh()</strong>


id: addcslashes
type: function
doc:
<comment>Description:</comment>
  Quote string with slashes in a C style
  
  Returns a string with backslashes before characters that are listed in <strong>$characters</strong> parameter.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>      The string to be escaped.
  <info>string</info>  <strong>$characters</strong>  A list of characters to be escaped. If <strong>$characters</strong> contains characters <return>\n</return>, <return>\r</return>
                       etc., they are converted in C-like style, while other non-alphanumeric
                       characters with ASCII codes lower than 32 and higher than 126 converted to
                       octal representation.
                       
                       When you define a sequence of characters in the <strong>$characters</strong> argument make
                       sure that you know what characters come between the characters that you set
                       as the start and end of the range.
                       ]]> Also, if the first character in a range has a higher ASCII value than the
                       second character in the range, no range will be constructed.  Only the start,
                       end and period characters will be escaped. Use the <strong>ord()</strong> function to find the
                       ASCII value for a character.
                       ]]>
                       
                       Be careful if you choose to escape characters 0, a, b, f, n, r, t and v. They
                       will be converted to \0, \a, \b, \f, \n, \r, \t and \v, all of which are
                       predefined escape sequences in C. Many of these sequences are also defined in
                       other C-derived languages, including PHP, meaning that you may not get the
                       desired result if you use the output of <strong>addcslashes()</strong> to generate code in
                       those languages with these characters defined in <strong>$characters</strong>.

<comment>Return:</comment>
  <info>string</info>  Returns the escaped string.

<comment>See Also:</comment>
   * <strong>stripcslashes()</strong>
   * <strong>stripslashes()</strong>
   * <strong>addslashes()</strong>
   * <strong>htmlspecialchars()</strong>
   * <strong>quotemeta()</strong>


id: addslashes
type: function
doc:
<comment>Description:</comment>
  Adiciona barras a uma string
  
  Retorna uma string com barras adicionadas antes de caracteres que precisam ser escapados. Estes
  caracteres são: aspas simples (<return>'</return>)aspas duplas (<return>"</return>)barra invertida (<return>\</return>)NUL (o byte NUL)
  
  Um caso de uso de <strong>addslashes()</strong> é o escape dos caracteres mencionados em uma string que deve ser
  avaliada pelo PHP:
  ]]>
  
  A função <strong>addslashes()</strong> às vezes é usada incorretamente para tentar prevenir Injeção de SQL. Em vez
  disso, funções de escape específicas do banco de dados e/ou instruções preparadas devem ser
  usadas.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  A string a ser escapada.

<comment>Return:</comment>
  <info>string</info>  Retorna a string com escapes.

<comment>See Also:</comment>
   * <strong>stripcslashes()</strong>
   * <strong>stripslashes()</strong>
   * <strong>addcslashes()</strong>
   * <strong>htmlspecialchars()</strong>
   * <strong>quotemeta()</strong>
   * <strong>get_magic_quotes_gpc()</strong>


id: apache_child_terminate
type: function
doc:
<comment>Description:</comment>
  Finaliza o processo Apache depois da requisição
  
  <strong>apache_child_terminate()</strong> registrará o processo Apache atual para finalização após a execução do
  código PHP terminar. Isto pode ser utilizado para terminar um processo depois que um script que
  tem um alto consumo de memória for rodado e quando essa memória normalmente só é liberada
  internamente, mas não é devolviva para o sistema operacional.
  
  Funciona no Apache e em servidores FastCGI.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * <strong>exit()</strong>


id: apache_get_modules
type: function
doc:
<comment>Description:</comment>
  Retorna uma lista de módulos carregados do Apache
  
  Retorna uma lista de módulos carregados do Apache.

<comment>Return:</comment>
  <info>array</info>  Um <info>array</info> de módulos carregados do Apache.


id: apache_get_version
type: function
doc:
<comment>Description:</comment>
  Retorna a versão do Apache
  
  Retorna a versão do Apache.

<comment>Return:</comment>
  <info>string|false</info>  Retorna a versão do Apache se tiver sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>phpinfo()</strong>


id: apache_getenv
type: function
doc:
<comment>Description:</comment>
  Retorna uma variável subprocess_env do Apache
  
  Retorna a variável de ambiente do Apache especificada por <strong>$variable</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$variable</strong>     A variável de ambiente do Apache
  <info>bool</info>    <strong>$walk_to_top</strong>  Se deve ou não retorna a variável de alto-ní­vel disponí­veis em todas as
                        camadas do Apache.

<comment>Return:</comment>
  <info>string|false</info>  O valor da variável de ambiente do Apache se tiver sucesso, ou <info>false</info> se falhar

<comment>See Also:</comment>
   * <strong>apache_setenv()</strong>
   * <strong>getenv()</strong>
   * Superglobais


id: apache_lookup_uri
type: function
doc:
<comment>Description:</comment>
  Realiza uma requisição parcial para a URI especificada e retorna todas as informações sobre ela
  
  Realiza uma requisição parcial para uma URI. Trabalha o suficiente para obter odas as informações
  importantes sobre o recurso informado.
  
  Esta função é suportada quando o PHP
  é instalado como um módulo do servidor web Apache.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  O nome do arquivo (URI) que está sendo requisitado.

<comment>Return:</comment>
  <info>object|false</info>  Um <info>object</info> com informações relacionadas a URI. As propriedades deste <info>object</info> são:
                
                
                statusthe_requeststatus_linemethodcontent_typehandlerurifilenamepath_infoargsboundaryno_cacheno_local_copyallowedsend_bodyctbytes_sentbyterangeclengthunparsed_urimtimerequest_time
                
                Retorna <info>false</info> se falhar.


id: apache_note
type: function
doc:
<comment>Description:</comment>
  Obtêm e configura notas de requisição
  
  Esta função chama as funções <return>table_get</return> e <return>table_set</return> do Apache. Edita as tabelas de notas que
  existem durante uma requisição. O objetivo das tabelas é permitir que os módulos do Apache se
  comuniquem entre entre si.
  
  O principal uso da função <strong>apache_note()</strong> é passar informações de um módulo para outro dentro da
  mesma requisição.

<comment>Param:</comment>
  <info>string</info>       <strong>$note_name</strong>   O nome da nota.
  <info>string|null</info>  <strong>$note_value</strong>  O valor da nota.

<comment>Return:</comment>
  <info>string|false</info>  Se <strong>$note_value</strong> for omitido ou <info>null</info>, retorna o valor atual da nota <return>note_name</return>. Se
                chamado com dois argumentos, define o valor da nota <return>note_name</return> para o valor
                <return>note_value</return> e retorna o valor anterior da nota <return>note_name</return>. Se a nota não puder ser
                retornada <info>false</info> é retornado.

<comment>See Also:</comment>
   * <strong>virtual()</strong>


id: apache_request_headers
type: function
doc:
<comment>Description:</comment>
  Obtém todos os cabeçalhos da requisição HTTP
  
  Obtém todos os cabeçalhos HTTP da requisição atual. Funciona na CLI e nos servidores web Apache,
  FastCGI e FPM.

<comment>Return:</comment>
  <info>array</info>  Um array associativo de todos os cabeçalho HTTP da requisição atual, ou <info>false</info> em caso de
         falha.

<comment>See Also:</comment>
   * <strong>apache_response_headers()</strong>


id: apache_response_headers
type: function
doc:
<comment>Description:</comment>
  Obtém todos os cabeçalhos da resposta HTTP
  
  Obtém todos os cabeçalhos de resposta. Funciona na CLI e nos servidores web Apache, FastCGI e FPM.

<comment>Return:</comment>
  <info>array|false</info>  Um array de todos os cabeçalhos de resposta do Apache em caso de sucesso, ou  ou
               <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>apache_request_headers()</strong>
   * <strong>headers_sent()</strong>
   * <strong>headers_list()</strong>


id: apache_setenv
type: function
doc:
<comment>Description:</comment>
  Define uma variável subprocess_env do Apache
  
  A função <strong>apache_setenv()</strong> define o valor de uma variável de ambiente Apache denotada por <strong>$variable</strong>.
  
  Quando configurar uma variável de ambiente, o valor correspondente em $_SERVER não é alterado.

<comment>Param:</comment>
  <info>string</info>  <strong>$variable</strong>     O nome da variável de ambiente a ser configurada.
  <info>string</info>  <strong>$value</strong>        O novo valor de <strong>$variable</strong>.
  <info>bool</info>    <strong>$walk_to_top</strong>  Se o valor deve ser definido como uma variável de alto nível em todos as
                        camadas do Apache.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>apache_getenv()</strong>


id: apcu_add
type: function
doc:
<comment>Description:</comment>
  Cache a new variable in the data store
    
  
  Caches a variable in the data store, only if it's not already stored.
  
  Unlike many other mechanisms in PHP, variables stored using <strong>apcu_add()</strong> will persist between
  requests (until the value is removed from the cache).

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>     Store the variable using this name. <strong>$key</strong>s are cache-unique, so attempting to use
                   <strong>apcu_add()</strong> to store data with a key that already exists will not overwrite the
                   existing data, and will instead return <info>false</info>. (This is the only difference
                   between <strong>apcu_add()</strong> and <strong>apcu_store()</strong>.)
  <info>mixed</info>   <strong>$var</strong>     The variable to store
  <info>int</info>     <strong>$ttl</strong>     Time To Live; store <strong>$var</strong> in the cache for <strong>$ttl</strong> seconds. After the <strong>$ttl</strong> has
                   passed, the stored variable will be expunged from the cache (on the next
                   request). If no <strong>$ttl</strong> is supplied (or if the <strong>$ttl</strong> is <return>0</return>), the value will persist
                   until it is removed from the cache manually, or otherwise fails to exist in the
                   cache (clear, restart, etc.).
  <info>array</info>   <strong>$values</strong>  Names in key, variables in value.

<comment>Return:</comment>
  <info>bool</info>  Returns TRUE if something has effectively been added into the cache, FALSE otherwise. Second
        syntax returns array with error keys.

<comment>See Also:</comment>
   * <strong>apcu_store()</strong>
   * <strong>apcu_fetch()</strong>
   * <strong>apcu_delete()</strong>


