# php_manual

id: UConverter::toUCallback
type: function
doc:
<comment>Description:</comment>
  Default "to" callback function
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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>
  Convert a string from one character encoding to another
  
  Converts <strong>$str</strong> from <strong>$fromEncoding</strong> to <strong>$toEncoding</strong>.

<comment>Param:</comment>
  <info>string</info>      <strong>$str</strong>           The <info>string</info> to be converted.
  <info>string</info>      <strong>$toEncoding</strong>    The desired encoding of the result.
  <info>string</info>      <strong>$fromEncoding</strong>  The current encoding used to interpret <strong>$str</strong>.
  <info>array|null</info>  <strong>$options</strong>       An optional <info>array</info>, which may contain the following keys: <return>'to_subst'</return> -
                             the substitution character to use in place of any character of <strong>$str</strong>
                             which cannot be encoded in <strong>$toEncoding</strong>. If specified, it must represent
                             a single character in the target encoding.

<comment>Return:</comment>
  <info>string|false</info>  Returns the converted string başarısızlık durumunda <info>false</info> döner.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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>
  <class>UnitEnum</class> arayüzü tüm sayılamalara motor tarafından özdevinimsel uygulanır. Kullanıcı tanımlı
  sınıflarla gerçeklenemez. Öntanımlı olarak motor tarafından sağlanan yöntemlerini sayılamalar
  geçersiz kılamaz. Yalnızca tür sınamaları için kullanılabilir.


id: UnitEnum::cases
type: function
doc:
<comment>Description:</comment>
  Bir sayılamadan kılıf listesi oluşturur
  
  Bu yöntem, bir sayılamadaki tüm kılıfları bildirildikleri sıraya göre içeren bir dizi döndürür.

<comment>Return:</comment>
  <info>array</info>  Sayılamadaki tüm kılıfları bildirildikleri sıraya göre içeren bir dizi döner.


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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

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


id: V8JsException::getJsLineNumber
type: function
doc:
<comment>Description:</comment>
  The getJsLineNumber purpose
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

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


id: V8JsException::getJsSourceLine
type: function
doc:
<comment>Description:</comment>
  The getJsSourceLine purpose
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

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


id: V8JsException::getJsTrace
type: function
doc:
<comment>Description:</comment>
  The getJsTrace purpose
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

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


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>
  Tür belirteci ile <info>VT_ARRAY</info> VEYAlanırsa sonuç bir <return>SAFEARRAY</return> göstericisi olur. <info>VT_ARRAY</info> sadece şu
  veri türleri ile VEYAlanabilir: <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> ve
  <info>VT_VARIANT</info>.


id: VT_BYREF
type: constant
doc:
<comment>Description:</comment>
  Tür belirteci ile <info>VT_BYREF</info>VEYAlanırsa sonuç bir başvurudur. Başvuru türleri, C++'daki başvuru
  türlerine benzer şekilde veriye bir başvuru olarak yorumlanır.


id: VT_DATE
type: constant
doc:
<comment>Description:</comment>
  31 Aralık 1899'dan beri geçen günlerin sayısını gösteren 64 bitlik kayan noktalı bir sayı.
  Örneğin, <return>1 Ocak 1900</return> için 2.0, <return>2 Ocak 1900</return> için 3.0 gibi). <info>VT_R8</info> ile aynı gösterimde saklanır.


id: VT_EMPTY
type: constant
doc:
<comment>Description:</comment>
  <info>VT_EMPTY</info> türünde bir özellikle ilişkili hiçbir veri yoktur, dolayısıyla değerin boyutu sıfırdır.


id: VT_I8
type: constant
doc:
<comment>Description:</comment>
  8 baytlık işaretli tamsayı değer
  
  PHP 7.0.0 ve sonrasında kullanılabiliir (sadece x64).


id: VT_UI8
type: constant
doc:
<comment>Description:</comment>
  8 baytlık işaretsiz tamsayı değer.
  
  PHP 7.0.0 ve sonrasında kullanılabiliir (sadece x64).


id: VT_UINT
type: constant
doc:
<comment>Description:</comment>
  4 baytlık işaretsiz tamsayı değer (<info>VT_UI4</info> eşdeğeri).


id: VT_VARIANT
type: constant
doc:
<comment>Description:</comment>
  Tür ismi ile öncelenmiş olarak ilgili değer. <info>VT_VARIANT</info> sadece <info>VT_BYREF</info> ile kullanılabilir.


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>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.


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>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.


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

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.


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>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.


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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.


id: WeakMap
type: class
doc:
<comment>Description:</comment>
  <class>WeakMap</class> nesneleri anahtar olarak kabul eden bir haritadır (veya sözlüktür). Ancak,
  <class>SplObjectStorage</class>'dan farklı olarak, <class>WeakMap</class> anahtarındaki nesne, nesnenin gönderim sayısına
  katkıda bulunmaz. Yani, herhangi bir noktada bir nesneye kalan tek gönderim bir <class>WeakMap</class> anahtarı
  ise, nesne çöp olarak toplanacak ve <class>WeakMap</class>'ten kaldırılacaktır. Birincil kullanım durumu,
  nesneden daha uzun yaşaması gerekmeyen bir nesneden türetilen verilerin arabelleklerini oluşturmak
  içindir.
  
  <class>WeakMap</class> sınıfı ArrayAccess, Iterator ve Countable arayüzlerini gerçekler, bu yüzden çoğu durumda
  ilişkili bir dizi gibi kullanılabilir.


id: WeakMap::count
type: function
doc:
<comment>Description:</comment>
  Haritadaki canlı girdileri sayar
  
  Haritadaki canlı girdileri sayar.

<comment>Return:</comment>
  <info>int</info>  Haritadaki canlı girdilerin sayısını döndürür.


id: WeakMap::getIterator
type: function
doc:
<comment>Description:</comment>
  Harici bir yineleyici ile döner
  
  Harici bir yineleyici ile döner.

<comment>Return:</comment>
  <info>Iterator</info>  <class>Iterator</class> veya <class>Traversable</class> gerçekleyen bir nesne örneği.


id: WeakMap::offsetExists
type: function
doc:
<comment>Description:</comment>
  Haritada belli bir nesnenin varlığına bakar
  
  Belirtilen nesneye haritada gönderim varsa <info>true</info>döner.

<comment>Param:</comment>
  <info>object</info>  <strong>$nesne</strong>  Varlığına bakılacak nesne.

<comment>Return:</comment>
  <info>bool</info>  Belirtilen nesne haritada varsa <info>true</info> yoksa <info>false</info> döner.


id: WeakMap::offsetGet
type: function
doc:
<comment>Description:</comment>
  Belirli bir nesnenin işaret ettiği değeri verir
  
  Belirtilen nesnenin işaret ettiği değeri döndürür.

<comment>Param:</comment>
  <info>object</info>  <strong>$nesne</strong>  Haritada bir anahtar olarak içerilen nesne.

<comment>Return:</comment>
  <info>mixed</info>  Başarı durumunda belirtilen nesne ile ilişkili değeri, yoksa <info>null</info> döndürür. otherwise.


id: WeakMap::offsetSet
type: function
doc:
<comment>Description:</comment>
  Yeni bir anahtar-değer çiftiyle haritayı günceller
  
  Haritayı yeni anahtar-değer çiftiyle günceller. Belirtilen anahtar haritada mevcutsa yeni değer
  eskisinin üzerine yazılır.

<comment>Param:</comment>
  <info>object</info>  <strong>$nesne</strong>  Anahtar-değer çiftinde anahtar olan nesne.
  <info>mixed</info>   <strong>$değer</strong>  Anahtar-değer çiftinde değer olan keyfi veri.

<comment>Return:</comment>
  <info>void</info>  Hiçbir değer dönmez.


id: WeakMap::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Haritadan bir girdiyi siler
  
  Haritadan belirtilen girdiyi siler.

<comment>Param:</comment>
  <info>object</info>  <strong>$girdi</strong>  Haritadan silinecek nesne.

<comment>Return:</comment>
  <info>void</info>  Hiçbir değer dönmez.


id: WeakReference
type: class
doc:
<comment>Description:</comment>
  Zayıf gönderimler, programcının, nesnenin yok edilmesini engellemeyen bir nesneye gönderim
  tutmasına izin verir. Önbellek benzeri yapıları gerçeklemek için kullanışlıdır.
  
  <class>WeakReference</class> örnekleri dizileştirilemez.


id: WeakReference::__construct
type: function
doc:
<comment>Description:</comment>
  Örneklemeye izin vermeyen kurucu
  
  Bu yöntem yalnızca <class>WeakReference</class> sınıfının örneklenmesine izin vermemek için vardır. Zayıf
  gönderimler  WeakReference::create yöntemi ile gerçeklenir.

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


id: WeakReference::create
type: function
doc:
<comment>Description:</comment>
  Yeni bir zayıf gönderim oluşturur
  
  Yeni bir <class>WeakReference</class> sınıfı örnekler.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  Zayıfça başvurulacak nesne.

<comment>Return:</comment>
  <info>WeakReference</info>  Taze bir nesne döndürür.


id: WeakReference::get
type: function
doc:
<comment>Description:</comment>
  Zayıf gönderimli bir nesne döndürür
  
  Zayıf gönderimli bir nesne döndürür Nesne yok edilmişse, <info>null</info> döner.

<comment>Return:</comment>
  <info>object|null</info>  Zayıfça gönderimli bir nesne döndürür. Nesne zaten yok edilmişse, <info>null</info> döndürülür.


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>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.


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: XDIFF_PATCH_NORMAL
type: constant
doc:
<comment>Description:</comment>
  <strong>xdiff_string_patch()</strong> ve <strong>xdiff_file_patch()</strong> işlevlerinin yamayı özgün dosyaya uygulayıp dosyanın
  yeni sürümünü elde etmek amacıyla kullanılacağını belirtir. Bu öntanımlı işlem kipidir.


id: XDIFF_PATCH_REVERSE
type: constant
doc:
<comment>Description:</comment>
  <strong>xdiff_string_patch()</strong> ve <strong>xdiff_file_patch()</strong> işlevlerinin yamayı yeni sürüme uygulayıp dosyanın
  özgün sürümünü elde etmek amacıyla kullanılacağını belirtir.


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: XMLReader
type: class
doc:
<comment>Description:</comment>
  XMLReader eklentisi bir XML çözümleyicisidir. Belge akımı üzerinde her düğümde durarak bir imleç
  gibi hareket eder.


id: XMLReader::XML
type: function
doc:
<comment>Description:</comment>
  Çözümlenecek XML belge içeriği belirtilir
  
  Çözümlenecek XML belge içeriğini belirtmek için kullanılır.

<comment>Param:</comment>
  <info>string</info>       <strong>$kaynak</strong>      Çözümlenecek XML belgeyi içeren dizge.
  <info>string|null</info>  <strong>$kodlama</strong>     Belgenin karakter kodlaması veya <info>null</info>.
  <info>int</info>          <strong>$seçenekler</strong>  LIBXML_* sabitlerinden oluşan bir bit maskesi.

<comment>Return:</comment>
  <info>bool|XMLReader</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner. Statik olarak
                  çağrılmışsa <class>XMLReader</class>, başarısızlık durumunda <info>false</info> döner.

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


id: XMLReader::close
type: function
doc:
<comment>Description:</comment>
  XMLReader girdisini kapatır
  
  Çözümlenmekte olan XMLReader nesnesini kapatır.

<comment>Return:</comment>
  <info>true</info>  Daima <info>true</info> döndürür.

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


id: XMLReader::expand
type: function
doc:
<comment>Description:</comment>
  Geçerli düğümün bir kopyasını bir DOM nesnesi olarak döndürür
    
  
  Geçerli düğümü kopyalar ve kopyayı bir DOM nesnesi olarak döndürür.

<comment>Param:</comment>
  <info>DOMNode|null</info>  <strong>$düğüm</strong>  Oluşturulan DOM nesnesi için hedef <class>DOMDocument</class> nesnesini tanımlayan <class>DOMNode</class>
                        nesnesi.

<comment>Return:</comment>
  <info>DOMNode|false</info>  Hata durumunda <info>false</info>, aksi takdirde elde edilen <class>DOMNode</class> nesnesi döner.


id: XMLReader::getAttribute
type: function
doc:
<comment>Description:</comment>
  İsmi belirtilen özniteliğin değerini döndürür
  
  İsmi belirtilen özniteliğin değerini döndürür. Öznitelik yoksa veya eleman düğümünde özniteliğe
  konumlanamıyorsa <info>null</info> döner.

<comment>Param:</comment>
  <info>string</info>  <strong>$isim</strong>  Özniteliğin ismi.

<comment>Return:</comment>
  <info>string|null</info>  İsmi belirtilen özniteliğin değerini bir dizge olarak döndürür. Öznitelik yoksa veya
               eleman düğümünde özniteliğe konumlanamıyorsa <info>null</info> döner.

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


id: XMLReader::getAttributeNo
type: function
doc:
<comment>Description:</comment>
  İndisi belirtilen özniteliğin değerini döndürür
  
  İndisi belirtilen özniteliğin değerini döndürür. Öznitelik yoksa veya eleman düğümünde özniteliğe
  konumlanamıyorsa <info>null</info> döner.

<comment>Param:</comment>
  <info>int</info>  <strong>$indis</strong>  Özniteliğin konumu.

<comment>Return:</comment>
  <info>string|null</info>  İndisi belirtilen özniteliğin değerini bir dizge olarak döndürür. Öznitelik yoksa
               veya eleman düğümünde özniteliğe konumlanamıyorsa <info>null</info> döner.

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


id: XMLReader::getAttributeNs
type: function
doc:
<comment>Description:</comment>
  İsmi ve isim alanı belirtilen özniteliğin değerini döndürür
    
  
  İsmi ve isim alanı belirtilen özniteliğin değerini döndürür. Öznitelik yoksa veya eleman düğümünde
  özniteliğe konumlanamıyorsa <info>null</info> döner.

<comment>Param:</comment>
  <info>string</info>  <strong>$isim</strong>       Özniteliğin yerel ismi.
  <info>string</info>  <strong>$isimalanı</strong>  İsim alanını betimleyen adres.

<comment>Return:</comment>
  <info>string|null</info>  İsmi ve isim alanı belirtilen özniteliğin değerini bir dizge olarak döndürür.
               Öznitelik yoksa veya eleman düğümünde özniteliğe konumlanamıyorsa <info>null</info> döner.

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


id: XMLReader::getParserProperty
type: function
doc:
<comment>Description:</comment>
  Belirtilen özelliğin tanımlı olup olmadığına bakar
  
  Belirtilen özelliğin tanımlı olup olmadığına bakar.

<comment>Param:</comment>
  <info>int</info>  <strong>$özellik</strong>  Çözümleyici seçeneği sabitlerinden biri.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

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


id: XMLReader::isValid
type: function
doc:
<comment>Description:</comment>
  Çözümlenen düğümün geçerliliğini sınar
  
  Çözümlenen düğüm geçerli ise <info>true</info> döner.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

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


id: XMLReader::lookupNamespace
type: function
doc:
<comment>Description:</comment>
  Bir önek için isim alanına bakar
  
  Belirtilen önek için isim alanına bakar.

<comment>Param:</comment>
  <info>string</info>  <strong>$önek</strong>  Önek olarak kullanılan dizge.

<comment>Return:</comment>
  <info>string|null</info>  İsimalanının değerini döndürür, böyle bir isimalanı yoksa <info>null</info> döner.


id: XMLReader::moveToAttribute
type: function
doc:
<comment>Description:</comment>
  İmleci ismi belirtilen özniteliğe konumlar
  
  İmleci ismi belirtilen özniteliğe konumlar.

<comment>Param:</comment>
  <info>string</info>  <strong>$isim</strong>  Özniteliğin ismi.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

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


id: XMLReader::moveToAttributeNo
type: function
doc:
<comment>Description:</comment>
  İmleci indisi belirtilen özniteliğe götürür
  
  İmleci, konumuna göre öznitelik üzerine konumlandırır.

<comment>Param:</comment>
  <info>int</info>  <strong>$indis</strong>  Özniteliğin konumu.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

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


id: XMLReader::moveToAttributeNs
type: function
doc:
<comment>Description:</comment>
  İmleci isimli özniteliğe götürür
  
  Positions cursor on the named attribute in specified namespace.

<comment>Param:</comment>
  <info>string</info>  <strong>$isim</strong>        Yerel ad.
  <info>string</info>  <strong>$isim_alanı</strong>  İsim alanı için URI.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

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


id: XMLReader::moveToElement
type: function
doc:
<comment>Description:</comment>
  İmleci geçerli özniteliğin ebeveyn elemanına konumlar
  
  İmleci geçerli özniteliğin ebeveyn elemanına konumlar.

<comment>Return:</comment>
  <info>bool</info>  İmleç bir özniteliğin üzerinde değilse veya işlem başarısız olursa <info>false</info>, yoksa <info>true</info> döner.

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


id: XMLReader::moveToFirstAttribute
type: function
doc:
<comment>Description:</comment>
  İmleci ilk özniteliğe konumlar
  
  İmleci ilk özniteliğe konumlar.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

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


id: XMLReader::moveToNextAttribute
type: function
doc:
<comment>Description:</comment>
  İmleci sonraki özniteliğe konumlar
  
  İmleç bir özniteliğin üzerindeyse bir sonraki özniteliğe geçer, elemanın üzerindeyse elemanın ilk
  özniteliğine gider.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

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


id: XMLReader::next
type: function
doc:
<comment>Description:</comment>
  Alt ağaçların tümünü atlayıp sonraki düğüme gider
  
  Alt ağaçların tümünü atlayıp imleci sonraki düğüme konumlandırır. Böyle bir düğüm yoksa imleç
  belge sonuna gider.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$isim</strong>  Gidilecek sonraki düğümün yerel ismi.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

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


id: XMLReader::open
type: function
doc:
<comment>Description:</comment>
  Çözemlenecek XML belgeyi içeren adresi belirler
  
  Çözemlenecek XML belgeyi içeren adresi belirler.

<comment>Param:</comment>
  <info>string</info>       <strong>$uri</strong>         Belgenin adresi.
  <info>string|null</info>  <strong>$kodlama</strong>     Belgenin karakter kodlaması veya <info>null</info>.
  <info>int</info>          <strong>$seçenekler</strong>  LIBXML_* sabitlerinden oluşan bir bit maskesi.

<comment>Return:</comment>
  <info>bool|XMLReader</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner. Statik olarak
                  çağrılmışsa <class>XMLReader</class>, başarısızlık durumunda <info>false</info> döner.

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


id: XMLReader::read
type: function
doc:
<comment>Description:</comment>
  Belgedeki sonraki düğüme gidilir
  
  İmleci belgede sonraki düğüme konumlandırır.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

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


id: XMLReader::readInnerXml
type: function
doc:
<comment>Description:</comment>
  Geçerli düğümün içeriğini okur
  
  Geçerli düğümün içeriğini, çocuk düğümler ve imlenimle birlikte okur.

<comment>Return:</comment>
  <info>string</info>  Geçerli düğümün içeriğini bir dizge olarak döndürür. Başarısızlık durumunda boş dizge
          döner.

<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>
  Geçerli düğümün içeriğini düğümün kendisiyle birlikte okur
    
  
  Geçerli düğümün içeriğini düğümün kendisiyle birlikte okur.

<comment>Return:</comment>
  <info>string</info>  Geçerli düğümün içeriğini düğümün kendisiyle birlikte bir dizge olarak döndürür.
          Başarısızlık durumunda boş dizge döner.

<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>
  Geçerli düğümün içeriğini bir dizge olarak okur
  
  Geçerli düğümün içeriğini bir dizge olarak okur.

<comment>Return:</comment>
  <info>string</info>  Geçerli düğümün içeriğini bir dizge olarak döndürür. Başarısızlık durumunda boş dizge
          döner.

<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>
  Çözümleyici seçeneklerini tanımlar
  
  Çözümleyici seçeneklerini etkin veya etkisiz kılar. Seçeneklerin <strong>XMLReader-open()</strong> veya
  <strong>XMLReader-xml()</strong> çağrıldıktan sonra <strong>XMLReader-read()</strong> çağrılmadan önce belirlenmesi gerekir.

<comment>Param:</comment>
  <info>int</info>   <strong>$seçenek</strong>  Çözümleyici seçeneği sabitlerinden biri.
  <info>bool</info>  <strong>$etkin</strong>    <info>true</info> atanırsa seçenek etkin olur, aksi takdirde seçenek etkisiz olur.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.


id: XMLReader::setRelaxNGSchema
type: function
doc:
<comment>Description:</comment>
  Belgeyi RelaxNG şemasına göre doğrular
  
  XML belgeyi doğrulamak için <strong>$dosya</strong> ile belirtilen RelaxNG şeması kullanılır.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$dosya</strong>  RelaxNG şemasının dosya yolu veya adresi.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

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


id: XMLReader::setRelaxNGSchemaSource
type: function
doc:
<comment>Description:</comment>
  Belgeyi dizge olarak belirtilen RelaxNG şemasına göre doğrular
  
  XML belgeyi doğrulamak için <strong>$kaynak</strong> dizgesi ile belirtilen RelaxNG şeması kullanılır.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$kaynak</strong>  RelaxNG şemasını içeren dizge.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

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


id: XMLReader::setSchema
type: function
doc:
<comment>Description:</comment>
  Belgeyi XSD şemasına göre doğrular
  
  XML belgeyi doğrulamak için <strong>$dosya</strong> ile belirtilen W3C XSD şeması kullanılır. Etkinleştirme sadece
  ilk XMLReader::read öncesi mümkündür.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$dosya</strong>  XSD şemasının dosya yolu.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

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


id: XMLWriter::endAttribute
type: function
doc:
<comment>Description:</comment>
  Geçerli özniteliği sonlandırır
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Geçerli özniteliği sonlandırır.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$nesne</strong>  Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                     <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * XMLWriter::startAttribute
   * XMLWriter::startAttributeNS
   * XMLWriter::writeAttribute
   * XMLWriter::writeAttributeNS


id: XMLWriter::endCdata
type: function
doc:
<comment>Description:</comment>
  Geçerli CDATA bölümünü kapatır
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Geçerli CDATA bölümünü kapatır.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$nesne</strong>  Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                     <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * XMLWriter::startCData
   * XMLWriter::writeCData


id: XMLWriter::endComment
type: function
doc:
<comment>Description:</comment>
  Geçerli açıklamayı kapatır
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Geçerli açıklamayı kapatır.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$nesne</strong>  Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                     <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

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


id: XMLWriter::endDocument
type: function
doc:
<comment>Description:</comment>
  Geçerli belgeyi sonlandırır
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Geçerli belgeyi sonlandırır.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$nesne</strong>  Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                     <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

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


id: XMLWriter::endDtd
type: function
doc:
<comment>Description:</comment>
  Geçerli DTD'yi kapatır
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Belgenin DTD bölümünü kapatır.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$nesne</strong>  Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                     <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * XMLWriter::startDTD
   * XMLWriter::writeDTD


id: XMLWriter::endDtdAttlist
type: function
doc:
<comment>Description:</comment>
  Geçerli DTD öznitelik listesi bildirimini kapatır
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Geçerli DTD öznitelik listesi bildirimini kapatır.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$nesne</strong>  Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                     <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * XMLWriter::startDTDAttlist
   * XMLWriter::writeDTDAttlist


id: XMLWriter::endDtdElement
type: function
doc:
<comment>Description:</comment>
  Geçerli DTD eleman bildirimini kapatır
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Geçerli DTD eleman bildirimini kapatır.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$nesne</strong>  Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                     <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * XMLWriter::startDTDElement
   * XMLWriter::writeDTDElement


id: XMLWriter::endDtdEntity
type: function
doc:
<comment>Description:</comment>
  Geçerli DTD öğe bildirimini kapatır
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Geçerli DTD öğe bildirimini kapatır.

<comment>Param:</comment>
  <info></info>  <strong>$nesne</strong>  Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
            <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * XMLWriter::startDTDEntity
   * XMLWriter::writeDTDEntity


id: XMLWriter::endElement
type: function
doc:
<comment>Description:</comment>
  Geçerli elemanı kapatır
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Geçerli elemanı kapatır.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$nesne</strong>  Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                     <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * XMLWriter::startElement
   * XMLWriter::writeElement


id: XMLWriter::endPi
type: function
doc:
<comment>Description:</comment>
  Geçerli işlem komutunu kapatır
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Geçerli işlem komutunu kapatır.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$nesne</strong>  Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                     <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * XMLWriter::startPI
   * XMLWriter::writePI


id: XMLWriter::flush
type: function
doc:
<comment>Description:</comment>
  Geçerli tamponu boşaltır
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Geçerli tamponu boşaltır.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$nesne</strong>   Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                      <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.
  <info>bool</info>       <strong>$boşalt</strong>  Tamponun içeriği boşaltılmayacaksa <info>false</info> belirtilir. <info>true</info> öntanımlıdır.

<comment>Return:</comment>
  <info>string|int</info>  Nesneyi bellekte oluşturmuşsanız bu işlev üretilen XML tamponunu döndürür. Çıktı için
              bir adres kullanıyorsanız bu işlev tampona yazar ve yazılan baytların sayısını
              döndürür.


id: XMLWriter::fullEndElement
type: function
doc:
<comment>Description:</comment>
  Geçerli elemanı kapatır
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Geçerli elemanı kapatır. Eleman boş olsa bile kapama etiketini yazar.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$nesne</strong>  Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                     <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

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


id: XMLWriter::openMemory
type: function
doc:
<comment>Description:</comment>
  Dizge çıktılamak için belleği kullanmak üzere yeni bir
    XMLWriter nesnesi oluşturur
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Dizge çıktılamak için belleği kullanmak üzere yeni bir <class>XMLWriter</class> nesnesi oluşturur.

<comment>Return:</comment>
  <info>bool</info>  Nesne yönelimli kullanım: Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.
        
        Yordamsal kullanım: Başarı durumunda <class>XMLWriter</class> işlevleri ile kullanılmak üzere yeni bir
        <class>XMLWriter</class> özkaynağı, aksi takdirde <info>false</info> döndürür.

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


id: XMLWriter::openUri
type: function
doc:
<comment>Description:</comment>
  Çıktı için kaynak adresini kullanarak yeni bir XMLWriter nesnesi oluşturur
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Çıktı için <strong>$uri</strong> ile belirtilen kaynak adresini kullanarak yeni bir <class>XMLWriter</class> nesnesi oluşturur.

<comment>Param:</comment>
  <info>string</info>  <strong>$uri</strong>  Çıktı için özkaynak adresi.

<comment>Return:</comment>
  <info>bool</info>  Nesne yönelimli kullanım: Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.
        
        Yordamsal kullanım: Başarı durumunda <class>XMLWriter</class> işlevleri ile kullanılmak üzere yeni bir
        <class>XMLWriter</class> özkaynağı, aksi takdirde <info>false</info> döndürür.

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


id: XMLWriter::outputMemory
type: function
doc:
<comment>Description:</comment>
  Geçerli tamponu döndürür
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Geçerli tamponu döndürür.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$nesne</strong>   Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                      <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.
  <info>bool</info>       <strong>$boşalt</strong>  Çıktı tamponu boşaltılmayacaksa <info>false</info> belirtilir. <info>true</info> öntanımlıdır.

<comment>Return:</comment>
  <info>string</info>  Geçerli tamponun içeriğini bir dizge olarak döndürür.

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


id: XMLWriter::setIndent
type: function
doc:
<comment>Description:</comment>
  Girintilemeyi açıp kapar
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Girintilemeyi açıp kapar.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$nesne</strong>      Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                         <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.
  <info>bool</info>       <strong>$girintile</strong>  Girintileme etkin olacaksa <info>true</info> belirtilir.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

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


id: XMLWriter::setIndentString
type: function
doc:
<comment>Description:</comment>
  Girintileme için kullanılacak dizgeyi belirler
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  XML belgedeki her elemanı girintilemekte kullanılacak dizgeyi belirler.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$nesne</strong>    Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                       <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.
  <info>string</info>     <strong>$girinti</strong>  Girintileme dizgesi.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

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


id: XMLWriter::startAttribute
type: function
doc:
<comment>Description:</comment>
  Bir öznitelik başlatır
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Bir öznitelik başlatır.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$nesne</strong>  Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                     <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.
  <info>string</info>     <strong>$isim</strong>   Özniteliğin ismi.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * XMLWriter::startAttributeNS
   * XMLWriter::endAttribute
   * XMLWriter::writeAttribute
   * XMLWriter::writeAttributeNS


id: XMLWriter::startAttributeNs
type: function
doc:
<comment>Description:</comment>
  İsim alanlı bir öznitelik başlatır
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  İsim alanlı bir öznitelik başlatır.

<comment>Param:</comment>
  <info></info>             <strong>$nesne</strong>  Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                       <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.
  <info>string|null</info>  <strong>$önek</strong>  İsim alanı öneki.
  <info>string</info>       <strong>$isim</strong>   Özniteliğin ismi.
  <info>string|null</info>  <strong>$uri</strong>    İsim alanını betimleyen adres; <info>null</info> ise isim alanı bildirimi atlanır.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * XMLWriter::startAttribute
   * XMLWriter::endAttribute
   * XMLWriter::writeAttribute
   * XMLWriter::writeAttributeNS


id: XMLWriter::startCdata
type: function
doc:
<comment>Description:</comment>
  Bir CDATA bölümü başlatır
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Bir CDATA bölümü başlatır.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$nesne</strong>  Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                     <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * XMLWriter::endCData
   * XMLWriter::writeCData


id: XMLWriter::startComment
type: function
doc:
<comment>Description:</comment>
  Bir açıklama başlatır
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Bir açıklama başlatır.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$nesne</strong>  Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                     <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

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


id: XMLWriter::startDocument
type: function
doc:
<comment>Description:</comment>
  Belgenin XML bildirimini yazar
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Belgenin XML bildirimini yazar.

<comment>Param:</comment>
  <info></info>             <strong>$nesne</strong>       Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                            <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.
  <info>string|null</info>  <strong>$version</strong>     XML bildirimindeki <return>version</return> özniteliğinin değeri. <return>1.0</return> öntanımlıdır.
  <info>string|null</info>  <strong>$encoding</strong>    XML bildirimindeki <return>encoding</return> özniteliğinin değeri.
  <info>string|null</info>  <strong>$standalone</strong>  XML bildirimindeki <return>standalone</return> özniteliğinin değeri. <return>yes</return> veya <return>no</return>
                            olabilir.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

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


id: XMLWriter::startDtd
type: function
doc:
<comment>Description:</comment>
  Bir DTD başlangıç etiketi oluşturur
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Bir DTD bölümünü başlatır.

<comment>Param:</comment>
  <info></info>             <strong>$nesne</strong>       Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                            <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.
  <info>string</info>       <strong>$kök_eleman</strong>  Oluşturulacak belgenin kök elemanının nitelikli ismi.
  <info>string|null</info>  <strong>$publicId</strong>    Harici alt kümenin genel betimleyicisi.
  <info>string|null</info>  <strong>$systemId</strong>    Harici alt kümenin sistem betimleyicisi.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * XMLWriter::endDTD
   * XMLWriter::writeDTD


id: XMLWriter::startDtdAttlist
type: function
doc:
<comment>Description:</comment>
  Bir DTD öznitelik listesi bildirimini başlatır
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Bir DTD öznitelik listesi bildirimini başlatır.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$nesne</strong>  Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                     <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.
  <info>string</info>     <strong>$isim</strong>   Öznitelik listesinin ismi.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * XMLWriter::endDTDAttlist
   * XMLWriter::writeDTDAttlist


id: XMLWriter::startDtdElement
type: function
doc:
<comment>Description:</comment>
  Bir DTD eleman bildirimini başlatır
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Bir DTD eleman bildirimini başlatır.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$nesne</strong>  Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                     <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.
  <info>string</info>     <strong>$isim</strong>   Oluşturulacak belge türünün nitelikli ismi.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * XMLWriter::endDTDElement
   * XMLWriter::writeDTDElement


id: XMLWriter::startDtdEntity
type: function
doc:
<comment>Description:</comment>
  Bir DTD öğe bildirimini başlatır
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Bir DTD öğe bildirimini başlatır.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$nesne</strong>          Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                             <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden
                             döndürülür.
  <info>string</info>     <strong>$isim</strong>           Öğe ismi.
  <info>bool</info>       <strong>$değiştige_var</strong>  

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * XMLWriter::endDTDEntity
   * XMLWriter::writeDTDEntity


id: XMLWriter::startElement
type: function
doc:
<comment>Description:</comment>
  Bir eleman başlangıç etiketi oluşturur
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Bir elemanı başlatır.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$nesne</strong>  Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                     <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.
  <info>string</info>     <strong>$isim</strong>   Elemanın ismi.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * XMLWriter::endElement
   * XMLWriter::writeElement


id: XMLWriter::startElementNs
type: function
doc:
<comment>Description:</comment>
  Bir isim alanlı eleman başlangıç etiketi oluşturur
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  İsim alanlı bir etiket başlatır.

<comment>Param:</comment>
  <info>XMLWriter</info>    <strong>$nesne</strong>  Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                       <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.
  <info>string|null</info>  <strong>$önek</strong>  İsim alanı öneki; <info>null</info> ise isim alanı atlanır.
  <info>string</info>       <strong>$isim</strong>   Elemanın ismi.
  <info>string|null</info>  <strong>$uri</strong>    İsim alanını betimleyen adres; <info>null</info> ise isim alanı bildirimi atlanır.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * XMLWriter::endElement
   * XMLWriter::writeElementNS


id: XMLWriter::startPi
type: function
doc:
<comment>Description:</comment>
  Bir işlem komutu başlangıç etiketi oluşturur
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Bir işlem komutu başlangıç etiketi oluşturur.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$nesne</strong>  Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                     <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.
  <info>string</info>     <strong>$hedef</strong>  İşlem komutunun hedefi.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * XMLWriter::endPI
   * XMLWriter::writePI


id: XMLWriter::text
type: function
doc:
<comment>Description:</comment>
  Bir metni yazar
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Bir metni yazar.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$nesne</strong>   Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                      <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.
  <info>string</info>     <strong>$içerik</strong>  Metnin içeriği. <return>\<</return>, <return>&gt;</return>, <return>&</return> ve <return>"</return>  karakterleri öğe gönderimleri olarak yazılır (yani sırasıyla, , ,  ve ). <return>'</return> dahil diğer tüm karakterler harfi harfine yazılır. Özel XML karakterlerini harfi harfine yazmak için veya değişmez öğe gönderimlerini yazmak için, <strong>xmlwriter_write_raw()</strong> kullanılmalıdır.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.


id: XMLWriter::writeAttribute
type: function
doc:
<comment>Description:</comment>
  Öznitelik yazar
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Bir özniteliği değeriyle birlikte yazar.

<comment>Param:</comment>
  <info></info>        <strong>$nesne</strong>  Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                  <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.
  <info>string</info>  <strong>$isim</strong>   Özniteliğin ismi.
  <info>string</info>  <strong>$değer</strong>  Özniteliğin değeri.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * XMLWriter::writeAttributeNS
   * XMLWriter::startAttribute
   * XMLWriter::startAttributeNS
   * XMLWriter::endAttribute


id: XMLWriter::writeAttributeNs
type: function
doc:
<comment>Description:</comment>
  İsim alanlı öznitelik yazar
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Bir isim alanlı özniteliği değeriyle birlikte yazar.

<comment>Param:</comment>
  <info></info>             <strong>$nesne</strong>  Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                       <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.
  <info>string|null</info>  <strong>$önek</strong>  İsim alanı öneki; <info>null</info> ise isim alanı atlanır.
  <info>string</info>       <strong>$isim</strong>   Özniteliğin ismi.
  <info>string|null</info>  <strong>$uri</strong>    İsim alanını betimleyen adres; <info>null</info> ise isim alanı bildirimi atlanır.
  <info>string</info>       <strong>$değer</strong>  Özniteliğin değeri.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * XMLWriter::writeAttribute
   * XMLWriter::startAttribute
   * XMLWriter::startAttributeNS
   * XMLWriter::endAttribute


id: XMLWriter::writeCdata
type: function
doc:
<comment>Description:</comment>
  CDATA yazar
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  İçeriğiyle birlikte CDATA yazar.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$nesne</strong>   Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                      <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.
  <info>string</info>     <strong>$içerik</strong>  CDATA içeriği.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * XMLWriter::startCData
   * XMLWriter::endCData


id: XMLWriter::writeComment
type: function
doc:
<comment>Description:</comment>
  Açıklama yazar
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Açıklama yazar.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$nesne</strong>   Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                      <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.
  <info>string</info>     <strong>$içerik</strong>  Açıklama içeriği.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

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


id: XMLWriter::writeDtd
type: function
doc:
<comment>Description:</comment>
  DTD'yi' yazar
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  DTD'yi yazar.

<comment>Param:</comment>
  <info></info>             <strong>$nesne</strong>     Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                          <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.
  <info>string</info>       <strong>$isim</strong>      DTD ismi.
  <info>string|null</info>  <strong>$publicId</strong>  Harici alt kümenin genel betimleyicisi.
  <info>string|null</info>  <strong>$systemId</strong>  Harici alt kümenin sistem betimleyicisi.
  <info>string|null</info>  <strong>$altküme</strong>  DTD içeriği.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * XMLWriter::startDTD
   * XMLWriter::endDTD


id: XMLWriter::writeDtdAttlist
type: function
doc:
<comment>Description:</comment>
  DTD öznitelik listesi yazar
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Bir DTD öznitelik listesini yazar.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$nesne</strong>   Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                      <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.
  <info>string</info>     <strong>$isim</strong>    DTD öznitelik listesinin ismi.
  <info>string</info>     <strong>$içerik</strong>  DTD öznitelik listesinin içeriği.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * XMLWriter::startDTDAttlist
   * XMLWriter::endDTDAttlist


id: XMLWriter::writeDtdElement
type: function
doc:
<comment>Description:</comment>
  DTD elemanını yazar
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Bir DTD elemanını yazar.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$nesne</strong>   Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                      <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.
  <info>string</info>     <strong>$isim</strong>    DTD elemanının ismi.
  <info>string</info>     <strong>$içerik</strong>  Elemanın içeriği.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * XMLWriter::startDTDElement
   * XMLWriter::endDTDElement


id: XMLWriter::writeDtdEntity
type: function
doc:
<comment>Description:</comment>
  DTD öğesini yazar
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Bir DTD öğesini yazar.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$nesne</strong>   Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                      <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.
  <info>string</info>     <strong>$isim</strong>    Öğe ismi.
  <info>string</info>     <strong>$içerik</strong>  Öğe içeriği.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * XMLWriter::startDTDEntity
   * XMLWriter::endDTDEntity


id: XMLWriter::writeElement
type: function
doc:
<comment>Description:</comment>
  Elemanı içeriğiyle birlikte yazar
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Elemanı içeriğiyle birlikte yazar.

<comment>Param:</comment>
  <info>XMLWriter</info>    <strong>$nesne</strong>   Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                        <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.
  <info>string</info>       <strong>$etiket</strong>  Elemanın ismi.
  <info>string|null</info>  <strong>$içerik</strong>  Elemanın içeriği.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * XMLWriter::startElement
   * XMLWriter::endElement
   * XMLWriter::writeElementNS


id: XMLWriter::writeElementNs
type: function
doc:
<comment>Description:</comment>
  İsim alanlı elemanı içeriğiyle birlikte yazar
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  İsim alanlı elemanı içeriğiyle birlikte yazar.

<comment>Param:</comment>
  <info>XMLWriter</info>    <strong>$nesne</strong>   Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                        <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.
  <info>string|null</info>  <strong>$önek</strong>   İsim alanı öneki; <info>null</info> ise isim alanı atlanır.
  <info>string</info>       <strong>$eleman</strong>  Elemanın ismi.
  <info>string|null</info>  <strong>$uri</strong>     İsim alanını betimleyen adres; <info>null</info> ise isim alanı bildirimi atlanır.
  <info>string|null</info>  <strong>$içerik</strong>  Elemanın içeriği.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * XMLWriter::startElementNS
   * XMLWriter::endElement
   * XMLWriter::writeElement


id: XMLWriter::writePi
type: function
doc:
<comment>Description:</comment>
  Bir işlem komutu (PI) yazar
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Bir işlem komutu (PI) yazar.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$nesne</strong>   Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                      <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.
  <info>string</info>     <strong>$hedef</strong>   İşlem komutunun hedefi.
  <info>string</info>     <strong>$içerik</strong>  İşlem komutunun içeriği.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * XMLWriter::startPI
   * XMLWriter::endPI


id: XMLWriter::writeRaw
type: function
doc:
<comment>Description:</comment>
  Ham XML metni yazar
  
  Nesne yönelimli kullanım
  
  Yordamsal kullanım
  
  Ham XML metni yazar.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$nesne</strong>   Sadece yordamsal çağrılar için. Değiştirilecek <class>XMLWriter</class> örneği. Nesne
                      <strong>xmlwriter_open_uri()</strong> veya <strong>xmlwriter_open_memory()</strong> işlevinden döndürülür.
  <info>string</info>     <strong>$içerik</strong>  Yazılacak metin.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

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


id: XML_SAX_IMPL
type: constant
doc:
<comment>Description:</comment>
  Yöntemin SAX gerçeklenimi. <return>libxml</return> veya <return>expat</return> olabilir.


id: XSLTProcessor::__construct
type: function
doc:
<comment>Description:</comment>
  Yeni bir XSLTProcessor nesnesi oluşturur
    
  
  Yeni bir <class>XSLTProcessor</class> nesnesi oluşturur.


id: XSLTProcessor::getParameter
type: function
doc:
<comment>Description:</comment>
  Bir bağımsız değişkenin değerini döndürür
  
  Evvelce <strong>XSLTProcessor::setParameter()</strong> tarafından atanmış bir bağımsız değişkenin değerini
  döndürür.

<comment>Param:</comment>
  <info>string</info>  <strong>$isimalanı</strong>  XSLT bağımsız değişkeninin ait olduğu isim alanının adresi.
  <info>string</info>  <strong>$isim</strong>       XSLT bağımsız değişkeninin yerel adı.

<comment>Return:</comment>
  <info>string|false</info>  Bağımsız değişkene değer atanmamışsa <info>false</info> yoksa değeri döndürür.

<comment>See Also:</comment>
   * <strong>XSLTProcessor::setParameter()</strong>
   * <strong>XSLTProcessor::removeParameter()</strong>


id: XSLTProcessor::getSecurityPrefs
type: function
doc:
<comment>Description:</comment>
  Güvenlik tercihlerini döndürür
  
  Güvenlik tercihlerini döndürür.

<comment>Return:</comment>
  <info>int</info>  <info>XSL_SECPREF_READ_FILE</info>, <info>XSL_SECPREF_WRITE_FILE</info>, <info>XSL_SECPREF_CREATE_DIRECTORY</info>,
       <info>XSL_SECPREF_READ_NETWORK</info>, <info>XSL_SECPREF_WRITE_NETWORK</info> sabitlerinin bit maskesi.


id: XSLTProcessor::hasExsltSupport
type: function
doc:
<comment>Description:</comment>
  PHP, EXSLT desteğine sahip mi diye bakar
  
  PHP, yerleşik EXSLT kütüphanesi ile derlenmiş mi diye bakar.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.


id: XSLTProcessor::importStylesheet
type: function
doc:
<comment>Description:</comment>
  Biçembent ithal eder
  
  Dönüşüm için kullanılmak üzere <class>XSLTProcessor</class> nesnesine biçembent dahil eder.

<comment>Param:</comment>
  <info>object</info>  <strong>$biçembent</strong>  Bir <class>DOMDocument</class> veya bir <class>SimpleXMLElement</class> nesnesi olarak dahil edilecek
                      biçembent.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.


id: XSLTProcessor::registerPHPFunctions
type: function
doc:
<comment>Description:</comment>
  XSLT işlevleri olarak PHP işlevlerinin kullanılması yeteneğini
    etkin kılar
  
  XSL biçembentlerinde XSLT işlevleri olarak PHP işlevlerinin kullanılabilmesini etkin kılar.

<comment>Param:</comment>
  <info>array|string|null</info>  <strong>$işlevler</strong>  XSLT'den çağrılacak işlevleri belli işlev isimleriyle sınırlamak
                                için kullanılır.
                                
                                Dizge olarak tek bir işlevin ismi veya dizi olarak işlev isimleri.

<comment>Return:</comment>
  <info>void</info>  Hiçbir değer dönmez.


id: XSLTProcessor::removeParameter
type: function
doc:
<comment>Description:</comment>
  Bağımsız değişken siler
  
  Atanmış bir bağımsız değişkeni siler. Böylece bağımsız değişkenin biçembentteki öntanımlı
  değerinin kullanılması sağlanır.

<comment>Param:</comment>
  <info>string</info>  <strong>$isimalanı</strong>  XSLT bağımsız değişkeninin ait olduğu isim alanının adresi.
  <info>string</info>  <strong>$isim</strong>       XSLT bağımsız değişkeninin yerel adı.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * <strong>XSLTProcessor::setParameter()</strong>
   * <strong>XSLTProcessor::getParameter()</strong>


id: XSLTProcessor::setParameter
type: function
doc:
<comment>Description:</comment>
  Bir bağımsız değişkene bir değer atar
  
  <class>XSLTProcessor</class> tarafından dönüşüm sırasında kullanılmak üzere bir veya daha fazla bağımsız
  değişkene değer atar. Biçembentte mevcut olmayan bağımsız değişkenler yok sayılır.

<comment>Param:</comment>
  <info>string</info>  <strong>$isimalanı</strong>  XSLT bağımsız değişkeninin ait olduğu isim alanının adresi.
  <info>string</info>  <strong>$isim</strong>        XSLT bağımsız değişkeninin yerel adı.
  <info>string</info>  <strong>$değer</strong>      XSLT bağımsız değişkeninin değeri.
  <info>array</info>   <strong>$seçenekler</strong>  <return>isim =&gt; değer</return> çiftlerinden oluşan bir dizi.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * <strong>XSLTProcessor::getParameter()</strong>
   * <strong>XSLTProcessor::removeParameter()</strong>


id: XSLTProcessor::setProfiling
type: function
doc:
<comment>Description:</comment>
  Profil çıktı dosyasını belirler
  
  Bir biçembent uygulanırken oluşan profil bilgisini belirtilen dosyaya çıktılar.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$dosya</strong>  Profil bilgisinin döküleceği dosyanın yolu.

<comment>Return:</comment>
  <info>true</info>  Daima <info>true</info> döndürür.


id: XSLTProcessor::setSecurityPrefs
type: function
doc:
<comment>Description:</comment>
  Güvenlik tercihlerini tanımlar
  
  Güvenlik tercihlerini tanımlar.

<comment>Param:</comment>
  <info>int</info>  <strong>$tercihler</strong>  Yeni güvenlik tercihleri. Aşağıdaki sabitler VEYAlanabilir:
                   <info>XSL_SECPREF_READ_FILE</info>, <info>XSL_SECPREF_WRITE_FILE</info>, <info>XSL_SECPREF_CREATE_DIRECTORY</info>,
                   <info>XSL_SECPREF_READ_NETWORK</info>, <info>XSL_SECPREF_WRITE_NETWORK</info>. Bunların yerine
                   <info>XSL_SECPREF_NONE</info> veya <info>XSL_SECPREF_DEFAULT</info> aktarılabilir.

<comment>Return:</comment>
  <info>int</info>  Evvelki güvenlik tercihlerini döndürür.


id: XSLTProcessor::transformToDoc
type: function
doc:
<comment>Description:</comment>
  Belgeyi dönüştürür
  
  <strong>xsltprocessor::importStylesheet()</strong> yöntemi ile belirtilen biçembendi belirtilen belgeye uygulayarak
  kaynak düğümünü bir belgeye (örn, <class>DOMDocument</class> nesnesine) dönüştürür.

<comment>Param:</comment>
  <info>object</info>       <strong>$belge</strong>       Dönüştürülecek <class>DOMDocument</class> veya <class>SimpleXMLElement</class> nesnesi ya da libxml
                            uyumlu nesne.
  <info>string|null</info>  <strong>$dönenSınıf</strong>  Bu isteğe bağlı bağımsız değişken XSLTProcessor::transformToDoc
                            işlevinin belirtilen sınıfın nesnesini döndürmekte kullanılabilir. Bu
                            sınıf ya <strong>$belge</strong> sınıfı ile aynı olmalı ya da <strong>$belge</strong> sınıfına bir
                            genişletme olmalıdır.

<comment>Return:</comment>
  <info>object|false</info>  Bir hata oluşursa <info>false</info> aksi takdirde sonuçlanan belge döner.

<comment>See Also:</comment>
   * <strong>XSLTProcessor::transformToUri()</strong>
   * <strong>XSLTProcessor::transformToXml()</strong>


id: XSLTProcessor::transformToUri
type: function
doc:
<comment>Description:</comment>
  Dönüşüm sonucunu bir dosyaya yazar
  
  <strong>xsltprocessor::importStylesheet()</strong> yöntemi ile belirtilen biçembendi belirtilen belgeye uygulayarak
  kaynak düğümünü bir dizgeye dönüştürüp belirtilen dosyaya yazar.

<comment>Param:</comment>
  <info>object</info>  <strong>$belge</strong>  Dönüştürülecek <class>DOMDocument</class> veya <class>SimpleXMLElement</class> nesnesi.
  <info>string</info>  <strong>$dosya</strong>  Dönüşüm sonucunun yazılacağı dosyanın yolu.

<comment>Return:</comment>
  <info>int</info>  Bir hata oluşmuşsa <info>false</info> aksi takdirde yazılan bayt sayısı döner.

<comment>See Also:</comment>
   * <strong>XSLTProcessor::transformToDoc()</strong>
   * <strong>XSLTProcessor::transformToXml()</strong>


id: XSLTProcessor::transformToXML
type: function
doc:
<comment>Description:</comment>
  Dönüşümü bir dizge olarak döndürür
  
  <strong>xsltprocessor::importStylesheet()</strong> yöntemi ile belirtilen biçembendi belirtilen belgeye uygulayarak
  kaynak düğümünü bir dizgeye dönüştürüp döndürür.

<comment>Param:</comment>
  <info>object</info>  <strong>$belge</strong>  Dönüştürülecek <class>DOMDocument</class> veya <class>SimpleXMLElement</class> nesnesi.

<comment>Return:</comment>
  <info>string|null|false</info>  Hata durumunda <info>false</info>, aksi takdirde dönüşüm sonucunu bir dizge olarak döndürür.

<comment>See Also:</comment>
   * <strong>XSLTProcessor::transformToDoc()</strong>
   * <strong>XSLTProcessor::transformToUri()</strong>


id: XSL_SECPREF_DEFAULT
type: constant
doc:
<comment>Description:</comment>
  Hiçbir yazma erişimine izin vermez. Yani, <info>XSL_SECPREF_WRITE_NETWORK</info> | <info>XSL_SECPREF_CREATE_DIRECTORY</info>
  | <info>XSL_SECPREF_WRITE_FILE</info> sabitlerinin bit maskesidir.


id: XmlParser
type: class
doc:
<comment>Description:</comment>
  PHP 8.0.0 ve sonrasında <return>xml</return> özkaynaklarının yerini alan etkileşimsiz sınıf.


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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<comment>Return:</comment>
  <info>mixed</info>  


id: Yaf_Config_Abstract::readonly
type: function
doc:
<comment>Description:</comment>
  Find a config whether readonly
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

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


id: Yaf_Config_Abstract::set
type: function
doc:
<comment>Description:</comment>
  Setter
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<comment>Return:</comment>
  <info>Yaf_Config_Abstract</info>  


id: Yaf_Config_Abstract::toArray
type: function
doc:
<comment>Description:</comment>
  Cast to array
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

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


id: Yaf_Config_Ini::current
type: function
doc:
<comment>Description:</comment>
  Retrieve the current value
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

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


id: Yaf_Config_Ini::key
type: function
doc:
<comment>Description:</comment>
  Fetch current element's key
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

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


id: Yaf_Config_Ini::next
type: function
doc:
<comment>Description:</comment>
  Advance the internal pointer
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

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


id: Yaf_Config_Ini::offsetExists
type: function
doc:
<comment>Description:</comment>
  The offsetExists purpose
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

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


id: Yaf_Config_Ini::rewind
type: function
doc:
<comment>Description:</comment>
  The rewind purpose
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

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


id: Yaf_Config_Simple::__construct
type: function
doc:
<comment>Description:</comment>
  The __construct purpose
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

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


id: Yaf_Config_Simple::current
type: function
doc:
<comment>Description:</comment>
  The current purpose
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

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


id: Yaf_Config_Simple::key
type: function
doc:
<comment>Description:</comment>
  The key purpose
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

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


id: Yaf_Config_Simple::next
type: function
doc:
<comment>Description:</comment>
  The next purpose
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.


id: Yaf_Exception::getPrevious
type: function
doc:
<comment>Description:</comment>
  The getPrevious purpose
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

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


id: Yaf_Loader::clearLocalNamespace
type: function
doc:
<comment>Description:</comment>
  The clearLocalNamespace purpose
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

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


id: Yaf_Loader::getInstance
type: function
doc:
<comment>Description:</comment>
  The getInstance purpose
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

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


id: Yaf_Loader::getLibraryPath
type: function
doc:
<comment>Description:</comment>
  Get the library path
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

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


id: Yaf_Loader::isLocalName
type: function
doc:
<comment>Description:</comment>
  The isLocalName purpose
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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.
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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.
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

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


id: Yaf_Request_Abstract::getBaseUri
type: function
doc:
<comment>Description:</comment>
  The getBaseUri purpose
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

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


id: Yaf_Request_Abstract::getControllerName
type: function
doc:
<comment>Description:</comment>
  The getControllerName purpose
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.


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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.


id: Yaf_Request_Simple::get
type: function
doc:
<comment>Description:</comment>
  The get purpose
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

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


id: Yaf_Request_Simple::getCookie
type: function
doc:
<comment>Description:</comment>
  The getCookie purpose
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

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


id: Yaf_Request_Simple::getPost
type: function
doc:
<comment>Description:</comment>
  The getPost purpose
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

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


id: Yaf_Request_Simple::getQuery
type: function
doc:
<comment>Description:</comment>
  The getQuery purpose
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.


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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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.
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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.
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

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


id: Yaf_Session::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor of Yaf_Session
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.


id: Yaf_Session::__unset
type: function
doc:
<comment>Description:</comment>
  The __unset purpose
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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.
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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.
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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.
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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>
  
  Bu işlev hala
  belgelendirilmemiştir; sadece bağımsız değişken listesi
  mevcuttur.

<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 başarısızlık durumunda <info>false</info> döner.

<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>
  The socket limit for this context. Available if compiled against ZeroMQ 3.x or higher (Value: <info>int</info>)


id: ZMQ::ERR_EAGAIN
type: constant
doc:
<comment>Description:</comment>
  Implies that the operation would block when ZMQ::MODE_DONTWAIT is used


id: ZMQ::ERR_EFSM
type: constant
doc:
<comment>Description:</comment>
  The operation can not be executed because the socket is not in correct state


id: ZMQ::MODE_NOBLOCK
type: constant
doc:
<comment>Description:</comment>
  Non-blocking operation. Deprecated, use ZMQ::MODE_DONTWAIT instead


id: ZMQ::SOCKET_STREAM
type: constant
doc:
<comment>Description:</comment>
  Used to send and receive TCP data from a non-ØMQ peer. Available if compiled against ZeroMQ 4.x or
  higher (Value: <info>int</info>).


id: ZMQ::SOCKET_XPUB
type: constant
doc:
<comment>Description:</comment>
  Similar to SOCKET_PUB, except you can receive subscriptions as messages. The subscription message
  is 0 (unsubscribe) or 1 (subscribe) followed by the topic.


id: ZMQ::SOCKET_XSUB
type: constant
doc:
<comment>Description:</comment>
  Similar to SOCKET_SUB, except you can send subscriptions as messages. See SOCKET_XPUB for format.


id: ZMQ::SOCKOPT_BACKLOG
type: constant
doc:
<comment>Description:</comment>
  The SOCKOPT_BACKLOG option shall set the maximum length of the queue of outstanding peer
  connections for the specified socket; this only applies to connection-oriented transports. (Value:
  <info>int</info>)


id: ZMQ::SOCKOPT_DELAY_ATTACH_ON_CONNECT
type: constant
doc:
<comment>Description:</comment>
  Set a CIDR string to match against incoming TCP connections. Available if compiled against ZeroMQ
  3.x or higher (Value: <info>string</info>)


id: ZMQ::SOCKOPT_HWM
type: constant
doc:
<comment>Description:</comment>
  The high water mark for inbound and outbound messages is a hard limit on the maximum number of
  outstanding messages ØMQ shall queue in memory for any single peer that the specified socket is
  communicating with. Setting this option on a socket will only affect connections made after the
  option has been set. On ZeroMQ 3.x this is a wrapper for setting both SNDHWM and RCVHWM. (Value:
  <info>int</info>).


id: ZMQ::SOCKOPT_IPV4ONLY
type: constant
doc:
<comment>Description:</comment>
  Disable IPV6 support if 1. Available if compiled against ZeroMQ 3.x (Value: <info>int</info>)


id: ZMQ::SOCKOPT_IPV6
type: constant
doc:
<comment>Description:</comment>
  Enable IPV6. Available if compiled against ZeroMQ 4.0 or higher (Value: <info>string</info>)


id: ZMQ::SOCKOPT_LAST_ENDPOINT
type: constant
doc:
<comment>Description:</comment>
  Retrieve the last connected endpoint - for use with * wildcard ports. Available if compiled
  against ZeroMQ 3.x or higher (Value: <info>string</info>)


id: ZMQ::SOCKOPT_LINGER
type: constant
doc:
<comment>Description:</comment>
  The linger value of the socket. Specifies how long the socket blocks trying flush messages after
  it has been closed (Value: <info>int</info>)


id: ZMQ::SOCKOPT_MAXMSGSIZE
type: constant
doc:
<comment>Description:</comment>
  Limits the maximum size of the inbound message. Value -1 means no limit. Available if compiled
  against ZeroMQ 3.x or higher (Value: <info>int</info>)


id: ZMQ::SOCKOPT_RATE
type: constant
doc:
<comment>Description:</comment>
  Set rate for multicast sockets (pgm) (Value: <info>int</info> &gt;= 0)


id: ZMQ::SOCKOPT_RCVHWM
type: constant
doc:
<comment>Description:</comment>
  The SOCKOPT_RCVHWM option shall set the high water mark for inbound messages on the specified
  socket. Available if compiled against ZeroMQ 3.x or higher (Value: <info>int</info>).


id: ZMQ::SOCKOPT_RCVTIMEO
type: constant
doc:
<comment>Description:</comment>
  Sets the timeout for receive operation on the socket. Value -1 means no limit. Available if
  compiled against ZeroMQ 3.x or higher (Value: <info>int</info>)


id: ZMQ::SOCKOPT_RECONNECT_IVL
type: constant
doc:
<comment>Description:</comment>
  Set the initial reconnection interval (Value: <info>int</info> &gt;= 0)


id: ZMQ::SOCKOPT_RECONNECT_IVL_MAX
type: constant
doc:
<comment>Description:</comment>
  Set the max reconnection interval (Value: <info>int</info> &gt;= 0)


id: ZMQ::SOCKOPT_RECOVERY_IVL
type: constant
doc:
<comment>Description:</comment>
  Set multicast recovery interval (Value: <info>int</info> &gt;= 0)


id: ZMQ::SOCKOPT_ROUTER_RAW
type: constant
doc:
<comment>Description:</comment>
  Sets the raw mode on the ROUTER, when set to 1. In raw mode when using tcp:// transport the socket
  will read and write without ZeroMQ framing. Available if compiled against ZeroMQ 4.0 or higher
  (Value: <info>string</info>)


id: ZMQ::SOCKOPT_SNDBUF
type: constant
doc:
<comment>Description:</comment>
  Set kernel transmit buffer size (Value: <info>int</info> &gt;= 0)


id: ZMQ::SOCKOPT_SNDHWM
type: constant
doc:
<comment>Description:</comment>
  The ZMQ_SNDHWM option shall set the high water mark for outbound messages on the specified socket.
  Available if compiled against ZeroMQ 3.x or higher (Value: <info>int</info>).


id: ZMQ::SOCKOPT_SNDTIMEO
type: constant
doc:
<comment>Description:</comment>
  Sets the timeout for send operation on the socket. Value -1 means no limit. Available if compiled
  against ZeroMQ 3.x or higher (Value: <info>int</info>)


id: ZMQ::SOCKOPT_SUBSCRIBE
type: constant
doc:
<comment>Description:</comment>
  Establish message filter. Valid for subscriber socket (Value: <info>string</info>)


id: ZMQ::SOCKOPT_TCP_KEEPALIVE_CNT
type: constant
doc:
<comment>Description:</comment>
  Count time for TCP keepalive. Available if compiled against ZeroMQ 3.x or higher (Value: <info>int</info>)


id: ZMQ::SOCKOPT_TCP_KEEPALIVE_IDLE
type: constant
doc:
<comment>Description:</comment>
  Idle time for TCP keepalive. Available if compiled against ZeroMQ 3.x or higher (Value: <info>int</info>)


id: ZMQ::SOCKOPT_TCP_KEEPALIVE_INTVL
type: constant
doc:
<comment>Description:</comment>
  Interval for TCP keepalive. Available if compiled against ZeroMQ 3.x or higher (Value: <info>int</info>)


id: ZMQ::SOCKOPT_TYPE
type: constant
doc:
<comment>Description:</comment>
  Get the socket type. Valid for getSockOpt (Value: <info>int</info>)


id: ZMQ::SOCKOPT_UNSUBSCRIBE
type: constant
doc:
<comment>Description:</comment>
  Remove message filter. Valid for subscriber socket (Value: <info>string</info>)


id: ZMQ::SOCKOPT_XPUB_VERBOSE
type: constant
doc:
<comment>Description:</comment>
  Set the XPUB to receive an application message on each instance of a subscription. Available if
  compiled against ZeroMQ 3.x or higher (Value: <info>string</info>)


id: ZMQ::__construct
type: function
doc:
<comment>Description:</comment>
  ZMQ constructor
  
  Private constructor to prevent direct initialization. This class holds the constants for ZMQ
  extension.


id: ZMQContext::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new ZMQContext object
  
  Constructs a new ZMQ context. The context is used to initialize sockets. A persistent context is
  required  to initialize persistent sockets.

<comment>Param:</comment>
  <info>int</info>   <strong>$io_threads</strong>     Number of io-threads in the context.
  <info>bool</info>  <strong>$is_persistent</strong>  Whether the context is persistent. Persistent context is stored over
                        multiple requests and is a requirement for persistent sockets.


id: ZMQContext::getOpt
type: function
doc:
<comment>Description:</comment>
  Get context option
  
  Returns the value of a context option.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  An integer representing the option. See the <info>ZMQ::CTXOPT_*</info> constants.

<comment>Return:</comment>
  <info>mixed</info>  Returns either a <info>string</info> or an <info>int</info> depending on <strong>$key</strong>. Throws ZMQContextException on error.


id: ZMQContext::getSocket
type: function
doc:
<comment>Description:</comment>
  Create a new socket
  
  Shortcut for creating new sockets from the context. If the context is not persistent the
  <strong>$persistent_id</strong>  parameter is ignored and the socket falls back to being non-persistent. The
  <strong>$on_new_socket</strong> is called only when a new underlying socket structure is created.

<comment>Param:</comment>
  <info>int</info>       <strong>$type</strong>           <info>ZMQ::SOCKET_*</info> constant to specify socket type.
  <info>string</info>    <strong>$persistent_id</strong>  If <strong>$persistent_id</strong> is specified the socket will be persisted over
                            multiple requests.
  <info>callable</info>  <strong>$on_new_socket</strong>  Callback function, which is executed when a new socket structure is
                            created. This function does not get invoked if the underlying persistent
                            connection is re-used. The callback takes ZMQSocket and persistent_id as
                            two arguments.

<comment>Return:</comment>
  <info>ZMQSocket</info>  Returns a <class>ZMQSocket</class> object.


id: ZMQContext::isPersistent
type: function
doc:
<comment>Description:</comment>
  Whether the context is persistent
  
  Whether the context is persistent. Persistent context is needed for persistent connections as each
  socket is allocated from a context.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the context is persistent and <info>false</info> if the context is non-persistent.


id: ZMQContext::setOpt
type: function
doc:
<comment>Description:</comment>
  Set a socket option
  
  Sets a ZMQ context option. The type of the <strong>$value</strong> depends on the <strong>$key</strong>. See ZMQ Constant Types for
  more information.

<comment>Param:</comment>
  <info>int</info>    <strong>$key</strong>    One of the <info>ZMQ::CTXOPT_*</info> constants.
  <info>mixed</info>  <strong>$value</strong>  The value of the parameter.

<comment>Return:</comment>
  <info>ZMQContext</info>  Returns the current object. Throws ZMQContextException on error.


id: ZMQDevice::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new device
  
  "ØMQ devices can do intermediation of addresses, services, queues, or any other abstraction you
  care to define above the message and socket layers." -- zguide

<comment>Param:</comment>
  <info>ZMQSocket</info>  <strong>$frontend</strong>  Frontend parameter for the devices. Usually where there messages are coming.
  <info>ZMQSocket</info>  <strong>$backend</strong>   Backend parameter for the devices. Usually where there messages going to.
  <info>ZMQSocket</info>  <strong>$listener</strong>  Listener socket, which receives a copy of all messages going both
                        directions. The type of this socket should be SUB, PULL or DEALER.

<comment>Return:</comment>
  <info>unknown</info>  Call to this method will prepare the device. Usually devices are very long running
           processes so running this method from interactive script is not recommended. This method
           throw ZMQDeviceException if the device cannot be started.


id: ZMQDevice::getIdleTimeout
type: function
doc:
<comment>Description:</comment>
  Get the idle timeout
  
  Gets the idle callback timeout value. Added in ZMQ extension version 1.1.0.

<comment>Return:</comment>
  <info>ZMQDevice</info>  This method returns the idle callback timeout value.


id: ZMQDevice::getTimerTimeout
type: function
doc:
<comment>Description:</comment>
  Get the timer timeout
  
  Gets the timer callback timeout value. Added in ZMQ extension version 1.1.0.

<comment>Return:</comment>
  <info>ZMQDevice</info>  This method returns the timer timeout value.


id: ZMQDevice::run
type: function
doc:
<comment>Description:</comment>
  Run the new device
  
  Runs the device.

<comment>Return:</comment>
  <info>void</info>  Call to this method will block until the device is running. It is not recommended that
        devices are used from interactive scripts. On failure this method will throw
        ZMQDeviceException.


id: ZMQDevice::setIdleCallback
type: function
doc:
<comment>Description:</comment>
  Set the idle callback function
  
  Sets the idle callback function. If idle timeout is defined the idle callback function shall be
  called if the internal poll loop times out without events. If the callback function returns false
  or a value that evaluates to false the device is stopped.
   The callback function signature is callback (mixed $user_data).

<comment>Param:</comment>
  <info>callable</info>  <strong>$cb_func</strong>    Callback function to invoke when the device is idle. Returning false or a
                        value that evaluates to false from this function will cause the  device to
                        stop.
  <info>int</info>       <strong>$timeout</strong>    How often to invoke the idle callback in milliseconds. The idle callback is
                        invoked periodically when there is no activity on the device. The timeout
                        value guarantees that there is at least this amount of milliseconds between
                        invocations of the callback function.
  <info>mixed</info>     <strong>$user_data</strong>  Additional data to pass to the callback function.

<comment>Return:</comment>
  <info>ZMQDevice</info>  On success this method returns the current object.


id: ZMQDevice::setIdleTimeout
type: function
doc:
<comment>Description:</comment>
  Set the idle timeout
  
  Sets the idle callback timeout value. The idle callback is invoked periodically when the device is
  idle.

<comment>Param:</comment>
  <info>int</info>  <strong>$timeout</strong>  The idle callback timeout value.

<comment>Return:</comment>
  <info>ZMQDevice</info>  On success this method returns the current object.


id: ZMQDevice::setTimerCallback
type: function
doc:
<comment>Description:</comment>
  Set the timer callback function
  
  Sets the timer callback function. The timer callback will be invoked after timeout has passed. The
  difference between idle and timer callbacks are that idle callback is invoked only when the device
  is idle.
   The callback function signature is callback (mixed $user_data). Added in ZMQ extension version
  1.1.0.

<comment>Param:</comment>
  <info>callable</info>  <strong>$cb_func</strong>    Callback function to invoke when the device is idle. Returning false or a
                        value that evaluates to false from this function will cause the  device to
                        stop.
  <info>int</info>       <strong>$timeout</strong>    How often to invoke the idle callback in milliseconds. The idle callback is
                        invoked periodically when there is no activity on the device. The timeout
                        value guarantees that there is at least this amount of milliseconds between
                        invocations of the callback function.
  <info>mixed</info>     <strong>$user_data</strong>  Additional data to pass to the callback function.

<comment>Return:</comment>
  <info>ZMQDevice</info>  On success this method returns the current object.


id: ZMQDevice::setTimerTimeout
type: function
doc:
<comment>Description:</comment>
  Set the timer timeout
  
  Sets the timer callback timeout value. The timer callback is invoked periodically if it's set.
  Added in ZMQ extension version 1.1.0.

<comment>Param:</comment>
  <info>int</info>  <strong>$timeout</strong>  The timer callback timeout value.

<comment>Return:</comment>
  <info>ZMQDevice</info>  On success this method returns the current object.


id: ZMQPoll::add
type: function
doc:
<comment>Description:</comment>
  Add item to the poll set
  
  Adds a new item to the poll set and returns the internal id of the added item. The item can be
  removed from the poll set using the returned string id.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$entry</strong>  ZMQSocket object or a PHP stream resource
  <info>int</info>    <strong>$type</strong>   Defines what activity the socket is polled for.  See <info>ZMQ::POLL_IN</info> and <info>ZMQ::POLL_OUT</info>
                 constants.

<comment>Return:</comment>
  <info>string</info>  Returns a string id of the added item which can be later used to remove the item.  Throws
          ZMQPollException on error.


id: ZMQPoll::clear
type: function
doc:
<comment>Description:</comment>
  Clear the poll set
  
  Clears all elements from the poll set.

<comment>Return:</comment>
  <info>ZMQPoll</info>  Returns the current object.


id: ZMQPoll::count
type: function
doc:
<comment>Description:</comment>
  Count items in the poll set
  
  Count the items in the poll set.

<comment>Return:</comment>
  <info>int</info>  Returns an <info>int</info> representing the amount of items in the poll set.


id: ZMQPoll::getLastErrors
type: function
doc:
<comment>Description:</comment>
  Get poll errors
  
  Returns the ids of the objects that had errors in the last poll.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing ids for the items that had errors in the last poll. Empty array
         is  returned if there were no errors.


id: ZMQPoll::poll
type: function
doc:
<comment>Description:</comment>
  Poll the items
  
  Polls the items in the current poll set. The readable and writable items are returned in the
  <strong>$readable</strong> and <strong>$writable</strong> parameters.  <strong>ZMQPoll::getLastErrors()</strong> can be used to check if there were
  errors.

<comment>Param:</comment>
  <info>array</info>  <strong>$readable</strong>  Array where readable ZMQSockets/PHP streams are returned. The array will be
                    cleared at the beginning of the operation.
  <info>array</info>  <strong>$writable</strong>  Array where writable ZMQSockets/PHP streams are returned. The array will be
                    cleared at the beginning of the operation.
  <info>int</info>    <strong>$timeout</strong>   Timeout for the operation. -1 means that poll waits until at least one item has
                    activity. Please note that starting from  version 1.0.0 the poll timeout is
                    defined in milliseconds, rather than microseconds.

<comment>Return:</comment>
  <info>int</info>  Returns an integer representing the amount of items with activity.


id: ZMQPoll::remove
type: function
doc:
<comment>Description:</comment>
  Remove item from poll set
  
  Remove item from the poll set. The <strong>$item</strong> parameter can be ZMQSocket object, a stream resource or
  the id returned from <strong>ZMQPoll::add()</strong> method.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$item</strong>  The ZMQSocket object, PHP stream or <info>string</info> id of the item.

<comment>Return:</comment>
  <info>bool</info>  Returns true if the item was removed and false if the object  with given id does not exist
        in the poll set.


id: ZMQSocket::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new ZMQSocket
  
  Constructs a ZMQSocket object. <strong>$persistent_id</strong> parameter can be used to allocated a persistent
  socket. A persistent socket has to be allocated from a persistent context and it stays connected
  over multiple requests. The <strong>$persistent_id</strong> parameter can be used to recall the same socket over
  multiple requests. The      <strong>$on_new_socket</strong> is called only when a new underlying socket structure
  is created.

<comment>Param:</comment>
  <info>ZMQContext</info>  <strong>$context</strong>        ZMQContext object.
  <info>int</info>         <strong>$type</strong>           The socket type. See <info>ZMQ::SOCKET_*</info> constants.
  <info>string</info>      <strong>$persistent_id</strong>  If <strong>$persistent_id</strong> is specified the socket will be persisted over
                              multiple requests. If <strong>$context</strong> is not persistent the socket falls back
                              to non-persistent mode.
  <info>callable</info>    <strong>$on_new_socket</strong>  Callback function, which is executed when a new socket structure is
                              created. This function does not get invoked if the underlying
                              persistent connection is re-used.


id: ZMQSocket::bind
type: function
doc:
<comment>Description:</comment>
  Bind the socket
  
  Bind the socket to an endpoint. The endpoint is defined in format <return>transport://address</return> where
  transport is one of the following: inproc, ipc, tcp, pgm or epgm.

<comment>Param:</comment>
  <info>string</info>  <strong>$dsn</strong>    The bind dsn, for example <return>transport://address</return>.
  <info>bool</info>    <strong>$force</strong>  Tries to bind even if the socket has already been bound to the given endpoint.

<comment>Return:</comment>
  <info>ZMQSocket</info>  Returns the current object. Throws ZMQSocketException on error.


id: ZMQSocket::connect
type: function
doc:
<comment>Description:</comment>
  Connect the socket
  
  Connect the socket to a remote endpoint. The endpoint is defined in format <return>transport://address</return>
  where  transport is one of the following: inproc, ipc, tcp, pgm or epgm.

<comment>Param:</comment>
  <info>string</info>  <strong>$dsn</strong>    The connect dsn, for example <return>transport://address</return>.
  <info>bool</info>    <strong>$force</strong>  Tries to connect even if the socket has already been connected to given endpoint.

<comment>Return:</comment>
  <info>ZMQSocket</info>  Returns the current object.


id: ZMQSocket::disconnect
type: function
doc:
<comment>Description:</comment>
  Disconnect a socket
  
  Disconnect the socket from a previously connected remote endpoint. The endpoint is defined in
  format <return>transport://address</return> where transport is one of the following: inproc, ipc, tcp, pgm or epgm.

<comment>Param:</comment>
  <info>string</info>  <strong>$dsn</strong>  The connect dsn, for example <return>transport://address</return>.

<comment>Return:</comment>
  <info>ZMQSocket</info>  Returns the current object. Throws ZMQSocketException on error.


id: ZMQSocket::getEndpoints
type: function
doc:
<comment>Description:</comment>
  Get list of endpoints
  
  Returns a list of endpoints where the socket is connected or bound to.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing elements 'bind' and 'connect'.


id: ZMQSocket::getPersistentId
type: function
doc:
<comment>Description:</comment>
  Get the persistent id
  
  Returns the persistent id of the socket.

<comment>Return:</comment>
  <info>string</info>  Returns the persistent id string assigned of the object and <info>null</info> if socket is not
          persistent.


id: ZMQSocket::getSockOpt
type: function
doc:
<comment>Description:</comment>
  Get socket option
  
  Returns the value of a socket option.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  An integer representing the option. See the <info>ZMQ::SOCKOPT_*</info> constants.

<comment>Return:</comment>
  <info>mixed</info>  Returns either a <info>string</info> or an <info>int</info> depending on <strong>$key</strong>. Throws ZMQSocketException on error.


id: ZMQSocket::getSocketType
type: function
doc:
<comment>Description:</comment>
  Get the socket type
  
  Gets the socket type.

<comment>Return:</comment>
  <info>int</info>  Returns an integer representing the socket type. The integer can be compared against
       <info>ZMQ::SOCKET_*</info> constants.


id: ZMQSocket::isPersistent
type: function
doc:
<comment>Description:</comment>
  Whether the socket is persistent
  
  Check whether the socket is persistent.

<comment>Return:</comment>
  <info>bool</info>  Returns a <info>bool</info> based on whether the socket is persistent or not.


id: ZMQSocket::recv
type: function
doc:
<comment>Description:</comment>
  Receives a message
  
  Receive a message from a socket. By default receiving will block until a message is available
  unless <info>ZMQ::MODE_DONTWAIT</info> flag is used. <info>ZMQ::SOCKOPT_RCVMORE</info> socket option can be used for
  receiving multi-part messages. See <strong>ZMQSocket::setSockOpt()</strong>  for more information.

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  Pass mode flags to receive multipart messages or non-blocking operation.  See
              <info>ZMQ::MODE_*</info> constants.

<comment>Return:</comment>
  <info>string</info>  Returns the message. If <info>ZMQ::MODE_DONTWAIT</info>  is used and the operation would block <info>false</info>
          shall be returned.


id: ZMQSocket::recvMulti
type: function
doc:
<comment>Description:</comment>
  Receives a multipart message
  
  Receive an array multipart message from a socket. By default receiving will block until a message
  is available unless <info>ZMQ::MODE_NOBLOCK</info> flag is used.

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  Pass mode flags to receive multipart messages or non-blocking operation.  See
              <info>ZMQ::MODE_*</info> constants.

<comment>Return:</comment>
  <info>array</info>  Returns the array of message parts. Throws ZMQSocketException in error.  If
         <info>ZMQ::MODE_NOBLOCK</info> is used and the operation would  block <info>bool</info> false shall be returned.


id: ZMQSocket::send
type: function
doc:
<comment>Description:</comment>
  Sends a message
  
  Send a message using the socket. The operation can block unless <info>ZMQ::MODE_NOBLOCK</info> is used.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The message to send.
  <info>int</info>     <strong>$mode</strong>     Pass mode flags to receive multipart messages or non-blocking operation.  See
                    <info>ZMQ::MODE_*</info> constants.

<comment>Return:</comment>
  <info>ZMQSocket</info>  Returns the current object. Throws ZMQSocketException on error.  If <info>ZMQ::MODE_NOBLOCK</info>
             is used and the operation would  block <info>bool</info> false shall be returned.


id: ZMQSocket::sendmulti
type: function
doc:
<comment>Description:</comment>
  Sends a multipart message
  
  Send a multipart message using the socket. The operation can block unless <info>ZMQ::MODE_NOBLOCK</info> is
  used.

<comment>Param:</comment>
  <info>array</info>  <strong>$message</strong>  The message to send - an array of strings
  <info>int</info>    <strong>$mode</strong>     Pass mode flags to receive multipart messages or non-blocking operation.  See
                   <info>ZMQ::MODE_*</info> constants.

<comment>Return:</comment>
  <info>ZMQSocket</info>  Returns the current object. Throws ZMQSocketException on error.  If <info>ZMQ::MODE_NOBLOCK</info>
             is used and the operation would  block <info>bool</info> false shall be returned.


id: ZMQSocket::setSockOpt
type: function
doc:
<comment>Description:</comment>
  Set a socket option
  
  Sets a ZMQ socket option. The type of the <strong>$value</strong> depends on the <strong>$key</strong>. See ZMQ Constant Types for
  more information.

<comment>Param:</comment>
  <info>int</info>    <strong>$key</strong>    One of the <info>ZMQ::SOCKOPT_*</info> constants.
  <info>mixed</info>  <strong>$value</strong>  The value of the parameter.

<comment>Return:</comment>
  <info>ZMQSocket</info>  Returns the current object. Throws ZMQSocketException on error.


id: ZMQSocket::unbind
type: function
doc:
<comment>Description:</comment>
  Unbind the socket
  
  Unbind the socket from an endpoint. The endpoint is defined in format <return>transport://address</return> where
  transport is one of the following: inproc, ipc, tcp, pgm or epgm.

<comment>Param:</comment>
  <info>string</info>  <strong>$dsn</strong>  The previously bound dsn, for example <return>transport://address</return>.

<comment>Return:</comment>
  <info>ZMQSocket</info>  Returns the current object. Throws ZMQSocketException on error.


id: ZipArchive::AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE
type: constant
doc:
<comment>Description:</comment>
  Arşiv boşsa arşiv dosyası silinmez. libzip ≥ 1.10.0 destekli PHP 8.3.0 ve PECL zip 1.22.0
  sürümlerinde ve sonrasında kullanılabilir.


id: ZipArchive::AFL_IS_TORRENTZIP
type: constant
doc:
<comment>Description:</comment>
  Geçerli arşiv torrentzip'li. libzip ≥ 1.10.0 destekli PHP 8.3.0 ve PECL zip 1.22.0 sürümlerinde ve
  sonrasında kullanılabilir.


id: ZipArchive::AFL_RDONLY
type: constant
doc:
<comment>Description:</comment>
  Arşiv salt-okunur, silinemez. libzip ≥ 1.10.0 destekli PHP 8.3.0 ve PECL zip 1.22.0 sürümlerinde
  ve sonrasında kullanılabilir.


id: ZipArchive::AFL_WANT_TORRENTZIP
type: constant
doc:
<comment>Description:</comment>
  Arşiv torrentzip'li yazılır. libzip ≥ 1.10.0 destekli PHP 8.3.0 ve PECL zip 1.22.0 sürümlerinde ve
  sonrasında kullanılabilir.


id: ZipArchive::CHECKCONS
type: constant
doc:
<comment>Description:</comment>
  Arşiv üzerinde ek tutarlılık sınamaları yapar; sınamalar başarısız olursa hata verir.


id: ZipArchive::CM_LZMA2
type: constant
doc:
<comment>Description:</comment>
  LZMA2 algoritması. libzip ≥ 1.6.0 ile derlenmişse PHP 7.4.3 ve PECL zip 1.16.0 itibariyle
  kullanılabilir.


id: ZipArchive::CM_XZ
type: constant
doc:
<comment>Description:</comment>
  XZ algoritması. libzip ≥ 1.6.0 ile derlenmişse PHP 7.4.3 ve PECL zip 1.16.1 itibariyle
  kullanılabilir.


id: ZipArchive::CM_ZSTD
type: constant
doc:
<comment>Description:</comment>
  Zstandard algoritması. libzip ≥ 1.8.0 ile derlenmişse PHP 8.0.0 ve PECL zip 1.19.1 itibariyle
  kullanılabilir.


id: ZipArchive::EM_AES_128
type: constant
doc:
<comment>Description:</comment>
  AES 128 şifrelemesi. libzip ≥ 1.2.0 desteğiyle derlenmişse PHP 7.2.0 ve PECL zip 1.14.0 itibariyle
  kullanılabilir.


id: ZipArchive::EM_AES_192
type: constant
doc:
<comment>Description:</comment>
  AES 192 şifrelemesi. libzip ≥ 1.2.0 desteğiyle derlenmişse PHP 7.2.0 ve PECL zip 1.14.0 itibariyle
  kullanılabilir.


id: ZipArchive::EM_AES_256
type: constant
doc:
<comment>Description:</comment>
  AES 256 şifrelemesi. libzip ≥ 1.2.0 desteğiyle derlenmişse PHP 7.2.0 ve PECL zip 1.14.0 itibariyle
  kullanılabilir.


id: ZipArchive::EM_NONE
type: constant
doc:
<comment>Description:</comment>
  Şifreleme yok. PHP 7.2.0 ve PECL zip 1.14.0 itibariyle kullanılabilir.


id: ZipArchive::EM_TRAD_PKWARE
type: constant
doc:
<comment>Description:</comment>
  Geleneksel PKWARE şifrelemesi. PHP 8.0.0 ve PECL zip 1.19.0 itibariyle kullanılabilir.


id: ZipArchive::EM_UNKNOWN
type: constant
doc:
<comment>Description:</comment>
  Bilinmeyen şifreleme algoritması. PHP 8.0.0 ve PECL zip 1.19.0 itibariyle kullanılabilir.


id: ZipArchive::ER_CANCELLED
type: constant
doc:
<comment>Description:</comment>
  İşlem iptal edildi. libzip ≥ 1.6.0 desteğiyle derlenmişse PHP 7.4.3 ve PECL zip 1.16.1 itibariyle
  kullanılabilir.


id: ZipArchive::ER_COMPRESSED_DATA
type: constant
doc:
<comment>Description:</comment>
  Sıkıştırlmış veri geçersiz. libzip ≥ 1.6.0 desteğiyle derlenmişse PHP 7.4.3 ve PECL zip 1.16.1
  itibariyle kullanılabilir.


id: ZipArchive::ER_DATA_LENGTH
type: constant
doc:
<comment>Description:</comment>
  Beklenmedik uzunlukta veri. libzip ≥ 1.10.0 destekli PHP 8.3.0 ve PECL zip 1.22.0 sürümlerinde ve
  sonrasında kullanılabilir.


id: ZipArchive::ER_ENCRNOTSUPP
type: constant
doc:
<comment>Description:</comment>
  Şifreleme yöntemi desteklenmiyor. PHP 7.4.3 ve PECL zip 1.16.1 itibariyle kullanılabilir.


id: ZipArchive::ER_INUSE
type: constant
doc:
<comment>Description:</comment>
  Özkaynak hala kullanımda. libzip ≥ 1.0.0 desteğiyle derlenmişse PHP 7.4.3 ve PECL zip 1.16.1
  itibariyle kullanılabilir.


id: ZipArchive::ER_NOPASSWD
type: constant
doc:
<comment>Description:</comment>
  Parola girilmedi. PHP 7.4.3 ve PECL zip 1.16.1 itibariyle kullanılabilir.


id: ZipArchive::ER_NOT_ALLOWED
type: constant
doc:
<comment>Description:</comment>
  torrentzip için izin verilmez. libzip ≥ 1.10.0 destekli PHP 8.3.0 ve PECL zip 1.22.0 sürümlerinde
  ve sonrasında kullanılabilir.


id: ZipArchive::ER_OPNOTSUPP
type: constant
doc:
<comment>Description:</comment>
  İşlem desteklenmiyor. libzip ≥ 1.0.0 desteğiyle derlenmişse PHP 7.4.3 ve PECL zip 1.16.1
  itibariyle kullanılabilir.


id: ZipArchive::ER_RDONLY
type: constant
doc:
<comment>Description:</comment>
  Salt-okunur arşiv. PHP 7.4.3 ve PECL zip 1.16.1 itibariyle kullanılabilir.


id: ZipArchive::ER_TELL
type: constant
doc:
<comment>Description:</comment>
  Tell hatası. libzip ≥ 1.0.0 desteğiyle derlenmişse PHP 7.4.3 ve PECL zip 1.16.1 itibariyle
  kullanılabilir.


id: ZipArchive::ER_WRONGPASSWD
type: constant
doc:
<comment>Description:</comment>
  Yanlış parola girildi. PHP 7.4.3 ve PECL zip 1.16.1 itibariyle kullanılabilir.


id: ZipArchive::FL_CENTRAL
type: constant
doc:
<comment>Description:</comment>
  Merkezî dizinde. PHP 8.0.0 ve PECL zip 1.18.0 itibariyle kullanılabilir.


id: ZipArchive::FL_ENCRYPTED
type: constant
doc:
<comment>Description:</comment>
  Şifreli veri okunur (FL_COMPRESSED uygulanır). PHP 8.0.0 ve PECL zip 1.18.0 itibariyle
  kullanılabilir.


id: ZipArchive::FL_ENC_GUESS
type: constant
doc:
<comment>Description:</comment>
  Dizge kodlaması tahmin edilir (öntanımlıdır). PHP 7.0.8 ve sonrasında geçerlidir.


id: ZipArchive::FL_LOCAL
type: constant
doc:
<comment>Description:</comment>
  Yerel başlıkta. PHP 8.0.0 ve PECL zip 1.18.0 itibariyle kullanılabilir.


id: ZipArchive::FL_OPEN_FILE_NOW
type: constant
doc:
<comment>Description:</comment>
  Arşivin kapanmasını beklemek yerine, eklendiğinde dosyayı açar. Dosya tanıtıcı tüketiminin
  farkında olunur. PHP 8.3.0 ve PECL zip 1.22.1 ve sonrasında geçerlidir.


id: ZipArchive::FL_OVERWRITE
type: constant
doc:
<comment>Description:</comment>
  İsmi belirtilen dosya mevcutsa, üzerine yazılır. PHP 8.0.0 ve PECL zip 1.18.0 itibariyle
  kullanılabilir.


id: ZipArchive::FL_RECOMPRESS
type: constant
doc:
<comment>Description:</comment>
  Verinin yeniden sıkıştırlmasını zorlar. PHP 8.0.0 ve PECL zip 1.18.0 itibariyle kullanılabilir.
  PHP 8.3.0 ve PECL zip 1.22.0 itibariyle önerilmemekte olup gelecek libzip sürümlerinden birinde
  kaldırılacaktır.


id: ZipArchive::GetStatusString
type: function
doc:
<comment>Description:</comment>
  Durum hata iletilerini, sistem ve/veya zip iletilerini
    döndürür
  
  Durum hata iletilerini, sistem ve/veya zip iletilerini döndürür

<comment>Return:</comment>
  <info>string</info>  Durum iletisini içeren bir dizge döner.


id: ZipArchive::LENGTH_TO_END
type: constant
doc:
<comment>Description:</comment>
  Dosya boyutu kullanılır, dosya büyürse ek veriler göz ardı edilir, dosya küçülürse hata ortaya
  çıkar (<info>ZipArchive::ER_DATA_LENGTH</info>). PHP 8.3.0 ve PECL zip 1.22.2 itibariyle kullanılabilir.


id: ZipArchive::LENGTH_UNCHECKED
type: constant
doc:
<comment>Description:</comment>
  Kullanılabilecek tüm veri kullanılır. Derleme libzip ≥ 1.10.1 kullanarak yapılmışsa PHP 8.3.0 ve
  PECL zip 1.22.2 itibariyle kullanılabilir.


id: ZipArchive::LIBZIP_VERSION
type: constant
doc:
<comment>Description:</comment>
  Zip kütüphanesi sürümü. PHP 7.4.3 ve PECL zip 1.16.0 itibariyle kullanılabilir.


id: ZipArchive::OVERWRITE
type: constant
doc:
<comment>Description:</comment>
  Arşiv mevcutsa, o anki içeriği yoksayılır. Başka bir deyişle, daima boş bir arşiv başlatır.


id: ZipArchive::RDONLY
type: constant
doc:
<comment>Description:</comment>
  Arşiv salt-okunur kipte açılır. libzip ≥ 1.0.0 ile derlenmişse PHP 7.4.3 ve PECL zip 1.17.1
  itibariyle kullanılabilir.


id: ZipArchive::addEmptyDir
type: function
doc:
<comment>Description:</comment>
  Yeni bir dizin ekler
  
  Arşive boş bir dizin ekler.

<comment>Param:</comment>
  <info>string</info>  <strong>$dizin</strong>       Eklenecek dizinin ismi.
  <info>int</info>     <strong>$seçenekler</strong>  <info>ZipArchive::FL_ENC_GUESS</info>, <info>ZipArchive::FL_ENC_UTF_8</info>, <info>ZipArchive::FL_ENC_CP437</info>
                       sabitlerinin bit maskesi. Bu sabitlerin davranışı ZIP sabitleri sayfasında
                       açıklanmıştır.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.


id: ZipArchive::addFile
type: function
doc:
<comment>Description:</comment>
  Yolu belirtilen dosyayı arşive ekler
  
  Yolu belirtilen dosyayı arşive ekler.
  
  Taşınabilirliği arttırmak için ZIP dosya isimlerinde dizin ayracı
  olarak bölü çizgilerini (<return>/</return>) kullanın.

<comment>Param:</comment>
  <info>string</info>  <strong>$dosyayolu</strong>   Eklenecek dosyanın yolu.
  <info>string</info>  <strong>$girdiadı</strong>   Belirtilmişse ve boş değilse dosyanın ZIP arşivi içindeki ismi olup
                       <strong>$dosyayolu</strong>nu geçersiz kılar.
  <info>int</info>     <strong>$başlangıç</strong>  Kısmi kopya için başlangıç konumu.
  <info>int</info>     <strong>$uzunluk</strong>     Kısmi kopya için kopyalanan uzunluk; <info>ZipArchive::LENGTH_TO_END</info> (0) ise dosya
                       boyutu, <info>ZipArchive::LENGTH_UNCHECKED</info> ise dosyanın tamamı kullanılır.
  <info>int</info>     <strong>$seçenekler</strong>  <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> sabitlerinin bit
                       maskesi. Bu sabitlerin davranışı ZIP sabitleri sayfasında açıklanmıştır.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * ZipArchive::replaceFile


id: ZipArchive::addFromString
type: function
doc:
<comment>Description:</comment>
  İsmi ve içeriği belirtilen dosyayı arşive ekler
  
  İsmi ve içeriği belirtilen dosyayı arşive ekler.
  
  Taşınabilirliği arttırmak için ZIP dosya isimlerinde dizin ayracı
  olarak bölü çizgilerini (<return>/</return>) kullanın.

<comment>Param:</comment>
  <info>string</info>  <strong>$isim</strong>        Oluşturulacak girdinin ismi.
  <info>string</info>  <strong>$içerik</strong>     Oluşturulacak girdinin içeriği. İkil olarak güvenli kipte yazılır.
  <info>int</info>     <strong>$seçenekler</strong>  <info>ZipArchive::FL_OVERWRITE</info>, <info>ZipArchive::FL_ENC_GUESS</info>, <info>ZipArchive::FL_ENC_UTF_8</info>,
                       <info>ZipArchive::FL_ENC_CP437</info> sabitlerinin bit maskesi. Bu sabitlerin davranışı
                       ZIP sabitleri sayfasında açıklanmıştır.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.


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>.
  
  Taşınabilirliği arttırmak için ZIP dosya isimlerinde dizin ayracı
  olarak bölü çizgilerini (<return>/</return>) kullanın.

<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  başarısızlık durumunda <info>false</info> döner

<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  başarısızlık durumunda <info>false</info> döner

<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>  Hiçbir değer dönmez.

<comment>See Also:</comment>
   * ZipArchive::getStatusString


id: ZipArchive::close
type: function
doc:
<comment>Description:</comment>
  Etkin (açık veya oluşturulmuş) arşivi kapatır
  
  Açılmış veya yeni oluşturulmuş arşivi kapatır ve değişiklikleri kaydeder. Bu yöntem betiğin
  sonunda otomatik olarak çağrılır.
  
  Arşiv dosya içermiyorsa, arşiv dosyası <info>ZipArchive::AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE</info>
  küresel seçeneğinin değerine uygun olarak silinir (veya silinmez).

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<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>
  İndisi belirtilen girdiyi arşivden siler
  
  İndisi belirtilen girdiyi arşivden siler.

<comment>Param:</comment>
  <info>int</info>  <strong>$indis</strong>  Silinecek girdinin indisi.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.


id: ZipArchive::deleteName
type: function
doc:
<comment>Description:</comment>
  İsmi belirtilen girdiyi siler
  
  İsmi belirtilen girdiyi arşivden siler.

<comment>Param:</comment>
  <info>string</info>  <strong>$isim</strong>  Silinecek girdinin ismi.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.


id: ZipArchive::extractTo
type: function
doc:
<comment>Description:</comment>
  Arşiv içeriğini çıkarır
  
  Arşivin tamamını veya belirtilen dosyaları belirtilen hedefe çıkarır.
  
  Çıkarılan dosya ve dizinler için öntanımlı izinler olası en geniş yetkileri sağlar. Bu geçerli
  umask değeri ile sınırlanabilir. Geçerli umask değeri <strong>umask()</strong> işlevi ile değiştirilebilir.

<comment>Param:</comment>
  <info>string</info>             <strong>$hedef</strong>     Dosyaların çıkarılacağı yer.
  <info>array|string|null</info>  <strong>$girdiler</strong>  Çıkarılacak girdiler. Tek bir girdi ismi içeren bir dizge veya girdi
                                isimlerini içeren bir dizi kabul eder.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.


id: ZipArchive::getArchiveComment
type: function
doc:
<comment>Description:</comment>
  Zip arşivinin açıklamasını döndürür
  
  Zip arşivinin açıklamasını döndürür.

<comment>Param:</comment>
  <info>int</info>  <strong>$seçenekler</strong>  Değer olarak <info>ZipArchive::FL_UNCHANGED</info> belirtilirse özgün açıklama değişmeden
                    döner.

<comment>Return:</comment>
  <info>string|false</info>  Başarısızlık durumunda <info>false</info> aksi takdirde açıklama dizgesi döner.


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>
  İndisi belirtilen girdinin açıklamasını döndürür
  
  İndisi belirtilen girdinin açıklamasını döndürür.

<comment>Param:</comment>
  <info>int</info>  <strong>$indis</strong>       Girdinin indisi.
  <info>int</info>  <strong>$seçenekler</strong>  Değer olarak <info>ZipArchive::FL_UNCHANGED</info> belirtilirse özgün açıklama değişmeden
                    döner.

<comment>Return:</comment>
  <info>string|false</info>  Başarısızlık durumunda <info>false</info> aksi takdirde açıklama dizgesi döner.


id: ZipArchive::getCommentName
type: function
doc:
<comment>Description:</comment>
  İsmi belirtilen girdinin açıklamasını döndürür
  
  İsmi belirtilen girdinin açıklamasını döndürür.

<comment>Param:</comment>
  <info>string</info>  <strong>$isim</strong>        Girdinin ismi.
  <info>int</info>     <strong>$seçenekler</strong>  Değer olarak <info>ZipArchive::FL_UNCHANGED</info> belirtilirse özgün açıklama değişmeden
                       döner.

<comment>Return:</comment>
  <info>string|false</info>  Başarısızlık durumunda <info>false</info> aksi takdirde açıklama dizgesi döner.


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>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.


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>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.


id: ZipArchive::getFromIndex
type: function
doc:
<comment>Description:</comment>
  İndisi belirtilen girdinin içeriğini döndürür
  
  İndisi belirtilen girdinin içeriğini döndürür.

<comment>Param:</comment>
  <info>int</info>  <strong>$indis</strong>       Girdi indisi.
  <info>int</info>  <strong>$uzunluk</strong>     Girdiden okunacak uzunluk. <return>0</return> belirtilirse, tüm girdi okunur.
  <info>int</info>  <strong>$seçenekler</strong>  Arşivi açmakta kullanılacak seçenekler, Aşağıdaki sabitler VEYAlanarak
                    belirtilir: <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>  Başarısızlık durumunda <info>false</info> aksi takdirde girdinin içeriği döner.

<comment>See Also:</comment>
   * ZipArchive::getFromName


id: ZipArchive::getFromName
type: function
doc:
<comment>Description:</comment>
  İsmi belirtilen girdinin içeriğini döndürür
  
  İsmi belirtilen girdinin içeriğini döndürür.

<comment>Param:</comment>
  <info>string</info>  <strong>$isim</strong>        Girdinin ismi.
  <info>int</info>     <strong>$uzunluk</strong>     Girdiden okunacak uzunluk. <return>0</return> belirtilirse, tüm girdi okunur.
  <info>int</info>     <strong>$seçenekler</strong>  Girdiyi bulmak için kullanılacak seçenekler, Aşağıdaki sabitler VEYAlanarak
                       belirtilir:
                       <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>  Başarısızlık durumunda <info>false</info> aksi takdirde girdinin içeriği döner.

<comment>See Also:</comment>
   * ZipArchive::getFromIndex


id: ZipArchive::getNameIndex
type: function
doc:
<comment>Description:</comment>
  İndisi belirtilen girdinin ismini döndürür
  
  İndisi belirtilen girdinin ismini döndürür.

<comment>Param:</comment>
  <info>int</info>  <strong>$indis</strong>       Girdi indisi.
  <info>int</info>  <strong>$seçenekler</strong>  Değer olarak <info>ZipArchive::FL_UNCHANGED</info> belirtilirse özgün isim değişmeden döner.

<comment>Return:</comment>
  <info>string|false</info>  Başarısızlık durumunda <info>false</info> aksi takdirde girdinin ismi döner.


id: ZipArchive::getStream
type: function
doc:
<comment>Description:</comment>
  İsmi belirtilen girdi için dosya tanıtıcısı (salt okunur)
    döndürür
  
  İsmi belirtilen girdi için dosya tanıtıcısı döndürür. Şimdilik sadece okuma işlemleri
  desteklenmektedir.

<comment>Param:</comment>
  <info>string</info>  <strong>$isim</strong>  Kullanılacak girdinin ismi.

<comment>Return:</comment>
  <info>resource|false</info>  Başarısızlık durumunda <info>false</info> aksi takdirde girdinin dosya tanıtıcısı döner.

<comment>See Also:</comment>
   * ZipArchive::getStreamIndex
   * ZipArchive::getStreamName
   * Sıkıştırma Akımları


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 başarısızlık durumunda <info>false</info> döner.

<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 başarısızlık durumunda <info>false</info> döner.

<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>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<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>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * ZipArchive::setEncryptionIndex
   * ZipArchive::setEncryptionName


id: ZipArchive::locateName
type: function
doc:
<comment>Description:</comment>
  İsmi belirtilen girdinin indisini döndürür
  
  İsmi belirtilen girdinin indisini döndürür.

<comment>Param:</comment>
  <info>string</info>  <strong>$isim</strong>        Girdinin ismi.
  <info>int</info>     <strong>$seçenekler</strong>  İsmin nasıl aranacağı aşağıdaki sabitlerden oluşan bir bit maskesi olarak
                       belirtilir. Hiçbiri belirtilmeyecekse <return>0</return> belirtilir.
                       <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>  Başarısızlık durumunda <info>false</info> aksi takdirde girdinin indisi döner.


id: ZipArchive::open
type: function
doc:
<comment>Description:</comment>
  Bir ZIP dosya arşivi açar
  
  Okumak, yazmak veya değiştirmek amacıyla bir zip arşivi açar.
  
  libzip 1.6.0'dan beri, boş dosya artık geçerli bir arşiv değil.

<comment>Param:</comment>
  <info>string</info>  <strong>$dosya</strong>       Açılacak ZIP arşivinin dosya ismi.
  <info>int</info>     <strong>$seçenekler</strong>  Arşivin açılacağı kip; şu sabitlerden biridir:
                       <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>  Başarı durumunda <info>true</info> yoksa aşağıdaki hata kodarından biri döner:
            <info>ZipArchive::ER_EXISTS</info>Dosya zaten mevcut.<info>ZipArchive::ER_INCONS</info>Zip arşivi
            tutarsız.<info>ZipArchive::ER_INVAL</info>Geçersiz bağımsız değişken.<info>ZipArchive::ER_MEMORY</info>Malloc
            hatası.<info>ZipArchive::ER_NOENT</info>Böyle bir dosya yok.<info>ZipArchive::ER_NOZIP</info>Bir zip arşivi
            değil.<info>ZipArchive::ER_OPEN</info>Dosya açılamiyor.<info>ZipArchive::ER_READ</info>Okuma
            hatası.<info>ZipArchive::ER_SEEK</info>Konumlama hatası.
            
            Dosya zaten mevcut.
            
            Zip arşivi tutarsız.
            
            Geçersiz bağımsız değişken.
            
            Malloc hatası.
            
            Böyle bir dosya yok.
            
            Bir zip arşivi değil.
            
            Dosya açılamiyor.
            
            Okuma hatası.
            
            Konumlama hatası.


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>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<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>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * ZipArchive::registerCancelCallback


id: ZipArchive::renameIndex
type: function
doc:
<comment>Description:</comment>
  İndisi belirtilen girdinin ismini değiştirir
  
  İndisi belirtilen girdinin ismini değiştirir.

<comment>Param:</comment>
  <info>int</info>     <strong>$indis</strong>      İsmi değiştirilecek girdinin indisi.
  <info>string</info>  <strong>$yeni_isim</strong>  Girdinin yeni ismi.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.


id: ZipArchive::renameName
type: function
doc:
<comment>Description:</comment>
  İsmi belirtilen girdinin ismini değiştirir
  
  İsmi belirtilen girdinin ismini değiştirir.

<comment>Param:</comment>
  <info>string</info>  <strong>$isim</strong>    Girdinin değiştirilecek ismi.
  <info>string</info>  <strong>$yenisi</strong>  Girdinin yeni ismi.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.


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.
  
  Taşınabilirliği arttırmak için ZIP dosya isimlerinde dizin ayracı
  olarak bölü çizgilerini (<return>/</return>) kullanın.

<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>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * ZipArchive::addFile


id: ZipArchive::setArchiveComment
type: function
doc:
<comment>Description:</comment>
  Bir ZIP arşivine açıklama ekler
  
  Bir ZIP arşivine açıklama ekler.

<comment>Param:</comment>
  <info>string</info>  <strong>$açıklama</strong>  Açıklamanın içeriği.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.


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>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * ZipArchive::getArchiveFlag


id: ZipArchive::setCommentIndex
type: function
doc:
<comment>Description:</comment>
  İndisi belirtilen girdiye bir açıklama ekler
  
  İndisi belirtilen girdiye bir açıklama ekler.

<comment>Param:</comment>
  <info>int</info>     <strong>$indis</strong>     Girdi indisi.
  <info>string</info>  <strong>$açıklama</strong>  Açıklamanın içeriği.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.


id: ZipArchive::setCommentName
type: function
doc:
<comment>Description:</comment>
  İsmi belirtilen girdiye bir açıklama ekler
  
  İsmi belirtilen girdiye bir açıklama ekler.

<comment>Param:</comment>
  <info>string</info>  <strong>$isim</strong>      Girdinin ismi.
  <info>string</info>  <strong>$açıklama</strong>  Açıklamanın içeriği.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.


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>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.


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>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.


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>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<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>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<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>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.


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>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.


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>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<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>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<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>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * ZipArchive::setEncryptionIndex
   * ZipArchive::setEncryptionName


id: ZipArchive::statIndex
type: function
doc:
<comment>Description:</comment>
  İndisi belirtilen girdiyle ilgili bilgileri döndürür
  
  İndisi belirtilen girdiyle ilgili bilgileri döndürür.

<comment>Param:</comment>
  <info>int</info>  <strong>$indis</strong>       Girdi indisi.
  <info>int</info>  <strong>$seçenekler</strong>  Değişiklikleri yok sayarak arşivin özgün dosyası hakkında bilgi istemek için
                    <info>ZipArchive::FL_UNCHANGED</info> sabiti bit maskesine dahil edilebilir.

<comment>Return:</comment>
  <info>array|false</info>  Başarısızlık durumunda <info>false</info> aksi takdirde girdi ile ilgili ayrıntıları içeren bir
               dizi döner.


id: ZipArchive::statName
type: function
doc:
<comment>Description:</comment>
  İsmi belirtilen girdiyle ilgili bilgileri döndürür
  
  İsmi belirtilen girdiyle ilgili bilgileri döndürür.

<comment>Param:</comment>
  <info>string</info>  <strong>$isim</strong>        Girdi ismi.
  <info>int</info>     <strong>$seçenekler</strong>  İsmin nasıl aranacağı aşağıdaki sabitlerden oluşan bir bit maskesi olarak
                       belirtilir. Ayrıca, değişiklikleri yoksayarak arşivin özgün dosyası hakkında
                       bilgi edinmek için <info>ZipArchive::FL_UNCHANGED</info> sabiti de bit maskesine dahil
                       edilebilir. Sabitlerin açıklamaları  sayfasında bulunabilir.
                       <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>  Başarısızlık durumunda <info>false</info> aksi takdirde girdi ile ilgili ayrıntıları içeren bir
               dizi döner.


id: ZipArchive::unchangeAll
type: function
doc:
<comment>Description:</comment>
  Arşivde yapılmış değişikliklerin tamamını geri alır
  
  Arşivde yapılmış değişikliklerin tamamını geri alır.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.


id: ZipArchive::unchangeArchive
type: function
doc:
<comment>Description:</comment>
  Arşiv bilgilerinde yapılmış değişiklikleri geri alır
  
  Arşiv bilgilerinde yapılmış değişiklikleri geri alır.  Şimdilik sadece açıklama değişiklikleri
  geri alınabilmektedir.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.


id: ZipArchive::unchangeIndex
type: function
doc:
<comment>Description:</comment>
  İndisi belirtilen girdideki değişiklikleri geri alır
  
  İndisi belirtilen girdideki değişiklikleri geri alır.

<comment>Param:</comment>
  <info>int</info>  <strong>$indis</strong>  Girdi indisi.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.


id: ZipArchive::unchangeName
type: function
doc:
<comment>Description:</comment>
  İsmi belirtilen girdideki değişiklikleri geri alır
  
  Belirtilen girdide yapılmış değişiklikleri geri alır.

<comment>Param:</comment>
  <info>string</info>  <strong>$isim</strong>  Girdinin ismi.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.


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>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<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>  Hiçbir değer dönmez.

<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>  Hiçbir değer dönmez.

<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>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<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>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<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>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<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>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<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>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<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>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<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>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<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>  Hiçbir değer dönmez.

<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>  Hiçbir değer dönmez.

<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>  Hiçbir değer dönmez.

<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>
  Sınıf ismi. Bildirildiği isim alanını (<return>Foo\Bar</return> gibi) içerir. Kalıtsal özelliklerin içinde
  kullanıldığında __CLASS__, içinde kullanıldığı sınıfın ismidir.


id: __DIR__
type: constant
doc:
<comment>Description:</comment>
  Dosyanın bulurduğu dizin. Dahil edilen bir dosyanın içinde kullanıldığında dahil edilen dosyanın
  dizini döner. Bu <return>dirname(__FILE__)</return> işlevine eşdeğerder. Bu dizin isminin sonuna bir kök dizin
  olmadıkça bir bölü imi konmaz.


id: __FILE__
type: constant
doc:
<comment>Description:</comment>
  Dosyanın veya sembolik bağdan çözümlenen dosyanın tam dosya yolu ve dosya ismi. <strong>include()</strong> işlevi
  ile betiğe eklenen bir dosyanın içinde kullanıldığında betiğin ismini değil, eklenen dosyanın
  ismini içerir.


id: __TRAIT__
type: constant
doc:
<comment>Description:</comment>
  Kalıtsal özellik ismi. Bildirildiği isim alanını (<return>Foo\Bar</return> gibi) içerir.


id: __autoload
type: function
doc:
<comment>Description:</comment>
  Tanımsız sınıfı yüklemeye çalışır
  
  Sınıfları otomatik yüklemek için bu işlev tanımlanabilir.

<comment>Param:</comment>
  <info>string</info>  <strong>$sınıf</strong>  Yüklenecek sınıfın ismi.

<comment>Return:</comment>
  <info>void</info>  Hiçbir değer dönmez.

<comment>See Also:</comment>
   * <strong>spl_autoload_register()</strong>


id: __halt_compiler
type: function
doc:
<comment>Description:</comment>
  Derleyicinin çalışmasını durdurur
  
  Derleyicinin çalışmasını durdurur. PHP betiklerine kurulum dosyaları gibi verileri gömmek için
  kullanışlıdır.
  
  Veri başlangıç baytının konumu <info>__COMPILER_HALT_OFFSET__</info> sabitiye belirtilebilir. Bu sabit sadece
  dosyada bir <strong>__halt_compiler()</strong> işlevi varsa tanımlıdır.

<comment>Return:</comment>
  <info>void</info>  Hiçbir değer dönmez.


id: abs
type: function
doc:
<comment>Description:</comment>
  Absolute value
  
  Returns the absolute value of <strong>$num</strong>.

<comment>Param:</comment>
  <info>int|float</info>  <strong>$num</strong>  The numeric value to process

<comment>Return:</comment>
  <info>int|float</info>  The absolute value of <strong>$num</strong>. If the argument <strong>$num</strong> is of type <info>float</info>, the return type is
             also <info>float</info>, otherwise it is <info>int</info> (as <info>float</info> usually has a bigger value range than <info>int</info>).

<comment>See Also:</comment>
   * <strong>gmp_abs()</strong>
   * <strong>gmp_sign()</strong>


id: acos
type: function
doc:
<comment>Description:</comment>
  Arc cosine
  
  Returns the arc cosine of <strong>$num</strong> in radians. <strong>acos()</strong> is the inverse function of <strong>cos()</strong>, which means
  that $num == cos(acos($num)) for every value of <strong>$num</strong> that is in the domain of <strong>acos()</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  The argument to process

<comment>Return:</comment>
  <info>float</info>  The arc cosine of <strong>$num</strong> in radians.

<comment>See Also:</comment>
   * <strong>cos()</strong>
   * <strong>acosh()</strong>
   * <strong>asin()</strong>
   * <strong>atan()</strong>


id: acosh
type: function
doc:
<comment>Description:</comment>
  Inverse hyperbolic cosine
  
  Returns the inverse hyperbolic cosine of <strong>$num</strong>, i.e. the value whose hyperbolic cosine is <strong>$num</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  The value to process

<comment>Return:</comment>
  <info>float</info>  The inverse hyperbolic cosine of <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>
  Dizgeye C tarzı öncelem uygular
  
  <strong>$dizge</strong> dizgesindeki <strong>$karakterler</strong> bağımsız değişkeninde listelenmiş karakterlerin önüne tersbölü
  yerleştirilerek elde edilen dizgeyi döndürür.

<comment>Param:</comment>
  <info>string</info>  <strong>$dizge</strong>        Öncelenecek dizge.
  <info>string</info>  <strong>$karakterler</strong>  Önlerine tersbölü konulacak <return>\n</return>, <return>\r</return> gibi karakterleri içeren dizge.
                        Belirtilen karakterler C tarzı öncelenirken, ASCII kodu 32'den küçük ve
                        126'dan büyük karakterler sekizlik gösterimlerine dönüştürülür.
                        
                        Burada karakter aralığı belirtiyorsanız aralığın hangi karakterleri
                        içerdiğine dikkat etmelisiniz.
                        ]]> Ayrıca, bir aralığın başlangıç karakterinin ASCII değeri, son
                        karakterininkinden büyükse ilk ve son karakter hariç bu aralıktaki hiçbir
                        karakter öncelenmez. Bir karakterin ASCII değerini bulmak için <strong>ord()</strong>
                        işlevini kullanın.
                        ]]>
                        
                        Karakterleri seçerken dikkatli olun: 0, a, b, f, n, r, t ve v karakterleri
                        \0, \a, \b, \f, \n, \r, \t ve \v karakterlerine dönüştürülecektir. Bunların
                        hepsi C tarzı öncelemde öntanımlı dizilimler olup PHP'de  \0 (NULL), \r
                        (satırbaşı), \n (satırsonu), \f (sayfa ileri), \v (düşey sekme) ve \t (yatay
                        sekme) öntanımlı dizilimlerdir. Bu dizilimler ayrıca, PHP dahil C'den
                        türetilmiş dillerde de tanımlıdır. Yani, <strong>$karakterler</strong>'de tanımlanan bu
                        karakterlerle bu dillerde kod üretmek için <strong>addcslashes()</strong> çıktısını
                        kullanmak istenen sonucu vermeyebilir.

<comment>Return:</comment>
  <info>string</info>  Öncelenmiş dizge.

<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>
  Özel karakterlerin önüne tersbölü yerleştirir
  
  Veritabanı sorguları gibi yerlerde kullanılmak üzere bir dizgenin içindeki özel karakterlerin
  önüne tersbölü koyarak elde edilen dizgeyi döndürür. Özel karakterler: tek tırmak (<return>'</return>)çift tırnak
  (<return>"</return>)tersbölü (<return>\</return>)NUL (NUL baytı)
  
  <strong>addslashes()</strong> kullanımından amaç, PHP tarafından değerlendirilecek bir dizede yukarıda belirtilen
  karakterleri tersbölü ile öncelemektir:
  ]]>
  
  <strong>addslashes()</strong> işlevi bazan hatalı olarak SQL Enjeksiyonunu engellemek için kullanılırdı. Bunun
  yerine veritbanlarına özgü önceleme işlevleri ve/veya hazırlanmış ifadeler kullanılmalıdır.

<comment>Param:</comment>
  <info>string</info>  <strong>$dizge</strong>  Öncelenecek dizge.

<comment>Return:</comment>
  <info>string</info>  Öncelemli dizge.

<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>
  Bu istekten sonra Apache sürecini sonlandırır
  
  <strong>apache_child_terminate()</strong> işlevi PHP kodunun çalışması bittikten sonra geçerli PHP isteğini
  çalıştıran Apache sürecini sonlandırmak için kullanılır. Daha ziyade çok bellek tüketen ancak
  işlem bittikten sonra tükettiği belleği işletim sistemine geri veremeyen işlemleri yoketmek için
  kullanılabilir.
  
  Apache, ve FastCGI http sunucularında çalışır.

<comment>Return:</comment>
  <info>void</info>  Hiçbir değer dönmez.

<comment>See Also:</comment>
   * <strong>exit()</strong>


id: apache_get_modules
type: function
doc:
<comment>Description:</comment>
  Yüklü Apache modüllerinin listesini verir
  
  Yüklü Apache modüllerinin listesini verir.

<comment>Return:</comment>
  <info>array</info>  Yüklü Apache modülleri dizisi.


id: apache_get_version
type: function
doc:
<comment>Description:</comment>
  Apache sürümünü getirir
  
  Apache sürümünü getirir.

<comment>Return:</comment>
  <info>string|false</info>  Başarı halinde Apache sürümünü, aksi halde <info>false</info> döndürür.

<comment>See Also:</comment>
   * <strong>phpinfo()</strong>


id: apache_getenv
type: function
doc:
<comment>Description:</comment>
  Bir Apache ortam değişkeninin değerini döndürür
  
  <strong>$değişken</strong> bağımsız değişkeniyle belirtilen Apache ortam değişkenini döndürür.

<comment>Param:</comment>
  <info>string</info>  <strong>$değişken</strong>   Apache ortam değişkeni
  <info>bool</info>    <strong>$tepe_seviye</strong>  Tüm Apache katmanlarında kullanılabilen tepe seviye değişkenin alınıp
                        alınmayacağını belirler.

<comment>Return:</comment>
  <info>string|false</info>  Başarı halinde Apache ortam değişkeninin değeri, aksi halde <info>false</info> döner.

<comment>See Also:</comment>
   * <strong>apache_sentenv()</strong>
   * <strong>getenv()</strong>
   * Süper Küreseller


id: apache_lookup_uri
type: function
doc:
<comment>Description:</comment>
  Verilen URI için kısmi bir istekte bulunur ve hakkındaki tüm bilgileri döndürür
  
  Bir URI için kısmi istekte bulunur. Özkaynak hakkında önemli tüm bilgileri alır.
  
  Bu
  işlev sadece PHP bir Apache modülü olarak kuruluysa desteklenir.

<comment>Param:</comment>
  <info>string</info>  <strong>$dosya_adı</strong>  İstenen dosyanın ismi (URI).

<comment>Return:</comment>
  <info>object|false</info>  URL bilgisiyle ilgili nesne. Nesnenin özellikleri
                
                
                statusthe_requeststatus_linemethodcontent_typehandlerurifilenamepath_infoargsboundaryno_cacheno_local_copyallowedsend_bodyctbytes_sentbyterangeclengthunparsed_urimtimerequest_time
                
                Başarısızlık durumunda <info>false</info> döner.


id: apache_note
type: function
doc:
<comment>Description:</comment>
  Apache istek notlarını alır veya atar
  
  Bu işlev Apache'nin <return>table_get</return> ve <return>table_set</return> işlevleri için bir sarmalayıcıdır. Bir istek sırasında
  var olan not tablosunu düzenler. Tablonun amacı Apache modüllerinin iletişimini sağlamaktır.
  
  <strong>apache_note()</strong> işlevinin ana kullanım amacı aynı istek dahilinde bir modülden diğerine bilgi
  aktarmaktır.

<comment>Param:</comment>
  <info>string</info>  <strong>$not_adı</strong>    Notun adı.
  <info></info>        <strong>$not_değeri</strong>  Notun değeri.

<comment>Return:</comment>
  <info>string|false</info>  <strong>$not_değeri</strong> verilmezse ya da <info>null</info> ise <return>not_adı</return> notunun o anki değerini döndürür. Aksi
                takdirde <return>not_değeri</return> değerini <return>not_adı</return> notuna atar ve <return>not_adı</return> notunun önceki değerini
                döndürür. Eğer işlem başarısız olursa <info>false</info> döner.

<comment>See Also:</comment>
   * <strong>virtual()</strong>


id: apache_request_headers
type: function
doc:
<comment>Description:</comment>
  Tüm HTTP istek başlıklarını alır
  
  Geçerli istekteki HTTP istek başlıklarının tümünü alır. Apache, FastCGI, CLI ve FPM http
  sunucularında çalışır.

<comment>Return:</comment>
  <info>array</info>  Başarı halinde mevcut isteğin tüm HTTP başlıklarını içeren bir ilişkili dizi döndürür; aksi
         halde <info>false</info> döndürür.

<comment>See Also:</comment>
   * <strong>apache_response_headers()</strong>


id: apache_response_headers
type: function
doc:
<comment>Description:</comment>
  Tüm HTTP yanıt başlıklarını alır
  
  Tüm HTTP yanıt başlıklarını alır. Apache, FastCGI, CLI ve FPM http sunucularında çalışır.

<comment>Return:</comment>
  <info>array|false</info>  Başarı halinde Apache yanıt başlıklarını içeren bir dizi; aksi halde <info>false</info> döndürür.

<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>
  Bir Apache ortam değişkeni atar
  
  <strong>apache_setenv()</strong> işlevi <strong>$değişken</strong> ile belirtilen Apache ortam değişkeninin değerini atar.
  
  Apache ortam değişkeni atanırken ilgili $_SERVER değişkeninde bir değişiklik olmaz.

<comment>Param:</comment>
  <info>string</info>  <strong>$değişken</strong>   Atanmak istenen çevre değişkeni.
  <info>string</info>  <strong>$değer</strong>       <strong>$değişken</strong>'in yeni değeri.
  <info>bool</info>    <strong>$tepe_seviye</strong>  Değişkenin tüm Apache katmanlarına kullanılabilen tepe seviyeye atanıp
                        atanmayacağını belirler.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<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>


id: apcu_cache_info
type: function
doc:
<comment>Description:</comment>
  Retrieves cached information from APCu's data store
    
  
  Retrieves cached information and meta-data from APC's data store.

<comment>Param:</comment>
  <info>bool</info>  <strong>$limited</strong>  If <strong>$limited</strong> is <info>true</info>, the return value will exclude the individual list of cache
                  entries.  This is useful when trying to optimize calls for statistics gathering.

<comment>Return:</comment>
  <info>array|false</info>  Array of cached data (and meta-data) başarısızlık durumunda <info>false</info> döner
               
               <strong>apcu_cache_info()</strong> will raise a warning if it is unable to retrieve APC cache data.
               This typically occurs when APC is not enabled.

<comment>See Also:</comment>
   * APCu configuration directives
   * APCUIterator::getTotalSize
   * APCUIterator::getTotalHits
   * APCUIterator::getTotalCount


id: apcu_cas
type: function
doc:
<comment>Description:</comment>
  Updates an old value with a new value
  
  <strong>apcu_cas()</strong> updates an already existing integer value if the  <strong>$old</strong> parameter matches the currently
  stored value  with the value of the <strong>$new</strong> parameter.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  The key of the value being updated.
  <info>int</info>     <strong>$old</strong>  The old value (the value currently stored).
  <info>int</info>     <strong>$new</strong>  The new value to update to.

<comment>Return:</comment>
  <info>bool</info>  Başarı durumunda <info>true</info>, başarısızlık durumunda <info>false</info> döner.

<comment>See Also:</comment>
   * <strong>apcu_dec()</strong>
   * <strong>apcu_store()</strong>


id: apcu_clear_cache
type: function
doc:
<comment>Description:</comment>
  Clears the APCu cache
    
  
  Clears the cache.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> always

<comment>See Also:</comment>
   * <strong>apcu_cache_info()</strong>


id: apcu_dec
type: function
doc:
<comment>Description:</comment>
  Decrease a stored number
  
  Decreases a stored integer value.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>      The key of the value being decreased.
  <info>int</info>     <strong>$step</strong>     The step, or value to decrease.
  <info>bool</info>    <strong>$success</strong>  Optionally pass the success or fail boolean value to this referenced variable.
  <info>int</info>     <strong>$ttl</strong>      TTL to use if the operation inserts a new value (rather than decrementing an
                    existing one).

<comment>Return:</comment>
  <info>int|false</info>  Returns the current value of <strong>$key</strong>'s value on success, başarısızlık durumunda <info>false</info>
             döner

<comment>See Also:</comment>
   * <strong>apcu_inc()</strong>


id: apcu_delete
type: function
doc:
<comment>Description:</comment>
  Removes a stored variable from the cache
    
  
  Removes a stored variable from the cache.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>  A <strong>$key</strong> used to store the value as a <info>string</info> for a single key, or as an <info>array</info> of
               strings for several keys, or as an <class>APCUIterator</class> <info>object</info>.

<comment>Return:</comment>
  <info>mixed</info>  If <strong>$key</strong> is an <info>array</info>, an indexed <info>array</info> of the keys is returned. Otherwise <info>true</info> is returned
         on success, or <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>apcu_store()</strong>
   * <strong>apcu_fetch()</strong>
   * <strong>apcu_clear_cache()</strong>
   * <class>APCUIterator</class>


id: apcu_enabled
type: function
doc:
<comment>Description:</comment>
  Whether APCu is usable in the current environment
  
  Returns whether APCu is usable in the current environment.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> when APCu is usable in the current environment, <info>false</info> otherwise.


id: apcu_entry
type: function
doc:
<comment>Description:</comment>
  Atomically fetch or generate a cache entry
    
  
  Atomically attempts to find <strong>$key</strong> in the cache, if it cannot be found <strong>$generator</strong> is called, passing
  <strong>$key</strong> as the only argument. The return value of the call is then cached with the optionally
  specified <strong>$ttl</strong>, and returned.
  
  When control enters <strong>apcu_entry()</strong> the lock for the cache is acquired exclusively, it is released
  when control leaves <strong>apcu_entry()</strong>:  In effect, this turns the body of <strong>$generator</strong> into a critical
  section, disallowing two processes from executing the same code paths concurrently. In addition,
  it prohibits the concurrent execution of any other APCu functions, since they will acquire the
  same lock.
  
  The only APCu function that can be called safely by <strong>$generator</strong> is <strong>apcu_entry()</strong>.

<comment>Param:</comment>
  <info>string</info>    <strong>$key</strong>        Identity of cache entry
  <info>callable</info>  <strong>$generator</strong>  A callable that accepts <strong>$key</strong> as the only argument and returns the value to
                        cache.
  <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.).

<comment>Return:</comment>
  <info>mixed</info>  Returns the cached value

<comment>See Also:</comment>
   * <strong>apcu_store()</strong>
   * <strong>apcu_fetch()</strong>
   * <strong>apcu_delete()</strong>


