# php_manual

id: EvIdle::createStopped
type: function
doc:
<comment>Description:</comment>
  Creates instance of a stopped EvIdle watcher object
  
  The same as EvIdle::__construct , but doesn't start the watcher automatically.

<comment>Param:</comment>
  <info>string</info>  <strong>$callback</strong>  See Watcher callbacks .
  <info>mixed</info>   <strong>$data</strong>      Custom data associated with the watcher.
  <info>int</info>     <strong>$priority</strong>  Watcher priority

<comment>Return:</comment>
  <info>object</info>  Returns EvIdle object on success.

<comment>See Also:</comment>
   * EvIdle::__construct
   * EvLoop::idle


id: EvIo
type: class
doc:
<comment>Description:</comment>
  <class>EvIo</class> watchers check whether a file descriptor(or socket, or a stream castable to numeric file
  descriptor) is readable or writable in each iteration of the event loop, or, more precisely, when
  reading would not block the process and writing would at least be able to write some data. This
  behaviour is called level-triggering because events are kept receiving as long as the condition
  persists. To stop receiving events just stop the watcher.
  
  The number of read and/or write event watchers per <strong>$fd</strong> is unlimited. Setting all file descriptors
  to non-blocking mode is also usually a good idea(but not required).
  
  Another thing to watch out for is that it is quite easy to receive false readiness notifications,
  i.e. the callback might be called with <info>Ev::READ</info> but a subsequent read() will actually block
  because there is no data. It is very easy to get into this situation. Thus it is best to always
  use non-blocking I/O: An extra read() returning <info>EAGAIN</info> (or similar) is far preferable to a program
  hanging until some data arrives.
  
  If for some reason it is impossible to run the <strong>$fd</strong> in non-blocking mode, then separately re-test
  whether a file descriptor is really ready. Some people additionally use <info>SIGALRM</info> and an interval
  timer, just to be sure thry won't block infinitely.
  
  Always consider using non-blocking mode.


id: EvIo::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs EvIo watcher object
  
  Constructs EvIo watcher object and starts the watcher automatically.

<comment>Param:</comment>
  <info>mixed</info>     <strong>$fd</strong>        Can be a stream opened with <strong>fopen()</strong> or similar functions, numeric file
                       descriptor, or socket.
  <info>int</info>       <strong>$events</strong>    <info>Ev::READ</info> and/or <info>Ev::WRITE</info> . See the bit masks .
  <info>callable</info>  <strong>$callback</strong>  See Watcher callbacks .
  <info>mixed</info>     <strong>$data</strong>      Custom data associated with the watcher.
  <info>int</info>       <strong>$priority</strong>  Watcher priority

<comment>See Also:</comment>
   * EvIo::createStopped
   * EvLoop::io


id: EvIo::createStopped
type: function
doc:
<comment>Description:</comment>
  Create stopped EvIo watcher object
  
  The same as EvIo::__construct , but doesn't start the watcher automatically.

<comment>Param:</comment>
  <info>mixed</info>     <strong>$fd</strong>        The same as for EvIo::__construct
  <info>int</info>       <strong>$events</strong>    The same as for EvIo::__construct
  <info>callable</info>  <strong>$callback</strong>  See Watcher callbacks .
  <info>mixed</info>     <strong>$data</strong>      Custom data associated with the watcher.
  <info>int</info>       <strong>$priority</strong>  Watcher priority

<comment>Return:</comment>
  <info>EvIo</info>  Returns EvIo object on success.

<comment>See Also:</comment>
   * EvIo::__construct
   * EvLoop::io


id: EvIo::set
type: function
doc:
<comment>Description:</comment>
  Configures the watcher
  
  Configures the EvIo watcher

<comment>Param:</comment>
  <info>mixed</info>  <strong>$fd</strong>      The same as for EvIo::__construct
  <info>int</info>    <strong>$events</strong>  The same as for EvIo::__construct

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: EvLoop
type: class
doc:
<comment>Description:</comment>
  Represents an event loop that is always distinct from the default loop . Unlike the default loop ,
  it cannot handle <class>EvChild</class> watchers.
  
  Having threads we have to create a loop per thread, and use the default loop in the parent thread.
  
  The default event loop is initialized automatically by Ev . It is accessible via methods of the <class>Ev</class>
  class, or via EvLoop::defaultLoop method.


id: EvLoop::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs the event loop object
  
  Constructs the event loop object.

<comment>Param:</comment>
  <info>int</info>    <strong>$flags</strong>             One of the event loop flags
  <info>mixed</info>  <strong>$data</strong>              Custom data associated with the loop.
  <info>float</info>  <strong>$io_interval</strong>       See io_interval
  <info>float</info>  <strong>$timeout_interval</strong>  See timeout_interval

<comment>See Also:</comment>
   * EvLoop::defaultLoop


id: EvLoop::backend
type: function
doc:
<comment>Description:</comment>
  Returns an integer describing the backend used by libev
  
  The same as Ev::backend , but for the loop instance.

<comment>Return:</comment>
  <info>int</info>  Returns an integer describing the backend used by libev. See Ev::backend .

<comment>See Also:</comment>
   * Ev::backend


id: EvLoop::check
type: function
doc:
<comment>Description:</comment>
  Creates EvCheck object associated with the current event loop
    instance
  
  Creates EvCheck object associated with the current event loop instance.

<comment>Return:</comment>
  <info>EvCheck</info>  Returns EvCheck object on success.

<comment>See Also:</comment>
   * EvCheck::__construct


id: EvLoop::child
type: function
doc:
<comment>Description:</comment>
  Creates EvChild object associated with the current event loop
  
  Creates EvChild object associated with the current event loop.

<comment>Return:</comment>
  <info>EvChild</info>  Returns EvChild object on success.

<comment>See Also:</comment>
   * EvChild::__construct


id: EvLoop::defaultLoop
type: function
doc:
<comment>Description:</comment>
  Returns or creates the default event loop
  
  If the default event loop is not created, EvLoop::defaultLoop creates it with the specified
  parameters. Otherwise, it just returns the object representing previously created instance
  ignoring all the parameters.

<comment>Param:</comment>
  <info>int</info>    <strong>$flags</strong>                     One of the event loop flags
  <info>mixed</info>  <strong>$data</strong>                      Custom data to associate with the loop.
  <info></info>       <strong>$io_collect_interval</strong>       See io_interval
  <info></info>       <strong>$timeout_collect_interval</strong>  See timeout_interval

<comment>Return:</comment>
  <info>EvLoop</info>  Returns EvLoop object on success.

<comment>See Also:</comment>
   * EvLoop::__construct


id: EvLoop::embed
type: function
doc:
<comment>Description:</comment>
  Creates an instance of EvEmbed watcher associated
    with the current EvLoop object
  
  Creates an instance of <class>EvEmbed</class> watcher associated with the current <class>EvLoop</class> object.

<comment>Return:</comment>
  <info>EvEmbed</info>  Returns EvEmbed object on success.

<comment>See Also:</comment>
   * EvEmbed::__construct


id: EvLoop::fork
type: function
doc:
<comment>Description:</comment>
  Creates EvFork watcher object associated with the current event
    loop instance
  
  Creates EvFork watcher object associated with the current event loop instance

<comment>Return:</comment>
  <info>EvFork</info>  Returns EvFork object on success.

<comment>See Also:</comment>
   * EvFork::__construct


id: EvLoop::idle
type: function
doc:
<comment>Description:</comment>
  Creates EvIdle watcher object associated with the current event
    loop instance
  
  Creates EvIdle watcher object associated with the current event loop instance

<comment>Return:</comment>
  <info>EvIdle</info>  Returns EvIdle object on success.

<comment>See Also:</comment>
   * EvIdle::__construct


id: EvLoop::invokePending
type: function
doc:
<comment>Description:</comment>
  Invoke all pending watchers while resetting their pending state
  
  Invoke all pending watchers while resetting their pending state.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: EvLoop::io
type: function
doc:
<comment>Description:</comment>
  Create EvIo watcher object associated with the current event
    loop instance
  
  Create EvIo watcher object associated with the current event loop instance.

<comment>Return:</comment>
  <info>EvIo</info>  Returns EvIo object on success.

<comment>See Also:</comment>
   * EvIo::__construct


id: EvLoop::loopFork
type: function
doc:
<comment>Description:</comment>
  Must be called after a fork
  
  Must be called after a fork in the child, before entering or continuing the event loop. An
  alternative is to use <info>Ev::FLAG_FORKCHECK</info> which calls this function automatically, at some
  performance loss (refer to the libev documentation ).

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: EvLoop::now
type: function
doc:
<comment>Description:</comment>
  Returns the current "event loop time"
  
  Returns the current "event loop time", which is the time the event loop received events and
  started processing them. This timestamp does not change as long as callbacks are being processed,
  and this is also the base time used for relative timers. You can treat it as the timestamp of the
  event occurring(or more correctly, libev finding out about it).

<comment>Return:</comment>
  <info>float</info>  Returns time of the event loop in (fractional) seconds.

<comment>See Also:</comment>
   * Ev::now


id: EvLoop::nowUpdate
type: function
doc:
<comment>Description:</comment>
  Establishes the current time by querying the kernel, updating the time
      returned by EvLoop::now in the progress
  
  Establishes the current time by querying the kernel, updating the time returned by EvLoop::now in
  the progress. This is a costly operation and is usually done automatically within EvLoop::run .

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * EvLoop::now
   * Ev::nowUpdate


id: EvLoop::periodic
type: function
doc:
<comment>Description:</comment>
  Creates EvPeriodic watcher object associated with the current
    event loop instance
  
  Creates EvPeriodic watcher object associated with the current event loop instance

<comment>Return:</comment>
  <info>EvPeriodic</info>  Returns EvPeriodic object on success.

<comment>See Also:</comment>
   * EvPeriodic::__construct


id: EvLoop::prepare
type: function
doc:
<comment>Description:</comment>
  Creates EvPrepare watcher object associated with the current
    event loop instance
  
  Creates EvPrepare watcher object associated with the current event loop instance

<comment>Return:</comment>
  <info>EvPrepare</info>  Returns EvPrepare object on success

<comment>See Also:</comment>
   * EvPrepare::__construct


id: EvLoop::resume
type: function
doc:
<comment>Description:</comment>
  Resume previously suspended default event loop
  
  EvLoop::suspend and EvLoop::resume methods suspend and resume a loop correspondingly.

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * EvLoop::suspend
   * Ev::resume


id: EvLoop::run
type: function
doc:
<comment>Description:</comment>
  Begin checking for events and calling callbacks for the loop
  
  Begin checking for events and calling callbacks for the current event loop. Returns when a
  callback calls Ev::stop method, or the flags are nonzero(in which case the return value is true)
  or when there are no active watchers which reference the loop( EvWatcher::keepalive is <info>true</info>), in
  which case the return value will be <info>false</info>. The return value can generally be interpreted as if
  <info>true</info>, there is more work left to do .

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Optional parameter <strong>$flags</strong> can be one of the following:  List for possible values of
               <strong>$flags</strong> <strong>$flags</strong>Description<info>0</info>The default behavior described above<info>Ev::RUN_ONCE</info>Block at
               most one(wait, but don't loop)<info>Ev::RUN_NOWAIT</info>Don't block at all(fetch/handle events,
               but don't wait)
               
               See the run flag constants .

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * EvLoop::stop
   * Ev::run


id: EvLoop::signal
type: function
doc:
<comment>Description:</comment>
  Creates EvSignal watcher object associated with the current
    event loop instance
  
  Creates EvSignal watcher object associated with the current event loop instance

<comment>Return:</comment>
  <info>EvSignal</info>  Returns EvSignal object on success

<comment>See Also:</comment>
   * EvSignal::__construct


id: EvLoop::stat
type: function
doc:
<comment>Description:</comment>
  Creates EvStat watcher object associated with the current event
    loop instance
  
  Creates EvStat watcher object associated with the current event loop instance

<comment>Return:</comment>
  <info>EvStat</info>  Returns EvStat object on success

<comment>See Also:</comment>
   * EvSignal::__construct


id: EvLoop::stop
type: function
doc:
<comment>Description:</comment>
  Stops the event loop
  
  Stops the event loop

<comment>Param:</comment>
  <info>int</info>  <strong>$how</strong>  One of Ev::BREAK_* constants .

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * EvLoop::run
   * Ev::stop


id: EvLoop::suspend
type: function
doc:
<comment>Description:</comment>
  Suspend the loop
  
  EvLoop::suspend and EvLoop::resume methods suspend and resume a loop correspondingly.

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * EvLoop::resume
   * Ev::suspend


id: EvLoop::timer
type: function
doc:
<comment>Description:</comment>
  Creates EvTimer watcher object associated with the current event
    loop instance
  
  Creates EvTimer watcher object associated with the current event loop instance

<comment>Return:</comment>
  <info>EvTimer</info>  Returns EvTimer object on success

<comment>See Also:</comment>
   * EvTimer::__construct


id: EvLoop::verify
type: function
doc:
<comment>Description:</comment>
  Performs internal consistency checks(for debugging)
  
  Performs internal consistency checks(for debugging libev ) and abort the program if any data
  structures were found to be corrupted.

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * Ev::verify


id: EvPeriodic
type: class
doc:
<comment>Description:</comment>
  Periodic watchers are also timers of a kind, but they are very versatile.
  
  Unlike <class>EvTimer</class> , <class>EvPeriodic</class> watchers are not based on real time(or relative time, the physical
  time that passes) but on wall clock time(absolute time, calendar or clock). The difference is that
  wall clock time can run faster or slower than real time, and time jumps are not uncommon(e.g. when
  adjusting it).
  
  <class>EvPeriodic</class> watcher can be configured to trigger after some specific point in time. For example, if
  an <class>EvPeriodic</class> watcher is configured to trigger "in 10 seconds" (e.g. EvLoop::now + <info>10.0</info> , i.e. an
  absolute time, not a delay), and the system clock is reset to January of the previous year , then
  it will take a year or more to trigger the event (unlike an <class>EvTimer</class> , which would still trigger
  roughly <info>10</info> seconds after starting it as it uses a relative timeout).
  
  As with timers, the callback is guaranteed to be invoked only when the point in time where it is
  supposed to trigger has passed. If multiple timers become ready during the same loop iteration
  then the ones with earlier time-out values are invoked before ones with later time-out values (but
  this is no longer true when a callback calls EvLoop::run recursively).


id: EvPeriodic::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs EvPeriodic watcher object
  
  Constructs EvPeriodic watcher object and starts it automatically. EvPeriodic::createStopped method
  creates stopped periodic watcher.

<comment>Param:</comment>
  <info>float</info>     <strong>$offset</strong>         See Periodic watcher operation modes
  <info>string</info>    <strong>$interval</strong>       See Periodic watcher operation modes
  <info>callable</info>  <strong>$reschedule_cb</strong>  Reschedule callback. You can pass <info>null</info>. See Periodic watcher operation
                            modes
  <info>callable</info>  <strong>$callback</strong>       See Watcher callbacks .
  <info>mixed</info>     <strong>$data</strong>           Custom data associated with the watcher.
  <info>int</info>       <strong>$priority</strong>       Watcher priority

<comment>See Also:</comment>
   * Periodic watcher operation modes
   * <class>EvTimer</class>
   * EvPeriodic::createStopped


id: EvPeriodic::again
type: function
doc:
<comment>Description:</comment>
  Simply stops and restarts the periodic watcher again
  
  Simply stops and restarts the periodic watcher again. This is only useful when attributes are
  changed.

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * EvTimer::again


id: EvPeriodic::at
type: function
doc:
<comment>Description:</comment>
  Returns the absolute time that this
    watcher is supposed to trigger next
  
  When the watcher is active, returns the absolute time that this watcher is supposed to trigger
  next. This is not the same as the offset argument to EvPeriodic::set or EvPeriodic::__construct ,
  but indeed works even in interval mode.

<comment>Return:</comment>
  <info>float</info>  Returns the absolute time this watcher is supposed to trigger next in seconds.


id: EvPeriodic::createStopped
type: function
doc:
<comment>Description:</comment>
  Create a stopped EvPeriodic watcher
  
  Create EvPeriodic object. Unlike EvPeriodic::__construct this method doesn't start the watcher
  automatically.

<comment>Param:</comment>
  <info>float</info>     <strong>$offset</strong>         See Periodic watcher operation modes
  <info>float</info>     <strong>$interval</strong>       See Periodic watcher operation modes
  <info>callable</info>  <strong>$reschedule_cb</strong>  Reschedule callback. You can pass <info>null</info>. See Periodic watcher operation
                            modes
  <info>callable</info>  <strong>$callback</strong>       See Watcher callbacks .
  <info>mixed</info>     <strong>$data</strong>           Custom data associated with the watcher.
  <info>int</info>       <strong>$priority</strong>       Watcher priority

<comment>Return:</comment>
  <info>EvPeriodic</info>  Returns EvPeriodic watcher object on success.

<comment>See Also:</comment>
   * EvPeriodic::__construct
   * EvTimer::createStopped


id: EvPeriodic::set
type: function
doc:
<comment>Description:</comment>
  Configures the watcher
  
  (Re-)Configures EvPeriodic watcher

<comment>Param:</comment>
  <info>float</info>  <strong>$offset</strong>    The same meaning as for EvPeriodic::__construct . See Periodic watcher operation
                    modes
  <info>float</info>  <strong>$interval</strong>  The same meaning as for EvPeriodic::__construct . See Periodic watcher operation
                    modes

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: EvPrepare::__construct
type: function
doc:
<comment>Description:</comment>
  EvPrepare ウォッチャーオブジェクトを作る
  
  EvPrepare ウォッチャーオブジェクトを作り、自動的に開始させます。 停止状態のウォッチャーが必要なと
  きは、 EvPrepare::createStopped を使いましょう。

<comment>Param:</comment>
  <info>string</info>  <strong>$callback</strong>  ウォッチャーのコールバック を参照ください。
  <info>string</info>  <strong>$data</strong>      このウォッチャーに関連づけるカスタムデータ。
  <info>string</info>  <strong>$priority</strong>  ウォッチャーの優先度。

<comment>See Also:</comment>
   * <class>EvCheck</class>


id: EvPrepare::createStopped
type: function
doc:
<comment>Description:</comment>
  停止した EvPrepare ウォッチャーのインスタンスを作る
  
  停止した EvPrepare ウォッチャーのインスタンスを作ります。 EvPrepare::__construct とは違い、 このメ
  ソッドはウォッチャーを自動的に開始させません。

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  ウォッチャーのコールバック を参照ください。
  <info>mixed</info>     <strong>$data</strong>      このウォッチャーに関連づけるカスタムデータ。
  <info>int</info>       <strong>$priority</strong>  ウォッチャーの優先度。

<comment>Return:</comment>
  <info>EvPrepare</info>  成功した場合に EvPrepare オブジェクトを返します。

<comment>See Also:</comment>
   * EvPrepare::__construct
   * EvWatcher::start


id: EvSignal
type: class
doc:
<comment>Description:</comment>
  <class>EvSignal</class> watchers will trigger an event when the process receives a specific signal one or more
  times. Even though signals are very asynchronous, libev will try its best to deliver signals
  synchronously, i.e. as part of the normal event processing, like any other event.
  
  There is no limit for the number of watchers for the same signal, but only within the same loop,
  i.e. one can watch for <info>SIGINT</info> in the default loop and for <info>SIGIO</info> in another loop, but it is not
  allowed to watch for <info>SIGINT</info> in both the default loop and another loop at the same time. At the
  moment, <info>SIGCHLD</info> is permanently tied to the default loop.
  
  If possible and supported, libev will install its handlers with <return>SA_RESTART</return> (or equivalent)
  behaviour enabled, so system calls should not be unduly interrupted. In case of a problem with
  system calls getting interrupted by signals, all the signals can be blocked in an <class>EvCheck</class> watcher
  and unblocked in a <class>EvPrepare</class> watcher.


id: EvSignal::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs EvSignal watcher object
  
  Constructs EvSignal watcher object and starts it automatically. For a stopped periodic watcher
  consider using EvSignal::createStopped method.

<comment>Param:</comment>
  <info>int</info>       <strong>$signum</strong>    Signal number. See constants exported by pcntl extension. See also <return>signal(7)</return>
                       man page.
  <info>callable</info>  <strong>$callback</strong>  See Watcher callbacks .
  <info>mixed</info>     <strong>$data</strong>      Custom data associated with the watcher.
  <info>int</info>       <strong>$priority</strong>  Watcher priority

<comment>See Also:</comment>
   * EvSignal::createStopped


id: EvSignal::createStopped
type: function
doc:
<comment>Description:</comment>
  Create stopped EvSignal watcher object
  
  Create stopped EvSignal watcher object. Unlike EvSignal::__construct , this method does't start
  the watcher automatically.

<comment>Param:</comment>
  <info>int</info>       <strong>$signum</strong>    Signal number. See constants exported by pcntl extension. See also <return>signal(7)</return>
                       man page.
  <info>callable</info>  <strong>$callback</strong>  See Watcher callbacks .
  <info>mixed</info>     <strong>$data</strong>      Custom data associated with the watcher.
  <info>int</info>       <strong>$priority</strong>  Watcher priority

<comment>Return:</comment>
  <info>EvSignal</info>  Returns EvSignal object on success.

<comment>See Also:</comment>
   * EvWatcher::start
   * EvSignal::__construct


id: EvSignal::set
type: function
doc:
<comment>Description:</comment>
  Configures the watcher
  
  Configures the watcher.

<comment>Param:</comment>
  <info>int</info>  <strong>$signum</strong>  Signal number. The same as for EvSignal::__construct

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: EvStat
type: class
doc:
<comment>Description:</comment>
  <class>EvStat</class> monitors a file system path for attribute changes. It calls stat() on that path in regular
  intervals(or when the OS signals it changed) and sees if it changed compared to the last time,
  invoking the callback if it did.
  
  The path does not need to exist: changing from "path exists" to "path does not exist" is a status
  change like any other. The condition "path does not exist" is signified by the <info>'nlink'</info> item being
  0(returned by EvStat::attr method).
  
  The path must not end in a slash or contain special components such as <info>'.'</info> or <info>..</info> . The path should
  be absolute: if it is relative and the working directory changes, then the behaviour is undefined.
  
  Since there is no portable change notification interface available, the portable implementation
  simply calls stat() regularly on the path to see if it changed somehow. For this case a
  recommended polling interval can be specified. If one specifies a polling interval of <info>0.0</info> (highly
  recommended) then a suitable, unspecified default value will be used(which could be expected to be
  around 5 seconds, although this might change dynamically). libev will also impose a minimum
  interval which is currently around <info>0.1</info> , but that’s usually overkill.
  
  This watcher type is not meant for massive numbers of <class>EvStat</class> watchers, as even with OS-supported
  change notifications, this can be resource-intensive.


id: EvStat::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs EvStat watcher object
  
  Constructs EvStat watcher object and starts the watcher automatically.

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      The path to wait for status changes on.
  <info>float</info>     <strong>$interval</strong>  Hint on how quickly a change is expected to be detected and should normally
                       be specified as <info>0.0</info> to let libev choose a suitable value.
  <info>callable</info>  <strong>$callback</strong>  See Watcher callbacks .
  <info>mixed</info>     <strong>$data</strong>      Custom data associated with the watcher.
  <info>int</info>       <strong>$priority</strong>  Watcher priority


id: EvStat::attr
type: function
doc:
<comment>Description:</comment>
  Returns the values most recently detected by Ev
  
  Returns array of the values most recently detected by Ev

<comment>Return:</comment>
  <info>array</info>  Returns array with the values most recently detect by Ev(without actual <return>stat</return> 'ing):  List
         for item keys of the array returned by EvStat::attr KeyDescription<info>'dev'</info>ID of device
         containing file<info>'ino'</info>inode number<info>'mode'</info>protection<info>'nlink'</info>number of hard links<info>'uid'</info>user ID of
         owner<info>'size'</info>total size, in bytes<info>'gid'</info>group ID of owner<info>'rdev'</info>device ID (if special
         file)<info>'blksize'</info>blocksize for file system I/O<info>'blocks'</info>number of 512B blocks
         allocated<info>'atime'</info>time of last access<info>'ctime'</info>time of last status change<info>'mtime'</info>time of last
         modification
         
         See <return>stat(2)</return> man page for details.

<comment>See Also:</comment>
   * EvStat::prev
   * EvStat::stat


id: EvStat::createStopped
type: function
doc:
<comment>Description:</comment>
  Create a stopped EvStat watcher object
  
  Creates EvStat watcher object, but doesn't start it automatically(unlike EvStat::__construct ).

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      The path to wait for status changes on.
  <info>float</info>     <strong>$interval</strong>  Hint on how quickly a change is expected to be detected and should normally
                       be specified as <info>0.0</info> to let libev choose a suitable value.
  <info>callable</info>  <strong>$callback</strong>  See Watcher callbacks .
  <info>mixed</info>     <strong>$data</strong>      Custom data associated with the watcher.
  <info>int</info>       <strong>$priority</strong>  Watcher priority

<comment>Return:</comment>
  <info>void</info>  Returns a stopped EvStat watcher object on success.

<comment>See Also:</comment>
   * EvStat::__construct
   * EvWatcher::start


id: EvStat::prev
type: function
doc:
<comment>Description:</comment>
  Returns the previous set of values returned by EvStat::attr
  
  Just like EvStat::attr , but returns the previous set of values.

<comment>Return:</comment>
  <info>void</info>  Returns an array with the same structure as the array returned by EvStat::attr . The array
        contains previously detected values.

<comment>See Also:</comment>
   * EvStat::attr
   * EvStat::stat


id: EvStat::set
type: function
doc:
<comment>Description:</comment>
  Configures the watcher
  
  Configures the watcher.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>      The path to wait for status changes on.
  <info>float</info>   <strong>$interval</strong>  Hint on how quickly a change is expected to be detected and should normally be
                     specified as <info>0.0</info> to let libev choose a suitable value.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: EvStat::stat
type: function
doc:
<comment>Description:</comment>
  Initiates the stat call
  
  Initiates the stat call(updates internal cache). It stats(using <return>lstat</return> ) the path specified in the
  watcher and sets to the values found.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if path exists. Otherwise <info>false</info>.

<comment>See Also:</comment>
   * EvStat::attr
   * EvStat::prev


id: EvTimer
type: class
doc:
<comment>Description:</comment>
  <class>EvTimer</class> watchers are simple relative timers that generate an event after a given time, and
  optionally repeating in regular intervals after that.
  
  The timers are based on real time, that is, if one registers an event that times out after an hour
  and resets the system clock to January last year , it will still time out after(roughly) one hour.
  "Roughly" because detecting time jumps is hard, and some inaccuracies are unavoidable.
  
  The callback is guaranteed to be invoked only after its timeout has passed (not at, so on systems
  with very low-resolution clocks this might introduce a small delay). If multiple timers become
  ready during the same loop iteration then the ones with earlier time-out values are invoked before
  ones of the same priority with later time-out values (but this is no longer true when a callback
  calls EvLoop::run recursively).
  
  The timer itself will do a best-effort at avoiding drift, that is, if a timer is configured to
  trigger every <info>10</info> seconds, then it will normally trigger at exactly <info>10</info> second intervals. If,
  however, the script cannot keep up with the timer because it takes longer than those <info>10</info> seconds to
  do) the timer will not fire more than once per event loop iteration.


id: EvTimer::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs an EvTimer watcher object
  
  Constructs an EvTimer watcher object.

<comment>Param:</comment>
  <info>float</info>     <strong>$after</strong>     Configures the timer to trigger after <strong>$after</strong> seconds.
  <info>float</info>     <strong>$repeat</strong>    If repeat is <info>0.0</info> , then it will automatically be stopped once the timeout is
                       reached. If it is positive, then the timer will automatically be configured
                       to trigger again every repeat seconds later, until stopped manually.
  <info>callable</info>  <strong>$callback</strong>  See Watcher callbacks .
  <info>mixed</info>     <strong>$data</strong>      Custom data associated with the watcher.
  <info>int</info>       <strong>$priority</strong>  Watcher priority

<comment>See Also:</comment>
   * EvTimer::createStopped
   * <class>EvPeriodic</class>
   * ev_timer - relative and optionally repeating timeouts
   * Be smart about timeouts


id: EvTimer::again
type: function
doc:
<comment>Description:</comment>
  Restarts the timer watcher
  
  This will act as if the timer timed out and restart it again if it is repeating. The exact
  semantics are:
  
  if the timer is pending, its pending status is cleared.
  
  if the timer is started but non-repeating, stop it (as if it timed out).
  
  if the timer is repeating, either start it if necessary (with the repeat value), or reset the
  running timer to the repeat value.

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * EvWatcher::stop


id: EvTimer::createStopped
type: function
doc:
<comment>Description:</comment>
  Creates EvTimer stopped watcher object
  
  Creates EvTimer stopped watcher object. Unlike EvTimer::__construct , this method doesn't start
  the watcher automatically.

<comment>Param:</comment>
  <info>float</info>     <strong>$after</strong>     Configures the timer to trigger after <strong>$after</strong> seconds.
  <info>float</info>     <strong>$repeat</strong>    If repeat is <info>0.0</info> , then it will automatically be stopped once the timeout is
                       reached. If it is positive, then the timer will automatically be configured
                       to trigger again every repeat seconds later, until stopped manually.
  <info>callable</info>  <strong>$callback</strong>  See Watcher callbacks .
  <info>mixed</info>     <strong>$data</strong>      Custom data associated with the watcher.
  <info>int</info>       <strong>$priority</strong>  Watcher priority

<comment>Return:</comment>
  <info>EvTimer</info>  Returns EvTimer watcher object on success.

<comment>See Also:</comment>
   * EvTimer::__construct
   * <class>EvPeriodic</class>


id: EvTimer::set
type: function
doc:
<comment>Description:</comment>
  Configures the watcher
  
  Configures the watcher

<comment>Param:</comment>
  <info>float</info>  <strong>$after</strong>   Configures the timer to trigger after <strong>$after</strong> seconds.
  <info>float</info>  <strong>$repeat</strong>  If repeat is <info>0.0</info> , then it will automatically be stopped once the timeout is
                  reached. If it is positive, then the timer will automatically be configured to
                  trigger again every repeat seconds later, until stopped manually.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: EvWatcher
type: class
doc:
<comment>Description:</comment>
  <class>EvWatcher</class> is a base class for all watchers( <class>EvCheck</class> , <class>EvChild</class> etc.). Since <class>EvWatcher</class> 's
  constructor is abstract , one can't(and don't need to) create EvWatcher objects directly.


id: EvWatcher::__construct
type: function
doc:
<comment>Description:</comment>
  Abstract constructor of a watcher object
  
  EvWatcher::__construct is an abstract constructor of a watcher object implemented in the derived
  classes.


id: EvWatcher::clear
type: function
doc:
<comment>Description:</comment>
  Clear watcher pending status
  
  If the watcher is pending, this method clears its pending status and returns its revents bitset(as
  if its callback was invoked). If the watcher isn't pending it does nothing and returns <info>0</info> .
  
  Sometimes it can be useful to "poll" a watcher instead of waiting for its callback to be invoked,
  which can be accomplished with this function.

<comment>Return:</comment>
  <info>int</info>  In case if the watcher is pending, returns revents bitset as if the watcher callback had been
       invoked. Otherwise returns <info>0</info> .


id: EvWatcher::feed
type: function
doc:
<comment>Description:</comment>
  Feeds the given revents set into the event loop
  
  Feeds the given revents set into the event loop, as if the specified event had happened for the
  watcher.

<comment>Param:</comment>
  <info>int</info>  <strong>$revents</strong>  Bit mask of watcher received events .

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: EvWatcher::getLoop
type: function
doc:
<comment>Description:</comment>
  Returns the loop responsible for the watcher
  
  Returns the loop responsible for the watcher

<comment>Return:</comment>
  <info>EvLoop</info>  Returns <class>EvLoop</class> event loop object responsible for the watcher.


id: EvWatcher::invoke
type: function
doc:
<comment>Description:</comment>
  Invokes the watcher callback with the given received events bit
    mask
  
  Invokes the watcher callback with the given received events bit mask.

<comment>Param:</comment>
  <info>int</info>  <strong>$revents</strong>  Bit mask of watcher received events .

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: EvWatcher::keepalive
type: function
doc:
<comment>Description:</comment>
  Configures whether to keep the loop from returning
  
  Configures whether to keep the loop from returning. With keepalive <strong>$value</strong> set to <info>false</info> the watcher
  won't keep Ev::run / EvLoop::run from returning even though the watcher is active.
  
  Watchers have keepalive <strong>$value</strong> <info>true</info> by default.
  
  Clearing keepalive status is useful when returning from Ev::run / EvLoop::run just because of the
  watcher is undesirable. It could be a long running UDP socket watcher or so.

<comment>Param:</comment>
  <info>bool</info>  <strong>$value</strong>  With keepalive <strong>$value</strong> set to <info>false</info> the watcher won't keep Ev::run / EvLoop::run from
                returning even though the watcher is active.

<comment>Return:</comment>
  <info>bool</info>  Returns the previous state.


id: EvWatcher::setCallback
type: function
doc:
<comment>Description:</comment>
  Sets new callback for the watcher
  
  Sets new callback for the watcher

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  See Watcher callbacks .

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: EvWatcher::start
type: function
doc:
<comment>Description:</comment>
  Starts the watcher
  
  Marks the watcher as active. Note that only active watchers will receive events.

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * EvWatcher::stop


id: EvWatcher::stop
type: function
doc:
<comment>Description:</comment>
  Stops the watcher
  
  Marks the watcher as inactive. Note that only active watchers will receive events.

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * EvWatcher::start


id: Event
type: class
doc:
<comment>Description:</comment>
  <class>Event</class> class represents and event firing on a file descriptor being ready to read from or write to;
  a file descriptor becoming ready to read from or write to(edge-triggered I/O only); a timeout
  expiring; a signal occurring; a user-triggered event.
  
  Every event is associated with <class>EventBase</class> . However, event will never fire until it is added (via
  Event::add ). An added event remains in pending state until the registered event occurs, thus
  turning it to active state. To handle events user may register a callback which is called when
  event becomes active. If event is configured persistent , it remains pending. If it is not
  persistent, it stops being pending when it's callback runs. Event::del method deletes event, thus
  making it non-pending. By means of Event::add method it could be added again.


id: Event::ET
type: constant
doc:
<comment>Description:</comment>
  Indicates that the event should be edge-triggered, if the underlying event base backend supports
  edge-triggered events. This affects the semantics of <info>Event::READ</info> and <info>Event::WRITE</info> .


id: Event::PERSIST
type: constant
doc:
<comment>Description:</comment>
  Indicates that the event is persistent. See About event persistence .


id: Event::READ
type: constant
doc:
<comment>Description:</comment>
  This flag indicates an event that becomes active when the provided file descriptor(usually a
  stream resource, or socket) is ready for reading.


id: Event::SIGNAL
type: constant
doc:
<comment>Description:</comment>
  Used to implement signal detection. See "Constructing signal events" below.


id: Event::TIMEOUT
type: constant
doc:
<comment>Description:</comment>
  This flag indicates an event that becomes active after a timeout elapses.
  
  The <info>Event::TIMEOUT</info> flag is ignored when constructing an event: one can either set a timeout when
  event is added , or not. It is set in the <return>$what</return> argument to the callback function when a timeout
  has occurred.


id: Event::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs Event object
  
  Constructs Event object.

<comment>Param:</comment>
  <info>EventBase</info>  <strong>$base</strong>  The event base to associate with.
  <info>mixed</info>      <strong>$fd</strong>    stream resource, socket resource, or numeric file descriptor. For timer events
                    pass <info>-1</info> . For signal events pass the signal number, e.g. <info>SIGHUP</info> .
  <info>int</info>        <strong>$what</strong>  Event flags. See Event flags .
  <info>callable</info>   <strong>$cb</strong>    The event callback. See Event callbacks .
  <info>mixed</info>      <strong>$arg</strong>   Custom data. If specified, it will be passed to the callback when event
                    triggers.

<comment>Return:</comment>
  <info>unknown</info>  Returns Event object.

<comment>See Also:</comment>
   * Event::signal
   * Event::timer


id: Event::add
type: function
doc:
<comment>Description:</comment>
  Makes event pending
  
  Marks event pending. Non-pending event will never occur, and the event callback will never be
  called. In conjunction with Event::del an event could be re-scheduled by user at any time.
  
  If Event::add is called on an already pending event, libevent will leave it pending and
  re-schedule it with the given timeout(if specified). If in this case timeout is not specified,
  Event::add has no effect.

<comment>Param:</comment>
  <info>float</info>  <strong>$timeout</strong>  Timeout in seconds.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * Event::add
   * Event::del
   * Event::signal
   * Event::timer


id: Event::del
type: function
doc:
<comment>Description:</comment>
  Makes event non-pending
  
  Removes an event from the set of monitored events, i.e. makes it non-pending.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * Event::add


id: Event::free
type: function
doc:
<comment>Description:</comment>
  Make event non-pending and free resources allocated for this
    event
  
  Removes event from the list of events monitored by libevent, and free resources allocated for the
  event.
  
  The Event::free method currently doesn't destruct the object itself. To destruct the object
  completely call <strong>unset()</strong> , or assign <info>null</info>.

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * Event::__construct


id: Event::getSupportedMethods
type: function
doc:
<comment>Description:</comment>
  Returns array with of the names of the methods supported in this version of Libevent
  
  Returns array with of the names of the methods(backends) supported in this version of Libevent.

<comment>Return:</comment>
  <info>array</info>  Returns array.

<comment>See Also:</comment>
   * <class>EventConfig</class>


id: Event::pending
type: function
doc:
<comment>Description:</comment>
  Detects whether event is pending or scheduled
  
  Detects whether event is pending or scheduled

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  One of, or a composition of the following constants: <info>Event::READ</info> , <info>Event::WRITE</info> ,
               <info>Event::TIMEOUT</info> , <info>Event::SIGNAL</info> .

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if event is pending or scheduled. Otherwise <info>false</info>.


id: Event::set
type: function
doc:
<comment>Description:</comment>
  Re-configures event
  
  Re-configures event. Note, this function doesn't invoke obsolete libevent's event_set. It calls
  event_assign instead.

<comment>Param:</comment>
  <info>EventBase</info>  <strong>$base</strong>  The event base to associate the event with.
  <info>mixed</info>      <strong>$fd</strong>    Stream resource, socket resource, or numeric file descriptor. For timer events
                    pass <info>-1</info> . For signal events pass the signal number, e.g. <info>SIGHUP</info> .
  <info>int</info>        <strong>$what</strong>  See Event flags .
  <info>callable</info>   <strong>$cb</strong>    The event callback. See Event callbacks .
  <info>mixed</info>      <strong>$arg</strong>   Custom data associated with the event. It will be passed to the callback when
                    the event becomes active.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: Event::setPriority
type: function
doc:
<comment>Description:</comment>
  Set event priority
  
  Set event priority.

<comment>Param:</comment>
  <info>int</info>  <strong>$priority</strong>  The event priority.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: Event::setTimer
type: function
doc:
<comment>Description:</comment>
  Re-configures timer event
  
  Re-configures timer event. Note, this function doesn't invoke obsolete libevent's <return>event_set</return> . It
  calls <return>event_assign</return> instead.

<comment>Param:</comment>
  <info>EventBase</info>  <strong>$base</strong>  The event base to associate with.
  <info>callable</info>   <strong>$cb</strong>    The timer event callback. See Event callbacks .
  <info>mixed</info>      <strong>$arg</strong>   Custom data. If specified, it will be passed to the callback when event
                    triggers.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * Event::__construct
   * Event::timer


id: Event::signal
type: function
doc:
<comment>Description:</comment>
  Constructs signal event object
  
  Constructs signal event object. This is a straightforward method to create a signal event. Note,
  the generic Event::__construct method can contruct signal event objects too.

<comment>Param:</comment>
  <info>EventBase</info>  <strong>$base</strong>    The associated event base object.
  <info>int</info>        <strong>$signum</strong>  The signal number.
  <info>callable</info>   <strong>$cb</strong>      The signal event callback. See Event callbacks .
  <info>mixed</info>      <strong>$arg</strong>     Custom data. If specified, it will be passed to the callback when event
                      triggers.

<comment>Return:</comment>
  <info>Event</info>  Returns Event object on success. Otherwise <info>false</info>.

<comment>See Also:</comment>
   * Constructing signal events


id: Event::timer
type: function
doc:
<comment>Description:</comment>
  Constructs timer event object
  
  Constructs timer event object. This is a straightforward method to create a timer event. Note, the
  generic Event::__construct method can contruct signal event objects too.

<comment>Param:</comment>
  <info>EventBase</info>  <strong>$base</strong>  The associated event base object.
  <info>callable</info>   <strong>$cb</strong>    The signal event callback. See Event callbacks .
  <info>mixed</info>      <strong>$arg</strong>   Custom data. If specified, it will be passed to the callback when event
                    triggers.

<comment>Return:</comment>
  <info>Event</info>  Returns Event object on success. Otherwise <info>false</info>.


id: EventBase
type: class
doc:
<comment>Description:</comment>
  <class>EventBase</class> class represents libevent's event base structure. It holds a set of events and can poll
  to determine which events are active.
  
  Each event base has a method , or a backend that it uses to determine which events are ready. The
  recognized methods are: <return>select</return> , <return>poll</return> , <return>epoll</return> , <return>kqueue</return> , <return>devpoll</return> , <return>evport</return> and <return>win32</return> .
  
  To configure event base to use, or avoid specific backend <class>EventConfig</class> class can be used.
  
  Do NOT destroy the <class>EventBase</class> object as long as resources of the associated <return>Event</return> objects are not
  released. Otherwise, it will lead to unpredictable results!


id: EventBase::EPOLL_USE_CHANGELIST
type: constant
doc:
<comment>Description:</comment>
  If we are using the <return>epoll</return> backend, this flag says that it is safe to use Libevent's internal
  change-list code to batch up adds and deletes in order to try to do as few syscalls as possible.
  
  Setting this flag can make code run faster, but it may trigger a Linux bug: it is not safe to use
  this flag if one has any fds cloned by dup(), or its variants. Doing so will produce strange and
  hard-to-diagnose bugs.
  
  This flag can also be activated by settnig the <return>EVENT_EPOLL_USE_CHANGELIST</return> environment variable.
  
  This flag has no effect if one winds up using a backend other than <return>epoll</return> .


id: EventBase::LOOP_NONBLOCK
type: constant
doc:
<comment>Description:</comment>
  Flag used with EventBase::loop method which means: "do not block: see which events are ready now,
  run the callbacks of the highest-priority ones, then exit".


id: EventBase::LOOP_ONCE
type: constant
doc:
<comment>Description:</comment>
  Flag used with EventBase::loop method which means: "block until libevent has an active event, then
  exit once all active events have had their callbacks run".


id: EventBase::NOLOCK
type: constant
doc:
<comment>Description:</comment>
  Configuration flag. Do not allocate a lock for the event base, even if we have locking set up".


id: EventBase::NO_CACHE_TIME
type: constant
doc:
<comment>Description:</comment>
  Configuration flag. Instead of checking the current time every time the event loop is ready to run
  timeout callbacks, check after each timeout callback.


id: EventBase::STARTUP_IOCP
type: constant
doc:
<comment>Description:</comment>
  Windows-only configuration flag. Enables the IOCP dispatcher at startup.


id: EventBase::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs EventBase object
  
  Constructs EventBase object

<comment>Param:</comment>
  <info>EventConfig</info>  <strong>$cfg</strong>  Optional <class>EventConfig</class> object.

<comment>Return:</comment>
  <info>unknown</info>  Returns EventBase object.

<comment>See Also:</comment>
   * <class>EventConfig</class>


id: EventBase::dispatch
type: function
doc:
<comment>Description:</comment>
  Dispatch pending events
  
  Wait for events to become active, and run their callbacks. The same as EventBase::loop with no
  flags set.
  
   Do NOT destroy the <class>EventBase</class> object as long as resources of the associated <return>Event</return> objects are not
  released. Otherwise, it will lead to unpredictable results!
  
  Do NOT destroy the <class>EventBase</class> object as long as resources of the associated <return>Event</return> objects are not
  released. Otherwise, it will lead to unpredictable results!

<comment>Return:</comment>
  <info>void</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * EventBase::loop


id: EventBase::exit
type: function
doc:
<comment>Description:</comment>
  Stop dispatching events
  
  Tells event base to stop optionally after given number of seconds.

<comment>Param:</comment>
  <info>float</info>  <strong>$timeout</strong>  Optional number of seconds after which the event base should stop dispatching
                   events.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * EventBase::stop


id: EventBase::free
type: function
doc:
<comment>Description:</comment>
  Free resources allocated for this event base
  
  Deallocates resources allocated by libevent for the <class>EventBase</class> object.
  
  The EventBase::free method doesn't destruct the object itself. To destruct the object completely
  call <strong>unset()</strong> , or assign <info>null</info>.
  
  This method does not deallocate or detach any of the events that are currently associated with the
  <class>EventBase</class> object, or close any of their sockets - beware.

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * EventBase::__construct


id: EventBase::getFeatures
type: function
doc:
<comment>Description:</comment>
  Returns bitmask of features supported
  
  Returns bitmask of features supported.

<comment>Return:</comment>
  <info>int</info>  Returns integer representing a bitmask of supported features. See EventConfig::FEATURE_*
       constants .

<comment>See Also:</comment>
   * EventBase::getMethod
   * <class>EventConfig</class>


id: EventBase::getMethod
type: function
doc:
<comment>Description:</comment>
  Returns event method in use

<comment>Return:</comment>
  <info>string</info>  String representing used event method(backend).

<comment>See Also:</comment>
   * EventBase::getFeatures


id: EventBase::getTimeOfDayCached
type: function
doc:
<comment>Description:</comment>
  Returns the current event base time
  
  On success returns the current time(as returned by <return>gettimeofday()</return> ), looking at the cached value
  in base if possible, and calling <return>gettimeofday()</return> or <return>clock_gettime()</return> as appropriate if there is no
  cached time.

<comment>Return:</comment>
  <info>float</info>  Returns the current event base time. On failure returns <info>null</info>.


id: EventBase::gotExit
type: function
doc:
<comment>Description:</comment>
  Checks if the event loop was told to exit
  
  Checks if the event loop was told to exit by EventBase::exit .

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info>, event loop was told to exit by EventBase::exit . Otherwise <info>false</info>.

<comment>See Also:</comment>
   * EventBase::exit
   * EventBase::stop
   * EventBase::gotStop


id: EventBase::gotStop
type: function
doc:
<comment>Description:</comment>
  Checks if the event loop was told to exit
  
  Checks if the event loop was told to exit by EventBase::stop .

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info>, event loop was told to stop by EventBase::stop . Otherwise <info>false</info>.

<comment>See Also:</comment>
   * EventBase::exit
   * EventBase::stop
   * EventBase::gotExit


id: EventBase::loop
type: function
doc:
<comment>Description:</comment>
  Dispatch pending events
  
  Wait for events to become active, and run their callbacks.
  
   Do NOT destroy the <class>EventBase</class> object as long as resources of the associated <return>Event</return> objects are not
  released. Otherwise, it will lead to unpredictable results!
  
  Do NOT destroy the <class>EventBase</class> object as long as resources of the associated <return>Event</return> objects are not
  released. Otherwise, it will lead to unpredictable results!

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Optional flags. One of <return>EventBase::LOOP_*</return> constants. See EventBase constants .

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * EventBase::dispatch


id: EventBase::priorityInit
type: function
doc:
<comment>Description:</comment>
  Sets number of priorities per event base
  
  Sets number of priorities per event base.

<comment>Param:</comment>
  <info>int</info>  <strong>$n_priorities</strong>  The number of priorities per event base.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * Event::setPriority


id: EventBase::reInit
type: function
doc:
<comment>Description:</comment>
  Re-initialize event base(after a fork)
  
  Re-initialize event base. Should be called after a fork.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: EventBase::stop
type: function
doc:
<comment>Description:</comment>
  Tells event_base to stop dispatching events
  
  Tells event_base to stop dispatching events

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * EventBase::exit
   * EventBase::gotStop


id: EventBuffer
type: class
doc:
<comment>Description:</comment>
  <class>EventBuffer</class> represents Libevent's "evbuffer", an utility functionality for buffered I/O.
  
  Event buffers are meant to be generally useful for doing the "buffer" part of buffered network
  I/O.


id: EventBuffer::EOL_ANY
type: constant
doc:
<comment>Description:</comment>
  The end of line is any sequence of any number of carriage return and linefeed characters. This
  format is not very useful; it exists mainly for backward compatibility.


id: EventBuffer::EOL_CRLF
type: constant
doc:
<comment>Description:</comment>
  The end of the line is an optional carriage return, followed by a linefeed. (In other words, it is
  either a <return>"\r\n"</return> or a <return>"\n"</return> .) This format is useful in parsing text-based Internet protocols, since
  the standards generally prescribe a <return>"\r\n"</return> line-terminator, but nonconformant clients sometimes
  say just <return>"\n"</return> .


id: EventBuffer::EOL_CRLF_STRICT
type: constant
doc:
<comment>Description:</comment>
  The end of a line is a single carriage return, followed by a single linefeed. (This is also known
  as <return>"\r\n"</return> . The ASCII values are <info>0x0D</info> <info>0x0A</info> ).


id: EventBuffer::EOL_LF
type: constant
doc:
<comment>Description:</comment>
  The end of a line is a single linefeed character. (This is also known as <return>"\n"</return> . It is ASCII value
  is <info>0x0A</info> .)


id: EventBuffer::PTR_ADD
type: constant
doc:
<comment>Description:</comment>
  The same as <info>EventBuffer::PTR_SET</info> , except this flag causes EventBuffer::setPosition method to move
  position forward up to the specified number of bytes(instead of setting absolute position).


id: EventBuffer::PTR_SET
type: constant
doc:
<comment>Description:</comment>
  Flag used as argument of EventBuffer::setPosition method. If this flag specified, the position
  pointer is moved to an absolute position within the buffer.


id: EventBuffer::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs EventBuffer object
  
  Constructs EventBuffer object

<comment>Return:</comment>
  <info>unknown</info>  Returns EventBuffer object.


id: EventBuffer::add
type: function
doc:
<comment>Description:</comment>
  Append data to the end of an event buffer
  
  Append data to the end of an event buffer.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  String to be appended to the end of the buffer.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * EventBuffer::addBuffer


id: EventBuffer::addBuffer
type: function
doc:
<comment>Description:</comment>
  Move all data from a buffer provided to the current instance of EventBuffer
  
  Move all data from the buffer provided in <strong>$buf</strong> parameter to the end of current <class>EventBuffer</class> . This
  is a destructive add. The data from one buffer moves into the other buffer. However, no
  unnecessary memory copies occur.

<comment>Param:</comment>
  <info>EventBuffer</info>  <strong>$buf</strong>  The source EventBuffer object.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * EventBuffer::add


id: EventBuffer::appendFrom
type: function
doc:
<comment>Description:</comment>
  Moves the specified number of bytes from a source buffer to the
    end of the current buffer
  
  Moves the specified number of bytes from a source buffer to the end of the current buffer. If
  there are fewer number of bytes, it moves all the bytes available from the source buffer.

<comment>Param:</comment>
  <info>EventBuffer</info>  <strong>$buf</strong>  Source buffer.
  <info>int</info>          <strong>$len</strong>  

<comment>Return:</comment>
  <info>int</info>  Returns the number of bytes read.

<comment>See Also:</comment>
   * EventBuffer::copyout
   * EventBuffer::drain
   * EventBuffer::pullup
   * EventBuffer::readLine
   * EventBuffer::read


id: EventBuffer::copyout
type: function
doc:
<comment>Description:</comment>
  Copies out specified number of bytes from the front of the buffer
  
  Behaves just like EventBuffer::read , but does not drain any data from the buffer. I.e. it copies
  the first <strong>$max_bytes</strong> bytes from the front of the buffer into <strong>$data</strong> . If there are fewer than
  <strong>$max_bytes</strong> bytes available, the function copies all the bytes there are.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>       Output string.
  <info>int</info>     <strong>$max_bytes</strong>  The number of bytes to copy.

<comment>Return:</comment>
  <info>int</info>  Returns the number of bytes copied, or <info>-1</info> on failure.

<comment>See Also:</comment>
   * EventBuffer::read
   * EventBuffer::appendFrom


id: EventBuffer::drain
type: function
doc:
<comment>Description:</comment>
  Removes specified number of bytes from the front of the buffer
    without copying it anywhere
  
  Behaves as EventBuffer::read , except that it does not copy the data: it just removes it from the
  front of the buffer.

<comment>Param:</comment>
  <info>int</info>  <strong>$len</strong>  The number of bytes to remove from the buffer.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * EventBuffer::read
   * EventBuffer::appendFrom


id: EventBuffer::enableLocking
type: function
doc:
<comment>Description:</comment>
  Enable locking on an <class>EventBuffer</class> so that it can safely be used by multiple threads at the same
  time. When locking is enabled, the lock will be held when callbacks are invoked. This could result
  in deadlock if you aren't careful. Plan accordingly!

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * Evbuffers and Thread-safety


id: EventBuffer::expand
type: function
doc:
<comment>Description:</comment>
  Reserves space in buffer
  
  Alters the last chunk of memory in the buffer, or adds a new chunk, such that the buffer is now
  large enough to contain <strong>$len</strong> bytes without any further allocations.

<comment>Param:</comment>
  <info>int</info>  <strong>$len</strong>  The number of bytes to reserve for the buffer

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: EventBuffer::freeze
type: function
doc:
<comment>Description:</comment>
  Prevent calls that modify an event buffer from succeeding
  
  Prevent calls that modify an event buffer from succeeding

<comment>Param:</comment>
  <info>bool</info>  <strong>$at_front</strong>  Whether to disable changes to the front or end of the buffer.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * EventBuffer::unfreeze


id: EventBuffer::lock
type: function
doc:
<comment>Description:</comment>
  Acquires a lock on buffer
  
  Acquires a lock on buffer. Can be used in pair with EventBuffer::unlock to make a set of
  operations atomic, i.e. thread-safe. Note, it is not needed to lock buffers for individual
  operations. When locking is enabled(see EventBuffer::enableLocking ), individual operations on
  event buffers are already atomic.

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * EventBuffer::unlock


id: EventBuffer::prepend
type: function
doc:
<comment>Description:</comment>
  Prepend data to the front of the buffer
  
  Prepend data to the front of the buffer.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  String to be prepended to the front of the buffer.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * EventBuffer::prependBuffer
   * EventBuffer::add
   * EventBuffer::addBuffer


id: EventBuffer::prependBuffer
type: function
doc:
<comment>Description:</comment>
  Moves all data from source buffer to the front of current buffer
  
  Behaves as EventBuffer::addBuffer , except that it moves data to the front of the buffer.

<comment>Param:</comment>
  <info>EventBuffer</info>  <strong>$buf</strong>  Source buffer.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * EventBuffer::add
   * EventBuffer::addBuffer
   * EventBuffer::prepend


id: EventBuffer::pullup
type: function
doc:
<comment>Description:</comment>
  Linearizes data within buffer
    and returns it's contents as a string
  
  "Linearizes" the first <strong>$size</strong> bytes of the buffer, copying or moving them as needed to ensure that
  they are all contiguous and occupying the same chunk of memory. If size is negative, the function
  linearizes the entire buffer.
  
  Calling EventBuffer::pullup with a large size can be quite slow, since it potentially needs to
  copy the entire buffer's contents.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  The number of bytes required to be contiguous within the buffer.

<comment>Return:</comment>
  <info>string</info>  If <strong>$size</strong> is greater than the number of bytes in the buffer, the function returns <info>null</info>.
          Otherwise, EventBuffer::pullup returns string.

<comment>See Also:</comment>
   * EventBuffer::copyout
   * EventBuffer::drain
   * EventBuffer::read
   * EventBuffer::readLine
   * EventBuffer::appendFrom


id: EventBuffer::read
type: function
doc:
<comment>Description:</comment>
  Read data from an evbuffer and drain the bytes read
  
  Read the first <strong>$max_bytes</strong> from the buffer and drain the bytes read. If more <strong>$max_bytes</strong> are
  requested than are available in the buffer, it only extracts as many bytes as available.

<comment>Param:</comment>
  <info>int</info>  <strong>$max_bytes</strong>  Maxmimum number of bytes to read from the buffer.

<comment>Return:</comment>
  <info>string</info>  Returns string read, or <info>false</info> on failure.

<comment>See Also:</comment>
   * EventBuffer::copyout
   * EventBuffer::drain
   * EventBuffer::pullup
   * EventBuffer::readLine
   * EventBuffer::appendFrom


id: EventBuffer::readFrom
type: function
doc:
<comment>Description:</comment>
  Read data from a file onto the end of the buffer
  
  Read data from the file specified by <strong>$fd</strong> onto the end of the buffer.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$fd</strong>       Socket resource, stream, or numeric file descriptor.
  <info>int</info>    <strong>$howmuch</strong>  Maxmimum number of bytes to read.

<comment>Return:</comment>
  <info>int</info>  Returns the number of bytes read, or <info>false</info> on failure.

<comment>See Also:</comment>
   * EventBuffer::copyout
   * EventBuffer::drain
   * EventBuffer::pullup
   * EventBuffer::readLine
   * EventBuffer::appendFrom


id: EventBuffer::readLine
type: function
doc:
<comment>Description:</comment>
  Extracts a line from the front of the buffer
  
  Extracts a line from the front of the buffer and returns it in a newly allocated string. If there
  is not a whole line to read, the function returns <info>null</info>. The line terminator is not included in the
  copied string.

<comment>Param:</comment>
  <info>int</info>  <strong>$eol_style</strong>  One of EventBuffer:EOL_* constants .

<comment>Return:</comment>
  <info>string</info>  On success returns the line read from the buffer, otherwise <info>null</info>.

<comment>See Also:</comment>
   * EventBuffer::copyout
   * EventBuffer::drain
   * EventBuffer::pullup
   * EventBuffer::read
   * EventBuffer::appendFrom


id: EventBuffer::search
type: function
doc:
<comment>Description:</comment>
  Scans the buffer for an occurrence of a string
  
  Scans the buffer for an occurrence of the string <strong>$what</strong> . It returns numeric position of the
  string, or <info>false</info> if the string was not found.
  
  If the <strong>$start</strong> argument is provided, it points to the position at which the search should begin;
  otherwise, the search is performed from the start of the string. If <strong>$end</strong> argument provided, the
  search is performed between start and end buffer positions.

<comment>Param:</comment>
  <info>string</info>  <strong>$what</strong>   String to search.
  <info>int</info>     <strong>$start</strong>  Start search position.
  <info>int</info>     <strong>$end</strong>    End search position.

<comment>Return:</comment>
  <info>mixed</info>  Returns numeric position of the first occurrence of the string in the buffer, or <info>false</info> if
         string is not found.
         
         この関数は論理値
         <info>false</info> を返す可能性がありますが、<info>false</info> として評価される値を返す可能性もあります。
         詳細については 論理値の
         セクションを参照してください。この関数の返り値を調べるには
         ===演算子 を
         使用してください。

<comment>See Also:</comment>
   * EventBuffer::searchEol


id: EventBuffer::searchEol
type: function
doc:
<comment>Description:</comment>
  Scans the buffer for an occurrence of an end of line
  
  Scans the buffer for an occurrence of an end of line specified by <strong>$eol_style</strong> parameter . It
  returns numeric position of the string, or <info>false</info> if the string was not found.
  
  If the <strong>$start</strong> argument is provided, it represents the position at which the search should begin;
  otherwise, the search is performed from the start of the string. If <strong>$end</strong> argument provided, the
  search is performed between start and end buffer positions.

<comment>Param:</comment>
  <info>int</info>  <strong>$start</strong>      Start search position.
  <info>int</info>  <strong>$eol_style</strong>  One of EventBuffer:EOL_* constants .

<comment>Return:</comment>
  <info>mixed</info>  Returns numeric position of the first occurrence of end-of-line symbol in the buffer, or
         <info>false</info> if not found.
         
         この関数は論理値
         <info>false</info> を返す可能性がありますが、<info>false</info> として評価される値を返す可能性もあります。
         詳細については 論理値の
         セクションを参照してください。この関数の返り値を調べるには
         ===演算子 を
         使用してください。

<comment>See Also:</comment>
   * EventBuffer::search


id: EventBuffer::substr
type: function
doc:
<comment>Description:</comment>
  Substracts a portion of the buffer data
  
  Substracts up to <strong>$length</strong> bytes of the buffer data beginning at <strong>$start</strong> position.

<comment>Param:</comment>
  <info>int</info>  <strong>$start</strong>   The start position of data to be substracted.
  <info>int</info>  <strong>$length</strong>  Maximum number of bytes to substract.

<comment>Return:</comment>
  <info>string</info>  Returns the data substracted as a <info>string</info> on success, or <info>false</info> on failure.

<comment>See Also:</comment>
   * EventBuffer::read


id: EventBuffer::unfreeze
type: function
doc:
<comment>Description:</comment>
  Re-enable calls that modify an event buffer
  
  Re-enable calls that modify an event buffer.

<comment>Param:</comment>
  <info>bool</info>  <strong>$at_front</strong>  Whether to enable events at the front or at the end of the buffer.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * EventBuffer::freeze


id: EventBuffer::unlock
type: function
doc:
<comment>Description:</comment>
  Releases lock acquired by EventBuffer::lock
  
  Releases lock acquired by EventBuffer::lock .

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * EventBuffer::lock


id: EventBuffer::write
type: function
doc:
<comment>Description:</comment>
  Write contents of the buffer to a file or socket
  
  Write contents of the buffer to a file descriptor. The buffer will be drained after the bytes have
  been successfully written.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$fd</strong>       Socket resource, stream or numeric file descriptor associated normally associated
                   with a socket.
  <info>int</info>    <strong>$howmuch</strong>  The maximum number of bytes to write.

<comment>Return:</comment>
  <info>int</info>  Returns the number of bytes written, or <info>false</info> on error.

<comment>See Also:</comment>
   * EventBuffer::read


id: EventBufferEvent
type: class
doc:
<comment>Description:</comment>
  Represents Libevent's buffer event.
  
  Usually an application wants to perform some amount of data buffering in addition to just
  responding to events. When we want to write data, for example, the usual pattern looks like:
  
  Decide that we want to write some data to a connection; put that data in a buffer.
  
  Wait for the connection to become writable
  
  Write as much of the data as we can
  
  Remember how much we wrote, and if we still have more data to write, wait for the connection to
  become writable again.
  
  This buffered I/O pattern is common enough that Libevent provides a generic mechanism for it. A
  "buffer event" consists of an underlying transport (like a socket), a read buffer, and a write
  buffer. Instead of regular events, which give callbacks when the underlying transport is ready to
  be read or written, a buffer event invokes its user-supplied callbacks when it has read or written
  enough data.


id: EventBufferEvent::ERROR
type: constant
doc:
<comment>Description:</comment>
  An error occurred during a bufferevent operation. For more information on what the error was, call
  EventUtil::getLastSocketErrno and/or EventUtil::getLastSocketError .


id: EventBufferEvent::OPT_CLOSE_ON_FREE
type: constant
doc:
<comment>Description:</comment>
  When the buffer event is freed, close the underlying transport. This will close an underlying
  socket, free an underlying buffer event, etc.


id: EventBufferEvent::OPT_DEFER_CALLBACKS
type: constant
doc:
<comment>Description:</comment>
  When this flag is set, the bufferevent defers all of its callbacks. See Fast portable non-blocking
  network programming with Libevent, Deferred callbacks .


id: EventBufferEvent::OPT_THREADSAFE
type: constant
doc:
<comment>Description:</comment>
  Automatically allocate locks for the bufferevent, so that it’s safe to use from multiple threads.


id: EventBufferEvent::OPT_UNLOCK_CALLBACKS
type: constant
doc:
<comment>Description:</comment>
  By default, when the bufferevent is set up to be threadsafe, the buffer event’s locks are held
  whenever the any user-provided callback is invoked. Setting this option makes Libevent release the
  buffer event’s lock when it’s invoking the callbacks.


id: EventBufferEvent::READING
type: constant
doc:
<comment>Description:</comment>
  An event occurred during a read operation on the bufferevent. See the other flags for which event
  it was.


id: EventBufferEvent::WRITING
type: constant
doc:
<comment>Description:</comment>
  An event occurred during a write operation on the bufferevent. See the other flags for which event
  it was.


id: EventBufferEvent::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs EventBufferEvent object
  
  Create a buffer event on a socket, stream or a file descriptor. Passing <info>null</info> to <strong>$socket</strong> means that
  the socket should be created later, e.g. by means of EventBufferEvent::connect .

<comment>Param:</comment>
  <info>EventBase</info>  <strong>$base</strong>     Event base that should be associated with the new buffer event.
  <info>mixed</info>      <strong>$socket</strong>   May be created as a stream(not necessarily by means of <return>sockets</return> extension)
  <info>int</info>        <strong>$options</strong>  One of EventBufferEvent::OPT_* constants , or <info>0</info> .
  <info>callable</info>   <strong>$readcb</strong>   Read event callback. See About buffer event callbacks .
  <info>callable</info>   <strong>$writecb</strong>  Write event callback. See About buffer event callbacks .
  <info>callable</info>   <strong>$eventcb</strong>  Status-change event callback. See About buffer event callbacks .
  <info>mixed</info>      <strong>$arg</strong>      A variable that will be passed to all the callbacks.

<comment>Return:</comment>
  <info>unknown</info>  Returns buffer event resource optionally associated with socket resource. */

<comment>See Also:</comment>
   * EventBufferEvent::sslFilter
   * EventBufferEvent::sslSocket


id: EventBufferEvent::close
type: function
doc:
<comment>Description:</comment>
  Closes file descriptor associated with the current buffer event
  
  Closes file descriptor associated with the current buffer event.
  
  This method may be used in cases when the <info>EventBufferEvent::OPT_CLOSE_ON_FREE</info> option is not
  appropriate.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: EventBufferEvent::connect
type: function
doc:
<comment>Description:</comment>
  Connect buffer event's file descriptor to given address or
    UNIX socket
  
  Connect buffer event's file descriptor to given address(optionally with port), or a UNIX domain
  socket.
  
  If socket is not assigned to the buffer event, this function allocates a new socket and makes it
  non-blocking internally.
  
  To resolve DNS names(asyncronously), use EventBufferEvent::connectHost method.

<comment>Param:</comment>
  <info>string</info>  <strong>$addr</strong>  Should contain an IP address with optional port number, or a path to UNIX domain
                 socket. Recognized formats are:
                  Note, <return>'unix:'</return> prefix is currently not case sensitive.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * EventBufferEvent::connectHost


id: EventBufferEvent::connectHost
type: function
doc:
<comment>Description:</comment>
  Connects to a hostname with optionally asyncronous DNS resolving
  
  Resolves the DNS name hostname, looking for addresses of type <strong>$family</strong> ( <return>EventUtil::AF_*</return>
  constants). If the name resolution fails, it invokes the event callback with an error event. If it
  succeeds, it launches a connection attempt just as EventBufferEvent::connect would.
  
  <strong>$dns_base</strong> is optional. May be <info>null</info>, or an object created with EventDnsBase::__construct . For
  asyncronous hostname resolving pass a valid event dns base resource. Otherwise the hostname
  resolving will block.
  
  <class>EventDnsBase</class> is available only if <return>Event</return> configured --with-event-extra ( <return>event_extra</return> library,
  libevent protocol-specific functionality support including HTTP, DNS, and RPC ).
  
  EventBufferEvent::connectHost requires <return>libevent-2.0.3-alpha</return> or greater.

<comment>Param:</comment>
  <info>EventDnsBase</info>  <strong>$dns_base</strong>  Object of <class>EventDnsBase</class> in case if DNS is to be resolved asyncronously.
                           Otherwise <info>null</info>.
  <info>string</info>        <strong>$hostname</strong>  Hostname to connect to. Recognized formats are:
                           
  <info>int</info>           <strong>$port</strong>      Port number
  <info>int</info>           <strong>$family</strong>    Address family. <info>EventUtil::AF_UNSPEC</info> , <info>EventUtil::AF_INET</info> , or
                           <info>EventUtil::AF_INET6</info> . See EventUtil constants .

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * EventBufferEvent::connect


id: EventBufferEvent::createPair
type: function
doc:
<comment>Description:</comment>
  Creates two buffer events connected to each other
  
  Returns array of two <class>EventBufferEvent</class> objects connected to each other. All the usual options are
  supported, except for <info>EventBufferEvent::OPT_CLOSE_ON_FREE</info> , which has no effect, and
  <info>EventBufferEvent::OPT_DEFER_CALLBACKS</info> , which is always on.

<comment>Param:</comment>
  <info>EventBase</info>  <strong>$base</strong>     Associated event base
  <info>int</info>        <strong>$options</strong>  EventBufferEvent::OPT_* constants combined with bitwise <return>OR</return> operator.

<comment>Return:</comment>
  <info>array</info>  Returns array of two <class>EventBufferEvent</class> objects connected to each other.


id: EventBufferEvent::disable
type: function
doc:
<comment>Description:</comment>
  Disable events read, write, or both on a buffer event
  
  Disable events <info>Event::READ</info> , <info>Event::WRITE</info> , or <info>Event::READ</info> <return>|</return> <info>Event::WRITE</info> on a buffer event.

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

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * EventBufferEvent::enable


id: EventBufferEvent::enable
type: function
doc:
<comment>Description:</comment>
  Enable events read, write, or both on a buffer event
  
  Enable events <info>Event::READ</info> , <info>Event::WRITE</info> , or <info>Event::READ</info> <return>|</return> <info>Event::WRITE</info> on a buffer event.

<comment>Param:</comment>
  <info>int</info>  <strong>$events</strong>  <info>Event::READ</info> , <info>Event::WRITE</info> , or <info>Event::READ</info> <return>|</return> <info>Event::WRITE</info> on a buffer event.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * EventBufferEvent::disable


id: EventBufferEvent::free
type: function
doc:
<comment>Description:</comment>
  Free a buffer event
  
  Free resources allocated by buffer event.
  
  Usually there is no need to call this method, since normally it is done within internal object
  destructors. However, sometimes we have a long-time script allocating lots of instances, or a
  script with a heavy memory usage, where we need to free resources as soon as possible. In such
  cases EventBufferEvent::free may be used to protect the script against running up to the
  <return>memory_limit</return> .

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: EventBufferEvent::getDnsErrorString
type: function
doc:
<comment>Description:</comment>
  Returns string describing the last failed DNS lookup attempt
  
  Returns string describing the last failed DNS lookup attempt made by EventBufferEvent::connectHost
  , or an empty string, if there is no DNS error detected.

<comment>Return:</comment>
  <info>string</info>  Returns a string describing DNS lookup error, or an empty string for no error.

<comment>See Also:</comment>
   * EventBufferEvent::connectHost


id: EventBufferEvent::getEnabled
type: function
doc:
<comment>Description:</comment>
  Returns bitmask of events currently enabled on the buffer event
  
  Returns bitmask of events currently enabled on the buffer event

<comment>Return:</comment>
  <info>int</info>  Returns integer representing a bitmask of events currently enabled on the buffer event

<comment>See Also:</comment>
   * EventBufferEvent::enable
   * EventBufferEvent::disable


id: EventBufferEvent::getInput
type: function
doc:
<comment>Description:</comment>
  Returns underlying input buffer associated with current buffer
    event
  
  Returns underlying input buffer associated with current buffer event. An input buffer is a storage
  for data to read.
  
  Note, there is also <return>input</return> property of <class>EventBufferEvent</class> class.

<comment>Return:</comment>
  <info>EventBuffer</info>  Returns instance of <class>EventBuffer</class> input buffer associated with current buffer event.

<comment>See Also:</comment>
   * EventBufferEvent::getOutput


id: EventBufferEvent::getOutput
type: function
doc:
<comment>Description:</comment>
  Returns underlying output buffer associated with current buffer
    event
  
  Returns underlying output buffer associated with current buffer event. An output buffer is a
  storage for data to be written.
  
  Note, there is also <return>output</return> property of <class>EventBufferEvent</class> class.

<comment>Return:</comment>
  <info>EventBuffer</info>  Returns instance of <class>EventBuffer</class> output buffer associated with current buffer event.

<comment>See Also:</comment>
   * EventBufferEvent::getInput


id: EventBufferEvent::read
type: function
doc:
<comment>Description:</comment>
  Read buffer's data
  
  Removes up to <strong>$size</strong> bytes from the input buffer. Returns a string of data read from the input
  buffer.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  Maximum number of bytes to read

<comment>Return:</comment>
  <info>string</info>  Returns string of data read from the input buffer.

<comment>See Also:</comment>
   * EventBufferEvent::readBuffer


id: EventBufferEvent::readBuffer
type: function
doc:
<comment>Description:</comment>
  Drains the entire contents of the input buffer and places them into buf
  
  Drains the entire contents of the input buffer and places them into <strong>$buf</strong> .

<comment>Param:</comment>
  <info>EventBuffer</info>  <strong>$buf</strong>  Target buffer

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * EventBufferEvent::read


id: EventBufferEvent::setCallbacks
type: function
doc:
<comment>Description:</comment>
  Assigns read, write and event(status) callbacks
  
  Assigns read, write and event(status) callbacks.

<comment>Param:</comment>
  <info>callable</info>  <strong>$readcb</strong>   Read event callback. See About buffer event callbacks .
  <info>callable</info>  <strong>$writecb</strong>  Write event callback. See About buffer event callbacks .
  <info>callable</info>  <strong>$eventcb</strong>  Status-change event callback. See About buffer event callbacks .
  <info>mixed</info>     <strong>$arg</strong>      A variable that will be passed to all the callbacks.

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * EventBufferEvent::__construct


id: EventBufferEvent::setPriority
type: function
doc:
<comment>Description:</comment>
  Assign a priority to a bufferevent
  
  Assign a priority to a bufferevent
  
  Only supported for socket buffer events

<comment>Param:</comment>
  <info>int</info>  <strong>$priority</strong>  Priority value.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: EventBufferEvent::setTimeouts
type: function
doc:
<comment>Description:</comment>
  Set the read and write timeout for a buffer event
  
  Set the read and write timeout for a buffer event

<comment>Param:</comment>
  <info>float</info>  <strong>$timeout_read</strong>   Read timeout
  <info>float</info>  <strong>$timeout_write</strong>  Write timeout

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: EventBufferEvent::setWatermark
type: function
doc:
<comment>Description:</comment>
  Adjusts read and/or write watermarks
  
  Adjusts the read watermarks, the write watermarks , or both, of a single buffer event.
  
  A buffer event watermark is an edge, a value specifying number of bytes to be read or written
  before callback is invoked. By default every read/write event triggers a callback invokation. See
  Fast portable non-blocking network programming with Libevent: Callbacks and watermarks

<comment>Param:</comment>
  <info>int</info>  <strong>$events</strong>    Bitmask of <info>Event::READ</info> , <info>Event::WRITE</info> , or both.
  <info>int</info>  <strong>$lowmark</strong>   Minimum watermark value.
  <info>int</info>  <strong>$highmark</strong>  Maximum watermark value. <info>0</info> means "unlimited".

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: EventBufferEvent::sslError
type: function
doc:
<comment>Description:</comment>
  Returns most recent OpenSSL error reported on the buffer event
  
  Returns most recent OpenSSL error reported on the buffer event.
  
  This function is available only if <return>Event</return> is compiled with OpenSSL support.

<comment>Return:</comment>
  <info>string</info>  Returns OpenSSL error string reported on the buffer event, or <info>false</info>, if there is no more
          error to return.

<comment>See Also:</comment>
   * EventBufferEvent::sslRenegotiate


id: EventBufferEvent::sslFilter
type: function
doc:
<comment>Description:</comment>
  Create a new SSL buffer event to send its data over another buffer event
  
  Create a new SSL buffer event to send its data over another buffer event
  
  This function is available only if <return>Event</return> is compiled with OpenSSL support.

<comment>Param:</comment>
  <info>EventBase</info>         <strong>$base</strong>        Associated event base.
  <info>EventBufferEvent</info>  <strong>$underlying</strong>  A socket buffer event to use for this SSL.
  <info>EventSslContext</info>   <strong>$ctx</strong>         Object of <class>EventSslContext</class> class.
  <info>int</info>               <strong>$state</strong>       The current state of SSL connection: <info>EventBufferEvent::SSL_OPEN</info> ,
                                 <info>EventBufferEvent::SSL_ACCEPTING</info> or <info>EventBufferEvent::SSL_CONNECTING</info>
                                 .
  <info>int</info>               <strong>$options</strong>     One or more buffer event options.

<comment>Return:</comment>
  <info>EventBufferEvent</info>  Returns a new SSL <class>EventBufferEvent</class> object.

<comment>See Also:</comment>
   * EventBufferEvent::sslSocket


id: EventBufferEvent::sslGetCipherInfo
type: function
doc:
<comment>Description:</comment>
  Returns a textual description of the cipher
  
  Retrieves description of the current cipher by means of the <return>SSL_CIPHER_description</return> SSL API
  function (see SSL_CIPHER_get_name(3) man page).
  
  This function is available only if <return>Event</return> is compiled with OpenSSL support.

<comment>Return:</comment>
  <info>string</info>  Returns a textual description of the cipher on success, or <info>false</info> on error.


id: EventBufferEvent::sslGetCipherName
type: function
doc:
<comment>Description:</comment>
  Returns the current cipher name of the SSL connection
  
  Retrieves name of cipher used by current SSL connection.
  
  This function is available only if <return>Event</return> is compiled with OpenSSL support.

<comment>Return:</comment>
  <info>string</info>  Returns the current cipher name of the SSL connection, or <info>false</info> on error.


id: EventBufferEvent::sslGetCipherVersion
type: function
doc:
<comment>Description:</comment>
  Returns version of cipher used by current SSL connection
  
  Retrieves version of cipher used by current SSL connection.
  
  This function is available only if <return>Event</return> is compiled with OpenSSL support.

<comment>Return:</comment>
  <info>string</info>  Returns the current cipher version of the SSL connection, or <info>false</info> on error.


id: EventBufferEvent::sslGetProtocol
type: function
doc:
<comment>Description:</comment>
  Returns the name of the protocol used for current SSL connection
  
  Returns the name of the protocol used for current SSL connection.
  
  This function is available only if <return>Event</return> is compiled with OpenSSL support.

<comment>Return:</comment>
  <info>string</info>  Returns the name of the protocol used for current SSL connection.


id: EventBufferEvent::sslRenegotiate
type: function
doc:
<comment>Description:</comment>
  Tells a bufferevent to begin SSL renegotiation
  
  Tells a bufferevent to begin SSL renegotiation.
  
  Calling this function tells the SSL to renegotiate, and the buffer event to invoke appropriate
  callbacks. This is an advanced topic; this should be generally avoided unless one really knows
  what he/she does, especially since many SSL versions have had known security issues related to
  renegotiation.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: EventBufferEvent::sslSocket
type: function
doc:
<comment>Description:</comment>
  Creates a new SSL buffer event to send its data over an SSL on a socket
  
  Creates a new SSL buffer event to send its data over an SSL on a socket.

<comment>Param:</comment>
  <info>EventBase</info>        <strong>$base</strong>     Associated event base.
  <info>mixed</info>            <strong>$socket</strong>   Socket to use for this SSL. Can be stream or socket resource, numeric
                             file descriptor, or <info>null</info>. If <strong>$socket</strong> is <info>null</info>, it is assumed that the
                             file descriptor for the socket will be assigned later, for instance, by
                             means of EventBufferEvent::connectHost method.
  <info>EventSslContext</info>  <strong>$ctx</strong>      Object of <class>EventSslContext</class> class.
  <info>int</info>              <strong>$state</strong>    The current state of SSL connection: <info>EventBufferEvent::SSL_OPEN</info> ,
                             <info>EventBufferEvent::SSL_ACCEPTING</info> or <info>EventBufferEvent::SSL_CONNECTING</info> .
  <info>int</info>              <strong>$options</strong>  The buffer event options.

<comment>Return:</comment>
  <info>EventBufferEvent</info>  Returns <class>EventBufferEvent</class> object.

<comment>See Also:</comment>
   * EventBufferEvent::sslFilter


id: EventBufferEvent::write
type: function
doc:
<comment>Description:</comment>
  Adds data to a buffer event's output buffer
  
  Adds <strong>$data</strong> to a buffer event's output buffer

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Data to be added to the underlying buffer.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * EventBufferEvent::writeBuffer


id: EventBufferEvent::writeBuffer
type: function
doc:
<comment>Description:</comment>
  Adds contents of the entire buffer to a buffer event's output
    buffer
  
  Adds contents of the entire buffer to a buffer event's output buffer

<comment>Param:</comment>
  <info>EventBuffer</info>  <strong>$buf</strong>  Source <class>EventBuffer</class> object.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * EventBufferEvent::write


id: EventConfig
type: class
doc:
<comment>Description:</comment>
  Represents configuration structure which could be used in construction of the <class>EventBase</class> .


id: EventConfig::FEATURE_FDS
type: constant
doc:
<comment>Description:</comment>
  Requires a backend method that can support arbitrary file descriptor types, and not just sockets.


id: EventConfig::FEATURE_O1
type: constant
doc:
<comment>Description:</comment>
  Requires a backend method where adding or deleting a single event, or having a single event become
  active, is an O(1) operation.


id: EventConfig::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs EventConfig object
  
  Constructs EventConfig object which could be passed to EventBase::__construct constructor.

<comment>Return:</comment>
  <info>unknown</info>  Returns <class>EventConfig</class> object.

<comment>See Also:</comment>
   * EventBase::__construct


id: EventConfig::avoidMethod
type: function
doc:
<comment>Description:</comment>
  Tells libevent to avoid specific event method
  
  Tells libevent to avoid specific event method(backend). See Creating an event base .

<comment>Param:</comment>
  <info>string</info>  <strong>$method</strong>  The backend method to avoid. See EventConfig constants .

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * EventBase::__construct


id: EventConfig::requireFeatures
type: function
doc:
<comment>Description:</comment>
  Enters a required event method feature that the application demands
  
  Enters a required event method feature that the application demands

<comment>Param:</comment>
  <info>int</info>  <strong>$feature</strong>  Bitmask of required features. See <return>EventConfig::FEATURE_*</return> constants

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * EventBase::getFeatures


id: EventConfig::setFlags
type: function
doc:
<comment>Description:</comment>
  Sets one or more flags to configure the eventual EventBase will be initialized
  
  Sets one or more flags to configure what parts of  the eventual EventBase will be initialized, and
  how they'll work.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  One of <return>EventBase::LOOP_*</return> constants.  See EventBase constants.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * EventBase::getFeatures


id: EventConfig::setMaxDispatchInterval
type: function
doc:
<comment>Description:</comment>
  Prevents priority inversion
  
  Prevents priority inversion by limiting how many low-priority event callbacks can be invoked
  before checking for more high-priority events.
  
  Available since <return>libevent 2.1.0-alpha</return> .

<comment>Param:</comment>
  <info>int</info>  <strong>$max_interval</strong>   An interval after which Libevent should stop running callbacks and check for
                       more events, or <info>0</info> , if there should be no such interval.
  <info>int</info>  <strong>$max_callbacks</strong>  A number of callbacks after which Libevent should stop running callbacks and
                       check for more events, or <info>-1</info> , if there should be no such limit.
  <info>int</info>  <strong>$min_priority</strong>   A priority below which <strong>$max_interval</strong> and <strong>$max_callbacks</strong> should not be
                       enforced. If this is set to <info>0</info> , they are enforced for events of every
                       priority; if it's set to <info>1</info> , they're enforced for events of priority <info>1</info> and
                       above, and so on.

<comment>Return:</comment>
  <info>void</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: EventDnsBase
type: class
doc:
<comment>Description:</comment>
  Represents Libevent's DNS base structure. Used to resolve DNS asyncronously, parse configuration
  files like resolv.conf etc.


id: EventDnsBase::OPTIONS_ALL
type: constant
doc:
<comment>Description:</comment>
  Tells to learn as much as it can from the <return>resolv.conf</return> file.


id: EventDnsBase::OPTION_HOSTSFILE
type: constant
doc:
<comment>Description:</comment>
  Tells to read a list of hosts from <return>/etc/hosts</return> as part of loading the <return>resolv.conf</return> file.


id: EventDnsBase::OPTION_NAMESERVERS
type: constant
doc:
<comment>Description:</comment>
  Tells to learn the nameservers from the <return>resolv.conf</return> file.


id: EventDnsBase::OPTION_SEARCH
type: constant
doc:
<comment>Description:</comment>
  Tells to read the domain and search fields from the <return>resolv.conf</return> file and the <return>ndots</return> option, and use
  them to decide which domains(if any) to search for hostnames that aren’t fully-qualified.


id: EventDnsBase::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs EventDnsBase object
  
  Constructs EventDnsBase object.

<comment>Param:</comment>
  <info>EventBase</info>  <strong>$base</strong>        Event base.
  <info>bool</info>       <strong>$initialize</strong>  If the <strong>$initialize</strong> argument is <info>true</info>, it tries to configure the DNS base
                          sensibly given your operating system’s default. Otherwise, it leaves the
                          event DNS base empty, with no nameservers or options configured. In the
                          latter case DNS base should be configured manually, e.g. with
                          EventDnsBase::parseResolvConf .

<comment>Return:</comment>
  <info>unknown</info>  Returns EventDnsBase object.


id: EventDnsBase::addNameserverIp
type: function
doc:
<comment>Description:</comment>
  Adds a nameserver to the DNS base
  
  Adds a nameserver to the evdns_base.

<comment>Param:</comment>
  <info>string</info>  <strong>$ip</strong>  The nameserver string, either as an IPv4 address, an IPv6 address, an IPv4 address
               with a port ( <return>IPv4:Port</return> ), or an IPv6 address with a port ( <return>[IPv6]:Port</return> ).

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: EventDnsBase::addSearch
type: function
doc:
<comment>Description:</comment>
  Adds a domain to the list of search domains
  
  Adds a domain to the list of search domains

<comment>Param:</comment>
  <info>string</info>  <strong>$domain</strong>  Search domain.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: EventDnsBase::clearSearch
type: function
doc:
<comment>Description:</comment>
  Removes all current search suffixes
  
  Removes all current search suffixes from the DNS base; the EventDnsBase::addSearch function adds a
  suffix.

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * EventDnsBase::addSearch


id: EventDnsBase::countNameservers
type: function
doc:
<comment>Description:</comment>
  Gets the number of configured nameservers
  
  Gets the number of configured nameservers

<comment>Return:</comment>
  <info>int</info>  Returns the number of configured nameservers(not necessarily the number of running
       nameservers). This is useful for double-checking whether our calls to the various nameserver
       configuration functions have been successful.


id: EventDnsBase::loadHosts
type: function
doc:
<comment>Description:</comment>
  Loads a hosts file (in the same format as /etc/hosts) from hosts file
  
  Loads a hosts file (in the same format as <return>/etc/hosts</return> ) from hosts file.

<comment>Param:</comment>
  <info>string</info>  <strong>$hosts</strong>  Path to the hosts' file.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: EventDnsBase::parseResolvConf
type: function
doc:
<comment>Description:</comment>
  Scans the resolv.conf-formatted file
  
  Scans the resolv.conf-formatted file stored in filename, and read in all the options from it that
  are listed in flags

<comment>Param:</comment>
  <info>int</info>     <strong>$flags</strong>     Determines what information is parsed from the <return>resolv.conf</return> file. See the man
                     page for <return>resolv.conf</return> for the format of this file.
                     
                     The following directives are not parsed from the file: <return>sortlist, rotate,
                     no-check-names, inet6, debug</return> .
                     
                     If this function encounters an error, the possible return values are: <info>1</info> =
                     failed to open file<info>2</info> = failed to stat file<info>3</info> = file too large<info>4</info> = out of memory<info>5</info>
                     = short read from file<info>6</info> = no nameservers listed in the file
  <info>string</info>  <strong>$filename</strong>  Path to <return>resolv.conf</return> file.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: EventDnsBase::setOption
type: function
doc:
<comment>Description:</comment>
  Set the value of a configuration option
  
  Set the value of a configuration option.

<comment>Param:</comment>
  <info>string</info>  <strong>$option</strong>  The currently available configuration options are: <return>"ndots"</return> , <return>"timeout"</return> ,
                   <return>"max-timeouts"</return> , <return>"max-inflight"</return> , and <return>"attempts"</return> .
  <info>string</info>  <strong>$value</strong>   Option value.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: EventDnsBase::setSearchNdots
type: function
doc:
<comment>Description:</comment>
  Set the 'ndots' parameter for searches
  
  Set the <info>'ndots'</info> parameter for searches. Sets the number of dots which, when found in a name,
  causes the first query to be without any search domain.

<comment>Param:</comment>
  <info>int</info>  <strong>$ndots</strong>  The number of dots.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: EventHttp::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs EventHttp object(the HTTP server)
  
  Constructs the HTTP server object.

<comment>Param:</comment>
  <info>EventBase</info>        <strong>$base</strong>  Associated event base.
  <info>EventSslContext</info>  <strong>$ctx</strong>   <class>EventSslContext</class> class object. Turns plain HTTP server into HTTPS server.
                          It means that if <strong>$ctx</strong> is configured correctly, then the underlying buffer
                          events will be based on OpenSSL sockets. Thus, all traffic will pass
                          through the SSL or TLS.
                          
                          This parameter is available only if <return>Event</return> is compiled with OpenSSL support
                          and only with <return>Libevent 2.1.0-alpha</return> and higher.

<comment>Return:</comment>
  <info>unknown</info>  Returns <class>EventHttp</class> object.


id: EventHttp::accept
type: function
doc:
<comment>Description:</comment>
  Makes an HTTP server accept connections on the specified socket stream or resource
  
  Makes an HTTP server accept connections on the specified socket stream or resource. The socket
  should be ready to accept connections.
  
  Can be called multiple times to accept connections on different sockets.
  
  To bind a socket, <return>listen</return> , and <return> accept</return> connections on the socket in s single call use
  EventHttp::bind . EventHttp::accept is needed only if one already has a socket ready to accept
  connections.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$socket</strong>  Socket resource, stream or numeric file descriptor representing a socket ready to
                  accept connections.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * EventHttp::bind


id: EventHttp::addServerAlias
type: function
doc:
<comment>Description:</comment>
  Adds a server alias to the HTTP server object
  
  Adds a server alias to the HTTP server object.

<comment>Param:</comment>
  <info>string</info>  <strong>$alias</strong>  The alias to add.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * EventHttp::removeServerAlias


id: EventHttp::bind
type: function
doc:
<comment>Description:</comment>
  Binds an HTTP server on the specified address and port
  
  Binds an HTTP server on the specified address and port.
  
  Can be called multiple times to bind the same HTTP server to multiple different ports.

<comment>Param:</comment>
  <info>string</info>  <strong>$address</strong>  A string containing the IP address to <return>listen(2)</return> on.
  <info>int</info>     <strong>$port</strong>     The port number to listen on.

<comment>Return:</comment>
  <info>void</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * EventHttp::accept


id: EventHttp::removeServerAlias
type: function
doc:
<comment>Description:</comment>
  Removes server alias
  
  Removes server alias added with EventHttp::addServerAlias

<comment>Param:</comment>
  <info>string</info>  <strong>$alias</strong>  The alias to remove.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * EventHttp::addServerAlias


id: EventHttp::setAllowedMethods
type: function
doc:
<comment>Description:</comment>
  Sets the what HTTP methods are supported in requests accepted by this server, and passed to user
  callbacks
  
  Sets the what HTTP methods are supported in requests accepted by this server, and passed to user
  callbacks
  
  If not supported they will generate a <return>"405 Method not allowed"</return> response.
  
  By default this includes the following methods: <return>GET</return> , <return>POST</return> , <return>HEAD</return> , <return>PUT</return> , <return>DELETE</return> . See
  <return>EventHttpRequest::CMD_*</return> constants.

<comment>Param:</comment>
  <info>int</info>  <strong>$methods</strong>  A bit mask of <return>EventHttpRequest::CMD_*</return> constants .

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: EventHttp::setCallback
type: function
doc:
<comment>Description:</comment>
  Sets a callback for specified URI
  
  Sets a callback for specified URI.

<comment>Param:</comment>
  <info>string</info>            <strong>$path</strong>  The path for which to invoke the callback.
  <info>string</info>            <strong>$cb</strong>    The callback <info>callable</info> that gets invoked on requested <strong>$path</strong> . It should
                           match the following prototype:
                           
                           <strong>$req</strong><class>EventHttpRequest</class> object. <strong>$arg</strong> Custom data. 
                           
                           <class>EventHttpRequest</class> object.
                           
                           Custom data.
  <info>EventHttpRequest</info>  <strong>$req</strong>   <class>EventHttpRequest</class> object.
  <info>string</info>            <strong>$arg</strong>   Custom data.
  <info>string</info>            <strong>$arg</strong>   Custom data.

<comment>Return:</comment>
  <info>void</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * EventHttp::setDefaultCallback


id: EventHttp::setDefaultCallback
type: function
doc:
<comment>Description:</comment>
  Sets default callback to handle requests that are not caught by specific callbacks
  
  Sets default callback to handle requests that are not caught by specific callbacks

<comment>Param:</comment>
  <info>string</info>            <strong>$cb</strong>   The callback <info>callable</info> . It should match the following prototype:
                          
                          <strong>$req</strong><class>EventHttpRequest</class> object. <strong>$arg</strong> Custom data. 
                          
                          <class>EventHttpRequest</class> object.
                          
                          Custom data.
  <info>EventHttpRequest</info>  <strong>$req</strong>  <class>EventHttpRequest</class> object.
  <info>string</info>            <strong>$arg</strong>  Custom data.
  <info>string</info>            <strong>$arg</strong>  User custom data passed to the callback.

<comment>Return:</comment>
  <info>void</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * EventHttp::setCallback


id: EventHttp::setMaxBodySize
type: function
doc:
<comment>Description:</comment>
  Sets maximum request body size
  
  Sets maximum request body size.

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  The body size in bytes.

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * EventHttp::setMaxHeadersSize


id: EventHttp::setMaxHeadersSize
type: function
doc:
<comment>Description:</comment>
  Sets maximum HTTP header size
  
  Sets maximum HTTP header size.

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  The header size in bytes.

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * EventHttp::setMaxHeadersSize


id: EventHttp::setTimeout
type: function
doc:
<comment>Description:</comment>
  Sets the timeout for an HTTP request
  
  Sets the timeout for an HTTP request.

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  The timeout in seconds.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: EventHttpConnection::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs EventHttpConnection object
  
  Constructs EventHttpConnection object.

<comment>Param:</comment>
  <info>EventBase</info>        <strong>$base</strong>      Associated event base.
  <info>EventDnsBase</info>     <strong>$dns_base</strong>  If <strong>$dns_base</strong> is <info>null</info>, hostname resolution will block.
  <info>string</info>           <strong>$address</strong>   The address to connect to.
  <info>int</info>              <strong>$port</strong>      The port to connect to.
  <info>EventSslContext</info>  <strong>$ctx</strong>       <class>EventSslContext</class> class object. Enables OpenSSL.
                              
                              This parameter is available only if <return>Event</return> is compiled with OpenSSL
                              support and only with <return>Libevent 2.1.0-alpha</return> and higher.

<comment>Return:</comment>
  <info>unknown</info>  Returns <class>EventHttpConnection</class> object.


id: EventHttpConnection::getBase
type: function
doc:
<comment>Description:</comment>
  Returns event base associated with the connection
  
  Returns event base associated with the connection.

<comment>Return:</comment>
  <info>EventBase</info>  On success returns <class>EventBase</class> object associated with the connection. Otherwise <info>false</info>.


id: EventHttpConnection::getPeer
type: function
doc:
<comment>Description:</comment>
  Gets the remote address and port associated with the connection
  
  Gets the remote address and port associated with the connection

<comment>Param:</comment>
  <info>string</info>  <strong>$address</strong>  Address of the peer.
  <info>int</info>     <strong>$port</strong>     Port of the peer.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: EventHttpConnection::makeRequest
type: function
doc:
<comment>Description:</comment>
  Makes an HTTP request over the specified connection
  
  Makes an HTTP request over the specified connection. <strong>$type</strong> is one of <return>EventHttpRequest::CMD_*</return>
  constants.

<comment>Param:</comment>
  <info>EventHttpRequest</info>  <strong>$req</strong>   The connection object over which to send the request.
  <info>int</info>               <strong>$type</strong>  One of <return>EventHttpRequest::CMD_*</return> constants .
  <info>string</info>            <strong>$uri</strong>   The URI associated with the request.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * EventHttpRequest::addHeader


id: EventHttpConnection::setCloseCallback
type: function
doc:
<comment>Description:</comment>
  Set callback for connection close
  
  Sets callback for connection close.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  Callback which is called when connection is closed. Should match the
                       following prototype:

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: EventHttpConnection::setLocalAddress
type: function
doc:
<comment>Description:</comment>
  Sets the IP address from which HTTP connections are made
  
  Sets the IP address from which http connections are made.

<comment>Param:</comment>
  <info>string</info>  <strong>$address</strong>  The IP address from which HTTP connections are made.

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * EventHttpConnection::setLocalPort


id: EventHttpConnection::setLocalPort
type: function
doc:
<comment>Description:</comment>
  Sets the local port from which connections are made
  
  Sets the local port from which connections are made.

<comment>Param:</comment>
  <info>int</info>  <strong>$port</strong>  The port number.

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

<comment>See Also:</comment>
   * EventHttpConnection::setLocalAddress


id: EventHttpConnection::setMaxBodySize
type: function
doc:
<comment>Description:</comment>
  Sets maximum body size for the connection
  
  Sets maximum body size for the connection.

<comment>Param:</comment>
  <info>string</info>  <strong>$max_size</strong>  The maximum body size in bytes.

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * EventHttpConnection::setMaxHeadersSize


id: EventHttpConnection::setMaxHeadersSize
type: function
doc:
<comment>Description:</comment>
  Sets maximum header size
  
  Sets maximum header size for the connection.

<comment>Param:</comment>
  <info>string</info>  <strong>$max_size</strong>  The maximum header size in bytes.

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * EventHttpConnection::setMaxBodySize


id: EventHttpConnection::setRetries
type: function
doc:
<comment>Description:</comment>
  Sets the retry limit for the connection
  
  Sets the retry limit for the connection

<comment>Param:</comment>
  <info>int</info>  <strong>$retries</strong>  The retry limit. <info>-1</info> means infinity.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: EventHttpConnection::setTimeout
type: function
doc:
<comment>Description:</comment>
  Sets the timeout for the connection
  
  Sets the timeout for the connection

<comment>Param:</comment>
  <info>int</info>  <strong>$timeout</strong>  Timeout in seconds.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: EventHttpRequest::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs EventHttpRequest object
  
  Constructs EventHttpRequest object.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  Gets invoked on requesting path. Should match the following prototype:
  <info>mixed</info>     <strong>$data</strong>      User custom data passed to the callback.

<comment>Return:</comment>
  <info>unknown</info>  Returns EventHttpRequest object.

<comment>See Also:</comment>
   * EventHttpRequest::cancel
   * EventHttpRequest::addHeader


id: EventHttpRequest::addHeader
type: function
doc:
<comment>Description:</comment>
  Adds an HTTP header to the headers of the request
  
  Adds an HTTP header to the headers of the request.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>    Header name.
  <info>string</info>  <strong>$value</strong>  Header value.
  <info>int</info>     <strong>$type</strong>   One of <return>EventHttpRequest::*_HEADER</return> constants .

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * EventHttpRequest::removeHeader


id: EventHttpRequest::cancel
type: function
doc:
<comment>Description:</comment>
  Cancels a pending HTTP request
  
  Cancels a pending HTTP request.
  
  Cancels an ongoing HTTP request. The callback associated with this request is not executed and the
  request object is freed. If the request is currently being processed, e.g. it is ongoing, the
  corresponding <class>EventHttpConnection</class> object is going to get reset.
  
  A request cannot be canceled if its callback has executed already. A request may be canceled
  reentrantly from its chunked callback.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: EventHttpRequest::clearHeaders
type: function
doc:
<comment>Description:</comment>
  Removes all output headers from the header list of the request
  
  Removes all output headers from the header list of the request.

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * EventHttpRequest::addHeader


id: EventHttpRequest::closeConnection
type: function
doc:
<comment>Description:</comment>
  Closes associated HTTP connection
  
  Closes HTTP connection associated with the request.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: EventHttpRequest::findHeader
type: function
doc:
<comment>Description:</comment>
  Finds the value belonging a header
  
  Finds the value belonging a header.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>   The header name.
  <info>string</info>  <strong>$type</strong>  One of <return>EventHttpRequest::*_HEADER</return> constants .

<comment>Return:</comment>
  <info>void</info>  Returns <info>null</info> if header not found.

<comment>See Also:</comment>
   * EventHttpRequest::addHeader


id: EventHttpRequest::free
type: function
doc:
<comment>Description:</comment>
  Frees the object and removes associated events
  
  Frees the object and removes associated events.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: EventHttpRequest::getBufferEvent
type: function
doc:
<comment>Description:</comment>
  Returns EventBufferEvent object
  
  Returns <class>EventBufferEvent</class> object which represents buffer event that the connection is using.
  
  The reference counter of the returned object will be incremented by one to protect internal
  structures against premature destruction when the method is called from a user callback. So the
  <class>EventBufferEvent</class> object should be freed explicitly with EventBufferEvent::free method. Otherwise
  memory will leak.

<comment>Return:</comment>
  <info>EventBufferEvent</info>  Returns <class>EventBufferEvent</class> object.

<comment>See Also:</comment>
   * EventHttpRequest::getConnection


id: EventHttpRequest::getCommand
type: function
doc:
<comment>Description:</comment>
  Returns the request command(method)
  
  Returns the request command, one of <return>EventHttpRequest::CMD_*</return> constants.

<comment>Return:</comment>
  <info>void</info>  Returns the request command, one of <return>EventHttpRequest::CMD_*</return> constants.


id: EventHttpRequest::getConnection
type: function
doc:
<comment>Description:</comment>
  Returns EventHttpConnection object
  
  Returns <class>EventHttpConnection</class> object which represents HTTP connection associated with the request.
  
  Libevent API allows HTTP request objects to be not bound to any HTTP connection. Therefore we
  can't unambiguously associate <class>EventHttpRequest</class> with <class>EventHttpConnection</class> . Thus, we construct
  <class>EventHttpConnection</class> object on-the-fly. Having no information about the event base, DNS base and
  connection-close callback, we just leave these fields unset.
  
  EventHttpRequest::getConnection method is usually useful when we need to set up a callback on
  connection close. See EventHttpConnection::setCloseCallback .

<comment>Return:</comment>
  <info>EventHttpConnection</info>  Returns <class>EventHttpConnection</class> object.

<comment>See Also:</comment>
   * EventHttpConnection::setCloseCallback
   * EventHttpRequest::getBufferEvent


id: EventHttpRequest::getHost
type: function
doc:
<comment>Description:</comment>
  Returns the request host
  
  Returns the request host.

<comment>Return:</comment>
  <info>string</info>  Returns the request host.

<comment>See Also:</comment>
   * EventHttpRequest::getUri
   * EventHttpRequest::getCommand


id: EventHttpRequest::getInputBuffer
type: function
doc:
<comment>Description:</comment>
  Returns the input buffer
  
  Returns the input buffer.

<comment>Return:</comment>
  <info>EventBuffer</info>  Returns the input buffer.

<comment>See Also:</comment>
   * EventHttpRequest::getOutputBuffer


id: EventHttpRequest::getInputHeaders
type: function
doc:
<comment>Description:</comment>
  Returns associative array of the input headers
  
  Returns associative array of the input headers.

<comment>Return:</comment>
  <info>array</info>  Returns associative array of the input headers.

<comment>See Also:</comment>
   * EventHttpRequest::getOutputHeaders


id: EventHttpRequest::getOutputBuffer
type: function
doc:
<comment>Description:</comment>
  Returns the output buffer of the request
  
  Returns the output buffer of the request.

<comment>Return:</comment>
  <info>EventBuffer</info>  Returns the output buffer of the request.

<comment>See Also:</comment>
   * EventHttpRequest::getInputBuffer


id: EventHttpRequest::getOutputHeaders
type: function
doc:
<comment>Description:</comment>
  Returns associative array of the output headers
  
  Returns associative array of the output headers.

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

<comment>See Also:</comment>
   * EventHttpRequest::getInputHeaders


id: EventHttpRequest::getResponseCode
type: function
doc:
<comment>Description:</comment>
  Returns the response code
  
  Returns the response code.

<comment>Return:</comment>
  <info>int</info>  Returns the response code of the request.

<comment>See Also:</comment>
   * EventHttpRequest::getCommand
   * EventHttpRequest::getHost
   * EventHttpRequest::getUri


id: EventHttpRequest::getUri
type: function
doc:
<comment>Description:</comment>
  Returns the request URI
  
  Returns the request URI

<comment>Return:</comment>
  <info>string</info>  Returns the request URI

<comment>See Also:</comment>
   * EventHttpRequest::getCommand
   * EventHttpRequest::getHost
   * EventHttpRequest::getResponseCode


id: EventHttpRequest::removeHeader
type: function
doc:
<comment>Description:</comment>
  Removes an HTTP header from the headers of the request
  
  Removes an HTTP header from the headers of the request.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>   The header name.
  <info>string</info>  <strong>$type</strong>  <strong>$type</strong> is one of <return>EventHttpRequest::*_HEADER</return> constants.

<comment>Return:</comment>
  <info>void</info>  Removes an HTTP header from the headers of the request.

<comment>See Also:</comment>
   * EventHttpRequest::addHeader


id: EventHttpRequest::sendError
type: function
doc:
<comment>Description:</comment>
  Send an HTML error message to the client
  
  Send an HTML error message to the client.

<comment>Param:</comment>
  <info>int</info>     <strong>$error</strong>   The HTTP error code.
  <info>string</info>  <strong>$reason</strong>  A brief explanation ofthe error. If <info>null</info>, the standard meaning of the error code
                   will be used.

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * EventHttpRequest::sendReply


id: EventHttpRequest::sendReply
type: function
doc:
<comment>Description:</comment>
  Send an HTML reply to the client
  
  Send an HTML reply to the client. The body of the reply consists of data in optional <strong>$buf</strong>
  parameter.

<comment>Param:</comment>
  <info>int</info>          <strong>$code</strong>    The HTTP response code to send.
  <info>string</info>       <strong>$reason</strong>  A brief message to send with the response code.
  <info>EventBuffer</info>  <strong>$buf</strong>     The body of the response.

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * EventHttpRequest::sendError
   * EventHttpRequest::sendReplyChunk


id: EventHttpRequest::sendReplyChunk
type: function
doc:
<comment>Description:</comment>
  Send another data chunk as part of an ongoing chunked reply
  
  Send another data chunk as part of an ongoing chunked reply. After calling this method <strong>$buf</strong> will
  be empty.

<comment>Param:</comment>
  <info>EventBuffer</info>  <strong>$buf</strong>  The data chunk to send as part of the reply.

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * EventHttpRequest::sendReplyStart
   * EventHttpRequest::sendReplyEnd


id: EventHttpRequest::sendReplyEnd
type: function
doc:
<comment>Description:</comment>
  Complete a chunked reply, freeing the request as appropriate
  
  Complete a chunked reply, freeing the request as appropriate.

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * EventHttpRequest::sendReplyStart
   * EventHttpRequest::sendReplyChunk


id: EventHttpRequest::sendReplyStart
type: function
doc:
<comment>Description:</comment>
  Initiate a chunked reply
  
  Initiate a reply that uses <return>Transfer-Encoding</return> <return>chunked</return> .
  
  This allows the caller to stream the reply back to the client and is useful when either not all of
  the reply data is immediately available or when sending very large replies.
  
  The caller needs to supply data chunks with EventHttpRequest::sendReplyChunk and complete the
  reply by calling EventHttpRequest::sendReplyEnd .

<comment>Param:</comment>
  <info>int</info>     <strong>$code</strong>    The HTTP response code to send.
  <info>string</info>  <strong>$reason</strong>  A brief message to send with the response code.

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * EventHttpRequest::sendReplyChunk
   * EventHttpRequest::sendReplyEnd


id: EventListener::OPT_CLOSE_ON_EXEC
type: constant
doc:
<comment>Description:</comment>
  If this option is set, the connection listener sets the close-on-exec flag on the underlying
  listener socket. See platform documentation for <return>fcntl</return> and <info>FD_CLOEXEC</info> for more information.


id: EventListener::OPT_CLOSE_ON_FREE
type: constant
doc:
<comment>Description:</comment>
  If this option is set, the connection listener closes its underlying socket when the <class>EventListener</class>
  object is freed.


id: EventListener::OPT_LEAVE_SOCKETS_BLOCKING
type: constant
doc:
<comment>Description:</comment>
  By default Libevent turns underlying file descriptors, or sockets, to non-blocking mode. This flag
  tells Libevent to leave them in blocking mode.


id: EventListener::OPT_REUSEABLE
type: constant
doc:
<comment>Description:</comment>
  By default on some platforms, once a listener socket is closed, no other socket can bind to the
  same port until a while has passed. Setting this option makes Libevent mark the socket as
  reusable, so that once it is closed, another socket can be opened to listen on the same port.


id: EventListener::OPT_THREADSAFE
type: constant
doc:
<comment>Description:</comment>
  Allocate locks for the listener, so that it’s safe to use it from multiple threads.


id: EventListener::__construct
type: function
doc:
<comment>Description:</comment>
  Creates new connection listener associated with an event base
  
  Creates new connection listener associated with an event base.

<comment>Param:</comment>
  <info>EventBase</info>  <strong>$base</strong>     Associated event base.
  <info>callable</info>   <strong>$cb</strong>       A <info>callable</info> that will be invoked when new connection received.
  <info>mixed</info>      <strong>$data</strong>     Custom user data attached to <strong>$cb</strong> .
  <info>int</info>        <strong>$flags</strong>    Bit mask of <return>EventListener::OPT_*</return> constants. See EventListener constants .
  <info>int</info>        <strong>$backlog</strong>  Controls the maximum number of pending connections that the network stack
                       should allow to wait in a not-yet-accepted state at any time; see
                       documentation for your system’s <return>listen</return> function for more details. If <strong>$backlog</strong>
                       is negative, Libevent tries to pick a good value for the <strong>$backlog</strong> ; if it is
                       zero, Event assumes that <return>listen</return> is already called on the socket( <strong>$target</strong> )
  <info>mixed</info>      <strong>$target</strong>   May be string, socket resource, or a stream associated with a socket. In case
                       if <strong>$target</strong> is a string, the string will be parsed as network address. It will
                       be interpreted as a UNIX domain socket path, if prefixed with <return>'unix:'</return> , e.g.
                       <return>'unix:/tmp/my.sock'</return> .

<comment>Return:</comment>
  <info>unknown</info>  Returns <class>EventListener</class> object representing the event connection listener.


id: EventListener::disable
type: function
doc:
<comment>Description:</comment>
  Disables an event connect listener object
  
  Disables an event connect listener object

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * EventListener::enable


id: EventListener::enable
type: function
doc:
<comment>Description:</comment>
  Enables an event connect listener object
  
  Enables an event connect listener object

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * EventListener::disable


id: EventListener::getBase
type: function
doc:
<comment>Description:</comment>
  Returns event base associated with the event listener
  
  Returns event base associated with the event listener.

<comment>Return:</comment>
  <info>void</info>  Returns event base associated with the event listener.


id: EventListener::getSocketName
type: function
doc:
<comment>Description:</comment>
  Retreives the current address to which the
    listener's socket is bound
  
  Retreives the current address to which the listener's socket is bound.

<comment>Param:</comment>
  <info>string</info>  <strong>$address</strong>  Output parameter. IP-address depending on the socket address family.
  <info>mixed</info>   <strong>$port</strong>     Output parameter. The port the socket is bound to.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: EventListener::setCallback
type: function
doc:
<comment>Description:</comment>
  The setCallback purpose
  
  Adjust event connect listener's callback and optionally the callback argument.

<comment>Param:</comment>
  <info>callable</info>       <strong>$cb</strong>        The new callback for new connections. Ignored if <info>null</info>.
                            
                            Should match the following prototype:
                            
                            <strong>$listener</strong> The <class>EventListener</class> object. <strong>$fd</strong> The file descriptor or a
                            resource associated with the listener. <strong>$address</strong> Array of two elements:
                            IP address and the server port. <strong>$arg</strong> User custom data attached to the
                            callback.
                            
                            The <class>EventListener</class> object.
                            
                            The file descriptor or a resource associated with the listener.
                            
                            Array of two elements: IP address and the server port.
                            
                            User custom data attached to the callback.
  <info>EventListener</info>  <strong>$listener</strong>  The <class>EventListener</class> object.
  <info>mixed</info>          <strong>$fd</strong>        The file descriptor or a resource associated with the listener.
  <info>array</info>          <strong>$address</strong>   Array of two elements: IP address and the server port.
  <info>mixed</info>          <strong>$arg</strong>       User custom data attached to the callback.
  <info>mixed</info>          <strong>$arg</strong>       Custom user data attached to the callback. Ignored if <info>null</info>.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: EventListener::setErrorCallback
type: function
doc:
<comment>Description:</comment>
  Set event listener's error callback
  
  Set event listener's error callback

<comment>Param:</comment>
  <info>string</info>         <strong>$cb</strong>        The error callback. Should match the following prototype:
                            
                            <strong>$listener</strong> The <class>EventListener</class> object. <strong>$data</strong> User custom data attached to
                            the callback.
                            
                            The <class>EventListener</class> object.
                            
                            User custom data attached to the callback.
  <info>EventListener</info>  <strong>$listener</strong>  The <class>EventListener</class> object.
  <info>mixed</info>          <strong>$data</strong>      User custom data attached to the callback.

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

<comment>See Also:</comment>
   * EventListener::setCallback


id: EventSslContext
type: class
doc:
<comment>Description:</comment>
  Represents <return>SSL_CTX</return> structure. Provides methods and properties to configure the SSL context.


id: EventSslContext::OPT_ALLOW_SELF_SIGNED
type: constant
doc:
<comment>Description:</comment>
  Key for an item of the options' array used in EventSslContext::__construct . Represents option
  that allows self-signed certificates.


id: EventSslContext::OPT_CA_FILE
type: constant
doc:
<comment>Description:</comment>
  Key for an item of the options' array used in EventSslContext::__construct . Represents path of
  the certificate authority file.


id: EventSslContext::OPT_CA_PATH
type: constant
doc:
<comment>Description:</comment>
  Key for an item of the options' array used in EventSslContext::__construct . Represents path where
  the certificate authority file should be searched for.


id: EventSslContext::OPT_CIPHERS
type: constant
doc:
<comment>Description:</comment>
  Key for an item of the options' array used in EventSslContext::__construct . Represents the cipher
  list for the SSL context.


id: EventSslContext::OPT_LOCAL_CERT
type: constant
doc:
<comment>Description:</comment>
  Key for an item of the options' array used in EventSslContext::__construct . The option points to
  path of local certificate.


id: EventSslContext::OPT_LOCAL_PK
type: constant
doc:
<comment>Description:</comment>
  Key for an item of the options' array used in EventSslContext::__construct . The option points to
  path of the private key.


id: EventSslContext::OPT_PASSPHRASE
type: constant
doc:
<comment>Description:</comment>
  Key for an item of the options' array used in EventSslContext::__construct . Represents passphrase
  of the certificate.


id: EventSslContext::OPT_VERIFY_DEPTH
type: constant
doc:
<comment>Description:</comment>
  Key for an item of the options' array used in EventSslContext::__construct . Represents maximum
  depth for the certificate chain verification that shall be allowed for the SSL context.


id: EventSslContext::OPT_VERIFY_PEER
type: constant
doc:
<comment>Description:</comment>
  Key for an item of the options' array used in EventSslContext::__construct . Represents option
  that tells Event to verify peer.


id: EventSslContext::SSLv23_CLIENT_METHOD
type: constant
doc:
<comment>Description:</comment>
  SSLv23 client method. See <return>SSL_CTX_new(3)</return> man page.


id: EventSslContext::SSLv23_SERVER_METHOD
type: constant
doc:
<comment>Description:</comment>
  SSLv23 server method. See <return>SSL_CTX_new(3)</return> man page.


id: EventSslContext::SSLv2_CLIENT_METHOD
type: constant
doc:
<comment>Description:</comment>
  SSLv2 client method. See <return>SSL_CTX_new(3)</return> man page.


id: EventSslContext::SSLv2_SERVER_METHOD
type: constant
doc:
<comment>Description:</comment>
  SSLv2 server method. See <return>SSL_CTX_new(3)</return> man page.


id: EventSslContext::SSLv3_CLIENT_METHOD
type: constant
doc:
<comment>Description:</comment>
  SSLv3 client method. See <return>SSL_CTX_new(3)</return> man page.


id: EventSslContext::SSLv3_SERVER_METHOD
type: constant
doc:
<comment>Description:</comment>
  SSLv3 server method. See <return>SSL_CTX_new(3)</return> man page.


id: EventSslContext::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs an OpenSSL context for use with Event classes
  
  Creates SSL context holding pointer to <return>SSL_CTX</return> (see the system manual).

<comment>Param:</comment>
  <info>string</info>  <strong>$method</strong>   One of <return>EventSslContext::*_METHOD</return> constants .
  <info>string</info>  <strong>$options</strong>  Associative array of SSL context options One of <return>EventSslContext::OPT_*</return> constants
                    .

<comment>Return:</comment>
  <info>unknown</info>  Returns <class>EventSslContext</class> object.


id: EventUtil
type: class
doc:
<comment>Description:</comment>
  <class>EventUtil</class> is a singleton with supplimentary methods and constants.


id: EventUtil::IPPROTO_IP
type: constant
doc:
<comment>Description:</comment>
  See the <return>socket(7)</return> manual page. (Added in event-1.6.0.)


id: EventUtil::LIBEVENT_VERSION_NUMBER
type: constant
doc:
<comment>Description:</comment>
  Libevent' version number at the time when Event extension had been compiled with the library.


id: EventUtil::SOL_SOCKET
type: constant
doc:
<comment>Description:</comment>
  Socket option level. See the <return>socket(7)</return> manual page. (Added in event-1.6.0.)


id: EventUtil::SO_BROADCAST
type: constant
doc:
<comment>Description:</comment>
  Socket option. Reports whether transmission of broadcast messages is supported. See the <return>socket(7)</return>
  manual page. (Added in event-1.6.0.)


id: EventUtil::SO_DEBUG
type: constant
doc:
<comment>Description:</comment>
  Socket option. Enable socket debugging. Only allowed for processes with the <return>CAP_NET_ADMIN</return>
  capability or an effective user ID of <info>0</info> . (Added in event-1.6.0.)


id: EventUtil::SO_DONTROUTE
type: constant
doc:
<comment>Description:</comment>
  Socket option. See the <return>socket(7)</return> manual page. (Added in event-1.6.0.)


id: EventUtil::SO_KEEPALIVE
type: constant
doc:
<comment>Description:</comment>
  Socket option. Enable sending of keep-alive messages on connection-oriented sockets. Expects an
  integer boolean flag. See the <return>socket(7)</return> manual page. (Added in event-1.6.0.)


id: EventUtil::SO_LINGER
type: constant
doc:
<comment>Description:</comment>
  Socket option. When enabled, a <return>close(2)</return> or <return>shutdown(2)</return> will not return until all queued messages
  for the socket have been successfully sent or the linger timeout has been reached. Otherwise, the
  call returns immediately and the closing is done in the background. See the <return>socket(7)</return> manual page.
  (Added in event-1.6.0.)


id: EventUtil::SO_REUSEADDR
type: constant
doc:
<comment>Description:</comment>
  Socket option. Indicates that the rules used in validating addresses supplied in a <return>bind(2)</return> call
  should allow reuse of local addresses. See the <return>socket(7)</return> manual page. (Added in event-1.6.0.)


id: EventUtil::__construct
type: function
doc:
<comment>Description:</comment>
  The abstract constructor
  
  <class>EventUtil</class> is a singleton. Therefore the constructor is abstract, and it is impossible to create
  objects based on this class.

<comment>Return:</comment>
  <info>unknown</info>  値を返しません。


id: EventUtil::getLastSocketErrno
type: function
doc:
<comment>Description:</comment>
  Returns the most recent socket error number
  
  Returns the most recent socket error number( <return>errno</return> ).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$socket</strong>  Socket resource, stream or a file descriptor of a socket.

<comment>Return:</comment>
  <info>int</info>  Returns the most recent socket error number( <return>errno</return> ).

<comment>See Also:</comment>
   * EventUtil::getLastSocketError


id: EventUtil::getLastSocketError
type: function
doc:
<comment>Description:</comment>
  Returns the most recent socket error
  
  Returns the most recent socket error.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$socket</strong>  Socket resource, stream or a file descriptor of a socket.

<comment>Return:</comment>
  <info>string</info>  Returns the most recent socket error.

<comment>See Also:</comment>
   * EventUtil::getLastSocketErrno


id: EventUtil::getSocketFd
type: function
doc:
<comment>Description:</comment>
  Returns numeric file descriptor of a socket, or stream
  
  Returns numeric file descriptor of a socket or stream specified by <strong>$socket</strong> argument just like the
  <return>Event</return> extension does it internally for all methods accepting socket resource or stream.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$socket</strong>  Socket resource or stream.

<comment>Return:</comment>
  <info>int</info>  Returns numeric file descriptor of a socket, or stream. EventUtil::getSocketFd returns <info>false</info>
       in case if it is whether failed to recognize the type of the underlying file, or detected
       that the file descriptor associated with <strong>$socket</strong> is not valid.


id: EventUtil::getSocketName
type: function
doc:
<comment>Description:</comment>
  Retreives the current address to which the
    socket is bound
  
  Retreives the current address to which the <strong>$socket</strong> is bound.

<comment>Param:</comment>
  <info>mixed</info>   <strong>$socket</strong>   Socket resource, stream or a file descriptor of a socket.
  <info>string</info>  <strong>$address</strong>  Output parameter. IP-address, or the UNIX domain socket path depending on the
                    socket address family.
  <info>mixed</info>   <strong>$port</strong>     Output parameter. The port the socket is bound to. Has no meaning for UNIX
                    domain sockets.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: EventUtil::setSocketOption
type: function
doc:
<comment>Description:</comment>
  Sets socket options
  
  Sets socket options.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$socket</strong>   Socket resource, stream, or numeric file descriptor associated with the socket.
  <info>int</info>    <strong>$level</strong>    One of <return>EventUtil::SOL_*</return> constants. Specifies the protocol level at which the
                   option resides. For example, to retrieve options at the socket level, a <strong>$level</strong>
                   parameter of <info>EventUtil::SOL_SOCKET</info> would be used. Other levels, such as TCP, can
                   be used by specifying the protocol number of that level. Protocol numbers can be
                   found by using the <strong>getprotobyname()</strong> function. See EventUtil constants .
  <info>int</info>    <strong>$optname</strong>  Option name(type). Has the same meaning as corresponding parameter of
                   <strong>socket_get_option()</strong> function. See EventUtil constants .
  <info>mixed</info>  <strong>$optval</strong>   Accepts the same values as <strong>$optval</strong> parameter of the <strong>socket_get_option()</strong> function.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>socket_get_option()</strong>
   * <strong>socket_set_option()</strong>


id: EventUtil::sslRandPoll
type: function
doc:
<comment>Description:</comment>
  Generates entropy by means of OpenSSL's RAND_poll()
  
  Generates entropy by means of OpenSSL's <return>RAND_poll()</return> (see the system manual).

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Exception::__clone
type: function
doc:
<comment>Description:</comment>
  例外をコピーする
  
  <class>Exception</class> のコピーは作成できません。 作成しようとすると、<class>Error</class> がスローされます。

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Exception::__construct
type: function
doc:
<comment>Description:</comment>
  例外を作成する
  
  例外を作成します。

<comment>Param:</comment>
  <info>string</info>          <strong>$message</strong>   スローする例外メッセージ。
  <info>int</info>             <strong>$code</strong>      例外コード。
  <info>Throwable|null</info>  <strong>$previous</strong>  以前に使われた例外。例外の連結に使用します。


id: Exception::__toString
type: function
doc:
<comment>Description:</comment>
  例外の文字列表現
  
  例外を文字列で表現したものを返します。

<comment>Return:</comment>
  <info>string</info>  例外を文字列で表現したものを返します。

<comment>See Also:</comment>
   * Throwable::__toString


id: Exception::getCode
type: function
doc:
<comment>Description:</comment>
  例外コードを取得する
  
  例外コードを返します。

<comment>Return:</comment>
  <info>int</info>  例外コードを整数値で返します。しかし、 <class>Exception</class> クラスを継承したクラスでは、違う型を返すこと
       もあります (たとえば <class>PDOException</class> は文字列を返します)。

<comment>See Also:</comment>
   * Throwable::getCode


id: Exception::getFile
type: function
doc:
<comment>Description:</comment>
  例外が作られたファイルを取得する
  
  例外が作られたファイルの名前を取得します。

<comment>Return:</comment>
  <info>string</info>  例外が作られたファイルの名前を返します。

<comment>See Also:</comment>
   * Throwable::getFile


id: Exception::getLine
type: function
doc:
<comment>Description:</comment>
  例外が作られた行を取得する
  
  例外が作られた行番号を取得します。

<comment>Return:</comment>
  <info>int</info>  例外が作られた行番号を返します。

<comment>See Also:</comment>
   * Throwable::getLine


id: Exception::getMessage
type: function
doc:
<comment>Description:</comment>
  例外メッセージを取得する
  
  例外メッセージを返します。

<comment>Return:</comment>
  <info>string</info>  例外メッセージ文字列を返します。

<comment>See Also:</comment>
   * Throwable::getMessage


id: Exception::getPrevious
type: function
doc:
<comment>Description:</comment>
  前の例外(Throwable)を返す
  
  前に発生した <class>Throwable</class> (Exception::__construct に渡された 3 番目の引数) を返します。

<comment>Return:</comment>
  <info>Throwable|null</info>  前に発生した <class>Throwable</class>、あるいはそれが存在しない場合は <info>null</info> を返します。

<comment>See Also:</comment>
   * Throwable::getPrevious


id: Exception::getTrace
type: function
doc:
<comment>Description:</comment>
  スタックトレースを取得する
  
  例外のスタックトレースを返します。

<comment>Return:</comment>
  <info>array</info>  例外のスタックトレースを配列で返します。

<comment>See Also:</comment>
   * Throwable::getTrace


id: Exception::getTraceAsString
type: function
doc:
<comment>Description:</comment>
  スタックトレースを文字列で取得する
  
  例外のスタックトレースを文字列で返します。

<comment>Return:</comment>
  <info>string</info>  例外のスタックトレースを文字列で返します。

<comment>See Also:</comment>
   * Throwable::getTraceAsString


id: Executable::execute
type: function
doc:
<comment>Description:</comment>
  ステートメントを実行する
  
  コレクションへの操作、またはテーブルへのクエリから、ステートメントを実行します。 この機能によるメ
  ソッドのチェインが可能です。

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  Result または SqlStatementResult のような Result オブジェクトを返します。


id: ExecutionStatus::__construct
type: function
doc:
<comment>Description:</comment>
  ExecutionStatus のコンストラクタ
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。


id: Expression::__construct
type: function
doc:
<comment>Description:</comment>
  Expression のコンストラクタ
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: FANNConnection
type: class
doc:
<comment>Description:</comment>
  <class>FANNConnection</class> is used for the neural network connection. The objects of this class are used in
  <strong>fann_get_connection_array()</strong> and <strong>fann_set_weight_array()</strong>.


id: FANNConnection::__construct
type: function
doc:
<comment>Description:</comment>
  The connection constructor
  
  Create new connection and initialize its params. After creating the connection, only weight can be
  changed.

<comment>Param:</comment>
  <info>int</info>    <strong>$from_neuron</strong>  The position number of starting neuron.
  <info>int</info>    <strong>$to_neuron</strong>    The position number of terminating neuron.
  <info>float</info>  <strong>$weight</strong>       The connection weight value.


id: FANNConnection::getFromNeuron
type: function
doc:
<comment>Description:</comment>
  Returns the postions of starting neuron
  
  Returns the postions of starting neuron.

<comment>Return:</comment>
  <info>int</info>  The postions of starting neuron.


id: FANNConnection::getToNeuron
type: function
doc:
<comment>Description:</comment>
  Returns the postions of terminating neuron
  
  Returns the positions of terminating neuron.

<comment>Return:</comment>
  <info>int</info>  The postions of terminating neuron.


id: FANNConnection::getWeight
type: function
doc:
<comment>Description:</comment>
  Returns the connection weight
  
  Returns the connection weight.

<comment>Return:</comment>
  <info>void</info>  The connection weight.


id: FANNConnection::setWeight
type: function
doc:
<comment>Description:</comment>
  Sets the connections weight
  
  Sets the connection weight.
  
  This method is different than <strong>fann_set_weight()</strong>. It does not update the weight value in the
  network. The network value is updated only after calling <strong>fann_set_weight_array()</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$weight</strong>  The connection weight.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: FANN_ELLIOT
type: constant
doc:
<comment>Description:</comment>
  Fast (sigmoid like) activation function defined by David Elliott.


id: FANN_ELLIOT_SYMMETRIC
type: constant
doc:
<comment>Description:</comment>
  Fast (symmetric sigmoid like) activation function defined by David Elliott.


id: FANN_ERRORFUNC_TANH
type: constant
doc:
<comment>Description:</comment>
  Tanh error function; usually better but may require a lower learning rate. This error function
  aggressively targets outputs that differ much from the desired, while not targeting outputs that
  only differ slightly. Not recommended for cascade or incremental training.


id: FANN_E_TRAIN_DATA_MISMATCH
type: constant
doc:
<comment>Description:</comment>
  Irreconcilable differences between two struct fann_train_data structures.


id: FANN_STOPFUNC_BIT
type: constant
doc:
<comment>Description:</comment>
  Stop criteria is number of bits that fail.  The number of bits means the number of output neurons
  which differs more than the bit fail limit (see fann_get_bit_fail_limit, fann_set_bit_fail_limit).
  The bits are counted in all of the training data, so this number can be higher than the number of
  training data.


id: FANN_TRAIN_BATCH
type: constant
doc:
<comment>Description:</comment>
  Standard backpropagation algorithm, where the weights are updated after calculating the mean
  square error for the whole training set. This means that the weights are only updated once during
  a epoch. For this reason some problems, will train slower with this algorithm. But since the mean
  square error is calculated more correctly than in incremental training, some problems will reach a
  better solutions with this algorithm.


id: FANN_TRAIN_INCREMENTAL
type: constant
doc:
<comment>Description:</comment>
  Standard backpropagation algorithm, where the weights are updated after each training pattern.
  This means that the weights are updated many times during a single epoch. For this reason some
  problems, will train very fast with this algorithm, while other more advanced problems will not
  train very well.


id: FANN_TRAIN_QUICKPROP
type: constant
doc:
<comment>Description:</comment>
  A more advanced batch training algorithm which achieves good results for many problems. The
  quickprop training algorithm uses the learning_rate parameter along with other more advanced
  parameters, but it is only recommended to change these advanced parameters, for users with insight
  in how the quickprop training algorithm works. The quickprop training algorithm is described by
  [Fahlman, 1988].


id: FANN_TRAIN_RPROP
type: constant
doc:
<comment>Description:</comment>
  A more advanced batch training algorithm which achieves good results for many problems. The RPROP
  training algorithm is adaptive, and does therefore not use the learning_rate. Some other
  parameters can however be set to change the way the RPROP algorithm works, but it is only
  recommended for users with insight in how the RPROP training algorithm works. The RPROP training
  algorithm is described by [Riedmiller and Braun, 1993], but the actual learning algorithm used
  here is the iRPROP- training algorithm which is described by [Igel and Husken, 2000] which is an
  variety of the standard RPROP training algorithm.


id: FFI
type: class
doc:
<comment>Description:</comment>
  Objects of this class are created by the factory methods FFI::cdef, FFI::load or FFI::scope.
  Defined C variables are made available as properties of the FFI instance, and defined C functions
  are made available as methods of the FFI instance. Declared C types can be used to create new C
  data structures using FFI::new and FFI::type.
  
  FFI definition parsing and shared library loading may take significant time. It is not useful to
  do it on each HTTP request in a Web environment. However, it is possible to preload FFI
  definitions and libraries at PHP startup, and to instantiate FFI objects when necessary. Header
  files may be extended with special <return>FFI_SCOPE</return> defines (e.g. #define FFI_SCOPE "foo"; the default
  scope is "C") and then loaded by FFI::load during preloading. This leads to the creation of a
  persistent binding, that will be available to all the following requests through FFI::scope. Refer
  to the complete PHP/FFI/preloading example for details.
  
  It is possible to preload more than one C header file into the same scope.


id: FFI::addr
type: function
doc:
<comment>Description:</comment>
  Creates an unmanaged pointer to C data
  
  Creates an unmanaged pointer to the C data represented by the given <class>FFI\CData</class>. The source <strong>$ptr</strong>
  must survive the resulting pointer. This function is mainly useful to pass arguments to C
  functions by pointer.

<comment>Param:</comment>
  <info>FFI\CData</info>  <strong>$ptr</strong>  The handle of the pointer to a C data structure.

<comment>Return:</comment>
  <info>FFI\CData</info>  Returns the freshly created <class>FFI\CData</class> object.


id: FFI::alignof
type: function
doc:
<comment>Description:</comment>
  Gets the alignment
  
  Gets the alignment of the given <class>FFI\CData</class> or <class>FFI\CType</class> object.

<comment>Param:</comment>
  <info>FFI\CData|FFI\CType</info>  <strong>$ptr</strong>  The handle of the C data or type.

<comment>Return:</comment>
  <info>int</info>  Returns the alignment of the given <class>FFI\CData</class> or <class>FFI\CType</class> object.


id: FFI::arrayType
type: function
doc:
<comment>Description:</comment>
  Dynamically constructs a new C array type
  
  Dynamically constructs a new C array type with elements of type defined by <strong>$type</strong>, and dimensions
  specified by <strong>$dimensions</strong>. In the following example $t1 and $t2 are equivalent array types:
  ]]>

<comment>Param:</comment>
  <info>FFI\CType</info>  <strong>$type</strong>        A valid C declaration as <info>string</info>, or an instance of <class>FFI\CType</class> which has
                          already been created.
  <info>array</info>      <strong>$dimensions</strong>  The dimensions of the type as <info>array</info>.

<comment>Return:</comment>
  <info>FFI\CType</info>  Returns the freshly created <class>FFI\CType</class> object.


id: FFI::cast
type: function
doc:
<comment>Description:</comment>
  Performs a C type cast
  
  FFI::cast creates a new <class>FFI\CData</class> object, that references the same C data structure, but is
  associated with a different type. The resulting object does not own the C data, and the source
  <strong>$ptr</strong> must survive the result. The C type may be specified as a <info>string</info> with any valid C type
  declaration or as <class>FFI\CType</class> object, created before. If this method is called statically, it must
  only use predefined C type names (e.g. <return>int</return>, <return>char</return>, etc.); if the method is called as instance
  method, any type declared for the instance is allowed.

<comment>Param:</comment>
  <info>FFI\CType|string</info>               <strong>$type</strong>  A valid C declaration as <info>string</info>, or an instance of <class>FFI\CType</class>
                                        which has already been created.
  <info>FFI\CData|int|float|bool|null</info>  <strong>$ptr</strong>   The handle of the pointer to a C data structure.

<comment>Return:</comment>
  <info>FFI\CData|null</info>  Returns the freshly created <class>FFI\CData</class> object.


id: FFI::cdef
type: function
doc:
<comment>Description:</comment>
  Creates a new FFI object
  
  Creates a new FFI object.

<comment>Param:</comment>
  <info>string</info>       <strong>$code</strong>  A string containing a sequence of declarations in regular C language (types,
                      structures, functions, variables, etc). Actually, this string may be
                      copy-pasted from C header files.
                      
                      C preprocessor directives are not supported, i.e. #include, #define and CPP
                      macros do not work.
  <info>string|null</info>  <strong>$lib</strong>   The name of a shared library file, to be loaded and linked with the
                      definitions.
                      
                      If <strong>$lib</strong> is omitted or <info>null</info>, platforms supporting <return>RTLD_DEFAULT</return> attempt to
                      lookup symbols declared in <strong>$code</strong> in the normal global scope. Other systems
                      will fail to resolve these symbols.

<comment>Return:</comment>
  <info>FFI</info>  Returns the freshly created <class>FFI</class> object.


id: FFI::free
type: function
doc:
<comment>Description:</comment>
  Releases an unmanaged data structure
  
  Manually releases a previously created unmanaged data structure.

<comment>Param:</comment>
  <info>FFI\CData</info>  <strong>$ptr</strong>  The handle of the unmanaged pointer to a C data structure.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: FFI::isNull
type: function
doc:
<comment>Description:</comment>
  Checks whether a FFI\CData is a null pointer
  
  Checks whether a FFI\CData is a null pointer.

<comment>Param:</comment>
  <info>FFI\CData</info>  <strong>$ptr</strong>  The handle of the pointer to a C data structure.

<comment>Return:</comment>
  <info>bool</info>  Returns whether a <class>FFI\CData</class> is a null pointer.


id: FFI::load
type: function
doc:
<comment>Description:</comment>
  Loads C declarations from a C header file
  
  Loads C declarations from a C header file. It is possible to specify shared libraries that should
  be loaded, using special <return>FFI_LIB</return> defines in the loaded C header file.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The name of a C header file.
                     
                     C preprocessor directives are not supported, i.e. <return>#include</return>, <return>#define</return> and CPP
                     macros do not work, except for special cases listed below.
                     
                     The header file should contain a <return>#define</return> statement for the <return>FFI_SCOPE</return> variable,
                     e.g.: #define FFI_SCOPE "MYLIB". Refer to the class introduction for details.
                     
                     The header file may contain a <return>#define</return> statement for the <return>FFI_LIB</return> variable to
                     specify the library it exposes. If it is a system library only the file name is
                     required, e.g.: #define FFI_LIB "libc.so.6".  If it is a custom library, a
                     relative path is required, e.g.: #define FFI_LIB "./mylib.so".

<comment>Return:</comment>
  <info>FFI|null</info>  Returns the freshly created <class>FFI</class> object, or <info>null</info> on failure.

<comment>See Also:</comment>
   * FFI::scope


id: FFI::memcmp
type: function
doc:
<comment>Description:</comment>
  Compares memory areas
  
  Compares <strong>$size</strong> bytes from the memory areas <strong>$ptr1</strong> and <strong>$ptr2</strong>. Both <strong>$ptr1</strong> and <strong>$ptr2</strong> can be any native
  data structures (<class>FFI\CData</class>) or PHP <info>string</info>s.

<comment>Param:</comment>
  <info>string|FFI\CData</info>  <strong>$ptr1</strong>  The start of one memory area.
  <info>string|FFI\CData</info>  <strong>$ptr2</strong>  The start of another memory area.
  <info>int</info>               <strong>$size</strong>  The number of bytes to compare.

<comment>Return:</comment>
  <info>int</info>  Returns a value less than <return>0</return> if the contents of the memory area starting at <strong>$ptr1</strong> are
       considered less than the contents of the memory area starting at <strong>$ptr2</strong>, a value greater than
       <return>0</return> if the contents of the first memory area are considered greater than the second, and <return>0</return> if
       they are equal.


id: FFI::memcpy
type: function
doc:
<comment>Description:</comment>
  Copies one memory area to another
  
  Copies <strong>$size</strong> bytes from the memory area <strong>$from</strong> to the memory area <strong>$to</strong>.

<comment>Param:</comment>
  <info>FFI\CData</info>         <strong>$to</strong>    The start of the memory area to copy to.
  <info>FFI\CData|string</info>  <strong>$from</strong>  The start of the memory area to copy from.
  <info>int</info>               <strong>$size</strong>  The number of bytes to copy.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: FFI::memset
type: function
doc:
<comment>Description:</comment>
  Fills a memory area
  
  Fills <strong>$size</strong> bytes of the memory area pointed to by <strong>$ptr</strong> with the given byte <strong>$value</strong>.

<comment>Param:</comment>
  <info>FFI\CData</info>  <strong>$ptr</strong>    The start of the memory area to fill.
  <info>int</info>        <strong>$value</strong>  The byte to fill with.
  <info>int</info>        <strong>$size</strong>   The number of bytes to fill.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: FFI::new
type: function
doc:
<comment>Description:</comment>
  Creates a C data structure
  
  Creates a native data structure of the given C type. If this method is called statically, it must
  only use predefined C type names (e.g. <return>int</return>, <return>char</return>, etc.); if the method is called as instance
  method, any type declared for the instance is allowed.

<comment>Param:</comment>
  <info>FFI\CType|string</info>  <strong>$type</strong>        <strong>$type</strong> is a valid C declaration as <info>string</info>, or an instance of
                                 <class>FFI\CType</class> which has already been created.
  <info>bool</info>              <strong>$owned</strong>       Whether to create owned (i.e. managed) or unmanaged data. Managed
                                 data lives together with the returned <class>FFI\CData</class> object, and is
                                 released when the last reference to that object is released by
                                 regular PHP reference counting or GC. Unmanaged data should be
                                 released by calling FFI::free, when no longer needed.
  <info>bool</info>              <strong>$persistent</strong>  Whether to allocate the C data structure permanently on the system
                                 heap (using  <strong>malloc()</strong>), or on the PHP request heap (using
                                 <strong>emalloc()</strong>).

<comment>Return:</comment>
  <info>FFI\CData|null</info>  Returns the freshly created <class>FFI\CData</class> object, or <info>null</info> on failure.


id: FFI::scope
type: function
doc:
<comment>Description:</comment>
  Instantiates an FFI object with C declarations parsed during preloading
  
  Instantiates an FFI object with C declarations parsed during preloading.
  
  The FFI::scope method is safe to call multiple times for the same scope. Multiple references to
  the same scope may be loaded at the same time.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The scope name defined by a special <return>FFI_SCOPE</return> define.

<comment>Return:</comment>
  <info>FFI</info>  Returns the freshly created <class>FFI</class> object.

<comment>See Also:</comment>
   * FFI::load


id: FFI::sizeof
type: function
doc:
<comment>Description:</comment>
  Gets the size of C data or types
  
  Returns the size of the given <class>FFI\CData</class> or <class>FFI\CType</class> object.

<comment>Param:</comment>
  <info>FFI\CData|FFI\CType</info>  <strong>$ptr</strong>  The handle of the C data or type.

<comment>Return:</comment>
  <info>int</info>  The size of the memory area pointed at by <strong>$ptr</strong>.


id: FFI::string
type: function
doc:
<comment>Description:</comment>
  Creates a PHP string from a memory area
  
  Creates a PHP <info>string</info> from <strong>$size</strong> bytes of the memory area pointed to by <strong>$ptr</strong>.

<comment>Param:</comment>
  <info>FFI\CData</info>  <strong>$ptr</strong>   The start of the memory area from which to create a <info>string</info>.
  <info>int|null</info>   <strong>$size</strong>  The number of bytes to copy to the <info>string</info>. If <strong>$size</strong> is omitted or <info>null</info>, <strong>$ptr</strong>
                    must be a zero terminated array of C <return>char</return>.

<comment>Return:</comment>
  <info>string</info>  The freshly created PHP <info>string</info>.


id: FFI::type
type: function
doc:
<comment>Description:</comment>
  Creates an FFI\CType object from a C declaration
  
  This function creates and returns a <class>FFI\CType</class> object for the given <info>string</info> containing a C type
  declaration. If this method is called statically, it must only use predefined C type names (e.g.
  <return>int</return>, <return>char</return>, etc.); if the method is called as instance method, any type declared for the instance
  is allowed.

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  A valid C declaration as <info>string</info>.

<comment>Return:</comment>
  <info>FFI\CType|null</info>  Returns the freshly created <class>FFI\CType</class> object, or <info>null</info> on failure.


id: FFI::typeof
type: function
doc:
<comment>Description:</comment>
  Gets the FFI\CType of FFI\CData
  
  Gets the <class>FFI\CType</class> object representing the type of the given <class>FFI\CData</class> object.

<comment>Param:</comment>
  <info>FFI\CData</info>  <strong>$ptr</strong>  The handle of the pointer to a C data structure.

<comment>Return:</comment>
  <info>FFI\CType</info>  Returns the <class>FFI\CType</class> object representing the type of the given <class>FFI\CData</class> object.


id: FFI\CData
type: class
doc:
<comment>Description:</comment>
  <class>FFI\CData</class> objects can be used in a number of ways as a regular
   PHP data:  C data of scalar types can be read and assigned via the $cdata property, e.g.  $x =
  FFI::new('int'); $x-&gt;cdata = 42;  C struct and union fields can be accessed as regular PHP
  object property, e.g. $cdata-&gt;field  C array elements can be accessed as regular PHP array
  elements, e.g. $cdata[$offset]  C arrays can be iterated using foreach statements.  C arrays can
  be used as arguments of <strong>count()</strong>.  C pointers can be dereferenced as arrays, e.g. $cdata[0]  C
  pointers can be compared using regular comparison operators (\<, \<=, ==, !=, &gt;=, &gt;).  C pointers can be incremented and decremented using regular +/-/ ++/–- operations, e.g. $cdata += 5  C pointers can be subtracted from another using regular - operations.  C pointers to functions can be called as a regular PHP closure, e.g. $cdata()  Any C data can be duplicated using the clone operator, e.g. $cdata2 = clone $cdata;  Any C data can be visualized using <strong>var_dump()</strong>, <strong>print_r()</strong>, etc.   Notable limitations are that <class>FFI\CData</class> instances do not support <strong>isset()</strong>, <strong>empty()</strong> and <strong>unset()</strong>, and that wrapped C structs and unions do not implement Traversable.
  
  C data of scalar types can be read and assigned via the $cdata property, e.g.  $x =
  FFI::new('int'); $x-&gt;cdata = 42;
  
  C struct and union fields can be accessed as regular PHP object property, e.g. $cdata-&gt;field
  
  C array elements can be accessed as regular PHP array elements, e.g. $cdata[$offset]
  
  C arrays can be iterated using foreach statements.
  
  C arrays can be used as arguments of <strong>count()</strong>.
  
  C pointers can be dereferenced as arrays, e.g. $cdata[0]
  
  C pointers can be compared using regular comparison operators (\<, \<=, ==, !=, &gt;=, &gt;).
  
  C pointers can be incremented and decremented using regular +/-/ ++/–- operations, e.g. $cdata +=
  5
  
  C pointers can be subtracted from another using regular - operations.
  
  C pointers to functions can be called as a regular PHP closure, e.g. $cdata()
  
  Any C data can be duplicated using the clone operator, e.g. $cdata2 = clone $cdata;
  
  Any C data can be visualized using <strong>var_dump()</strong>, <strong>print_r()</strong>, etc.
  
  Notable limitations are that <class>FFI\CData</class> instances do not support <strong>isset()</strong>, <strong>empty()</strong> and <strong>unset()</strong>, and
  that wrapped C structs and unions do not implement Traversable.


id: FFI\CType::getAlignment
type: function
doc:
<comment>Description:</comment>
  Description
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: FFI\CType::getArrayElementType
type: function
doc:
<comment>Description:</comment>
  Description
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>FFI\CType</info>  


id: FFI\CType::getFuncParameterType
type: function
doc:
<comment>Description:</comment>
  Description
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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

<comment>Return:</comment>
  <info>FFI\CType</info>  


id: FFI\CType::getName
type: function
doc:
<comment>Description:</comment>
  Description
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: FFI\CType::getStructFieldNames
type: function
doc:
<comment>Description:</comment>
  Description
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>array</info>  


id: FFI\CType::getStructFieldOffset
type: function
doc:
<comment>Description:</comment>
  Description
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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

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


id: FFI\CType::getStructFieldType
type: function
doc:
<comment>Description:</comment>
  Description
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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

<comment>Return:</comment>
  <info>FFI\CType</info>  


id: FILEINFO_EXTENSION
type: constant
doc:
<comment>Description:</comment>
  ファイルから検出した MIME タイプに対応する適切な拡張子を返します。 the file.
  
  一般的な拡張子が複数存在するもの (たとえば <return>JPEG</return> 画像など) の場合は、複数の拡張子をスラッシュで連結
  した値 (<return>"jpeg/jpg/jpe/jfif"</return> など) を返します。 magic.mime データベースに存在しない MIME タイプの場
  合は <return>"???"</return> を返します。
  
  PHP 7.2.0 以降で使用可能です。


id: FILE_BINARY
type: constant
doc:
<comment>Description:</comment>
  バイナリモード  この定数は何の効果もありません。 <return>前方互換性</return> のためだけに用意されています。 
  
  この定数は何の効果もありません。 <return>前方互換性</return> のためだけに用意されています。


id: FILE_TEXT
type: constant
doc:
<comment>Description:</comment>
  テキストモード  この定数は何の効果もありません。 <return>前方互換性</return> のためだけに用意されています。 
  
  この定数は何の効果もありません。 <return>前方互換性</return> のためだけに用意されています。


id: FILTER_DEFAULT
type: constant
doc:
<comment>Description:</comment>
  デフォルト ("unsafe_raw") フィルタの ID。 これは <info>FILTER_UNSAFE_RAW</info> と同等です。


id: FILTER_FLAG_ALLOW_SCIENTIFIC
type: constant
doc:
<comment>Description:</comment>
  "number_float" フィルタで科学記法 (<return>e</return>, <return>E</return>) を許可します。


id: FILTER_FLAG_EMAIL_UNICODE
type: constant
doc:
<comment>Description:</comment>
  "validate_email" フィルタで、ローカルパートに Unicode 文字を許可します。 (PHP 7.1.0 以降で利用可
  能)


id: FILTER_FLAG_HOSTNAME
type: constant
doc:
<comment>Description:</comment>
  アルファベットと数字から始まり、アルファベットと数字およびハイフンだけを含むホスト名を必須としま
  す。 (PHP 7.0.0 以降で利用可能です)


id: FILTER_FLAG_HOST_REQUIRED
type: constant
doc:
<comment>Description:</comment>
  "validate_url" フィルタで host 部分を必須とします。 ("validate_url" フィルタに含まれるようになった
  ため、 PHP 7.3.0 以降は非推奨になり、PHP 8.0.0 で削除されました。)


id: FILTER_FLAG_SCHEME_REQUIRED
type: constant
doc:
<comment>Description:</comment>
  "validate_url" フィルタで scheme を必須とします。 ("validate_url" フィルタに含まれるようになったた
  め、 PHP 7.3.0 以降は非推奨になり、PHP 8.0.0 で削除されました。)


id: FILTER_SANITIZE_MAGIC_QUOTES
type: constant
doc:
<comment>Description:</comment>
  "magic_quotes" フィルタの ID。 (PHP 7.3.0 以降は非推奨になり、 PHP 8.0.0 以降 削除 されています。
  代わりに <info>FILTER_SANITIZE_ADD_SLASHES</info> を使ってください)


id: FILTER_SANITIZE_STRING
type: constant
doc:
<comment>Description:</comment>
  "string" フィルタの ID。 (PHP 8.1.0 以降は 非推奨 になりました。 代わりに <strong>htmlspecialchars()</strong> を
  使って下さい)


id: FILTER_SANITIZE_STRIPPED
type: constant
doc:
<comment>Description:</comment>
  "stripped" フィルタの ID。 (PHP 8.1.0 以降は 非推奨 になりました。 代わりに <strong>htmlspecialchars()</strong> を
  使って下さい)


id: FTP_AUTORESUME
type: constant
doc:
<comment>Description:</comment>
  GET と PUT において、自動的に通信を再開する位置と、通信を開始する位置を自動で決定します。
  (FTP_AUTOSEEK が有効な場合のみ機能します)


id: Fiber
type: class
doc:
<comment>Description:</comment>
  ファイバー(Fiber) は 完全なスタックを持つ、停止可能な関数です。 ファイバー はコールスタック中のど
  こからでも停止することができますし、 後に再開されるまで実行を停止したままにできます。


id: Fiber::__construct
type: function
doc:
<comment>Description:</comment>
  新しいファイバーのインスタンスを構築する

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  ファイバーを開始する時の <info>callable</info> を指定します。 Fiber::start に引数を指定す
                       ることで、 ここで指定する callable に引数を与えます。


id: Fiber::getCurrent
type: function
doc:
<comment>Description:</comment>
  現在実行中のファイバーのインスタンスを取得する

<comment>Return:</comment>
  <info>Fiber|null</info>  現在実行中の <class>Fiber</class> のインスタンスを返します。 このメソッドがファイバーの外から実行され
              た場合は <info>null</info> を返します。


id: Fiber::getReturn
type: function
doc:
<comment>Description:</comment>
  ファイバーが返した値を取得する

<comment>Return:</comment>
  <info>mixed</info>  Fiber::__construct に指定した <info>callable</info> が返した値を返します。 ファイバーが値を返さなかった
         場合、 ファイバーそのものが開始されていないか、 終了していないか、例外をスローしている場合
         で、 それらの場合は <class>FiberError</class> がスローされます。


id: Fiber::isRunning
type: function
doc:
<comment>Description:</comment>
  ファイバーが実行中かどうかを調べる

<comment>Return:</comment>
  <info>bool</info>  ファイバーが実行中の場合にのみ <info>true</info> を返します。 Fiber::start, Fiber::resume, Fiber::throw
        のいずれかがコールされた (但し、Fiber::throw の場合は、まだ制御が戻っていない場合に限る)
        後、 ファイバーは実行中と見なされます。 ファイバーが実行中でない場合、<info>false</info> を返します。


id: Fiber::isStarted
type: function
doc:
<comment>Description:</comment>
  ファイバーが開始したかどうかを調べる

<comment>Return:</comment>
  <info>bool</info>  ファイバーが既に開始した後にのみ、 <info>true</info> を返します。 そうでない場合、<info>false</info> を返します。


id: Fiber::isSuspended
type: function
doc:
<comment>Description:</comment>
  ファイバーが停止中かどうかを調べる

<comment>Return:</comment>
  <info>bool</info>  ファイバーが現在停止中の場合に <info>true</info> を返します。 そうでない場合、<info>false</info> を返します。


id: Fiber::isTerminated
type: function
doc:
<comment>Description:</comment>
  ファイバーが終了しているかを調べる

<comment>Return:</comment>
  <info>bool</info>  ファイバーが終了した後にのみ、<info>true</info> を返します。 値を返したか、例外をスローした場合のいずれか
        に限ります。 そうでない場合、<info>false</info> を返します。


id: Fiber::resume
type: function
doc:
<comment>Description:</comment>
  値を渡して、ファイバーの実行を再開させる
  
  現在の Fiber::suspend の呼び出し結果として、指定した値を渡すことでファイバーを再開します。
  
  このメソッドがコールされた時点で ファイバーが停止していない場合、 <class>FiberError</class> がスローされます。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  ファイバーの実行を再開するための値。 この値は、 現在の Fiber::suspend からの戻り値
                 となります。

<comment>Return:</comment>
  <info>mixed</info>  Fiber::suspend が次回コールされた際に指定した値を返します。 ファイバーから制御が戻った場合
         は <info>null</info> を返します。 停止する前に ファイバーが例外をスローする場合、 このメソッドの呼び出し
         からスローされます。


id: Fiber::start
type: function
doc:
<comment>Description:</comment>
  ファイバーの実行を開始する
  
  ファイバーを構築する際に使われる callable に対して、可変長引数を指定します。
  
  このメソッドをコールした時点で ファイバーが既に開始されている場合、 <class>FiberError</class> がスローされます。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$args</strong>  ファイバーのコンストラクタに指定する callable を呼び出す際に、 使用する引数。

<comment>Return:</comment>
  <info>mixed</info>  Fiber::suspend が最初にコールされた際に指定した値を返します。 ファイバーから制御が戻った場
         合は <info>null</info> を返します。 停止する前に ファイバーが例外をスローする場合、 このメソッドの呼び出
         しからスローされます。


id: Fiber::suspend
type: function
doc:
<comment>Description:</comment>
  現在実行中のファイバーを停止する
  
  現在実行中のファイバーを停止します。 このメソッドに渡した値が、 Fiber::start, Fiber::resume,
  Fiber::throw から返されます。 但し、Fiber::throw は 実行の制御が現在のファイバーに移った場合に限り
  ます。
  
  ファイバーの実行が再開されると、 このメソッドは Fiber::resume に渡された値を返します。 ファイバー
  の実行が Fiber::throw を使って再開された場合、 そのメソッドに渡された例外が、 このメソッドの呼び出
  しからスローされます。
  
  このメソッドがファイバーの外部からコールされた場合、 <class>FiberError</class> がスローされます。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Fiber::start, Fiber::resume, Fiber::throw を呼び出した際に返される値。 但し、
                 Fiber::throw は 実行の制御が現在のファイバーに移った場合に限ります。

<comment>Return:</comment>
  <info>mixed</info>  Fiber::resume に渡された値を返します。


id: Fiber::throw
type: function
doc:
<comment>Description:</comment>
  ファイバーの実行を、例外をスローすることで再開する
  
  現在の Fiber::suspend への呼び出しから、 指定した例外をスローさせることでファイバーを再開させま
  す。
  
  このメソッドがコールされた時点でファイバーが停止していない場合、 <class>FiberError</class> がスローされます。

<comment>Param:</comment>
  <info>Throwable</info>  <strong>$exception</strong>  現在の Fiber::suspend への呼び出しから、 ファイバーにスローする例外を指定し
                         ます。

<comment>Return:</comment>
  <info>mixed</info>  Fiber::suspend が次回コールされた際に指定した値を返します。 ファイバーから制御が戻った場合
         は <info>null</info> を返します。 停止する前にファイバーが例外をスローする場合、 このメソッドの呼び出し
         からスローされます。


id: FilesystemIterator::CURRENT_AS_FILEINFO
type: constant
doc:
<comment>Description:</comment>
  FilesystemIterator::current が <class>SplFileInfo</class> のインスタンスを返すようにします。


id: FilesystemIterator::CURRENT_AS_SELF
type: constant
doc:
<comment>Description:</comment>
  FilesystemIterator::current が $this (FilesystemIterator) を返すようにします。


id: FilesystemIterator::FOLLOW_SYMLINKS
type: constant
doc:
<comment>Description:</comment>
  RecursiveDirectoryIterator::hasChildren がシンボリックリンクのリンク先をたどるようにします。


id: FilesystemIterator::NEW_CURRENT_AND_KEY
type: constant
doc:
<comment>Description:</comment>
  <return>FilesystemIterator::KEY_AS_FILENAME | FilesystemIterator::CURRENT_AS_FILEINFO</return> と同じ。


id: FilesystemIterator::OTHER_MODE_MASK
type: constant
doc:
<comment>Description:</comment>
  FilesystemIterator::getFlags と FilesystemIterator::setFlags で使うマスク


id: FilesystemIterator::UNIX_PATHS
type: constant
doc:
<comment>Description:</comment>
  システムのデフォルトにかかわらず、Unix スタイルのスラッシュでパスをあらわすようにします。 コンスト
  ラクタから渡された <strong>$path</strong> は変更されないことに注意しましょう。


id: FilesystemIterator::__construct
type: function
doc:
<comment>Description:</comment>
  新しい filesystem イテレータを作成する
  
  新しい filesystem イテレータを <strong>$directory</strong> から作成します。

<comment>Param:</comment>
  <info>string</info>  <strong>$directory</strong>  反復処理したいファイルシステム上のアイテムへのパス。
  <info>int</info>     <strong>$flags</strong>      フラグを指定すると、いくつかのメソッドの振る舞いを変更することができます。 フ
                      ラグの一覧は FilesystemIterator の定義済み定数 を参照ください。これは、あとで
                      FilesystemIterator::setFlags で設定することもできます。

<comment>See Also:</comment>
   * FilesystemIterator::setFlags
   * DirectoryIterator::__construct


id: FilesystemIterator::current
type: function
doc:
<comment>Description:</comment>
  現在のファイル
  
  現在の要素のファイル情報を取得します。

<comment>Return:</comment>
  <info>string|SplFileInfo|FilesystemIterator</info>  設定されているフラグに応じ、ファイル名、ファイル情報あるい
                                         は $this を返します。 FilesystemIterator の定数 を参照くだ
                                         さい。

<comment>See Also:</comment>
   * FilesystemIterator 定数
   * DirectoryIterator::current
   * DirectoryIterator::getFileName


id: FilesystemIterator::getFlags
type: function
doc:
<comment>Description:</comment>
  処理フラグを取得する
  
  FilesystemIterator::__construct あるいは FilesystemIterator::setFlags で設定した処理フラグを取得し
  ます。

<comment>Return:</comment>
  <info>int</info>  設定されているフラグの値を返します。

<comment>See Also:</comment>
   * FilesystemIterator::__construct
   * FilesystemIterator::setFlags


id: FilesystemIterator::key
type: function
doc:
<comment>Description:</comment>
  現在のファイルのキーを取得する

<comment>Return:</comment>
  <info>string</info>  設定されているフラグに応じてパス名あるいはファイル名を返します。 FilesystemIterator の定数
          も参照ください。

<comment>See Also:</comment>
   * FilesystemIterator 定数
   * DirectoryIterator::key
   * DirectoryIterator::getFilename
   * DirectoryIterator::getPathname


id: FilesystemIterator::next
type: function
doc:
<comment>Description:</comment>
  次のファイルに移動する
  
  次のファイルに移動します。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * DirectoryIterator::next


id: FilesystemIterator::rewind
type: function
doc:
<comment>Description:</comment>
  先頭に巻き戻す
  
  ディレクトリを先頭に巻き戻します。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * DirectoryIterator::rewind


id: FilesystemIterator::setFlags
type: function
doc:
<comment>Description:</comment>
  処理フラグを設定する
  
  処理フラグを設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  設定する処理フラグ。 FilesystemIterator の定数 も参照ください。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * FilesystemIterator::__construct
   * FilesystemIterator::getFlags


id: FilterIterator
type: class
doc:
<comment>Description:</comment>
  この抽象イテレータは、望まざる値をフィルタリングします。 独自のイテレータフィルタを実装するには、
  このクラスを継承しなければなりません。 また、サブクラスでは FilterIterator::accept を実装する必要
  があります。


id: FilterIterator::__construct
type: function
doc:
<comment>Description:</comment>
  filterIterator を作成する
  
  新しい <class>FilterIterator</class> を作成します。 これは、イテレータとそれに適用するフィルタで構成されていま
  す。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>  フィルタリングの対象となるイテレータ。

<comment>See Also:</comment>
   * LimitIterator::__construct


id: FilterIterator::accept
type: function
doc:
<comment>Description:</comment>
  イテレータの現在の要素がフィルタを満たすかどうかを調べる
  
  イテレータの現在の要素がこのフィルタを通過するかどうかを返します。

<comment>Return:</comment>
  <info>bool</info>  現在の要素が通過する場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。


id: FilterIterator::current
type: function
doc:
<comment>Description:</comment>
  現在の要素の値を取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  現在の要素の値を取得します。

<comment>Return:</comment>
  <info>mixed</info>  現在の要素の値を返します。

<comment>See Also:</comment>
   * <strong>FilterIterator::key()</strong>
   * <strong>FilterIterator::next()</strong>


id: FilterIterator::key
type: function
doc:
<comment>Description:</comment>
  現在のキーを取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  現在のキーを取得します。

<comment>Return:</comment>
  <info>mixed</info>  現在のキーを返します。

<comment>See Also:</comment>
   * <strong>FilterIterator::next()</strong>
   * <strong>FilterIterator::current()</strong>


id: FilterIterator::next
type: function
doc:
<comment>Description:</comment>
  イテレータを前に移動する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  イテレータを前方に移動します。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * <strong>FilterIterator::current()</strong>
   * <strong>FilterIterator::key()</strong>


id: FilterIterator::rewind
type: function
doc:
<comment>Description:</comment>
  イテレータを巻き戻す
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  イテレータを巻き戻します。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * <strong>FilterIterator::current()</strong>
   * <strong>FilterIterator::key()</strong>
   * <strong>FilterIterator::next()</strong>


id: FilterIterator::valid
type: function
doc:
<comment>Description:</comment>
  現在の要素が有効かどうかをチェックする
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  現在の要素が有効かどうかをチェックします。

<comment>Return:</comment>
  <info>bool</info>  現在の要素が有効である場合に <info>true</info>、そうでない場合に <info>false</info> を返します。


id: GEARMAN_CLIENT_FREE_TASKS
type: constant
doc:
<comment>Description:</comment>
  Automatically free task objects once they are complete.  This is the default setting in this
  extension to prevent memory leaks.


id: GEARMAN_CLIENT_UNBUFFERED_RESULT
type: constant
doc:
<comment>Description:</comment>
  Allow the client to read data in chunks rather than have the library buffer the entire data result
  and pass that back.


id: GEARMAN_ECHO_DATA_CORRUPTION
type: constant
doc:
<comment>Description:</comment>
  After GearmanClient::echo or GearmanWorker::echo the data returned doesn't match the data sent.


id: GEARMAN_ERRNO
type: constant
doc:
<comment>Description:</comment>
  A system error.  Check GearmanClient::errno or GearmanWorker::errno for the system error code that
  was returned.


id: GEARMAN_INVALID_FUNCTION_NAME
type: constant
doc:
<comment>Description:</comment>
  Trying to register a function name of NULL or using the callback interface without specifying
  callbacks.


id: GEARMAN_IO_WAIT
type: constant
doc:
<comment>Description:</comment>
  When in non-blocking mode, an event is hit that would have blocked.


id: GEARMAN_NEED_WORKLOAD_FN
type: constant
doc:
<comment>Description:</comment>
  When the client opted to stream the workload of a task, but did not specify a workload callback
  function.


id: GEARMAN_NO_ACTIVE_FDS
type: constant
doc:
<comment>Description:</comment>
  GearmanClient::wait or GearmanWorker was called with no connections.


id: GEARMAN_NO_JOBS
type: constant
doc:
<comment>Description:</comment>
  For a non-blocking worker, when GearmanWorker::work does not have any active jobs.


id: GEARMAN_NO_SERVERS
type: constant
doc:
<comment>Description:</comment>
  Did not call GearmanClient::addServer before submitting jobs or tasks.


id: GEARMAN_PAUSE
type: constant
doc:
<comment>Description:</comment>
  For the non-blocking client task interface, can be returned from the task callback to "pause" the
  call and return from GearmanClient::runTasks. Call GearmanClient::runTasks again to continue.


id: GEARMAN_SEND_BUFFER_TOO_SMALL
type: constant
doc:
<comment>Description:</comment>
  Internal error: trying to flush more data in one atomic chunk than is possible due to hard-coded
  buffer sizes.


id: GEARMAN_SERVER_ERROR
type: constant
doc:
<comment>Description:</comment>
  Something went wrong in the Gearman server and it could not handle the request gracefully.


id: GEARMAN_UNEXPECTED_PACKET
type: constant
doc:
<comment>Description:</comment>
  Indicates something going very wrong in gearmand.  Applies only to <class>GearmanWorker</class>.


id: GEARMAN_WORKER_GRAB_UNIQ
type: constant
doc:
<comment>Description:</comment>
  Return the client assigned unique ID in addition to the job handle.


id: GEARMAN_WORK_DATA
type: constant
doc:
<comment>Description:</comment>
  Notice return code obtained with GearmanClient::returnCode when using GearmanClient::do.  Sent to
  update the client with data from a running job.  A worker uses this when it needs to send updates,
  send partial results, or flush data during long running jobs.


id: GEARMAN_WORK_EXCEPTION
type: constant
doc:
<comment>Description:</comment>
  Notice return code obtained with GearmanClient::returnCode when using GearmanClient::do. Indicates
  that a job failed with a given exception.


id: GEARMAN_WORK_FAIL
type: constant
doc:
<comment>Description:</comment>
  Notice return code obtained with GearmanClient::returnCode when using GearmanClient::do. Indicates
  that the job failed.


id: GEARMAN_WORK_STATUS
type: constant
doc:
<comment>Description:</comment>
  Notice return code obtained with GearmanClient::returnCode when using GearmanClient::do. Sent to
  update the status of a long running job. Use GearmanClient::doStatus to obtain the percentage
  complete of the task.


id: GEARMAN_WORK_WARNING
type: constant
doc:
<comment>Description:</comment>
  Notice return code obtained with GearmanClient::returnCode when using GearmanClient::do.  Updates
  the client with a warning.  The behavior is just like <info>GEARMAN_WORK_DATA</info>, but should be treated as
  a warning instead of normal response data.


id: GMP
type: class
doc:
<comment>Description:</comment>
  GMP 数。このオブジェクトは、オーバーロードされた 算術演算子, ビット演算子, 比較演算子 をサポートし
  ています。
  
  <class>GMP</class> オブジェクトを操作するオブジェクト指向インターフェイスは用意されていません。 手続き型の GMP
  API を使いましょう。


id: GMP::__construct
type: function
doc:
<comment>Description:</comment>
  GMP数を作成する
  
  整数または文字列から、GMP数を作成します。

<comment>Param:</comment>
  <info>int|string</info>  <strong>$num</strong>   整数または文字列。 文字列表現の場合、10進数、8進数、または16進数が指定可能で
                     す。
  <info>int</info>         <strong>$base</strong>  基数
                     
                     基数は、2から62までの値が指定できます。 この値が0(デフォルト値) の場合、 実際の
                     値は先頭に付加されている文字によって決まります。 最初の2文字が <return>0x</return> や <return>0X</return> の場
                     合、16進数が仮定されます。最初の2文字が <return>0b</return> や <return>0B</return> の場合、2進数が仮定されます。
                     それら以外の場合で、 最初の文字が <return>0</return> の場合、8進数が仮定されます。 これら以外の
                     場合、10進数が仮定されます。 基数が36までの場合、大文字小文字は区別されません。
                     つまり、大文字だろうと小文字だろうと同じ値です。 基数が37から62までの場合、大文
                     字は通常の10から35までの値を表します。 小文字の場合、36から61までの値を表しま
                     す。

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


id: GMP::__serialize
type: function
doc:
<comment>Description:</comment>
  GMP オブジェクトをシリアライズする
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>array</info>  値を返しません。


id: GMP::__unserialize
type: function
doc:
<comment>Description:</comment>
  data 引数をGMP オブジェクトとして復元する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>array</info>  <strong>$data</strong>  アンシリアライズされる値。

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: GearmanClient
type: class
doc:
<comment>Description:</comment>
  Represents a class for connecting to a Gearman job server and making requests to perform some
  function on provided data.  The function performed must be one registered by a Gearman worker and
  the data passed is opaque to the job server.


id: GearmanClient::__construct
type: function
doc:
<comment>Description:</comment>
  Create a GearmanClient instance
  
  Creates a <class>GearmanClient</class> instance representing a client that connects to the job server and submits
  tasks to complete.

<comment>Return:</comment>
  <info>unknown</info>  A <class>GearmanClient</class> object.

<comment>See Also:</comment>
   * GearmanClient::clone


id: GearmanClient::addOptions
type: function
doc:
<comment>Description:</comment>
  Add client options
  
  Adds one or more options to those already set.

<comment>Param:</comment>
  <info>int</info>  <strong>$option</strong>  The options to add. One of the following constants, or a combination of them using
                the bitwise OR operator (|): <info>GEARMAN_CLIENT_GENERATE_UNIQUE</info>,
                <info>GEARMAN_CLIENT_NON_BLOCKING</info>, <info>GEARMAN_CLIENT_UNBUFFERED_RESULT</info> or
                <info>GEARMAN_CLIENT_FREE_TASKS</info>.

<comment>Return:</comment>
  <info>bool</info>  Always returns <info>true</info>.


id: GearmanClient::addServer
type: function
doc:
<comment>Description:</comment>
  Add a job server to the client
  
  Adds a job server to a list of servers that can be used to run a task.  No socket I/O happens
  here; the server is simply added to the list.

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>  ジョブサーバーのホスト名。
  <info>int</info>     <strong>$port</strong>  ジョブサーバーのポート番号。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * GearmanClient::addServers


id: GearmanClient::addServers
type: function
doc:
<comment>Description:</comment>
  Add a list of job servers to the client
  
  Adds a list of job servers that can be used to run a task.  No socket I/O happens here; the
  servers are simply added to the full list of servers.

<comment>Param:</comment>
  <info>string</info>  <strong>$servers</strong>  A comma-separated list of servers, each server specified in the format
                    '<return>host:port</return>'.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * GearmanClient::addServer


id: GearmanClient::addTask
type: function
doc:
<comment>Description:</comment>
  Add a task to be run in parallel
  
  Adds a task to be run in parallel with other tasks.  Call this method for all the tasks to be run
  in parallel, then call GearmanClient::runTasks to  perform the work.  Note that enough workers
  need to be available for the tasks to all run in parallel.

<comment>Param:</comment>
  <info>string</info>            <strong>$function_name</strong>  ワーカーが実行するために登録した関数。
  <info>string|int|float</info>  <strong>$workload</strong>       シリアライズしたデータ。
  <info>mixed</info>             <strong>$context</strong>        タスクに関連づけるアプリケーションコンテキスト。
  <info>string|null</info>       <strong>$unique_key</strong>     タスクを特定するために用いる一意な ID。

<comment>Return:</comment>
  <info>GearmanTask|false</info>  A <class>GearmanTask</class> object or <info>false</info> if the task could not be added.

<comment>See Also:</comment>
   * GearmanClient::addTaskHigh
   * GearmanClient::addTaskLow
   * GearmanClient::addTaskBackground
   * GearmanClient::addTaskHighBackground
   * GearmanClient::addTaskLowBackground
   * GearmanClient::runTasks


id: GearmanClient::addTaskBackground
type: function
doc:
<comment>Description:</comment>
  Add a background task to be run in parallel
  
  Adds a background task to be run in parallel with other tasks.  Call this method for all the tasks
  to be run in parallel, then call GearmanClient::runTasks to perform the work.

<comment>Param:</comment>
  <info>string</info>            <strong>$function_name</strong>  ワーカーが実行するために登録した関数。
  <info>string|int|float</info>  <strong>$workload</strong>       シリアライズしたデータ。
  <info>mixed</info>             <strong>$context</strong>        タスクに関連づけるアプリケーションコンテキスト。
  <info>string|null</info>       <strong>$unique_key</strong>     タスクを特定するために用いる一意な ID。

<comment>Return:</comment>
  <info>GearmanTask|false</info>  A <class>GearmanTask</class> object or <info>false</info> if the task could not be added.

<comment>See Also:</comment>
   * GearmanClient::addTask
   * GearmanClient::addTaskHigh
   * GearmanClient::addTaskLow
   * GearmanClient::addTaskHighBackground
   * GearmanClient::addTaskLowBackground
   * GearmanClient::runTasks


id: GearmanClient::addTaskHigh
type: function
doc:
<comment>Description:</comment>
  Add a high priority task to run in parallel
  
  Adds a high priority task to be run in parallel with other tasks.  Call this method for all the
  high priority tasks to be run in parallel, then call GearmanClient::runTasks to perform the work.
  Tasks with a high priority will be selected from the queue before those of normal or low priority.

<comment>Param:</comment>
  <info>string</info>            <strong>$function_name</strong>  ワーカーが実行するために登録した関数。
  <info>string|int|float</info>  <strong>$workload</strong>       シリアライズしたデータ。
  <info>mixed</info>             <strong>$context</strong>        タスクに関連づけるアプリケーションコンテキスト。
  <info>string|null</info>       <strong>$unique_key</strong>     タスクを特定するために用いる一意な ID。

<comment>Return:</comment>
  <info>GearmanTask|false</info>  A <class>GearmanTask</class> object or <info>false</info> if the task could not be added.

<comment>See Also:</comment>
   * GearmanClient::addTask
   * GearmanClient::addTaskLow
   * GearmanClient::addTaskBackground
   * GearmanClient::addTaskHighBackground
   * GearmanClient::addTaskLowBackground
   * GearmanClient::runTasks


id: GearmanClient::addTaskHighBackground
type: function
doc:
<comment>Description:</comment>
  Add a high priority background task to be run in parallel
  
  Adds a high priority background task to be run in parallel with other tasks. Call this method for
  all the tasks to be run in parallel, then call GearmanClient::runTasks to perform the work. Tasks
  with a high priority will be selected from the queue before those of normal or low priority.

<comment>Param:</comment>
  <info>string</info>            <strong>$function_name</strong>  ワーカーが実行するために登録した関数。
  <info>string|int|float</info>  <strong>$workload</strong>       シリアライズしたデータ。
  <info>mixed</info>             <strong>$context</strong>        タスクに関連づけるアプリケーションコンテキスト。
  <info>string|null</info>       <strong>$unique_key</strong>     タスクを特定するために用いる一意な ID。

<comment>Return:</comment>
  <info>GearmanTask|false</info>  A <class>GearmanTask</class> object or <info>false</info> if the task could not be added.

<comment>See Also:</comment>
   * GearmanClient::addTask
   * GearmanClient::addTaskHigh
   * GearmanClient::addTaskLow
   * GearmanClient::addTaskBackground
   * GearmanClient::addTaskLowBackground
   * GearmanClient::runTasks


id: GearmanClient::addTaskLow
type: function
doc:
<comment>Description:</comment>
  Add a low priority task to run in parallel
  
  Adds a low priority background task to be run in parallel with other tasks. Call this method for
  all the tasks to be run in parallel, then call GearmanClient::runTasks to perform the work. Tasks
  with a low priority will be selected from the queue after those of normal or low priority.

<comment>Param:</comment>
  <info>string</info>            <strong>$function_name</strong>  ワーカーが実行するために登録した関数。
  <info>string|int|float</info>  <strong>$workload</strong>       シリアライズしたデータ。
  <info>mixed</info>             <strong>$context</strong>        タスクに関連づけるアプリケーションコンテキスト。
  <info>string|null</info>       <strong>$unique_key</strong>     タスクを特定するために用いる一意な ID。

<comment>Return:</comment>
  <info>GearmanTask|false</info>  A <class>GearmanTask</class> object or <info>false</info> if the task could not be added.

<comment>See Also:</comment>
   * GearmanClient::addTask
   * GearmanClient::addTaskHigh
   * GearmanClient::addTaskBackground
   * GearmanClient::addTaskHighBackground
   * GearmanClient::addTaskLowBackground
   * GearmanClient::runTasks


id: GearmanClient::addTaskLowBackground
type: function
doc:
<comment>Description:</comment>
  Add a low priority background task to be run in parallel
  
  Adds a low priority background task to be run in parallel with other tasks. Call this method for
  all the tasks to be run in parallel, then call GearmanClient::runTasks to perform the work. Tasks
  with a low priority will be selected from the queue after those of normal or high priority.

<comment>Param:</comment>
  <info>string</info>            <strong>$function_name</strong>  ワーカーが実行するために登録した関数。
  <info>string|int|float</info>  <strong>$workload</strong>       シリアライズしたデータ。
  <info>mixed</info>             <strong>$context</strong>        タスクに関連づけるアプリケーションコンテキスト。
  <info>string|null</info>       <strong>$unique_key</strong>     タスクを特定するために用いる一意な ID。

<comment>Return:</comment>
  <info>GearmanTask|false</info>  A <class>GearmanTask</class> object or <info>false</info> if the task could not be added.

<comment>See Also:</comment>
   * GearmanClient::addTask
   * GearmanClient::addTaskHigh
   * GearmanClient::addTaskLow
   * GearmanClient::addTaskBackground
   * GearmanClient::addTaskHighBackground
   * GearmanClient::runTasks


id: GearmanClient::addTaskStatus
type: function
doc:
<comment>Description:</comment>
  Add a task to get status
  
  Used to request status information from the Gearman server, which will call the specified status
  callback (set using GearmanClient::setStatusCallback).

<comment>Param:</comment>
  <info>string</info>  <strong>$job_handle</strong>  The job handle for the task to get status for
  <info>mixed</info>   <strong>$context</strong>     Data to be passed to the status callback, generally a reference to an array
                       or object

<comment>Return:</comment>
  <info>GearmanTask|false</info>  A <class>GearmanTask</class> object or <info>false</info> on failure.

<comment>See Also:</comment>
   * GearmanClient::setStatusCallback


id: GearmanClient::clearCallbacks
type: function
doc:
<comment>Description:</comment>
  Clear all task callback functions
  
  Clears all the task callback functions that have previously been set.

<comment>Return:</comment>
  <info>bool</info>  Always returns <info>true</info>.

<comment>See Also:</comment>
   * GearmanClient::setDataCallback
   * GearmanClient::setCompleteCallback
   * GearmanClient::setCreatedCallback
   * GearmanClient::setExceptionCallback
   * GearmanClient::setFailCallback
   * GearmanClient::setStatusCallback
   * GearmanClient::setWarningCallback
   * GearmanClient::setWorkloadCallback


id: GearmanClient::clone
type: function
doc:
<comment>Description:</comment>
  Create a copy of a GearmanClient object
  
  Creates a copy of a <class>GearmanClient</class> object.

<comment>Return:</comment>
  <info>GearmanClient</info>  A <class>GearmanClient</class> on success, <info>false</info> on failure.


id: GearmanClient::context
type: function
doc:
<comment>Description:</comment>
  Get the application context
  
  Get the application context previously set with GearmanClient::setContext.

<comment>Return:</comment>
  <info>string</info>  The same context data structure set with GearmanClient::setContext

<comment>See Also:</comment>
   * GearmanClient::setContext


id: GearmanClient::data
type: function
doc:
<comment>Description:</comment>
  Get the application data (deprecated)
  
  Get the application data previously set with GearmanClient::setData.
  
  This method was replaced by GearmanClient::setContext in the 0.6.0 release of the Gearman
  extension.

<comment>Return:</comment>
  <info>string</info>  The same string data set with GearmanClient::setData

<comment>See Also:</comment>
   * GearmanClient::setData


id: GearmanClient::do
type: function
doc:
<comment>Description:</comment>
  Run a single task and return a result [deprecated]
  
  The GearmanClient::do method is deprecated as of pecl/gearman 1.0.0. Use GearmanClient::doNormal.

<comment>Param:</comment>
  <info>string</info>  <strong>$function_name</strong>  ワーカーが実行するために登録した関数。
  <info>string</info>  <strong>$workload</strong>       シリアライズしたデータ。
  <info>string</info>  <strong>$unique</strong>         タスクを特定するために用いる一意な ID。

<comment>Return:</comment>
  <info>string</info>  A string representing the results of running a task.

<comment>See Also:</comment>
   * GearmanClient::doHigh
   * GearmanClient::doLow
   * GearmanClient::doBackground
   * GearmanClient::doHighBackground
   * GearmanClient::doLowBackground


id: GearmanClient::doBackground
type: function
doc:
<comment>Description:</comment>
  Run a task in the background
  
  Runs a task in the background, returning a job handle which can be used to get the status of the
  running task.

<comment>Param:</comment>
  <info>string</info>       <strong>$function</strong>  ワーカーが実行するために登録した関数。
  <info>string</info>       <strong>$workload</strong>  シリアライズしたデータ。
  <info>string|null</info>  <strong>$unique</strong>    タスクを特定するために用いる一意な ID。

<comment>Return:</comment>
  <info>string</info>  The job handle for the submitted task.

<comment>See Also:</comment>
   * GearmanClient::doNormal
   * GearmanClient::doHigh
   * GearmanClient::doLow
   * GearmanClient::doHighBackground
   * GearmanClient::doLowBackground


id: GearmanClient::doHigh
type: function
doc:
<comment>Description:</comment>
  Run a single high priority task
  
  Runs a single high priority task and returns a string representation of the result.  It is up to
  the <class>GearmanClient</class> and <class>GearmanWorker</class> to agree on the format of the result.  High priority tasks
  will get precedence over normal and low priority tasks in the job queue.

<comment>Param:</comment>
  <info>string</info>       <strong>$function</strong>  ワーカーが実行するために登録した関数。
  <info>string</info>       <strong>$workload</strong>  シリアライズしたデータ。
  <info>string|null</info>  <strong>$unique</strong>    タスクを特定するために用いる一意な ID。

<comment>Return:</comment>
  <info>string</info>  A string representing the results of running a task.

<comment>See Also:</comment>
   * GearmanClient::doNormal
   * GearmanClient::doLow
   * GearmanClient::doBackground
   * GearmanClient::doHighBackground
   * GearmanClient::doLowBackground


id: GearmanClient::doHighBackground
type: function
doc:
<comment>Description:</comment>
  Run a high priority task in the background
  
  Runs a high priority task in the background, returning a job handle which can be used to get the
  status of the running task.  High priority tasks take precedence over normal and low priority
  tasks in the job queue.

<comment>Param:</comment>
  <info>string</info>       <strong>$function</strong>  ワーカーが実行するために登録した関数。
  <info>string</info>       <strong>$workload</strong>  シリアライズしたデータ。
  <info>string|null</info>  <strong>$unique</strong>    タスクを特定するために用いる一意な ID。

<comment>Return:</comment>
  <info>string</info>  The job handle for the submitted task.

<comment>See Also:</comment>
   * GearmanClient::doNormal
   * GearmanClient::doHigh
   * GearmanClient::doLow
   * GearmanClient::doBackground
   * GearmanClient::doLowBackground


id: GearmanClient::doJobHandle
type: function
doc:
<comment>Description:</comment>
  Get the job handle for the running task
  
  Gets that job handle for a running task.  This should be used between repeated
  GearmanClient::doNormal calls.  The job handle can then be used to get information on the task.

<comment>Return:</comment>
  <info>string</info>  The job handle for the running task.

<comment>See Also:</comment>
   * GearmanClient::jobStatus


id: GearmanClient::doLow
type: function
doc:
<comment>Description:</comment>
  Run a single low priority task
  
  Runs a single low priority task and returns a string representation of the result.  It is up to
  the <class>GearmanClient</class> and <class>GearmanWorker</class> to agree on the format of the result.  Normal and high
  priority tasks will get precedence over low priority tasks in the job queue.

<comment>Param:</comment>
  <info>string</info>       <strong>$function</strong>  ワーカーが実行するために登録した関数。
  <info>string</info>       <strong>$workload</strong>  シリアライズしたデータ。
  <info>string|null</info>  <strong>$unique</strong>    タスクを特定するために用いる一意な ID。

<comment>Return:</comment>
  <info>string</info>  A string representing the results of running a task.

<comment>See Also:</comment>
   * GearmanClient::doNormal
   * GearmanClient::doHigh
   * GearmanClient::doBackground
   * GearmanClient::doHighBackground
   * GearmanClient::doLowBackground


id: GearmanClient::doLowBackground
type: function
doc:
<comment>Description:</comment>
  Run a low priority task in the background
  
  Runs a low priority task in the background, returning a job handle which can be used to get the
  status of the running task.  Normal and high priority tasks take precedence over low priority
  tasks in the job queue.

<comment>Param:</comment>
  <info>string</info>       <strong>$function</strong>  ワーカーが実行するために登録した関数。
  <info>string</info>       <strong>$workload</strong>  シリアライズしたデータ。
  <info>string|null</info>  <strong>$unique</strong>    タスクを特定するために用いる一意な ID。

<comment>Return:</comment>
  <info>string</info>  The job handle for the submitted task.

<comment>See Also:</comment>
   * GearmanClient::doNormal
   * GearmanClient::doHigh
   * GearmanClient::doLow
   * GearmanClient::doBackground
   * GearmanClient::doHighBackground


id: GearmanClient::doNormal
type: function
doc:
<comment>Description:</comment>
  Run a single task and return a result
  
  Runs a single task and returns a string representation of the result.  It is up to the
  <class>GearmanClient</class> and <class>GearmanWorker</class> to agree on the format of the result.

<comment>Param:</comment>
  <info>string</info>       <strong>$function</strong>  ワーカーが実行するために登録した関数。
  <info>string</info>       <strong>$workload</strong>  シリアライズしたデータ。
  <info>string|null</info>  <strong>$unique</strong>    タスクを特定するために用いる一意な ID。

<comment>Return:</comment>
  <info>string</info>  A string representing the results of running a task.

<comment>See Also:</comment>
   * GearmanClient::doHigh
   * GearmanClient::doLow
   * GearmanClient::doBackground
   * GearmanClient::doHighBackground
   * GearmanClient::doLowBackground


id: GearmanClient::doStatus
type: function
doc:
<comment>Description:</comment>
  Get the status for the running task
  
  Returns the status for the running task.  This should be used between repeated
  GearmanClient::doNormal calls.

<comment>Return:</comment>
  <info>array</info>  An array representing the percentage completion given as a fraction, with the first element
         the numerator and the second element the denomintor.

<comment>See Also:</comment>
   * GearmanClient::doNormal
   * GearmanJob::status


id: GearmanClient::echo
type: function
doc:
<comment>Description:</comment>
  Send data to all job servers to see if they echo it back [deprecated]
  
  The GearmanClient::echo method is deprecated as of pecl/gearman 1.0.0. Use GearmanClient::ping.

<comment>Param:</comment>
  <info>string</info>  <strong>$workload</strong>  Some arbitrary serialized data to be echo back

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: GearmanClient::error
type: function
doc:
<comment>Description:</comment>
  Returns an error string for the last error encountered
  
  Returns an error string for the last error encountered.

<comment>Return:</comment>
  <info>string|false</info>  A human readable error string, or <info>false</info> if there is no error message available.

<comment>See Also:</comment>
   * GearmanClient::getErrno


id: GearmanClient::getErrno
type: function
doc:
<comment>Description:</comment>
  Get an errno value
  
  Value of errno in the case of a GEARMAN_ERRNO return value.

<comment>Return:</comment>
  <info>int</info>  A valid Gearman errno.

<comment>See Also:</comment>
   * GearmanClient::error


id: GearmanClient::jobStatus
type: function
doc:
<comment>Description:</comment>
  Get the status of a background job
  
  オブジェクト指向型 (method):
  
  Gets the status for a background job given a job handle.  The status information will specify
  whether the job is known, whether the job is currently running, and the percentage completion.

<comment>Param:</comment>
  <info>string</info>  <strong>$job_handle</strong>  Gearman サーバーが割り当てたジョブハンドル。

<comment>Return:</comment>
  <info>array</info>  An array containing status information for the job corresponding to the supplied job
         handle.  The first array element is a boolean indicating whether the job is even known, the
         second is a boolean indicating whether the job is still running, and the third and fourth
         elements correspond to the numerator and denominator of the fractional completion
         percentage, respectively.

<comment>See Also:</comment>
   * GearmanClient::doStatus


id: GearmanClient::ping
type: function
doc:
<comment>Description:</comment>
  Send data to all job servers to see if they echo it back
  
  Sends some arbitrary data to all job servers to see if they echo it back.  The data sent is not
  used or processed in any other way.  Primarily used for testing and debugging.

<comment>Param:</comment>
  <info>string</info>  <strong>$workload</strong>  Some arbitrary serialized data to be echo back

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: GearmanClient::removeOptions
type: function
doc:
<comment>Description:</comment>
  Remove client options
  
  Removes (unsets) one or more options.

<comment>Param:</comment>
  <info>int</info>  <strong>$option</strong>  The options to be removed (unset)

<comment>Return:</comment>
  <info>bool</info>  Always returns <info>true</info>.


id: GearmanClient::returnCode
type: function
doc:
<comment>Description:</comment>
  Get the last Gearman return code
  
  Returns the last Gearman return code.

<comment>Return:</comment>
  <info>int</info>  A valid Gearman return code.


id: GearmanClient::runTasks
type: function
doc:
<comment>Description:</comment>
  Run a list of tasks in parallel
  
  For a set of tasks previously added with GearmanClient::addTask, GearmanClient::addTaskHigh,
  GearmanClient::addTaskLow, GearmanClient::addTaskBackground, GearmanClient::addTaskHighBackground,
  or GearmanClient::addTaskLowBackground, this call starts running the tasks in parallel.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * GearmanClient::addTask


id: GearmanClient::setClientCallback
type: function
doc:
<comment>Description:</comment>
  Callback function when there is a data packet for a task (deprecated)
  
  Sets the callback function for accepting data packets for a task. The callback function should
  take a single argument, a <class>GearmanTask</class> object.
  
  This method has been replaced by GearmanClient::setDataCallback in the 0.6.0 release of the
  Gearman extension.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  A function or method to call

<comment>Return:</comment>
  <info>void</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * GearmanClient::setCompleteCallback
   * GearmanClient::setCreatedCallback
   * GearmanClient::setDataCallback
   * GearmanClient::setExceptionCallback
   * GearmanClient::setFailCallback
   * GearmanClient::setStatusCallback
   * GearmanClient::setWarningCallback
   * GearmanClient::setWorkloadCallback


id: GearmanClient::setCompleteCallback
type: function
doc:
<comment>Description:</comment>
  Set a function to be called on task completion
  
  Use to set a function to be called when a <class>GearmanTask</class> is completed, or when
  GearmanJob::sendComplete is invoked by a worker (whichever happens first).
  
  This callback executes only when executing a <class>GearmanTask</class> using GearmanClient::runTasks. It is not
  used for individual jobs.

<comment>Param:</comment>
  <info>callable</info>  <strong>$function</strong>  A function to be called

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * GearmanClient::setDataCallback
   * GearmanClient::setCreatedCallback
   * GearmanClient::setExceptionCallback
   * GearmanClient::setFailCallback
   * GearmanClient::setStatusCallback
   * GearmanClient::setWarningCallback
   * GearmanClient::setWorkloadCallback


id: GearmanClient::setContext
type: function
doc:
<comment>Description:</comment>
  Set application context
  
  Sets an arbitrary string to provide application context that can later be retrieved by
  GearmanClient::context.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Arbitrary context data

<comment>Return:</comment>
  <info>bool</info>  Always returns <info>true</info>.

<comment>See Also:</comment>
   * GearmanClient::context


id: GearmanClient::setCreatedCallback
type: function
doc:
<comment>Description:</comment>
  Set a callback for when a task is queued
  
  Sets a function to be called when a task is received and queued by the Gearman job server. The
  callback should accept a single argument, a <class>GearmanTask</class> object.

<comment>Param:</comment>
  <info>callable</info>  <strong>$function</strong>  A function to call

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * GearmanClient::setDataCallback
   * GearmanClient::setCompleteCallback
   * GearmanClient::setExceptionCallback
   * GearmanClient::setFailCallback
   * GearmanClient::setStatusCallback
   * GearmanClient::setWarningCallback
   * GearmanClient::setWorkloadCallback


id: GearmanClient::setData
type: function
doc:
<comment>Description:</comment>
  Set application data (deprecated)
  
  Sets some arbitrary application data that can later be retrieved by  GearmanClient::data.
  
  This method has been replaced by GearmanCient::setContext in the 0.6.0 release of the Gearman
  extension.

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

<comment>Return:</comment>
  <info>bool</info>  Always returns <info>true</info>.

<comment>See Also:</comment>
   * GearmanClient::data


id: GearmanClient::setDataCallback
type: function
doc:
<comment>Description:</comment>
  Callback function when there is a data packet for a task
  
  Sets the callback function for accepting data packets for a task. The callback function should
  take a single argument, a <class>GearmanTask</class> object.

<comment>Param:</comment>
  <info>callable</info>  <strong>$function</strong>  A function or method to call

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * GearmanClient::setCompleteCallback
   * GearmanClient::setCreatedCallback
   * GearmanClient::setExceptionCallback
   * GearmanClient::setFailCallback
   * GearmanClient::setStatusCallback
   * GearmanClient::setWarningCallback
   * GearmanClient::setWorkloadCallback


id: GearmanClient::setExceptionCallback
type: function
doc:
<comment>Description:</comment>
  Set a callback for worker exceptions
  
  Specifies a function to call when a worker for a task sends an exception.

<comment>Param:</comment>
  <info>callable</info>  <strong>$function</strong>  Function to call when the worker throws an exception

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * GearmanClient::setDataCallback
   * GearmanClient::setCompleteCallback
   * GearmanClient::setCreatedCallback
   * GearmanClient::setFailCallback
   * GearmanClient::setStatusCallback
   * GearmanClient::setWarningCallback
   * GearmanClient::setWorkloadCallback


id: GearmanClient::setFailCallback
type: function
doc:
<comment>Description:</comment>
  Set callback for job failure
  
  Sets the callback function to be used when a task does not complete successfully.  The function
  should accept a single argument, a <class>GearmanTask</class> object.

<comment>Param:</comment>
  <info>callable</info>  <strong>$function</strong>  A function to call

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * GearmanClient::setDataCallback
   * GearmanClient::setCompleteCallback
   * GearmanClient::setCreatedCallback
   * GearmanClient::setExceptionCallback
   * GearmanClient::setStatusCallback
   * GearmanClient::setWarningCallback
   * GearmanClient::setWorkloadCallback


id: GearmanClient::setOptions
type: function
doc:
<comment>Description:</comment>
  Set client options
  
  Sets one or more client options.

<comment>Param:</comment>
  <info>int</info>  <strong>$option</strong>  The options to be set

<comment>Return:</comment>
  <info>bool</info>  Always returns <info>true</info>.


id: GearmanClient::setStatusCallback
type: function
doc:
<comment>Description:</comment>
  Set a callback for collecting task status
  
  Sets a callback function used for getting updated status information from a worker.  The function
  should accept a single argument, a <class>GearmanTask</class> object.

<comment>Param:</comment>
  <info>callable</info>  <strong>$function</strong>  A function to call

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * GearmanClient::setDataCallback
   * GearmanClient::setCompleteCallback
   * GearmanClient::setCreatedCallback
   * GearmanClient::setExceptionCallback
   * GearmanClient::setFailCallback
   * GearmanClient::setWarningCallback
   * GearmanClient::setWorkloadCallback


id: GearmanClient::setTimeout
type: function
doc:
<comment>Description:</comment>
  Set socket I/O activity timeout
  
  Sets the timeout for socket I/O activity.

<comment>Param:</comment>
  <info>int</info>  <strong>$timeout</strong>  An interval of time in milliseconds

<comment>Return:</comment>
  <info>bool</info>  Always returns <info>true</info>.


id: GearmanClient::setWarningCallback
type: function
doc:
<comment>Description:</comment>
  Set a callback for worker warnings
  
  Sets a function to be called when a worker sends a warning.  The callback should accept a single
  argument, a <class>GearmanTask</class> object.

<comment>Param:</comment>
  <info>callable</info>  <strong>$function</strong>  A function to call

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * GearmanClient::setDataCallback
   * GearmanClient::setCompleteCallback
   * GearmanClient::setCreatedCallback
   * GearmanClient::setExceptionCallback
   * GearmanClient::setFailCallback
   * GearmanClient::setStatusCallback
   * GearmanClient::setWorkloadCallback


id: GearmanClient::setWorkloadCallback
type: function
doc:
<comment>Description:</comment>
  Set a callback for accepting incremental data updates
  
  Sets a function to be called when a worker needs to send back data prior to job completion. A
  worker can do this when it needs to send updates, send partial results, or flush data during long
  running jobs.  The callback should accept a single argument, a  <class>GearmanTask</class> object.

<comment>Param:</comment>
  <info>callable</info>  <strong>$function</strong>  A function to call

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * GearmanClient::setDataCallback
   * GearmanClient::setCompleteCallback
   * GearmanClient::setCreatedCallback
   * GearmanClient::setExceptionCallback
   * GearmanClient::setFailCallback
   * GearmanClient::setStatusCallback
   * GearmanClient::setWarningCallback


id: GearmanClient::timeout
type: function
doc:
<comment>Description:</comment>
  Get current socket I/O activity timeout value
  
  Returns the timeout in milliseconds to wait for I/O activity.

<comment>Return:</comment>
  <info>int</info>  Timeout in milliseconds to wait for I/O activity.  A negative value means an infinite
       timeout.

<comment>See Also:</comment>
   * GearmanClient::setTimeout


id: GearmanClient::wait
type: function
doc:
<comment>Description:</comment>
  Wait for I/O activity on all connections in a client
  
  This waits for activity from any one of the connected servers.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> on success <info>false</info> on an error.

<comment>See Also:</comment>
   * GearmanWorker::wait


id: GearmanJob::__construct
type: function
doc:
<comment>Description:</comment>
  Create a GearmanJob instance
  
  Creates a <class>GearmanJob</class> instance representing a job the worker is to complete.

<comment>Return:</comment>
  <info>unknown</info>  A <class>GearmanJob</class> object.


id: GearmanJob::complete
type: function
doc:
<comment>Description:</comment>
  Send the result and complete status (deprecated)
  
  Sends result data and the complete status update for this job.
  
  This method has been replaced by GearmanJob::sendComplete in the 0.6.0 release of the Gearman
  extension.

<comment>Param:</comment>
  <info>string</info>  <strong>$result</strong>  Serialized result data.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * GearmanJob::sendFail
   * GearmanJob::setReturn


id: GearmanJob::data
type: function
doc:
<comment>Description:</comment>
  Send data for a running job (deprecated)
  
  Sends data to the job server (and any listening clients) for this job.
  
  This method has been replaced by GearmanJob::sendData in the 0.6.0 release of the Gearman
  extension.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Arbitrary serialized data.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * GearmanJob::workload
   * GearmanTask::data


id: GearmanJob::exception
type: function
doc:
<comment>Description:</comment>
  Send exception for running job (deprecated)
  
  Sends the supplied exception when this job is running.
  
  This method has been replaced by GearmanJob::sendException in the 0.6.0 release of the Gearman
  extension.

<comment>Param:</comment>
  <info>string</info>  <strong>$exception</strong>  An exception description.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * GearmanJob::setReturn
   * GearmanJob::sendStatus
   * GearmanJob::sendWarning


id: GearmanJob::fail
type: function
doc:
<comment>Description:</comment>
  Send fail status (deprecated)
  
  Sends failure status for this job, indicating that the job failed in a known way (as opposed to
  failing due to a thrown exception).
  
  This method has been replaced by GearmanJob::sendFail in the  0.6.0 release of the Gearman
  extension.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * GearmanJob::sendException
   * GearmanJob::setReturn
   * GearmanJob::sendStatus
   * GearmanJob::sendWarning


id: GearmanJob::functionName
type: function
doc:
<comment>Description:</comment>
  Get function name
  
  Returns the function name for this job.  This is the function the work will execute to perform the
  job.

<comment>Return:</comment>
  <info>false|string</info>  The name of a function, or <info>false</info> if the job has not yet been initialized.

<comment>See Also:</comment>
   * GearmanTask::function


id: GearmanJob::handle
type: function
doc:
<comment>Description:</comment>
  Get the job handle
  
  Returns the opaque job handle assigned by the job server.

<comment>Return:</comment>
  <info>false|string</info>  An opaque job handle, or <info>false</info> if the job has not yet been initialized.

<comment>See Also:</comment>
   * GearmanTask::jobHandle


id: GearmanJob::returnCode
type: function
doc:
<comment>Description:</comment>
  Get last return code
  
  Returns the last return code issued by the job server.

<comment>Return:</comment>
  <info>int</info>  A valid Gearman return code.

<comment>See Also:</comment>
   * GearmanTask::returnCode


id: GearmanJob::sendComplete
type: function
doc:
<comment>Description:</comment>
  Send the result and complete status
  
  Sends result data and the complete status update for this job.

<comment>Param:</comment>
  <info>string</info>  <strong>$result</strong>  Serialized result data.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * GearmanJob::sendFail
   * GearmanJob::setReturn


id: GearmanJob::sendData
type: function
doc:
<comment>Description:</comment>
  Send data for a running job
  
  Sends data to the job server (and any listening clients) for this job.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Arbitrary serialized data.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * GearmanJob::workload
   * GearmanTask::data


id: GearmanJob::sendException
type: function
doc:
<comment>Description:</comment>
  Send exception for running job (exception)
  
  Sends the supplied exception when this job is running.

<comment>Param:</comment>
  <info>string</info>  <strong>$exception</strong>  An exception description.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * GearmanJob::setReturn
   * GearmanJob::sendStatus
   * GearmanJob::sendWarning


id: GearmanJob::sendFail
type: function
doc:
<comment>Description:</comment>
  Send fail status
  
  Sends failure status for this job, indicating that the job failed in a known way (as opposed to
  failing due to a thrown exception).

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * GearmanJob::sendException
   * GearmanJob::setReturn
   * GearmanJob::sendStatus
   * GearmanJob::sendWarning


id: GearmanJob::sendStatus
type: function
doc:
<comment>Description:</comment>
  Send status
  
  Sends status information to the job server and any listening clients.  Use this to specify what
  percentage of the job has been completed.

<comment>Param:</comment>
  <info>int</info>  <strong>$numerator</strong>    The numerator of the precentage completed expressed as a fraction.
  <info>int</info>  <strong>$denominator</strong>  The denominator of the precentage completed expressed as a fraction.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * GearmanClient::jobStatus
   * GearmanTask::taskDenominator
   * GearmanTask::taskNumerator


id: GearmanJob::sendWarning
type: function
doc:
<comment>Description:</comment>
  Send a warning
  
  Sends a warning for this job while it is running.

<comment>Param:</comment>
  <info>string</info>  <strong>$warning</strong>  A warning message.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * GearmanJob::sendComplete
   * GearmanJob::sendException
   * GearmanJob::sendFail


id: GearmanJob::setReturn
type: function
doc:
<comment>Description:</comment>
  Set a return value
  
  Sets the return value for this job, indicates how the job completed.

<comment>Param:</comment>
  <info>int</info>  <strong>$gearman_return_t</strong>  A valid Gearman return value.

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


id: GearmanJob::status
type: function
doc:
<comment>Description:</comment>
  Send status (deprecated)
  
  Sends status information to the job server and any listening clients.  Use this to specify what
  percentage of the job has been completed.
  
  This method has been replaced by GearmanJob::sendStatus in the 0.6.0 release of the Gearman
  extenstion.

<comment>Param:</comment>
  <info>int</info>  <strong>$numerator</strong>    The numerator of the precentage completed expressed as a fraction.
  <info>int</info>  <strong>$denominator</strong>  The denominator of the precentage completed expressed as a fraction.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * GearmanClient::jobStatus
   * GearmanTask::taskDenominator
   * GearmanTask::taskNumerator


id: GearmanJob::unique
type: function
doc:
<comment>Description:</comment>
  Get the unique identifier
  
  Returns the unique identifier for this job.  The identifier is assigned by the client.

<comment>Return:</comment>
  <info>false|string</info>  An opaque unique identifier, or <info>false</info> if the job has not yet been initialized.

<comment>See Also:</comment>
   * GearmanClient::do
   * GearmanTask::uuid


id: GearmanJob::warning
type: function
doc:
<comment>Description:</comment>
  Send a warning (deprecated)
  
  Sends a warning for this job while it is running.
  
  This method has been replaced by GearmanJob::sendWarning in the 0.6.0 release of the Gearman
  extension.

<comment>Param:</comment>
  <info>string</info>  <strong>$warning</strong>  A warning messages.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * GearmanJob::sendComplete
   * GearmanJob::sendException
   * GearmanJob::sendFail


id: GearmanJob::workload
type: function
doc:
<comment>Description:</comment>
  Get workload
  
  Returns the workload for the job.  This is serialized data that is to be processed by the worker.

<comment>Return:</comment>
  <info>string</info>  Serialized data.

<comment>See Also:</comment>
   * GearmanClient::do
   * GearmanJob::workloadSize


id: GearmanJob::workloadSize
type: function
doc:
<comment>Description:</comment>
  Get size of work load
  
  Returns the size of the job's work load (the data the worker is to process) in bytes.

<comment>Return:</comment>
  <info>int</info>  The size in bytes.

<comment>See Also:</comment>
   * GearmanJob::workload


id: GearmanTask::__construct
type: function
doc:
<comment>Description:</comment>
  Create a GearmanTask instance
  
  Creates a <class>GearmanTask</class> instance representing a task to be submitted to a job server.

<comment>Return:</comment>
  <info>unknown</info>  A <class>GearmanTask</class> object.


id: GearmanTask::create
type: function
doc:
<comment>Description:</comment>
  Create a task (deprecated)
  
  Returns a new <class>GearmanTask</class> object.
  
  This method was removed in the 0.6.0 version of the Gearman extension.

<comment>Return:</comment>
  <info>GearmanTask|false</info>  A <class>GearmanTask</class> oject失敗した場合に <info>false</info> を返します.


id: GearmanTask::data
type: function
doc:
<comment>Description:</comment>
  Get data returned for a task
  
  Returns data being returned for a task by a worker.

<comment>Return:</comment>
  <info>false|string</info>  The serialized data, or <info>false</info> if no data is present.

<comment>See Also:</comment>
   * GearmanTask::dataSize


id: GearmanTask::dataSize
type: function
doc:
<comment>Description:</comment>
  Get the size of returned data
  
  Returns the size of the data being returned for a task.

<comment>Return:</comment>
  <info>int|false</info>  The data size, or <info>false</info> if there is no data.

<comment>See Also:</comment>
   * GearmanTask::data


id: GearmanTask::function
type: function
doc:
<comment>Description:</comment>
  Get associated function name (deprecated)
  
  Returns the name of the function this task is associated with, i.e., the function the Gearman
  worker calls.
  
  This method has been replaced by GearmanTask::functionName in the 0.6.0 release of the Gearman
  extension.

<comment>Return:</comment>
  <info>string</info>  A function name.


id: GearmanTask::functionName
type: function
doc:
<comment>Description:</comment>
  Get associated function name
  
  Returns the name of the function this task is associated with, i.e., the function the Gearman
  worker calls.

<comment>Return:</comment>
  <info>false|string</info>  A function name, or <info>false</info> if the task has not yet been created.


id: GearmanTask::isKnown
type: function
doc:
<comment>Description:</comment>
  Determine if task is known
  
  Gets the status information for whether or not this task is known to the job server.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the task is known, <info>false</info> otherwise.


id: GearmanTask::isRunning
type: function
doc:
<comment>Description:</comment>
  Test whether the task is currently running
  
  Indicates whether or not this task is currently running.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the task is running, <info>false</info> otherwise.


id: GearmanTask::jobHandle
type: function
doc:
<comment>Description:</comment>
  Get the job handle
  
  Returns the job handle for this task.

<comment>Return:</comment>
  <info>false|string</info>  The opaque job handle, or <info>false</info> if the task has not yet been created.

<comment>See Also:</comment>
   * GearmanClient::doJobHandle


id: GearmanTask::recvData
type: function
doc:
<comment>Description:</comment>
  Read work or result data into a buffer for a task
  
  この関数は、
  実験的 なものです。この関数の動作・
  名前・その他ドキュメントに書かれている事項は、予告なく、将来的な PHP
  のリリースにおいて変更される可能性があります。
  この関数は自己責任で使用してください。

<comment>Param:</comment>
  <info>int</info>  <strong>$data_len</strong>  Length of data to be read.

<comment>Return:</comment>
  <info>false|array</info>  An array whose first element is the length of data read and the second is the data
               buffer. Returns <info>false</info> if the read failed.

<comment>See Also:</comment>
   * GearmanTask::sendData


id: GearmanTask::returnCode
type: function
doc:
<comment>Description:</comment>
  Get the last return code
  
  Returns the last Gearman return code for this task.

<comment>Return:</comment>
  <info>int</info>  A valid Gearman return code.

<comment>See Also:</comment>
   * GearmanClient::returnCode


id: GearmanTask::sendData
type: function
doc:
<comment>Description:</comment>
  Send data for a task (deprecated)
  
  この関数は、
  実験的 なものです。この関数の動作・
  名前・その他ドキュメントに書かれている事項は、予告なく、将来的な PHP
  のリリースにおいて変更される可能性があります。
  この関数は自己責任で使用してください。

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Data to send to the worker.

<comment>Return:</comment>
  <info>int</info>  The length of data sent, or <info>false</info> if the send failed.

<comment>See Also:</comment>
   * GearmanTask::recvData


id: GearmanTask::sendWorkload
type: function
doc:
<comment>Description:</comment>
  Send data for a task
  
  この関数は、
  実験的 なものです。この関数の動作・
  名前・その他ドキュメントに書かれている事項は、予告なく、将来的な PHP
  のリリースにおいて変更される可能性があります。
  この関数は自己責任で使用してください。

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Data to send to the worker.

<comment>Return:</comment>
  <info>int|false</info>  The length of data sent, or <info>false</info> if the send failed.

<comment>See Also:</comment>
   * GearmanTask::recvData


id: GearmanTask::taskDenominator
type: function
doc:
<comment>Description:</comment>
  Get completion percentage denominator
  
  Returns the denominator of the percentage of the task that is complete expressed as a fraction.

<comment>Return:</comment>
  <info>false|int</info>  A number between 0 and 100, or <info>false</info> if cannot be determined.

<comment>See Also:</comment>
   * GearmanTask::taskNumerator


id: GearmanTask::taskNumerator
type: function
doc:
<comment>Description:</comment>
  Get completion percentage numerator
  
  Returns the numerator of the percentage of the task that is complete expressed as a fraction.

<comment>Return:</comment>
  <info>false|int</info>  A number between 0 and 100, or <info>false</info> if cannot be determined.

<comment>See Also:</comment>
   * GearmanTask::taskDenominator


id: GearmanTask::unique
type: function
doc:
<comment>Description:</comment>
  Get the unique identifier for a task
  
  Returns the unique identifier for this task.  This is assigned by the <class>GearmanClient</class>, as opposed to
  the job handle which is set by the Gearman job server.

<comment>Return:</comment>
  <info>false|string</info>  The unique identifier, or <info>false</info> if no identifier is assigned.

<comment>See Also:</comment>
   * GearmanClient::do
   * GearmanClient::addTask


id: GearmanTask::uuid
type: function
doc:
<comment>Description:</comment>
  Get the unique identifier for a task (deprecated)
  
  Returns the unique identifier for this task.  This is assigned by the <class>GearmanClient</class>, as opposed to
  the job handle which is set by the Gearman job server.
  
  This method has been replaced by GearmanTask::unique in the 0.6.0 release of the Gearman
  extension.

<comment>Return:</comment>
  <info>string</info>  The unique identifier, or <info>false</info> if no identifier is assigned.

<comment>See Also:</comment>
   * GearmanClient::do
   * GearmanClient::addTask


id: GearmanWorker::__construct
type: function
doc:
<comment>Description:</comment>
  Create a GearmanWorker instance
  
  Creates a <class>GearmanWorker</class> instance representing a worker that connects to the job server and accepts
  tasks to run.

<comment>Return:</comment>
  <info>unknown</info>  A <class>GearmanWorker</class> object

<comment>See Also:</comment>
   * GearmanWorker::clone


id: GearmanWorker::addFunction
type: function
doc:
<comment>Description:</comment>
  Register and add callback function
  
  Registers a function name with the job server and specifies a callback corresponding to that
  function.  Optionally specify extra application context data to be used when the callback is
  called and a timeout.

<comment>Param:</comment>
  <info>string</info>    <strong>$function_name</strong>  The name of a function to register with the job server
  <info>callable</info>  <strong>$function</strong>       A callback that gets called when a job for the registered function name
                            is submitted
  <info>mixed</info>     <strong>$context</strong>        A reference to arbitrary application context data that can be modified
                            by the worker function
  <info>int</info>       <strong>$timeout</strong>        An interval of time in seconds

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * GearmanClient::do


id: GearmanWorker::addOptions
type: function
doc:
<comment>Description:</comment>
  Add worker options
  
  Adds one or more options to the options previously set.

<comment>Param:</comment>
  <info>int</info>  <strong>$option</strong>  The options to be added

<comment>Return:</comment>
  <info>true</info>  常に <info>true</info> を返します。

<comment>See Also:</comment>
   * GearmanWorker::options
   * GearmanClient::setOptions
   * GearmanClient::removeOptions


id: GearmanWorker::addServer
type: function
doc:
<comment>Description:</comment>
  Add a job server
  
  Adds a job server to this worker.  This goes into a list of servers than can be used to run jobs.
  No socket I/O happens here.

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>  ジョブサーバーのホスト名。
  <info>int</info>     <strong>$port</strong>  ジョブサーバーのポート番号。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * GearmanWorker::addServers


id: GearmanWorker::addServers
type: function
doc:
<comment>Description:</comment>
  Add job servers
  
  Adds one or more job servers to this worker.  These go into a list of servers that can be used to
  run jobs.  No socket I/O happens here.

<comment>Param:</comment>
  <info>string</info>  <strong>$servers</strong>  A comma separated list of job servers in the format host:port. If no port is
                    specified, it defaults to 4730.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * GearmanWorker::addServer


id: GearmanWorker::clone
type: function
doc:
<comment>Description:</comment>
  Create a copy of the worker
  
  Creates a copy of the worker.

<comment>Return:</comment>
  <info>void</info>  A <class>GearmanWorker</class> object


id: GearmanWorker::echo
type: function
doc:
<comment>Description:</comment>
  Test job server response
  
  Sends data to all job servers to see if they echo it back.  This is a test function to see if job
  servers are responding properly.

<comment>Param:</comment>
  <info>string</info>  <strong>$workload</strong>  Arbitrary serialized data

<comment>Return:</comment>
  <info>bool</info>  Standard Gearman return value.

<comment>See Also:</comment>
   * GearmanClient::echo


id: GearmanWorker::error
type: function
doc:
<comment>Description:</comment>
  Get the last error encountered
  
  Returns an error string for the last error encountered.

<comment>Return:</comment>
  <info>string|false</info>  A human readable error string, or <info>false</info> if there is no error message available.

<comment>See Also:</comment>
   * GearmanWorker::getErrno


id: GearmanWorker::getErrno
type: function
doc:
<comment>Description:</comment>
  Get errno
  
  Returns the value of errno in the case of a GEARMAN_ERRNO return value.

<comment>Return:</comment>
  <info>int</info>  A valid errno.

<comment>See Also:</comment>
   * GearmanWorker::error


id: GearmanWorker::options
type: function
doc:
<comment>Description:</comment>
  Get worker options
  
  Gets the options previously set for the worker.

<comment>Return:</comment>
  <info>int</info>  The options currently set for the worker.

<comment>See Also:</comment>
   * GearmanWorker::setOptions


id: GearmanWorker::register
type: function
doc:
<comment>Description:</comment>
  Register a function with the job server
  
  Registers a function name with the job server with an optional timeout.  The timeout specifies how
  many seconds the server will wait before marking a job as failed. If the timeout is set to zero,
  there is no timeout.

<comment>Param:</comment>
  <info>string</info>  <strong>$function_name</strong>  The name of a function to register with the job server
  <info>int</info>     <strong>$timeout</strong>        An interval of time in seconds

<comment>Return:</comment>
  <info>bool</info>  A standard Gearman return value.

<comment>See Also:</comment>
   * GearmanWorker::unregister
   * GearmanWorker::unregisterAll


id: GearmanWorker::removeOptions
type: function
doc:
<comment>Description:</comment>
  Remove worker options
  
  Removes (unsets) one or more worker options.

<comment>Param:</comment>
  <info>int</info>  <strong>$option</strong>  The options to be removed (unset)

<comment>Return:</comment>
  <info>true</info>  常に <info>true</info> を返します。

<comment>See Also:</comment>
   * GearmanWorker::options
   * GearmanWorker::setOptions
   * GearmanWorker::addOptions


id: GearmanWorker::returnCode
type: function
doc:
<comment>Description:</comment>
  Get last Gearman return code
  
  Returns the last Gearman return code.

<comment>Return:</comment>
  <info>int</info>  A valid Gearman return code.

<comment>See Also:</comment>
   * GearmanWorker::error
   * GearmanWorker::getErrno


id: GearmanWorker::setId
type: function
doc:
<comment>Description:</comment>
  Give the worker an identifier so it can be tracked when asking gearmand for the list of available
  workers
  
  Assigns the worker an identifier.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  A string identifier.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: GearmanWorker::setOptions
type: function
doc:
<comment>Description:</comment>
  Set worker options
  
  Sets one or more options to the supplied value.

<comment>Param:</comment>
  <info>int</info>  <strong>$option</strong>  The options to be set

<comment>Return:</comment>
  <info>true</info>  常に <info>true</info> を返します。

<comment>See Also:</comment>
   * GearmanWorker::options
   * GearmanWorker::addOptions
   * GearmanWorker::removeOptions
   * GearmanClient::setOptions


id: GearmanWorker::setTimeout
type: function
doc:
<comment>Description:</comment>
  Set socket I/O activity timeout
  
  Sets the interval of time to wait for socket I/O activity.

<comment>Param:</comment>
  <info>int</info>  <strong>$timeout</strong>  An interval of time in milliseconds.  A negative value indicates an infinite
                 timeout.

<comment>Return:</comment>
  <info>true</info>  常に <info>true</info> を返します。

<comment>See Also:</comment>
   * GearmanWorker::timeout


id: GearmanWorker::timeout
type: function
doc:
<comment>Description:</comment>
  Get socket I/O activity timeout
  
  Returns the current time to wait, in milliseconds, for socket I/O activity.

<comment>Return:</comment>
  <info>int</info>  A time period is milliseconds.  A negative value indicates an infinite timeout.

<comment>See Also:</comment>
   * GearmanWorker::setTimeout


id: GearmanWorker::unregister
type: function
doc:
<comment>Description:</comment>
  Unregister a function name with the job servers
  
  Unregisters a function name with the job servers ensuring that no more jobs (for that function)
  are sent to this worker.

<comment>Param:</comment>
  <info>string</info>  <strong>$function_name</strong>  The name of a function to register with the job server

<comment>Return:</comment>
  <info>bool</info>  A standard Gearman return value.

<comment>See Also:</comment>
   * GearmanWorker::register
   * GearmanWorker::unregisterAll


id: GearmanWorker::unregisterAll
type: function
doc:
<comment>Description:</comment>
  Unregister all function names with the job servers
  
  Unregisters all previously registered functions, ensuring that no more jobs are sent to this
  worker.

<comment>Return:</comment>
  <info>bool</info>  A standard Gearman return value.

<comment>See Also:</comment>
   * GearmanWorker::register
   * GearmanWorker::unregister


id: GearmanWorker::wait
type: function
doc:
<comment>Description:</comment>
  Wait for activity from one of the job servers
  
  Causes the worker to wait for activity from one of the Gearman job servers when operating in
  non-blocking I/O mode.  On failure, issues a <info>E_WARNING</info> with the last Gearman error encountered.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * GearmanWorker::work


id: GearmanWorker::work
type: function
doc:
<comment>Description:</comment>
  Wait for and perform jobs
  
  Waits for a job to be assigned and then calls the appropriate callback function. Issues an
  <info>E_WARNING</info> with the last Gearman error if the return code is not one of <info>GEARMAN_SUCCESS</info>,
  <info>GEARMAN_IO_WAIT</info>, or <info>GEARMAN_WORK_FAIL</info>.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * GearmanWorker::addFunction


id: Gender\Gender::__construct
type: function
doc:
<comment>Description:</comment>
  Gender オブジェクトを作る
  
  Gender オブジェクトを作ります。オプションで、外部の名前ディレクトリに接続することもできます。 外部
  データベースを指定しなかったときは、コンパイル時に組み込まれたデータを使います。

<comment>Param:</comment>
  <info>string</info>  <strong>$dsn</strong>  開きたい DSN。


id: Gender\Gender::connect
type: function
doc:
<comment>Description:</comment>
  外部の名前ディレクトリに接続する
  
  外部の名前ディレクトリに接続します。 今のところ、サポートしているのはストリームだけです。

<comment>Param:</comment>
  <info>string</info>  <strong>$dsn</strong>  開きたい DSN。

<comment>Return:</comment>
  <info>bool</info>  成功したかどうかを boolean で返します。


id: Gender\Gender::country
type: function
doc:
<comment>Description:</comment>
  国を表すテキストを取得する
  
  Gender クラスの定数から、国を表す文字列を取得します。

<comment>Param:</comment>
  <info>int</info>  <strong>$country</strong>  <class>Gender\Gender</class> クラスの定数で表される国 ID。

<comment>Return:</comment>
  <info>array|false</info>  成功した場合は、短い国名と完全な国名の配列を返します。 失敗した場合に <info>false</info> を返しま
               す。


id: Gender\Gender::get
type: function
doc:
<comment>Description:</comment>
  性別を取得する
  
  指定した名前について、特定の国における性別を取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>     調べたい名前。
  <info>int</info>     <strong>$country</strong>  Gender クラスの定数で表される国 ID。

<comment>Return:</comment>
  <info>int</info>  性別を返します。


id: Gender\Gender::isNick
type: function
doc:
<comment>Description:</comment>
  name0 が name1 のエイリアスかどうかを調べる
  
  name0 が name1 のエイリアスかどうかを調べます。

<comment>Param:</comment>
  <info>string</info>  <strong>$name0</strong>    調べる名前。
  <info>string</info>  <strong>$name1</strong>    調べる名前。
  <info>int</info>     <strong>$country</strong>  Gender クラスの定数で指定する国 ID。省略した場合は ANY_COUNTRY を使います。

<comment>Return:</comment>
  <info>array</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: Gender\Gender::similarNames
type: function
doc:
<comment>Description:</comment>
  似た名前を取得する
  
  名前と国を指定して、似た名前を取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>     調べる名前。
  <info>int</info>     <strong>$country</strong>  Gender クラスの定数で指定する国 ID。省略した場合は ANY_COUNTRY を使います。

<comment>Return:</comment>
  <info>array</info>  似ている名前の配列を返します。


id: Generator
type: class
doc:
<comment>Description:</comment>
  <class>Generator</class> は ジェネレータ が返すオブジェクトです。
  
  <class>Generator</class> オブジェクトのインスタンスは new では作れません。


id: Generator::__wakeup
type: function
doc:
<comment>Description:</comment>
  シリアライズのコールバック
  
  ジェネレータはシリアライズできないので、例外をスローします。

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Generator::current
type: function
doc:
<comment>Description:</comment>
  yield した値を取得する

<comment>Return:</comment>
  <info>mixed</info>  yield した値を返します。


id: Generator::getReturn
type: function
doc:
<comment>Description:</comment>
  ジェネレータの戻り値を取得する

<comment>Return:</comment>
  <info>mixed</info>  ジェネレータの実行が終了すると、その戻り値を返します。


id: Generator::key
type: function
doc:
<comment>Description:</comment>
  yield したキーを取得する
  
  yield した値のキーを取得します。

<comment>Return:</comment>
  <info>mixed</info>  yield したキーを返します。


id: Generator::next
type: function
doc:
<comment>Description:</comment>
  ジェネレータを続行する
  
  Generator::next のコールは、 <info>null</info> を引数として Generator::send をコールすることと同じ効果がありま
  す。

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Generator::rewind
type: function
doc:
<comment>Description:</comment>
  イテレータを巻き戻す
  
  既に処理が始まっている場合は、例外をスローします。

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Generator::send
type: function
doc:
<comment>Description:</comment>
  値をジェネレータに送る
  
  指定した値を yield の結果としてジェネレータに送り、ジェネレータを続行します。
  
  ジェネレータが yield 式を指していないときにこのメソッドが呼ばれると、 まずは最初の yield 式まで進
  めてから値を送信します。そのため、 最初のジェネレータを指すためにわざわざ Generator::next を呼ぶ必
  要はありません (Python と同じです)。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  ジェネレータに送り込む値。この値が、ジェネレータが現在指している yield 式の戻り値に
                 なります。

<comment>Return:</comment>
  <info>mixed</info>  yield した値を返します。


id: Generator::throw
type: function
doc:
<comment>Description:</comment>
  例外をジェネレータにスローする
  
  例外をジェネレータにスローして、ジェネレータを続行します。 この振る舞いは、現在の yield 式の部分を
  <return>throw $exception</return> 文に置き換えたのと同じになります。
  
  このメソッドの起動時に既にジェネレータが閉じられている場合は、呼び出し側のコンテキストに例外がス
  ローされます。

<comment>Param:</comment>
  <info>Throwable</info>  <strong>$exception</strong>  ジェネレータにスローする例外。

<comment>Return:</comment>
  <info>mixed</info>  yield した値を返します。


id: Generator::valid
type: function
doc:
<comment>Description:</comment>
  イテレータが終了したかどうかを調べる

<comment>Return:</comment>
  <info>bool</info>  イテレータが終了した場合に <info>false</info> を返します。まだ終了していない場合は <info>true</info> を返します。


id: GlobIterator::__construct
type: function
doc:
<comment>Description:</comment>
  glob を使うディレクトリを作成する
  
  glob 式から新しいディレクトリイテレータを作成します。

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  <strong>glob()</strong> 関数に渡すパターン
  <info>int</info>     <strong>$flags</strong>    オプションのフラグ。 <class>FilesystemIterator</class> 定数のビットマスクとなります。

<comment>See Also:</comment>
   * DirectoryIterator::__construct
   * GlobIterator::count
   * <strong>glob()</strong>


id: GlobIterator::count
type: function
doc:
<comment>Description:</comment>
  ディレクトリやファイルの数を取得する
  
  glob 式から見つかったディレクトリやファイルの数を取得します。

<comment>Return:</comment>
  <info>int</info>  返されたディレクトリやファイルの数を <info>int</info> で返します。

<comment>See Also:</comment>
   * GlobIterator::__construct
   * <strong>count()</strong>
   * <strong>glob()</strong>


id: Gmagick::COMPOSITE_ATOP
type: constant
doc:
<comment>Description:</comment>
  The result is the same shape as image, with composite image obscuring image where the image shapes
  overlap


id: Gmagick::COMPOSITE_BUMPMAP
type: constant
doc:
<comment>Description:</comment>
  The same as COMPOSITE_MULTIPLY, except the source is converted to grayscale first.


id: Gmagick::COMPOSITE_DIFFERENCE
type: constant
doc:
<comment>Description:</comment>
  Subtracts the darker of the two constituent colors from the lighter


id: Gmagick::COMPOSITE_DSTATOP
type: constant
doc:
<comment>Description:</comment>
  The part of the destination lying inside of the source is composited over the source and replaces
  the destination


id: Gmagick::COMPOSITE_EXCLUSION
type: constant
doc:
<comment>Description:</comment>
  Produces an effect similar to that of Gmagick::COMPOSITE_DIFFERENCE, but appears as lower contrast


id: Gmagick::COMPOSITE_HARDLIGHT
type: constant
doc:
<comment>Description:</comment>
  Multiplies or screens the colors, dependent on the source color value


id: Gmagick::COMPOSITE_MODULATE
type: constant
doc:
<comment>Description:</comment>
  Modulates the target brightness, saturation and hue as defined by source


id: Gmagick::COMPOSITE_SCREEN
type: constant
doc:
<comment>Description:</comment>
  The source and destination are complemented and then multiplied and then replace the destination


id: Gmagick::COMPOSITE_SRCATOP
type: constant
doc:
<comment>Description:</comment>
  The part of the source lying inside of the destination is composited onto the destination


id: Gmagick::COMPOSITE_SRCIN
type: constant
doc:
<comment>Description:</comment>
  The part of the source lying inside of the destination replaces the destination


id: Gmagick::COMPOSITE_SRCOUT
type: constant
doc:
<comment>Description:</comment>
  The part of the source lying outside of the destination replaces the destination


id: Gmagick::COMPOSITE_SUBTRACT
type: constant
doc:
<comment>Description:</comment>
  Subtract the colors in the source image from the destination image


id: Gmagick::COMPOSITE_THRESHOLD
type: constant
doc:
<comment>Description:</comment>
  The source is composited on the target as defined by source threshold


id: Gmagick::COMPOSITE_XOR
type: constant
doc:
<comment>Description:</comment>
  The part of the source that lies outside of the destination is combined with the part of the
  destination that lies outside of the source


id: Gmagick::__construct
type: function
doc:
<comment>Description:</comment>
  Gmagick のコンストラクタ
  
  <class>Gmagick</class> のコンストラクタです。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  読み込みたい画像へのパス、あるいは複数のパスの配列。


id: Gmagick::addimage
type: function
doc:
<comment>Description:</comment>
  新しい画像を Gmagick オブジェクトの画像リストに追加する
  
  新しい画像を、ソースオブジェクトの現在位置から Gmagick オブジェクトに追加します。 この操作の後は、
  イテレータの位置がリストの末尾に移動します。

<comment>Param:</comment>
  <info>Gmagick</info>  <strong>$source</strong>  ソース Gmagick オブジェクト。

<comment>Return:</comment>
  <info>Gmagick</info>  Gmagick オブジェクトに画像を追加して返します。


id: Gmagick::addnoiseimage
type: function
doc:
<comment>Description:</comment>
  ランダムなノイズを画像に追加する
  
  ランダムなノイズを画像に追加します。

<comment>Param:</comment>
  <info>int</info>  <strong>$noise_type</strong>  ノイズの形式。 ノイズ定数 の一覧を参照ください。

<comment>Return:</comment>
  <info>Gmagick</info>  Gmagick オブジェクトにノイズを追加して返します。


id: Gmagick::annotateimage
type: function
doc:
<comment>Description:</comment>
  画像にテキストによる注記を加える
  
  テキストによる注記を画像に加えます。

<comment>Param:</comment>
  <info>GmagickDraw</info>  <strong>$GmagickDraw</strong>  テキスト描画設定を含む <class>GmagickDraw</class> オブジェクト。
  <info>float</info>        <strong>$x</strong>            テキストの左端の水平オフセットをあらわすピクセル数。
  <info>float</info>        <strong>$y</strong>            テキストのベースラインの垂直オフセットをあらわすピクセル数。
  <info>float</info>        <strong>$angle</strong>        テキストを書き出す角度。
  <info>string</info>       <strong>$text</strong>         描画するテキスト。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトに注記を加えて返します。


id: Gmagick::blurimage
type: function
doc:
<comment>Description:</comment>
  blur (にじみ) フィルタを画像に追加する
  
  blur (にじみ) フィルタを画像に追加します。

<comment>Param:</comment>
  <info>float</info>  <strong>$radius</strong>  にじみの半径。
  <info>float</info>  <strong>$sigma</strong>   標準偏差。

<comment>Return:</comment>
  <info>Gmagick</info>  にじませた <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::borderimage
type: function
doc:
<comment>Description:</comment>
  画像の周りを枠線で囲む
  
  画像の周りを枠線で囲みます。枠線の色は <class>GmagickPixel</class> オブジェクトあるいは色文字列で指定します。

<comment>Param:</comment>
  <info>GmagickPixel</info>  <strong>$color</strong>   枠線の色を含む <class>GmagickPixel</class> オブジェクトあるいは文字列。
  <info>int</info>           <strong>$width</strong>   枠線の幅。
  <info>int</info>           <strong>$height</strong>  枠線の高さ。

<comment>Return:</comment>
  <info>Gmagick</info>  枠線を定義した <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::charcoalimage
type: function
doc:
<comment>Description:</comment>
  木炭画をシミュレートする
  
  木炭画をシミュレートします。

<comment>Param:</comment>
  <info>float</info>  <strong>$radius</strong>  ガウス分布の半径。中心を含まないピクセル数。
  <info>float</info>  <strong>$sigma</strong>   ガウス分布の標準偏差 (ピクセル単位)。

<comment>Return:</comment>
  <info>Gmagick</info>  木炭画をシミュレートした <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::chopimage
type: function
doc:
<comment>Description:</comment>
  画像の一部を取り除き、切り詰める
  
  画像の一部を削除し、そこにあった画像をなくします。

<comment>Param:</comment>
  <info>int</info>  <strong>$width</strong>   切り取る範囲の幅。
  <info>int</info>  <strong>$height</strong>  切り取る範囲の高さ。
  <info>int</info>  <strong>$x</strong>       切り取る範囲の X 座標。
  <info>int</info>  <strong>$y</strong>       切り取る範囲の Y 座標。

<comment>Return:</comment>
  <info>Gmagick</info>  切り取った後の <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::clear
type: function
doc:
<comment>Description:</comment>
  Gmagick オブジェクトに関連付けられたすべてのリソースをクリアする
  
  <class>Gmagick</class> オブジェクトに関連付けられたすべてのリソースをクリアします。

<comment>Return:</comment>
  <info>Gmagick</info>  クリアした <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::commentimage
type: function
doc:
<comment>Description:</comment>
  コメントを画像に追加する
  
  コメントを画像に追加します。

<comment>Param:</comment>
  <info>string</info>  <strong>$comment</strong>  追加するコメント。

<comment>Return:</comment>
  <info>Gmagick</info>  コメントを追加した <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::compositeimage
type: function
doc:
<comment>Description:</comment>
  ある画像を別の画像に合成する
  
  ある画像を、別の画像の指定した位置に合成します。

<comment>Param:</comment>
  <info>Gmagick</info>  <strong>$source</strong>   合成する画像を保持する <class>Gmagick</class> オブジェクト。
  <info></info>         <strong>$compose</strong>  合成演算子。
  <info>int</info>      <strong>$x</strong>        合成する位置の列オフセット。
  <info>int</info>      <strong>$y</strong>        合成する位置の行オフセット。

<comment>Return:</comment>
  <info>Gmagick</info>  合成した <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::cropimage
type: function
doc:
<comment>Description:</comment>
  画像の一部を抽出する
  
  画像の一部を抽出します。

<comment>Param:</comment>
  <info>int</info>  <strong>$width</strong>   抽出する幅。
  <info>int</info>  <strong>$height</strong>  抽出する高さ。
  <info>int</info>  <strong>$x</strong>       抽出する領域の左上の X 座標。
  <info>int</info>  <strong>$y</strong>       抽出する領域の左上の Y 座標。

<comment>Return:</comment>
  <info>Gmagick</info>  抽出した <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::cropthumbnailimage
type: function
doc:
<comment>Description:</comment>
  切り取ってサムネイルを作成する
  
  固定サイズのサムネイルを作成します。 まず画像のサイズを拡大あるいは縮小し、指定した範囲を中心から
  切り取ります。

<comment>Param:</comment>
  <info>int</info>  <strong>$width</strong>   サムネイルの幅。
  <info>int</info>  <strong>$height</strong>  サムネイルの高さ。

<comment>Return:</comment>
  <info>Gmagick</info>  切り取った <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::current
type: function
doc:
<comment>Description:</comment>
  現在の Gmagick オブジェクトへの参照を返す
  
  現在の gmagick オブジェクトへの参照を返し、 画像ポインタを正しいシーケンスに設定します。

<comment>Return:</comment>
  <info>Gmagick</info>  成功した場合に自分自身を返します。


id: Gmagick::cyclecolormapimage
type: function
doc:
<comment>Description:</comment>
  画像のカラーマップを移動する
  
  位置番号を指定して、画像のカラーマップを移動します。 カラーマップを何度か回転させると、サイケデ
  リックな効果が得られます。

<comment>Param:</comment>
  <info>int</info>  <strong>$displace</strong>  カラーマップを移動させる量。

<comment>Return:</comment>
  <info>Gmagick</info>  成功した場合に自分自身を返します。


id: Gmagick::deconstructimages
type: function
doc:
<comment>Description:</comment>
  画像間の特定のピクセルの差を返す
  
  各画像をシーケンス内の次の画像と比較し、 最大の境界範囲を返します。

<comment>Return:</comment>
  <info>Gmagick</info>  新しい <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::despeckleimage
type: function
doc:
<comment>Description:</comment>
  画像内のスペックルノイズを軽減する
  
  画像内のスペックルノイズを軽減します。ただし元画像の輪郭は保持します。

<comment>Return:</comment>
  <info>Gmagick</info>  スペックルノイズを軽減した <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::destroy
type: function
doc:
<comment>Description:</comment>
  Gmagick オブジェクトを破棄する
  
  <class>Gmagick</class> オブジェクトを破棄し、 関連するリソースをすべて解放します。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: Gmagick::drawimage
type: function
doc:
<comment>Description:</comment>
  現在の画像上の GmagickDraw オブジェクトをレンダリングする
  
  現在の画像上の <class>GmagickDraw</class> オブジェクトをレンダリングします。

<comment>Param:</comment>
  <info>GmagickDraw</info>  <strong>$GmagickDraw</strong>  画像をレンダリングする描画操作。

<comment>Return:</comment>
  <info>Gmagick</info>  描かれた <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::edgeimage
type: function
doc:
<comment>Description:</comment>
  画像の輪郭を強調する
  
  指定した半径の畳み込みフィルタを使用して、画像の輪郭を強調します。 radius に 0 を設定すると自動選
  択となります。

<comment>Param:</comment>
  <info>float</info>  <strong>$radius</strong>  操作の半径。

<comment>Return:</comment>
  <info>Gmagick</info>  輪郭を強調した <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::embossimage
type: function
doc:
<comment>Description:</comment>
  グレースケール画像に三次元効果を施して返す
  
  グレースケール画像に三次元効果を施したものを返します。 指定した半径と標準偏差 (シグマ) によるガウ
  ス演算によって画像を畳み込みます。 意味のある結果を得るには、半径がシグマより大きくなければなりま
  せん。 radius に 0 を指定すると、適切な半径を自動的に設定します。

<comment>Param:</comment>
  <info>float</info>  <strong>$radius</strong>  効果の半径。
  <info>float</info>  <strong>$sigma</strong>   効果のシグマ。

<comment>Return:</comment>
  <info>Gmagick</info>  エンボス処理した <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::enhanceimage
type: function
doc:
<comment>Description:</comment>
  ノイジーな画像の品質を向上させる
  
  デジタルフィルタを適用して、ノイジーな画像の品質を向上させます。

<comment>Return:</comment>
  <info>Gmagick</info>  品質を向上させた <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::equalizeimage
type: function
doc:
<comment>Description:</comment>
  画像ヒストグラムを均等化する
  
  画像ヒストグラムを均等化します。

<comment>Return:</comment>
  <info>Gmagick</info>  均等化した <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::flipimage
type: function
doc:
<comment>Description:</comment>
  垂直方向に反転した画像を作成する
  
  中心の x 軸を基準してピクセルを反転させ、垂直方向のミラー画像を作成します。

<comment>Return:</comment>
  <info>Gmagick</info>  垂直反転した <class>Gmagick</class> オブジェクトを返します。

<comment>See Also:</comment>
   * <strong>Gmagick::flopimage()</strong>


id: Gmagick::flopimage
type: function
doc:
<comment>Description:</comment>
  水平方向に反転した画像を作成する
  
  中心の y 軸を基準してピクセルを反転させ、水平方向のミラー画像を作成します。

<comment>Return:</comment>
  <info>Gmagick</info>  垂直反転した <class>Gmagick</class> オブジェクトを返します。

<comment>See Also:</comment>
   * <strong>Gmagick::flipimage()</strong>


id: Gmagick::frameimage
type: function
doc:
<comment>Description:</comment>
  三次元の枠線をシミュレートする
  
  画像の周りに三次元の枠線を追加します。 width と height で、それぞれ縦の枠線と横の枠線の幅を指定し
  ます。 inner_bevel および outer_bevel は、 それぞれ枠の内側と外側の影の幅を指定します。

<comment>Param:</comment>
  <info>GmagickPixel</info>  <strong>$color</strong>        マット色を表す <class>GmagickPixel</class> オブジェクトあるいは浮動小数点数。
  <info>int</info>           <strong>$width</strong>        枠の幅。
  <info>int</info>           <strong>$height</strong>       枠の高さ。
  <info>int</info>           <strong>$inner_bevel</strong>  内側の影の幅。
  <info>int</info>           <strong>$outer_bevel</strong>  外側の影の幅。

<comment>Return:</comment>
  <info>Gmagick</info>  枠線をつけた <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::gammaimage
type: function
doc:
<comment>Description:</comment>
  画像をガンマ補正する
  
  画像をガンマ補正します。同じ画像でも、 異なるデバイス上で見ると見た目が変わることがあります。 これ
  は、画面上に画像の輝度を表現する方法がことなるためです。 赤、緑、青の各チャネルに個別のガンマレベ
  ルを指定するか、 あるいはすべてのチャネルに共通のガンマレベルを指定します。 値の典型的な範囲は、
  0.8 から 2.3 の間となります。

<comment>Param:</comment>
  <info>float</info>  <strong>$gamma</strong>  ガンマ補正の量。

<comment>Return:</comment>
  <info>Gmagick</info>  ガンマ補正した <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::getcopyright
type: function
doc:
<comment>Description:</comment>
  GraphicsMagick API の著作権情報を文字列で返す
  
  GraphicsMagick API の著作権情報を文字列で返します。

<comment>Return:</comment>
  <info>string</info>  GraphicsMagick および Magickwand C API の著作権情報を含む文字列を返します。


id: Gmagick::getfilename
type: function
doc:
<comment>Description:</comment>
  画像シーケンスに関連付けられたファイル名を取得する
  
  画像シーケンスに関連付けられたファイル名を取得します。

<comment>Return:</comment>
  <info>string</info>  成功した場合に文字列を返します。


id: Gmagick::getimagebackgroundcolor
type: function
doc:
<comment>Description:</comment>
  画像の背景色を返す
  
  画像の背景色を返します。

<comment>Return:</comment>
  <info>GmagickPixel</info>  画像の背景色を設定した GmagickPixel を返します。


id: Gmagick::getimageblueprimary
type: function
doc:
<comment>Description:</comment>
  青が一番強い点を返す
  
  青が一番強い点を返します。

<comment>Param:</comment>
  <info></info>  <strong>$x</strong>  青が一番強い点の x 座標。
  <info></info>  <strong>$y</strong>  青が一番強い点の y 座標。

<comment>Return:</comment>
  <info>array</info>  "x" 座標および "y" 座標を含む配列を返します。


id: Gmagick::getimagebordercolor
type: function
doc:
<comment>Description:</comment>
  画像の前景色を返す
  
  画像の前景色を返します。

<comment>Return:</comment>
  <info>GmagickPixel</info>  画像の前景色を表す <class>GmagickPixel</class> オブジェクトを返します。


id: Gmagick::getimagechanneldepth
type: function
doc:
<comment>Description:</comment>
  特定の画像チャネルの深度を返す
  
  特定の画像チャネルの深度を返します。

<comment>Return:</comment>
  <info>int</info>  画像チャネルの深度を返します。


id: Gmagick::getimagecolors
type: function
doc:
<comment>Description:</comment>
  指定した色マップインデックスの色を返す
  
  指定した色マップインデックスの色を返します。

<comment>Return:</comment>
  <info>int</info>  画像内の色の数を返します。


id: Gmagick::getimagecolorspace
type: function
doc:
<comment>Description:</comment>
  画像の色空間を取得する
  
  画像の色空間を取得します。

<comment>Return:</comment>
  <info>int</info>  色空間を返します。


id: Gmagick::getimagecompose
type: function
doc:
<comment>Description:</comment>
  画像の合成演算子を返す
  
  画像に関連付けられている合成演算子を返します。

<comment>Return:</comment>
  <info>int</info>  画像に関連付けられている合成演算子を返します。


id: Gmagick::getimagedelay
type: function
doc:
<comment>Description:</comment>
  画像の遅延を取得する
  
  画像の遅延を取得します。

<comment>Return:</comment>
  <info>int</info>  画像の遅延を返します。


id: Gmagick::getimagedepth
type: function
doc:
<comment>Description:</comment>
  画像の深度を取得する
  
  画像の深度を取得します。

<comment>Return:</comment>
  <info>int</info>  画像の深度を返します。


id: Gmagick::getimagedispose
type: function
doc:
<comment>Description:</comment>
  画像の配置方法を取得する
  
  画像の配置方法を取得します。

<comment>Return:</comment>
  <info>int</info>  画像の配置方法を返します。


id: Gmagick::getimageextrema
type: function
doc:
<comment>Description:</comment>
  画像の極値を取得する
  
  画像の極値を取得します。 "min" および "max" というキーを持つ連想配列を返します。

<comment>Return:</comment>
  <info>array</info>  "min" および "max" というキーを持つ連想配列を返します。


id: Gmagick::getimagefilename
type: function
doc:
<comment>Description:</comment>
  シーケンス内の特定の画像のファイル名を返す
  
  シーケンス内の特定の画像のファイル名を返します。

<comment>Return:</comment>
  <info>string</info>  画像のファイル名を文字列で返します。


id: Gmagick::getimageformat
type: function
doc:
<comment>Description:</comment>
  シーケンス内の特定の画像のフォーマットを返す
  
  シーケンス内の特定の画像のフォーマットを返します。

<comment>Return:</comment>
  <info>string</info>  成功した場合は画像のフォーマットを文字列で返します。


id: Gmagick::getimagegamma
type: function
doc:
<comment>Description:</comment>
  画像のガンマを取得する
  
  画像のガンマを取得します。

<comment>Return:</comment>
  <info>float</info>  成功した場合にガンマを返します。


id: Gmagick::getimagegreenprimary
type: function
doc:
<comment>Description:</comment>
  緑が一番強い点を返す
  
  緑が一番強い点を返します。"x" および "y" というキーを持つ配列を返します。

<comment>Return:</comment>
  <info>array</info>  成功した場合に "x" および "y" というキーを持つ配列を返します。


id: Gmagick::getimageheight
type: function
doc:
<comment>Description:</comment>
  画像の高さを返す
  
  画像の高さを返します。

<comment>Return:</comment>
  <info>int</info>  画像の高さをピクセル数で返します。


id: Gmagick::getimagehistogram
type: function
doc:
<comment>Description:</comment>
  画像のヒストグラムを取得する
  
  画像のヒストグラムを <class>GmagickPixel</class> オブジェクトの配列で返します。 エラーが起きた場合は
  <class>GmagickException</class> をスローします。

<comment>Return:</comment>
  <info>array</info>  画像のヒストグラムを <class>GmagickPixel</class> オブジェクトの配列で返します。


id: Gmagick::getimageindex
type: function
doc:
<comment>Description:</comment>
  現在アクティブな画像のインデックスを取得する
  
  <class>Gmagick</class> オブジェクト内で現在アクティブな画像のインデックスを取得します。

<comment>Return:</comment>
  <info>int</info>  現在アクティブな画像のインデックスを返します。


id: Gmagick::getimageinterlacescheme
type: function
doc:
<comment>Description:</comment>
  画像のインターレース手法を取得する
  
  画像のインターレース手法を取得します。

<comment>Return:</comment>
  <info>int</info>  成功した場合に画像のインターレース手法を返します。


id: Gmagick::getimageiterations
type: function
doc:
<comment>Description:</comment>
  画像の反復を取得する
  
  画像の反復を取得します。

<comment>Return:</comment>
  <info>int</info>  画像の反復を表す整数値を返します。


id: Gmagick::getimagematte
type: function
doc:
<comment>Description:</comment>
  画像がマットチャネルを持っているかどうかを調べる
  
  画像がマットチャネルを持っている場合に <info>true</info>、 そうでない場合に <info>false</info> を返します。

<comment>Return:</comment>
  <info>int</info>  画像がマットチャネルを持っている場合に <info>true</info>、 そうでない場合に <info>false</info> を返します。


id: Gmagick::getimagemattecolor
type: function
doc:
<comment>Description:</comment>
  画像のマット色を返す
  
  成功した場合に GmagickPixel オブジェクトを返します。エラー時に GmagickException をスローします。

<comment>Return:</comment>
  <info>GmagickPixel</info>  成功した場合に GmagickPixel オブジェクトを返します。


id: Gmagick::getimageprofile
type: function
doc:
<comment>Description:</comment>
  指定した名前の画像プロファイルを返す
  
  指定した名前の画像プロファイルを返します。

<comment>Return:</comment>
  <info>string</info>  画像プロファイルを含む文字列を返します。


id: Gmagick::getimageredprimary
type: function
doc:
<comment>Description:</comment>
  赤が一番強い点を返す
  
  赤が一番強い点を返します。"x" および "y" というキーを持つ配列を返します。

<comment>Return:</comment>
  <info>array</info>  赤が一番強い点を "x" および "y" というキーを持つ配列で返します。


id: Gmagick::getimagerenderingintent
type: function
doc:
<comment>Description:</comment>
  画像のレンダリング方向を取得する
  
  画像のレンダリング方向を取得します。

<comment>Return:</comment>
  <info>int</info>  画像のレンダリング方向を返します。


id: Gmagick::getimageresolution
type: function
doc:
<comment>Description:</comment>
  画像の X 方向と Y 方向の解像度を取得する
  
  解像度を配列で取得します。

<comment>Return:</comment>
  <info>array</info>  解像度を配列で返します。


id: Gmagick::getimagescene
type: function
doc:
<comment>Description:</comment>
  画像のシーンを取得する
  
  画像のシーンを取得します。

<comment>Return:</comment>
  <info>int</info>  画像のシーンを返します。


id: Gmagick::getimagesignature
type: function
doc:
<comment>Description:</comment>
  SHA-256 メッセージダイジェストを生成する
  
  画像ピクセルストリームの SHA-256 メッセージダイジェストを生成します。

<comment>Return:</comment>
  <info>string</info>  そのファイルの SHA-256 ハッシュを文字列で返します。


id: Gmagick::getimagetype
type: function
doc:
<comment>Description:</comment>
  画像の型を取得する
  
  画像の型を取得します。

<comment>Return:</comment>
  <info>int</info>  画像の型を返します。


id: Gmagick::getimageunits
type: function
doc:
<comment>Description:</comment>
  画像の解像度の単位を取得する
  
  画像の解像度の単位を取得します。

<comment>Return:</comment>
  <info>int</info>  画像の解像度の単位を返します。


id: Gmagick::getimagewhitepoint
type: function
doc:
<comment>Description:</comment>
  色度が白い点を返す
  
  色度が白い点を返します。 "x" および "y" というキーを持つ連想配列となります。

<comment>Return:</comment>
  <info>array</info>  色度が白い点を返します。 "x" および "y" というキーを持つ連想配列となります。


id: Gmagick::getimagewidth
type: function
doc:
<comment>Description:</comment>
  画像の幅を返す
  
  画像の幅を返します。

<comment>Return:</comment>
  <info>int</info>  画像の幅を返します。


id: Gmagick::getpackagename
type: function
doc:
<comment>Description:</comment>
  GraphicsMagick パッケージ名を返す
  
  GraphicsMagick パッケージ名を返します。

<comment>Return:</comment>
  <info>string</info>  GraphicsMagick パッケージ名を文字列で返します。


id: Gmagick::getquantumdepth
type: function
doc:
<comment>Description:</comment>
  Gmagick quantum depth を返す
  
  <class>Gmagick</class> quantum depth を文字列で返します。

<comment>Return:</comment>
  <info>array</info>  <class>Gmagick</class> quantum depth を文字列で返します。


id: Gmagick::getreleasedate
type: function
doc:
<comment>Description:</comment>
  GraphicsMagick のリリース日を返す
  
  GraphicsMagick のリリース日を文字列で返します。

<comment>Return:</comment>
  <info>string</info>  GraphicsMagick のリリース日を文字列で返します。


id: Gmagick::getsamplingfactors
type: function
doc:
<comment>Description:</comment>
  水平方向および垂直方向のサンプリング係数を取得する
  
  水平方向および垂直方向のサンプリング係数を取得します。

<comment>Return:</comment>
  <info>array</info>  画像の水平方向および垂直方向のサンプリング係数を含む連想配列を返します。


id: Gmagick::getsize
type: function
doc:
<comment>Description:</comment>
  Gmagick オブジェクトのサイズを取得する
  
  <class>Gmagick</class> オブジェクトのサイズを返します。 "columns" および "rows" というキーを持つ連想配列となりま
  す。

<comment>Return:</comment>
  <info>array</info>  <class>Gmagick</class> オブジェクトのサイズを返します。 "columns" および "rows" というキーを持つ連想配列と
         なります。


id: Gmagick::getversion
type: function
doc:
<comment>Description:</comment>
  GraphicsMagick API のバージョンを返す
  
  GraphicsMagick API のバージョンを文字列と数値で返します。

<comment>Return:</comment>
  <info>array</info>  GraphicsMagick API のバージョンを文字列と数値で返します。


id: Gmagick::hasnextimage
type: function
doc:
<comment>Description:</comment>
  オブジェクトが次の画像を保持しているかどうかを調べる
  
  リスト内でひとつ先に進んだときにまだオブジェクトが画像を保持していれば <info>true</info> を返します。

<comment>Return:</comment>
  <info>mixed</info>  リスト内でひとつ先に進んだときにまだオブジェクトが画像を保持していれば <info>true</info>、していなければ
         <info>false</info> を返します。


id: Gmagick::haspreviousimage
type: function
doc:
<comment>Description:</comment>
  オブジェクトが前の画像を保持しているかどうかを調べる
  
  リスト内で逆方向にひとつ進んだときにまだオブジェクトが画像を保持していれば <info>true</info> を返します。

<comment>Return:</comment>
  <info>mixed</info>  リスト内で逆方向にひとつ進んだときにまだオブジェクトが画像を保持していれば <info>true</info>、していなけ
         れば <info>false</info> を返します。


id: Gmagick::implodeimage
type: function
doc:
<comment>Description:</comment>
  新しい画像をコピーとして作成する
  
  既存の画像をコピーして新しい画像を作成します。 既存の画像のピクセルを、指定したパーセンテージで
  "内破" します。

<comment>Param:</comment>
  <info>float</info>  <strong>$radius</strong>  内破処理の半径。

<comment>Return:</comment>
  <info>mixed</info>  内破した <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::labelimage
type: function
doc:
<comment>Description:</comment>
  ラベルを画像に追加する
  
  ラベルを画像に追加します。

<comment>Param:</comment>
  <info>string</info>  <strong>$label</strong>  追加するラベル。

<comment>Return:</comment>
  <info>mixed</info>  ラベルを追加した Gmagick オブジェクトを返します。


id: Gmagick::levelimage
type: function
doc:
<comment>Description:</comment>
  画像のレベルを調節する
  
  画像のレベルを調整します。 指定した白と黒の範囲にある色を、利用可能な色の範囲全体に拡大します。 黒
  の点、中間点、白の点をパラメータで指定します。 黒の点は、画像の中で一番暗い色を表します。 これより
  暗い色の点はゼロに設定されます。 中間点は、画像に適用するガンマ補正を指定します。 黒の点は、画像の
  中で一番明るい色を表します。 これより明るい色の点は最大値に設定されます。

<comment>Param:</comment>
  <info>float</info>  <strong>$blackPoint</strong>  画像の黒の点。
  <info>float</info>  <strong>$gamma</strong>       ガンマ値。
  <info>float</info>  <strong>$whitePoint</strong>  画像の白の点。
  <info>int</info>    <strong>$channel</strong>     チャネルモードに対応したチャネル定数を指定します。 複数のチャネルに適用するに
                      は、 ビット演算子でチャネル型定数を組み合わせます。 チャネル定数 の一覧を参照
                      ください。

<comment>Return:</comment>
  <info>mixed</info>  画像のレベルを調節した <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::magnifyimage
type: function
doc:
<comment>Description:</comment>
  画像を二倍に比例拡大する
  
  画像を元のサイズの二倍に比例拡大します。

<comment>Return:</comment>
  <info>mixed</info>  拡大した <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::mapimage
type: function
doc:
<comment>Description:</comment>
  画像の色を、参照画像の中の最も近い色に置き換える
  
  画像の色を、参照画像の中の最も近い色に置き換えます。

<comment>Param:</comment>
  <info>gmagick</info>  <strong>$gmagick</strong>  参照する画像。
  <info>bool</info>     <strong>$dither</strong>   ゼロ以外の整数値を設定して、マップした画像をディザリングします。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::medianfilterimage
type: function
doc:
<comment>Description:</comment>
  デジタルフィルタを適用する
  
  デジタルフィルタを適用してノイジーな画像の品質を向上させます。 各ピクセルの内容を、radius で定義し
  た近傍ピクセルの中央値で置き換えます。

<comment>Param:</comment>
  <info>float</info>  <strong>$radius</strong>  近傍ピクセルの半径。

<comment>Return:</comment>
  <info>void</info>  メジアンフィルタを適用した <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::minifyimage
type: function
doc:
<comment>Description:</comment>
  画像をその半分のサイズに比例縮小する
  
  画像のサイズを元の半分に比例縮小します。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::modulateimage
type: function
doc:
<comment>Description:</comment>
  明度、彩度、色相を制御する
  
  画像の明度、彩度、色相を制御します。 色相は、現在位置からの絶対回転角のパーセンテージで表します。
  たとえば 50 の場合は反時計回りに 90 度の回転を表します。 また 150 の場合は時計回りの 90 度の回転、
  0 および 200 はともに 180 度の回転を表します。

<comment>Param:</comment>
  <info>float</info>  <strong>$brightness</strong>  画像の明度 (-100 から +100)。
  <info>float</info>  <strong>$saturation</strong>  画像の彩度 (-100 から +100)。
  <info>float</info>  <strong>$hue</strong>         画像の色相 (-100 から +100)。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::motionblurimage
type: function
doc:
<comment>Description:</comment>
  モーションブラーをシミュレートする
  
  モーションブラーをシミュレートします。 指定した半径と標準偏差 (シグマ) によるガウス演算によって画
  像を畳み込みます。 意味のある結果を得るには、半径がシグマより大きくなければなりません。 radius に
  0 を指定すると、 Gmagick::motionblurimage が適切な半径を自動的に設定します。 angle にはぼかしをか
  ける角度を指定します。

<comment>Param:</comment>
  <info>float</info>  <strong>$radius</strong>  ガウス演算の半径。ピクセル単位で指定し、中心は計算に入れません。
  <info>float</info>  <strong>$sigma</strong>   ガウス演算の標準偏差。ピクセル単位で指定します。
  <info>float</info>  <strong>$angle</strong>   この角度で効果を適用します。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::newimage
type: function
doc:
<comment>Description:</comment>
  新しい画像を作成する
  
  新しい画像を作成し、背景色を設定します。

<comment>Param:</comment>
  <info>int</info>     <strong>$width</strong>       新しい画像の幅。
  <info>int</info>     <strong>$height</strong>      新しい画像の高さ。
  <info>string</info>  <strong>$background</strong>  この画像で使う背景色 (浮動小数点数)。
  <info>string</info>  <strong>$format</strong>      画像フォーマット。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::nextimage
type: function
doc:
<comment>Description:</comment>
  次の画像に移動する
  
  画像リスト内の次の画像を <class>Gmagick</class> オブジェクトに関連付けます。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: Gmagick::normalizeimage
type: function
doc:
<comment>Description:</comment>
  カラー画像のコントラストを強調する
  
  カラー画像のコントラストを強調します。 ピクセルの色を、とりうる値の範囲全体に拡張します。

<comment>Param:</comment>
  <info>int</info>  <strong>$channel</strong>  どのチャネルを正規化するか。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::oilpaintimage
type: function
doc:
<comment>Description:</comment>
  油絵をシミュレートする
  
  油絵風の効果を施すフィルタを適用します。 各ピクセルが、指定した半径内の周囲の中で最もよくあらわれ
  る色に置き換えられます。

<comment>Param:</comment>
  <info>float</info>  <strong>$radius</strong>  近傍円の半径。

<comment>Return:</comment>
  <info>Gmagick</info>  成功した場合に Gmagick オブジェクトを返します。


id: Gmagick::previousimage
type: function
doc:
<comment>Description:</comment>
  オブジェクト内の前の画像に移動する
  
  画像リスト内の前の画像を Gmagick オブジェクトに関連付けます。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: Gmagick::profileimage
type: function
doc:
<comment>Description:</comment>
  画像のプロファイルを追加あるいは削除する
  
  ICC、IPTC あるいは汎用のプロファイルを画像に追加あるいは削除します。 profile が <info>null</info> の場合は画像
  からプロファイルを削除し、 それ以外の場合は追加します。 name に <return>*</return>、profile に <info>null</info> を指定すると、
  画像からすべてのプロパティを削除します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>     追加あるいは削除するプロファイルの名前。ICC、IPTC、あるいは generic。
  <info>string</info>  <strong>$profile</strong>  プロファイル。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::quantizeimage
type: function
doc:
<comment>Description:</comment>
  参照画像内の色を解析する
  
  参照画像内の色を解析し、その画像を表すための色を固定の色数で選びます。 そのアルゴリズムの目標は、
  入力画像と出力画像の色の差を最小限に抑えながらも 処理時間を短くすることです。

<comment>Param:</comment>
  <info>int</info>   <strong>$numColors</strong>     色数。
  <info>int</info>   <strong>$colorspace</strong>    この色空間の中で色数を減らす。通常は RGBColorspace。
  <info>int</info>   <strong>$treeDepth</strong>     通常は、この整数値は 0 か 1 になります。 0 あるいは 1 を指定すると、Quantize
                       に最適なツリーの深さとして Log4(number_colors) を選ばせます。 この深さのツ
                       リーは一般に、最小のメモリー消費で最大の計算速度を得られる最良の参照画像表現
                       法になります。 色数が少ないなど、場合によっては Log4(number_colors) 以外の値
                       が必要になることもあります。 色ツリーを完全に広げるには、この値を 8 にしま
                       す。
  <info>bool</info>  <strong>$dither</strong>        ゼロ以外の値を元の画像との間の違いに分配し、 対応する減色アルゴリズムを近傍ピ
                       クセルとのヒルベルト曲線に沿ったものにします。
  <info>bool</info>  <strong>$measureError</strong>  ゼロ以外の値で、元画像と量子化した画像の違いを計測します。 この違いが、全体の
                       量子化エラーになります。 エラーを判定するために、画像内の全ピクセルを計算し、
                       RGB 空間において参照画像と量子化語のピクセルの差を合計します。

<comment>Return:</comment>
  <info>Gmagick</info>  成功した場合に Gmagick オブジェクトを返します。


id: Gmagick::quantizeimages
type: function
doc:
<comment>Description:</comment>
  画像シーケンス内の色を解析する
  
  画像シーケンス内の色を解析し、その画像を表すための色を固定の色数で選びます。 そのアルゴリズムの目
  標は、入力画像と出力画像の色の差を最小限に抑えながらも 処理時間を短くすることです。

<comment>Param:</comment>
  <info>int</info>   <strong>$numColors</strong>     色数。
  <info>int</info>   <strong>$colorspace</strong>    この色空間の中で色数を減らす。通常は RGBColorspace。
  <info>int</info>   <strong>$treeDepth</strong>     通常は、この整数値は 0 か 1 になります。 0 あるいは 1 を指定すると、Quantize
                       に最適なツリーの深さとして Log4(number_colors) を選ばせます。 この深さのツ
                       リーは一般に、最小のメモリー消費で最大の計算速度を得られる最良の参照画像表現
                       法になります。 色数が少ないなど、場合によっては Log4(number_colors) 以外の値
                       が必要になることもあります。 色ツリーを完全に広げるには、この値を 8 にしま
                       す。
  <info>bool</info>  <strong>$dither</strong>        ゼロ以外の値を元の画像との間の違いに分配し、 対応する減色アルゴリズムを近傍ピ
                       クセルとのヒルベルト曲線に沿ったものにします。
  <info>bool</info>  <strong>$measureError</strong>  ゼロ以外の値で、元画像と量子化した画像の違いを計測します。 この違いが、全体の
                       量子化エラーになります。 エラーを判定するために、画像内の全ピクセルを計算し、
                       RGB 空間において参照画像と量子化語のピクセルの差を合計します。

<comment>Return:</comment>
  <info>Gmagick</info>  成功した場合に Gmagick オブジェクトを返します。


id: Gmagick::queryfontmetrics
type: function
doc:
<comment>Description:</comment>
  フォントメトリクスを表す配列を返す
  
  MagickQueryFontMetrics() は、フォントメトリクスを表す多次元配列を返します。

<comment>Return:</comment>
  <info>array</info>  成功した場合に Gmagick オブジェクトを返します。


id: Gmagick::queryfonts
type: function
doc:
<comment>Description:</comment>
  設定したフォントを返す
  
  設定したフォントを返します。

<comment>Return:</comment>
  <info>array</info>  成功した場合に Gmagick オブジェクトを返します。


id: Gmagick::queryformats
type: function
doc:
<comment>Description:</comment>
  Gmagick がサポートするフォーマットを返す
  
  <class>Gmagick</class> がサポートするフォーマットを返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  パターンを含む文字列へのポインタを指定します。

<comment>Return:</comment>
  <info>array</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::radialblurimage
type: function
doc:
<comment>Description:</comment>
  画像にラジアルブラーを施す
  
  画像にラジアルブラーを施します。

<comment>Param:</comment>
  <info>float</info>  <strong>$angle</strong>    ラジアルブラーの角度。
  <info>int</info>    <strong>$channel</strong>  関連するチャネル。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::raiseimage
type: function
doc:
<comment>Description:</comment>
  三次元のボタン風の効果をシミュレートする
  
  画像の輪郭を明るくしたり暗くしたりすることによって、 三次元のボタン風の効果をシミュレートします。
  raise_info のメンバ width および height が、 垂直方向および水平方向の効果の輪郭を定義します。

<comment>Param:</comment>
  <info>int</info>   <strong>$width</strong>   明るくする範囲の幅。
  <info>int</info>   <strong>$height</strong>  明るくする範囲の高さ。
  <info>int</info>   <strong>$x</strong>       X 座標。
  <info>int</info>   <strong>$y</strong>       Y 座標。
  <info>bool</info>  <strong>$raise</strong>   ゼロ以外の値を指定すると三次元の引き上げ効果、ゼロの場合は引き下げ効果。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::read
type: function
doc:
<comment>Description:</comment>
  ファイルから画像を読み込む
  
  ファイルから画像を読み込みます。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  画像ファイル名。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::readimageblob
type: function
doc:
<comment>Description:</comment>
  バイナリ文字列から画像を読み込む
  
  バイナリ文字列から画像を読み込みます。

<comment>Param:</comment>
  <info>string</info>  <strong>$imageContents</strong>  画像の内容。
  <info>string</info>  <strong>$filename</strong>       画像ファイル名。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::readimagefile
type: function
doc:
<comment>Description:</comment>
  オープンしているファイルハンドルから画像を読み込む
  
  オープンしているファイルハンドルから画像を読み込みます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$fp</strong>  ファイルディスクリプタ。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::reducenoiseimage
type: function
doc:
<comment>Description:</comment>
  画像の輪郭をなめらかにする
  
  画像の輪郭をなめらかにします。縁の情報は保持します。 各ピクセルの内容を近傍の一番近い値で置き換え
  るというアルゴリズムです。 近傍は半径で定義します。radius に 0 を指定すると、
  Gmagick::reducenoiseimage が適切な半径を自動的に設定します。

<comment>Param:</comment>
  <info>float</info>  <strong>$radius</strong>  近傍ピクセルの半径。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::removeimage
type: function
doc:
<comment>Description:</comment>
  画像リストから画像を削除する
  
  画像リストから画像を削除します。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::removeimageprofile
type: function
doc:
<comment>Description:</comment>
  指定した名前の画像プロファイルを削除して返す
  
  指定した名前の画像プロファイルを削除して返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  返すプロファイルの名前。ICC、IPTC あるいは generic。

<comment>Return:</comment>
  <info>string</info>  指定した名前のプロファイルを返します。


id: Gmagick::resampleimage
type: function
doc:
<comment>Description:</comment>
  画像を指定した解像度にリサンプリングする
  
  画像を指定した解像度にリサンプリングします。

<comment>Param:</comment>
  <info>float</info>  <strong>$xResolution</strong>  新しい画像の x 方向の解像度。
  <info>float</info>  <strong>$yResolution</strong>  新しい画像の y 方向の解像度。
  <info>int</info>    <strong>$filter</strong>       利用するフィルタ。
  <info>float</info>  <strong>$blur</strong>         blur 要素。&gt; 1 はぼやけた状態、\< 1 はシャープな状態を表します。

<comment>Return:</comment>
  <info>Gmagick</info>  成功した場合に Gmagick オブジェクトを返します。


id: Gmagick::resizeimage
type: function
doc:
<comment>Description:</comment>
  画像のサイズを変更する
  
  指定した大きさとフィルタで、画像のサイズを変更します。

<comment>Param:</comment>
  <info>int</info>    <strong>$width</strong>   画像の幅。
  <info>int</info>    <strong>$height</strong>  画像の高さ。
  <info>int</info>    <strong>$filter</strong>  利用するフィルタ。
  <info>float</info>  <strong>$blur</strong>    blur 要素。&gt; 1 はぼやけた状態、\< 1 はシャープな状態を表します。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::rollimage
type: function
doc:
<comment>Description:</comment>
  画像を補正する
  
  x および y を指定して画像を補正します。

<comment>Param:</comment>
  <info>int</info>  <strong>$x</strong>  x オフセット。
  <info>int</info>  <strong>$y</strong>  y オフセット。

<comment>Return:</comment>
  <info>Gmagick</info>  成功した場合に Gmagick オブジェクトを返します。


id: Gmagick::rotateimage
type: function
doc:
<comment>Description:</comment>
  画像を回転する
  
  指定した角度だけ画像を回転させます。回転によって生じる空き領域は、 背景色で埋められます。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$color</strong>    背景色。
  <info>float</info>  <strong>$degrees</strong>  画像を回転させる度数。

<comment>Return:</comment>
  <info>Gmagick</info>  成功した場合に Gmagick オブジェクトを返します。


id: Gmagick::scaleimage
type: function
doc:
<comment>Description:</comment>
  画像のサイズを変更する
  
  画像のサイズを指定した大きさに変更します。 パラメータに 0 を指定すると、そのパラメータを自動的に計
  算します。

<comment>Param:</comment>
  <info>int</info>  <strong>$width</strong>   変更後の画像の幅。
  <info>int</info>  <strong>$height</strong>  変更後の画像の高さ。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::separateimagechannel
type: function
doc:
<comment>Description:</comment>
  画像からチャネルを分離する
  
  画像からチャネルを分離し、グレースケール画像を返します。 channel には、画像の各ピクセルの特定の色
  コンポーネントを指定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$channel</strong>  チャンネル 定数のうちの一つ。 (<return>Gmagick::CHANNEL_*</return>)

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::setCompressionQuality
type: function
doc:
<comment>Description:</comment>
  オブジェクトのデフォルトの圧縮クオリティを設定する
  
  オブジェクトのデフォルトの圧縮クオリティを設定します。

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

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::setfilename
type: function
doc:
<comment>Description:</comment>
  画像を読み書きする前にファイル名を設定する
  
  画像を読み書きする前にファイル名を設定します。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  画像ファイル名。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::setimagebackgroundcolor
type: function
doc:
<comment>Description:</comment>
  画像の背景色を設定する
  
  画像の背景色を設定します。

<comment>Param:</comment>
  <info>GmagickPixel</info>  <strong>$color</strong>  画像の背景色。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::setimageblueprimary
type: function
doc:
<comment>Description:</comment>
  青が一番強い点を設定する
  
  青が一番強い点を設定します。

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  青が一番強い点の x 座標。
  <info>float</info>  <strong>$y</strong>  青が一番強い点の y 座標。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::setimagebordercolor
type: function
doc:
<comment>Description:</comment>
  画像の枠線の色を設定する
  
  画像の枠線の色を設定します。

<comment>Param:</comment>
  <info>GmagickPixel</info>  <strong>$color</strong>  画像の前景色。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::setimagechanneldepth
type: function
doc:
<comment>Description:</comment>
  特定の画像チャネルの深度を設定する
  
  特定の画像チャネルの深度を設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$channel</strong>  チャンネル 定数のうちの一つ。 (<return>Gmagick::CHANNEL_*</return>)
  <info>int</info>  <strong>$depth</strong>    深度を表すビット数。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::setimagecolorspace
type: function
doc:
<comment>Description:</comment>
  画像の色空間を設定する
  
  画像の色空間を設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$colorspace</strong>  色空間 定数のうちの一つ。 (<return>Gmagick::COLORSPACE_*</return>)

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::setimagecompose
type: function
doc:
<comment>Description:</comment>
  画像の合成演算子を設定する
  
  画像の合成演算子を設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$composite</strong>  画像の合成演算子。

<comment>Return:</comment>
  <info>Gmagick</info>  成功した場合に Gmagick オブジェクトを返します。


id: Gmagick::setimagedelay
type: function
doc:
<comment>Description:</comment>
  画像の遅延を設定する
  
  画像の遅延を設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$delay</strong>  画像の遅延を 1/100 秒単位で指定します。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::setimagedepth
type: function
doc:
<comment>Description:</comment>
  画像の深度を設定する
  
  画像の深度を設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$depth</strong>  画像の深度 (ビット)。8、16 あるいは 32。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::setimagedispose
type: function
doc:
<comment>Description:</comment>
  画像の配置方法を設定する
  
  画像の配置方法を設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$disposeType</strong>  画像の配置方法。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::setimagefilename
type: function
doc:
<comment>Description:</comment>
  シーケンス内の特定の画像のファイル名を設定する
  
  シーケンス内の特定の画像のファイル名を設定します。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  画像ファイル名。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::setimageformat
type: function
doc:
<comment>Description:</comment>
  特定の画像のフォーマットを設定する
  
  シーケンス内の特定の画像のフォーマットを設定します。

<comment>Param:</comment>
  <info>string</info>  <strong>$imageFormat</strong>  画像のフォーマット。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::setimagegamma
type: function
doc:
<comment>Description:</comment>
  画像のガンマを設定する
  
  画像のガンマを設定します。

<comment>Param:</comment>
  <info>float</info>  <strong>$gamma</strong>  画像のガンマ。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::setimagegreenprimary
type: function
doc:
<comment>Description:</comment>
  緑が一番強い点を設定する
  
  緑が一番強い点を設定します。

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  緑が一番強い点の x 座標。
  <info>float</info>  <strong>$y</strong>  緑が一番強い点の y 座標。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::setimageindex
type: function
doc:
<comment>Description:</comment>
  画像リスト内でのイテレータの位置を、index パラメータで指定した場所に設定する
  
  画像リスト内でのイテレータの位置を、index パラメータで指定した場所に設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  シーン番号。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::setimageinterlacescheme
type: function
doc:
<comment>Description:</comment>
  画像のインターレース手法を設定する
  
  画像のインターレース手法を設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$interlace</strong>  インターレース 定数のうちの一つ。 (<return>Gmagick::INTERLACE_*</return>)

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::setimageiterations
type: function
doc:
<comment>Description:</comment>
  画像の反復を設定する
  
  画像の反復を設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$iterations</strong>  画像の遅延を 1/100 秒単位で指定します。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::setimageprofile
type: function
doc:
<comment>Description:</comment>
  指定した名前の画像プロファイルを Gmagick オブジェクトに追加する
  
  指定した名前の画像プロファイルを Gmagick オブジェクトに追加します。 同じ名前のプロファイルが存在す
  る場合は、それを置き換えます。 このメソッドは Gmagick::profileImage() メソッドとは異なり、 CMS カ
  ラープロファイルは適用しません。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>     追加あるいは削除するプロファイルの名前。ICC、IPTC あるいは generic。
  <info>string</info>  <strong>$profile</strong>  プロファイル。

<comment>Return:</comment>
  <info>Gmagick</info>  成功した場合に Gmagick オブジェクトを返します。


id: Gmagick::setimageredprimary
type: function
doc:
<comment>Description:</comment>
  赤が一番強い点を設定する
  
  赤が一番強い点を設定します。

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  赤が一番強い点の x 座標。
  <info>float</info>  <strong>$y</strong>  赤が一番強い点の y 座標。

<comment>Return:</comment>
  <info>Gmagick</info>  成功した場合に Gmagick オブジェクトを返します。


id: Gmagick::setimagerenderingintent
type: function
doc:
<comment>Description:</comment>
  画像のレンダリング方向を設定する
  
  画像のレンダリング方向を設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$rendering_intent</strong>  レンダリング方向 の定数のうちの一つ。 (<return>Gmagick::RENDERINGINTENT_*</return>)

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::setimageresolution
type: function
doc:
<comment>Description:</comment>
  画像の解像度を設定する
  
  画像の解像度を設定します。

<comment>Param:</comment>
  <info>float</info>  <strong>$xResolution</strong>  x 方向の解像度。
  <info>float</info>  <strong>$yResolution</strong>  y 方向の解像度。

<comment>Return:</comment>
  <info>Gmagick</info>  成功した場合に Gmagick オブジェクトを返します。


id: Gmagick::setimagescene
type: function
doc:
<comment>Description:</comment>
  画像のシーンを設定する
  
  画像のシーンを設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$scene</strong>  画像のシーン番号。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::setimagetype
type: function
doc:
<comment>Description:</comment>
  画像の型を設定する
  
  画像の型を設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$imgType</strong>  画像の型 の定数のうちのひとつ。 (<return>Gmagick::IMGTYPE_*</return>)

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::setimageunits
type: function
doc:
<comment>Description:</comment>
  画像の解像度の単位を設定する
  
  画像の解像度の単位を設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$resolution</strong>  画像の解像度の単位。Undefinedresolution、PixelsPerInchResolution あるいは
                    PixelsPerCentimeterResolution。 解像度 の定数のうちの一つ。
                    (<return>Gmagick::RESOLUTION_*</return>)

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::setimagewhitepoint
type: function
doc:
<comment>Description:</comment>
  画像の色度が白い点を設定する
  
  画像の色度が白い点を設定します。

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  白い点の x 座標。
  <info>float</info>  <strong>$y</strong>  白い点の y 座標。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::setsamplingfactors
type: function
doc:
<comment>Description:</comment>
  画像のサンプリング係数を設定する
  
  画像のサンプリング係数を設定します。

<comment>Param:</comment>
  <info>array</info>  <strong>$factors</strong>  各色コンポーネントのサンプリング係数を表す <info>float</info> 型の値の配列 (RGB 順)。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::setsize
type: function
doc:
<comment>Description:</comment>
  Gmagick オブジェクトのサイズを設定する
  
  Gmagick オブジェクトのサイズを設定します。 <info>Gmagick::COLORSPACE_RGB</info> や <info>Gmagick::COLORSPACE_GRAY</info>、
  <info>Gmagick::COLORSPACE_CMYK</info> といった生の画像フォーマットを読み込む前に設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$columns</strong>  ピクセル数で指定する幅。
  <info>int</info>  <strong>$rows</strong>     ピクセル数で指定する高さ。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::shearimage
type: function
doc:
<comment>Description:</comment>
  平行四辺形を作成する
  
  画像を X 軸方向あるいは Y 軸方向に押しつぶし、平行四辺形を作成します。 X 方向に押しつぶすと X 軸方
  向にスライドし、Y 方向に押しつぶすと Y 軸方向にスライドします。押しつぶす量は、角度で指定します。
  X 方向に押しつぶす場合、x_shear は Y 軸からの相対角度となります。 同様に、Y 方向に押しつぶす場合は
  y_shear が X 軸からの相対角度となります。 変形によってできた空白部分は、背景色で埋められます。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$color</strong>   背景色。
  <info>float</info>  <strong>$xShear</strong>  x 軸方向に押しつぶす角度。
  <info>float</info>  <strong>$yShear</strong>  y 軸方向に押しつぶす角度。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::solarizeimage
type: function
doc:
<comment>Description:</comment>
  画像にソラリゼーション効果を適用する
  
  画像に特殊効果を施し、 印画紙の特定の箇所の露光時間を長くしたような画像になります。 threshold は 0
  から QuantumRange までの値で、 ソラリゼーションの効き具合を指定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$threshold</strong>  ソラリゼーションの効き具合を指定します。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::spreadimage
type: function
doc:
<comment>Description:</comment>
  ブロック内の各ピクセルをランダムに移動する
  
  radius パラメータで定義したブロック内の各ピクセルを、 ランダムに移動させます。

<comment>Param:</comment>
  <info>float</info>  <strong>$radius</strong>  この範囲の近くにあるランダムなピクセルを選びます。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::stripimage
type: function
doc:
<comment>Description:</comment>
  画像からすべてのプロパティやコメントを除去する
  
  画像からすべてのプロパティやコメントを除去します。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::swirlimage
type: function
doc:
<comment>Description:</comment>
  画像の中心から、ピクセルを渦巻状にする
  
  画像の中心から、ピクセルを渦巻状にします。 degrees は個々のピクセルが移動する弧の量を表します。
  degrees を 1 から 360 まで変化させると、劇的な効果が得られます。

<comment>Param:</comment>
  <info>float</info>  <strong>$degrees</strong>  渦巻効果の程度。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::thumbnailimage
type: function
doc:
<comment>Description:</comment>
  画像のサイズを変更する
  
  画像のサイズを指定したものに変更し、関連付けられたプロパティをすべて削除します。 ウェブ上での表示
  に適した小さなサムネイル画像を作成します。 三番目のパラメータに <info>true</info> を指定すると、columns や rows
  にそれぞれの最大値を使用します。両方のパラメータが、 マッチするまであるいは指定したパラメータより
  小さくなるまで縮小されます。

<comment>Param:</comment>
  <info>int</info>  <strong>$width</strong>   画像の幅。
  <info>int</info>  <strong>$height</strong>  画像の高さ。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::trimimage
type: function
doc:
<comment>Description:</comment>
  画像の輪郭を削除する
  
  画像の背景色と同じ色の輪郭を削除します。

<comment>Param:</comment>
  <info>float</info>  <strong>$fuzz</strong>  デフォルトでは、対象の色は特定のピクセルの色とまったく同じでなければなりません。 し
                かし、ふたつの色が微妙に異なることもよくあります。 画像の fuzz メンバは、どの程度の
                色を「同じ色」とみなすかを表します。 このパラメータは、量の範囲の変化を表します。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: Gmagick::write
type: function
doc:
<comment>Description:</comment>
  Gmagick::writeimage のエイリアス
  
  このメソッドは次のメソッドのエイリアスです。 Gmagick::writeimage


id: Gmagick::writeimage
type: function
doc:
<comment>Description:</comment>
  画像を指定したファイル名で書き出す
  
  画像を指定したファイル名で書き出します。filename が <info>null</info> の場合は、 Gmagick::readimage あるいは
  Gmagick::setimagefilename で設定したファイル名で書き出します。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  画像ファイル名。

<comment>Return:</comment>
  <info>Gmagick</info>  <class>Gmagick</class> オブジェクトを返します。


id: GmagickDraw::annotate
type: function
doc:
<comment>Description:</comment>
  画像の上にテキストを描画する
  
  画像の上にテキストを描画します。

<comment>Param:</comment>
  <info>float</info>   <strong>$x</strong>     テキストの左端の x 座標。
  <info>float</info>   <strong>$y</strong>     テキストのベースラインの y 座標。
  <info>string</info>  <strong>$text</strong>  描画するテキスト。

<comment>Return:</comment>
  <info>GmagickDraw</info>  <class>GmagickDraw</class> オブジェクトを返します。


id: GmagickDraw::arc
type: function
doc:
<comment>Description:</comment>
  弧を描く
  
  指定した矩形内に収まる弧を、画像上に描きます。

<comment>Param:</comment>
  <info>float</info>  <strong>$sx</strong>  矩形の開始位置の x 座標。
  <info>float</info>  <strong>$sy</strong>  矩形の開始位置の y 座標。
  <info>float</info>  <strong>$ex</strong>  矩形の終了位置の x 座標。
  <info>float</info>  <strong>$ey</strong>  矩形の終了位置の y 座標。
  <info>float</info>  <strong>$sd</strong>  開始角度。
  <info>float</info>  <strong>$ed</strong>  終了角度。

<comment>Return:</comment>
  <info>GmagickDraw</info>  <class>GmagickDraw</class> オブジェクトを返します。


id: GmagickDraw::bezier
type: function
doc:
<comment>Description:</comment>
  ベジエ曲線を描く
  
  指定した点を通るベジエ曲線を画像上に描きます。

<comment>Param:</comment>
  <info>array</info>  <strong>$coordinate_array</strong>  座標の配列。

<comment>Return:</comment>
  <info>GmagickDraw</info>  <class>GmagickDraw</class> オブジェクトを返します。


id: GmagickDraw::ellipse
type: function
doc:
<comment>Description:</comment>
  楕円を画像上に描く
  
  楕円を画像上に描きます。

<comment>Param:</comment>
  <info>float</info>  <strong>$ox</strong>     原点の x 座標。
  <info>float</info>  <strong>$oy</strong>     原点の y 座標。
  <info>float</info>  <strong>$rx</strong>     x 方向の半径。
  <info>float</info>  <strong>$ry</strong>     y 方向の半径。
  <info>float</info>  <strong>$start</strong>  開始角度。
  <info>float</info>  <strong>$end</strong>    終了角度。

<comment>Return:</comment>
  <info>GmagickDraw</info>  <class>GmagickDraw</class> オブジェクトを返します。


id: GmagickDraw::getfillcolor
type: function
doc:
<comment>Description:</comment>
  塗りつぶし色を返す
  
  オブジェクトを塗りつぶすときに使う色を返します。

<comment>Return:</comment>
  <info>GmagickPixel</info>  オブジェクトを塗りつぶすときに使う色の <class>GmagickPixel</class> を返します。


id: GmagickDraw::getfillopacity
type: function
doc:
<comment>Description:</comment>
  描画に使う不透明度を返す
  
  描画に使う不透明度を返します。

<comment>Return:</comment>
  <info>float</info>  塗りつぶしの色やテクスチャに使う不透明度を返します。完全に不透明な状態が 1.0 になります。


id: GmagickDraw::getfont
type: function
doc:
<comment>Description:</comment>
  フォントを返す
  
  テキストのアノテーションで使うフォントを表す文字列を返します。

<comment>Return:</comment>
  <info>mixed</info>  成功した場合に文字列を返します。フォントが設定されていない場合は <info>false</info> を返します。


id: GmagickDraw::getfontsize
type: function
doc:
<comment>Description:</comment>
  フォントのポイント数を返す
  
  テキストのアノテーションで使うフォントのポイント数を返します。

<comment>Return:</comment>
  <info>float</info>  現在の <class>GmagickDraw</class> オブジェクトに関連づけられたフォントのサイズを返します。


id: GmagickDraw::getfontstyle
type: function
doc:
<comment>Description:</comment>
  フォントスタイルを返す
  
  テキストのアノテーションで使うフォントのスタイルを返します。

<comment>Return:</comment>
  <info>int</info>  <class>GmagickDraw</class> オブジェクトに関連づけられたフォントスタイル定数 (STYLE_) を返します。 スタイルが
       設定されていない場合は <return>0</return> を返します。


id: GmagickDraw::getfontweight
type: function
doc:
<comment>Description:</comment>
  フォントのウェイトを返す
  
  テキストのアノテーションで使うフォントのウェイトを返します。

<comment>Return:</comment>
  <info>int</info>  成功した場合に整数値を返します。ウェイトが設定されていない場合は 0 を返します。


id: GmagickDraw::getstrokecolor
type: function
doc:
<comment>Description:</comment>
  オブジェクトの輪郭の描画に使う色を返す
  
  オブジェクトの輪郭の描画に使う色を返します。

<comment>Return:</comment>
  <info>GmagickPixel</info>  色を表す <class>GmagickPixel</class> オブジェクトを返します。


id: GmagickDraw::getstrokeopacity
type: function
doc:
<comment>Description:</comment>
  オブジェクトの輪郭の不透明度を返す
  
  オブジェクトの輪郭の不透明度を返します。

<comment>Return:</comment>
  <info>float</info>  不透明度を表す <info>float</info> 型の数値を返します。


id: GmagickDraw::getstrokewidth
type: function
doc:
<comment>Description:</comment>
  オブジェクトの輪郭の描画に使う線の幅を返す
  
  オブジェクトの輪郭の描画に使う線の幅を返します。

<comment>Return:</comment>
  <info>float</info>  線の幅を表す <info>float</info> 型の値を返します。


id: GmagickDraw::gettextdecoration
type: function
doc:
<comment>Description:</comment>
  テキストのデコレーションを返す
  
  テキストのアノテーションに適用するデコレーションを返します。

<comment>Return:</comment>
  <info>int</info>  DECORATION_ 定数のいずれかを返します。デコレーションが設定されていない場合は 0 を返します。


id: GmagickDraw::gettextencoding
type: function
doc:
<comment>Description:</comment>
  テキストのアノテーションで使うコードセットを返す
  
  テキストのアノテーションで使うコードセットを表す文字列を返します。

<comment>Return:</comment>
  <info>mixed</info>  コードセットを表す文字列を返します。 エンコーディングが設定されていない場合は <info>false</info> を返し
         ます。


id: GmagickDraw::line
type: function
doc:
<comment>Description:</comment>
  直線を描く
  
  現在の描画色、不透明度、線幅を使って画像上に直線を描きます。

<comment>Param:</comment>
  <info>float</info>  <strong>$sx</strong>  開始位置の x 座標。
  <info>float</info>  <strong>$sy</strong>  開始位置の y 座標。
  <info>float</info>  <strong>$ex</strong>  終了位置の x 座標。
  <info>float</info>  <strong>$ey</strong>  終了位置の y 座標。

<comment>Return:</comment>
  <info>GmagickDraw</info>  <class>GmagickDraw</class> オブジェクトを返します。


id: GmagickDraw::point
type: function
doc:
<comment>Description:</comment>
  点を描く
  
  現在の描画色と太さを使って、指定した座標に点を描きます。

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  点の x 座標。
  <info>float</info>  <strong>$y</strong>  点の y 座標。

<comment>Return:</comment>
  <info>GmagickDraw</info>  <class>GmagickDraw</class> オブジェクトを返します。


id: GmagickDraw::polygon
type: function
doc:
<comment>Description:</comment>
  多角形を描く
  
  現在の描画色、線幅、塗りつぶし色、塗りつぶしテクスチャを使って、指定した座標の配列による多角形を描
  きます。

<comment>Param:</comment>
  <info>array</info>  <strong>$coordinates</strong>  座標の配列。

<comment>Return:</comment>
  <info>GmagickDraw</info>  <class>GmagickDraw</class> オブジェクトを返します。


id: GmagickDraw::polyline
type: function
doc:
<comment>Description:</comment>
  ポリラインを描く
  
  現在の描画色、線幅、塗りつぶし色、塗りつぶしテクスチャを使って、指定した座標の配列によるポリライン
  を描きます。

<comment>Param:</comment>
  <info>array</info>  <strong>$coordinate_array</strong>  座標の配列。

<comment>Return:</comment>
  <info>GmagickDraw</info>  <class>GmagickDraw</class> オブジェクトを返します。


id: GmagickDraw::rectangle
type: function
doc:
<comment>Description:</comment>
  矩形を描く
  
  二つの座標を指定して、現在の描画色と線幅そして塗りつぶし設定を使った矩形を描きます。

<comment>Param:</comment>
  <info>float</info>  <strong>$x1</strong>  最初の x 座標。
  <info>float</info>  <strong>$y1</strong>  最初の y 座標。
  <info>float</info>  <strong>$x2</strong>  二番目の x 座標。
  <info>float</info>  <strong>$y2</strong>  二番目の y 座標。

<comment>Return:</comment>
  <info>GmagickDraw</info>  <class>GmagickDraw</class> オブジェクトを返します。


id: GmagickDraw::rotate
type: function
doc:
<comment>Description:</comment>
  指定した回転角を現在の座標空間に適用する
  
  指定した回転角を現在の座標空間に適用します。

<comment>Param:</comment>
  <info>float</info>  <strong>$degrees</strong>  回転角度。

<comment>Return:</comment>
  <info>GmagickDraw</info>  <class>GmagickDraw</class> オブジェクトを返します。


id: GmagickDraw::roundrectangle
type: function
doc:
<comment>Description:</comment>
  角が丸い矩形を描く
  
  二つの座標そして x 方向と y 方向の角の半径を指定して、現在の描画色と線幅そして塗りつぶし設定を使っ
  た過度の丸い矩形を描きます。

<comment>Param:</comment>
  <info>float</info>  <strong>$x1</strong>  最初の x 座標。
  <info>float</info>  <strong>$y1</strong>  最初の y 座標。
  <info>float</info>  <strong>$x2</strong>  二番目の x 座標。
  <info>float</info>  <strong>$y2</strong>  二番目の y 座標。
  <info>float</info>  <strong>$rx</strong>  水平方向の角の半径。
  <info>float</info>  <strong>$ry</strong>  垂直方向の角の半径。

<comment>Return:</comment>
  <info>GmagickDraw</info>  <class>GmagickDraw</class> オブジェクトを返します。


id: GmagickDraw::scale
type: function
doc:
<comment>Description:</comment>
  倍率を調整する
  
  現在の座標空間に対して水平方向と垂直方向の倍率を調整します。

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  水平方向の倍率。
  <info>float</info>  <strong>$y</strong>  垂直方向の倍率。

<comment>Return:</comment>
  <info>GmagickDraw</info>  <class>GmagickDraw</class> オブジェクトを返します。


id: GmagickDraw::setfillcolor
type: function
doc:
<comment>Description:</comment>
  オブジェクトの塗りつぶしに使う色を設定する
  
  オブジェクトの塗りつぶしに使う色を設定します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$color</strong>  塗りつぶしに使う色を表す <class>GmagickPixel</class> オブジェクトあるいは文字列。

<comment>Return:</comment>
  <info>GmagickDraw</info>  成功した場合に <class>GmagickDraw</class> オブジェクトを返します。


id: GmagickDraw::setfillopacity
type: function
doc:
<comment>Description:</comment>
  不透明度を設定する
  
  塗りつぶし色や塗りつぶしテクスチャを使った描画のときに使う不透明度を設定します。 1.0 にすると、完
  全に不透明になります。

<comment>Param:</comment>
  <info>float</info>  <strong>$fill_opacity</strong>  塗りつぶしの不透明度。

<comment>Return:</comment>
  <info>GmagickDraw</info>  <class>GmagickDraw</class> オブジェクトを返します。


id: GmagickDraw::setfont
type: function
doc:
<comment>Description:</comment>
  テキストのアノテーションで使うフォントの完全な名前を設定する
  
  テキストのアノテーションで使うフォントの完全な名前を設定します。

<comment>Param:</comment>
  <info>string</info>  <strong>$font</strong>  フォント名。

<comment>Return:</comment>
  <info>GmagickDraw</info>  <class>GmagickDraw</class> オブジェクトを返します。


id: GmagickDraw::setfontsize
type: function
doc:
<comment>Description:</comment>
  テキストのアノテーションで使うフォントのポイント数を設定する
  
  テキストのアノテーションで使うフォントのポイント数を設定します。

<comment>Param:</comment>
  <info>float</info>  <strong>$pointsize</strong>  テキストのポイント数。

<comment>Return:</comment>
  <info>GmagickDraw</info>  <class>GmagickDraw</class> オブジェクトを返します。


id: GmagickDraw::setfontstyle
type: function
doc:
<comment>Description:</comment>
  テキストのアノテーションで使うフォントのスタイルを設定する
  
  テキストのアノテーションで使うフォントのスタイルを設定します。 AnyStyle はワイルドカードで、「気に
  しない」という意味になります。

<comment>Param:</comment>
  <info>int</info>  <strong>$style</strong>  フォントスタイル (NormalStyle, ItalicStyle, ObliqueStyle, AnyStyle)。

<comment>Return:</comment>
  <info>GmagickDraw</info>  <class>GmagickDraw</class> オブジェクトを返します。


id: GmagickDraw::setfontweight
type: function
doc:
<comment>Description:</comment>
  フォントのウェイトを設定する
  
  テキストのアノテーションで使うフォントのウェイトを設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$weight</strong>  フォントのウェイト (100-900 の範囲が有効)。

<comment>Return:</comment>
  <info>GmagickDraw</info>  <class>GmagickDraw</class> オブジェクトを返します。


id: GmagickDraw::setstrokecolor
type: function
doc:
<comment>Description:</comment>
  オブジェクトの輪郭の描画に使う色を設定する
  
  オブジェクトの輪郭の描画に使う色を設定します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$color</strong>  輪郭の色を表す <class>GmagickPixel</class> オブジェクトあるいは文字列。

<comment>Return:</comment>
  <info>GmagickDraw</info>  成功した場合に <class>GmagickDraw</class> オブジェクトを返します。


id: GmagickDraw::setstrokeopacity
type: function
doc:
<comment>Description:</comment>
  オブジェクトの輪郭の不透明度を設定する
  
  オブジェクトの輪郭の不透明度を設定します。

<comment>Param:</comment>
  <info>float</info>  <strong>$stroke_opacity</strong>  不透明度。1.0 が完全な不透明を表します。

<comment>Return:</comment>
  <info>GmagickDraw</info>  <class>GmagickDraw</class> オブジェクトを返します。


id: GmagickDraw::setstrokewidth
type: function
doc:
<comment>Description:</comment>
  オブジェクトの輪郭の描画に使う線の幅を設定する
  
  オブジェクトの輪郭の描画に使う線の幅を設定します。

<comment>Param:</comment>
  <info>float</info>  <strong>$width</strong>  線の幅。

<comment>Return:</comment>
  <info>GmagickDraw</info>  <class>GmagickDraw</class> オブジェクトを返します。


id: GmagickDraw::settextdecoration
type: function
doc:
<comment>Description:</comment>
  デコレーションを設定する
  
  テキストのアノテーションに適用するデコレーションを設定します。

<comment>Param:</comment>
  <info></info>  <strong>$int</strong>  テキストのデコレーション。NoDecoration、UnderlineDecoration、OverlineDecoration あるいは
          LineThroughDecoration のいずれか。

<comment>Return:</comment>
  <info>GmagickDraw</info>  <class>GmagickDraw</class> オブジェクトを返します。


id: GmagickDraw::settextencoding
type: function
doc:
<comment>Description:</comment>
  テキストのコードセットを設定する
  
  テキストのアノテーションで使うコードセットを表す文字列を設定します。 現時点で使える文字エンコー
  ディングは "UTF-8" だけで、 これは Unicode をバイト列として使います。 空文字列を指定すると、テキス
  トのエンコーディングをシステムのデフォルトに合わせます。 Unicode を使ったテキストのアノテーション
  をするには、Unicode に対応したフォントが必要です。

<comment>Param:</comment>
  <info>string</info>  <strong>$encoding</strong>  テキストのエンコーディングを表す文字列。

<comment>Return:</comment>
  <info>GmagickDraw</info>  <class>GmagickDraw</class> オブジェクトを返します。


id: GmagickPixel::__construct
type: function
doc:
<comment>Description:</comment>
  GmagickPixel のコンストラクタ
  
  <class>GmagickPixel</class> オブジェクトを作ります。 色を指定した場合は、オブジェクトを作ってからその色で初期化し
  たものを返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$color</strong>  オプションで指定する色文字列。このオブジェクトの初期値として使います。


id: GmagickPixel::getcolor
type: function
doc:
<comment>Description:</comment>
  色を返す
  
  <class>GmagickPixel</class> オブジェクトの色を文字列あるいは配列で返します。 透明度が設定されているときは、リスト
  の四番目の値として返します。

<comment>Param:</comment>
  <info>bool</info>  <strong>$as_array</strong>         <info>true</info> にすると、戻り値を文字列ではなく配列にします。
  <info>bool</info>  <strong>$normalize_array</strong>  <info>true</info> にすると、色の値を正規化します。

<comment>Return:</comment>
  <info>mixed</info>  各チャネルの値を文字列あるいは配列で返します。<strong>$normalize_array</strong> に <info>true</info> を市得治した場合は正
         規化をします。エラー時には <class>GmagickPixelException</class> をスローします。


id: GmagickPixel::getcolorcount
type: function
doc:
<comment>Description:</comment>
  この色の色カウントを返す
  
  この色に関連づけられた色カウントを返します。

<comment>Return:</comment>
  <info>int</info>  成功した場合に色カウントを整数値で返します。 失敗した場合は <class>GmagickPixelException</class> をスローし
       ます。


id: GmagickPixel::getcolorvalue
type: function
doc:
<comment>Description:</comment>
  指定した色チャネルの正規化した値を取得する
  
  指定した色チャネルの値を取得します。0 から 1 までの間の浮動小数点数値になります。

<comment>Param:</comment>
  <info>int</info>  <strong>$color</strong>  調べたいチャネル。Gmagick チャネル定数で指定します。

<comment>Return:</comment>
  <info>float</info>  チャネルの値を、正規化した浮動小数点数値で返します。 エラー時には <class>GmagickPixelException</class> を
         スローします。


id: GmagickPixel::setcolor
type: function
doc:
<comment>Description:</comment>
  色を設定する
  
  <class>GmagickPixel</class> オブジェクトの色を文字列で設定します ("blue"、"#0000ff"、"rgb(0,0,255)"、
  "cmyk(100,100,100,10)" など)。

<comment>Param:</comment>
  <info>string</info>  <strong>$color</strong>  <class>GmagickPixel</class> オブジェクトを初期化するときに使う色。

<comment>Return:</comment>
  <info>GmagickPixel</info>  <class>GmagickPixel</class> オブジェクトを返します。


id: GmagickPixel::setcolorvalue
type: function
doc:
<comment>Description:</comment>
  色チャネルの正規化した値を設定する
  
  このオブジェクトの指定したチャネルの値を設定します。 これは 0 から 1 までの間の値になります。 この
  関数を使って <class>GmagickPixel</class> オブジェクトの透明度チャネルを設定できます。

<comment>Param:</comment>
  <info>int</info>    <strong>$color</strong>  Gmagick チャネル定数のいずれか。
  <info>float</info>  <strong>$value</strong>  設定したい値。0 から 1 までの範囲で指定します。

<comment>Return:</comment>
  <info>GmagickPixel</info>  <class>GmagickPixel</class> オブジェクトを返します。


id: HASH_HMAC
type: constant
doc:
<comment>Description:</comment>
  <strong>hash_init()</strong> のオプションのフラグです。 現在のハッシュコンテキストに対して HMAC digest-keying アル
  ゴリズムが適用されることを示します。


id: HRTime\PerformanceCounter::getFrequency
type: function
doc:
<comment>Description:</comment>
  Timer frequency in ticks per second
  
  Returns the timer frequency in ticks per second. This value is constant after
  the system start on almost any operating system.

<comment>Return:</comment>
  <info>int</info>  Returns <info>int</info> indicating the timer frequency.


id: HRTime\PerformanceCounter::getTicks
type: function
doc:
<comment>Description:</comment>
  Current ticks from the system
  
  Returns the ticks count.

<comment>Return:</comment>
  <info>int</info>  Returns <info>int</info> indicating the ticks count.


id: HRTime\PerformanceCounter::getTicksSince
type: function
doc:
<comment>Description:</comment>
  Ticks elapsed since the given value
  
  Returns the ticks count elapsed since the given start value.

<comment>Param:</comment>
  <info>int</info>  <strong>$start</strong>  Starting ticks value.

<comment>Return:</comment>
  <info>int</info>  Returns <info>int</info> indicating the ticks count.


id: HRTime\StopWatch::getElapsedTicks
type: function
doc:
<comment>Description:</comment>
  Get elapsed ticks for all intervals
  
  Get elapsed ticks for all the previously closed intervals.

<comment>Return:</comment>
  <info>int</info>  Returns <info>int</info> indicating elapsed ticks.


id: HRTime\StopWatch::getElapsedTime
type: function
doc:
<comment>Description:</comment>
  Get elapsed time for all intervals
  
  Get elapsed time for all the previously closed intervals.

<comment>Param:</comment>
  <info>int</info>  <strong>$unit</strong>  Time unit represented by a HRTime\Unit constant. Default is HRTime\Unit::SECOND.

<comment>Return:</comment>
  <info>float</info>  Returns <info>float</info> indicating elapsed time.


id: HRTime\StopWatch::getLastElapsedTicks
type: function
doc:
<comment>Description:</comment>
  Get elapsed ticks for the last interval
  
  Get elapsed ticks for the previously closed interval.

<comment>Return:</comment>
  <info>int</info>  Returns <info>int</info> indicating elapsed ticks.


id: HRTime\StopWatch::getLastElapsedTime
type: function
doc:
<comment>Description:</comment>
  Get elapsed time for the last interval
  
  Get elapsed time for the previously closed interval.

<comment>Param:</comment>
  <info>int</info>  <strong>$unit</strong>  Time unit represented by a HRTime\Unit constant. Default is HRTime\Unit::SECOND.

<comment>Return:</comment>
  <info>float</info>  Returns <info>float</info> indicating elapsed time.


id: HRTime\StopWatch::isRunning
type: function
doc:
<comment>Description:</comment>
  Whether the measurement is running
  
  Reveals whether the measurement was started.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>bool</info> indicating whether the measurement is running.


id: HRTime\StopWatch::start
type: function
doc:
<comment>Description:</comment>
  Start time measurement
  
  Starts the time measurement. It has no effect if the measurement was already
  started. The measurement will be continued if it was previously stopped.

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


id: HRTime\StopWatch::stop
type: function
doc:
<comment>Description:</comment>
  Stop time measurement
  
  Stop the time measurement for the previously started interval.

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


id: HashContext::__serialize
type: function
doc:
<comment>Description:</comment>
  HashContext オブジェクトをシリアライズする
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>array</info>  値を返しません。


id: HashContext::__unserialize
type: function
doc:
<comment>Description:</comment>
  data を HashContext オブジェクト に復元する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>array</info>  <strong>$data</strong>  アンシリアライズする値。

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: ICONV_MIME_DECODE_CONTINUE_ON_ERROR
type: constant
doc:
<comment>Description:</comment>
  <info>int</info>
  
  <strong>iconv_mime_decode()</strong>で使用されるビットマスク


id: IDNA_CHECK_BIDI
type: constant
doc:
<comment>Description:</comment>
  入力が BiDi の規則を満たすかどうかをチェックします。 IDNA2003 の実装ではこの設定は無視され、常にこ
  のチェックを行います。


id: IDNA_CHECK_CONTEXTJ
type: constant
doc:
<comment>Description:</comment>
  入力が CONTEXTJ の規則を満たすかどうかをチェックします。 IDNA2003 の実装ではこの設定は無視されま
  す。このチェックは IDNA2008 から追加されたものだからです。


id: IDNA_DEFAULT
type: constant
doc:
<comment>Description:</comment>
  IDN 関数の入力で、アサインされていないコードポイントの処理を拒否し、 入力がドメイン名 ASCII 規則を
  満たすかどうかをチェックしません。


id: IDNA_ERROR_BIDI
type: constant
doc:
<comment>Description:</comment>
  UTS #46 アルゴリズムを <strong>idn_to_utf8()</strong> と <strong>idn_to_ascii()</strong> で使うときに、 これらのエラーがビットセット
  で報告されます。


id: IDNA_NONTRANSITIONAL_TO_ASCII
type: constant
doc:
<comment>Description:</comment>
  <strong>idn_to_ascii()</strong> で非移行的処理をするためのオプション。 デフォルトでは移行的処理となります。このオプ
  ションは IDNA2003 の実装では無視されます。


id: IDNA_NONTRANSITIONAL_TO_UNICODE
type: constant
doc:
<comment>Description:</comment>
  <strong>idn_to_utf8()</strong> で非移行的処理をするためのオプション。 デフォルトでは移行的処理となります。このオプ
  ションは IDNA2003 の実装では無視されます。


id: IMAGETYPE_AVIF
type: constant
doc:
<comment>Description:</comment>
  画像タイプ定数。<strong>image_type_to_mime_type()</strong> や <strong>image_type_to_extension()</strong> 関数で使用します。
  
  (PHP 8.1.0 以降で利用可能です)


id: IMAGETYPE_BMP
type: constant
doc:
<comment>Description:</comment>
  画像タイプ定数。<strong>image_type_to_mime_type()</strong> や <strong>image_type_to_extension()</strong> 関数で使用します。


id: IMAGETYPE_WEBP
type: constant
doc:
<comment>Description:</comment>
  画像タイプ定数。<strong>image_type_to_mime_type()</strong> や <strong>image_type_to_extension()</strong> 関数で使用します。
  
  (PHP 7.1.0 以降で利用可能です)


id: IMG_ARC_ROUNDED
type: constant
doc:
<comment>Description:</comment>
  スタイル定数。<strong>imagefilledarc()</strong> 関数が使用します。
  
  この定数の値は <info>IMG_ARC_PIE</info> と同じです。


id: IMG_AVIF
type: constant
doc:
<comment>Description:</comment>
  <strong>imagetypes()</strong> の戻り値として用います。
  
  (PHP 8.1.0 以降で利用可能です)


id: IMG_BELL
type: constant
doc:
<comment>Description:</comment>
  <strong>imagesetinterpolation()</strong> で使用します。PHP 5.5.0 以降で使用可能です。


id: IMG_COLOR_BRUSHED
type: constant
doc:
<comment>Description:</comment>
  <strong>imagecolorallocate()</strong> や <strong>imagecolorallocatealpha()</strong> で割り当てた色のかわりに使用できる、特別な色オプ
  ション。


id: IMG_FILTER_SCATTER
type: constant
doc:
<comment>Description:</comment>
  特別な GD フィルタ。<strong>imagefilter()</strong> 関数で使用します。
  
  (PHP 7.4.0 以降で使用可能)


id: IMG_JPEG
type: constant
doc:
<comment>Description:</comment>
  <strong>imagetypes()</strong> の戻り値として用います。
  
  この定数の値は <info>IMG_JPG</info> と同じです。


id: IMG_WEBP
type: constant
doc:
<comment>Description:</comment>
  <strong>imagetypes()</strong> の戻り値として用います。
  
  (PHP 7.0.10 以降で利用可能です)


id: INFO_VARIABLES
type: constant
doc:
<comment>Description:</comment>
  <return>EGPCS</return> (Environment, GET, POST, Cookie, Server)から定義済の変数を表示します。


id: INTL_IDNA_VARIANT_2003
type: constant
doc:
<comment>Description:</comment>
  IDNA 2003 のアルゴリズムを <strong>idn_to_utf8()</strong> と <strong>idn_to_ascii()</strong> で使います。これはデフォルトの設定で
  す。 この定数およびデフォルトの使用は、PHP 7.2.0 以降は非推奨です。


id: INTL_IDNA_VARIANT_UTS46
type: constant
doc:
<comment>Description:</comment>
  UTS #46 アルゴリズムを <strong>idn_to_utf8()</strong> と <strong>idn_to_ascii()</strong> で使います。 ICU 4.6 以降で利用可能です。


id: IN_IGNORED
type: constant
doc:
<comment>Description:</comment>
  監視が削除された (明示的に <strong>inotify_rm_watch()</strong> したか、ファイルが削除されたりファイルシステムがアン
  マウントされたりした)


id: Imagick::__construct
type: function
doc:
<comment>Description:</comment>
  Imagick のコンストラクタ
  
  指定した画像あるいは画像群用に Imagick のインスタンスを作ります。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$files</strong>  読み込みたい画像へのパス、あるいは複数のパスの配列。 パスのファイル名にはワイルド
                 カードを含めることができ、 また URL を指定することもできます。


id: Imagick::__toString
type: function
doc:
<comment>Description:</comment>
  Returns the image as a string
  
  Returns the current image as string. This will only return a single image; it should not be used
  for Imagick objects that contain multiple images e.g. an animated GIF or PDF with multiple pages.

<comment>Return:</comment>
  <info>string</info>  Returns the string content on success or an empty string on failure.

<comment>See Also:</comment>
   * Imagick::getImageBlob
   * Imagick::getImagesBlob


id: Imagick::adaptiveBlurImage
type: function
doc:
<comment>Description:</comment>
  adaptive blur (順応性にじみ) フィルタを画像に追加する
  
  adaptive blur (順応性にじみ) フィルタを画像に追加します。 adaptive blur の効果は、画像の端に近づく
  ほど弱くなります。 一方、標準の blur の場合は画像全体に均一に働きます。 このメソッドは、
  ImageMagick バージョン 6.2.9 以降で Imagick をコンパイルした場合に使用可能です。

<comment>Param:</comment>
  <info>float</info>  <strong>$radius</strong>   ガウス分布の半径。中心を含まないピクセル数。 0 を指定すると、半径を自動的に選択し
                   ます。
  <info>float</info>  <strong>$sigma</strong>    ガウス分布の標準偏差 (ピクセル単位)。
  <info>int</info>    <strong>$channel</strong>  そのモードで有効なチャネル定数を指定します。
                   複数のチャネルを適用するには、チャネル定数
                   をビット演算子で組み合わせます。デフォルトは <info>Imagick::CHANNEL_DEFAULT</info> です。
                   チャネル定数 の一覧を参照ください。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。

<comment>See Also:</comment>
   * <strong>Imagick::blurImage()</strong>
   * <strong>Imagick::motionBlurImage()</strong>
   * <strong>Imagick::radialBlurImage()</strong>


id: Imagick::adaptiveResizeImage
type: function
doc:
<comment>Description:</comment>
  データに依存する三角測量にもとづいて画像のサイズを変更する
  
  データに依存する三角測量にもとづいて画像のサイズを変更します。 色が突然変わる箇所でのにじみを避け
  ます。 たとえば、画像をほんの少しだけ縮小して "ウェブサイズ" にする場合などに便利です。フルサイズ
  の画像のサムネイルを作成する場合などは、 あまりうまくいかないかもしれません。 このメソッドは、
  ImageMagick バージョン 6.2.9 以降で Imagick をコンパイルした場合に使用可能です。
  
  パラメータ <strong>$bestfit</strong> の挙動は Imagick 3.0.0 で変わりました。 これより前のバージョンでは、200x150 の
  画像に対して 400x400 を指定した場合は何もせずそのままになっていました。 Imagick 3.0.0 以降では、こ
  の画像は 400x300 に拡大されます。これが、 指定したサイズに対して「ベストフィット」する大きさだから
  です。 <strong>$bestfit</strong> を使う場合は、幅と高さの両方を指定しなければなりません。

<comment>Param:</comment>
  <info>int</info>   <strong>$columns</strong>  変更後の画像のカラム数。
  <info>int</info>   <strong>$rows</strong>     変更後の画像の行数。
  <info>bool</info>  <strong>$bestfit</strong>  画像の大きさをバウンディングボックスにあわせるかどうか。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。

<comment>See Also:</comment>
   * <strong>Imagick::chopImage()</strong>
   * <strong>Imagick::cropImage()</strong>
   * <strong>Imagick::magnifyImage()</strong>
   * <strong>Imagick::minifyImage()</strong>
   * <strong>Imagick::resizeImage()</strong>
   * <strong>Imagick::scaleImage()</strong>
   * <strong>Imagick::shaveImage()</strong>
   * <strong>Imagick::thumbnailImage()</strong>
   * <strong>Imagick::trimImage()</strong>


id: Imagick::adaptiveSharpenImage
type: function
doc:
<comment>Description:</comment>
  順応して画像をシャープにする
  
  画像をシャープにします。 画像の端の方ほど強くシャープ処理を行い、 端から離れるにつれてシャープ処理
  の程度を弱くします。 このメソッドは、ImageMagick バージョン 6.2.9 以降で Imagick をコンパイルした
  場合に使用可能です。

<comment>Param:</comment>
  <info>float</info>  <strong>$radius</strong>   ガウス分布の半径。中心を含まないピクセル数。 0 を使用すると自動的に選択します。
  <info>float</info>  <strong>$sigma</strong>    ガウス分布の標準偏差 (ピクセル単位)。
  <info>int</info>    <strong>$channel</strong>  そのモードで有効なチャネル定数を指定します。
                   複数のチャネルを適用するには、チャネル定数
                   をビット演算子で組み合わせます。デフォルトは <info>Imagick::CHANNEL_DEFAULT</info> です。
                   チャネル定数 の一覧を参照ください。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。

<comment>See Also:</comment>
   * <strong>Imagick::sharpenImage()</strong>


id: Imagick::adaptiveThresholdImage
type: function
doc:
<comment>Description:</comment>
  輝度の範囲にもとづいて各ピクセルの閾値を選択する
  
  周辺のピクセルの輝度の範囲にもとづいて、 各ピクセルの閾値を選択します。 画像全体の輝度のヒストグラ
  ムが特定の頂点を持っていない場合の閾値の設定が可能となります。

<comment>Param:</comment>
  <info>int</info>  <strong>$width</strong>   周辺の幅。
  <info>int</info>  <strong>$height</strong>  周辺の高さ。
  <info>int</info>  <strong>$offset</strong>  平均オフセット。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::addImage
type: function
doc:
<comment>Description:</comment>
  新しい画像を Imagick オブジェクトの画像リストに追加する
  
  元オブジェクトの現在の位置にある新しい画像を、 Imagick オブジェクトの画像リストに追加します。 この
  操作を行うと、イテレータがリストの最後尾に移動します。

<comment>Param:</comment>
  <info>Imagick</info>  <strong>$source</strong>  元の Imagick オブジェクト。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::addNoiseImage
type: function
doc:
<comment>Description:</comment>
  ランダムなノイズを画像に追加する
  
  ランダムなノイズを画像に追加します。

<comment>Param:</comment>
  <info>int</info>  <strong>$noise_type</strong>  ノイズの形式。 ノイズ定数 の一覧を参照ください。
  <info>int</info>  <strong>$channel</strong>     そのモードで有効なチャネル定数を指定します。
                    複数のチャネルを適用するには、チャネル定数
                    をビット演算子で組み合わせます。デフォルトは <info>Imagick::CHANNEL_DEFAULT</info> です。
                    チャネル定数 の一覧を参照ください。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::affineTransformImage
type: function
doc:
<comment>Description:</comment>
  画像を変換する
  
  アフィン行列の指定にしたがって画像を変換します。

<comment>Param:</comment>
  <info>ImagickDraw</info>  <strong>$matrix</strong>  アフィン行列。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::animateImages
type: function
doc:
<comment>Description:</comment>
  画像を動かす
  
  このメソッドは、ローカルあるいはリモートの X サーバーで画像を動かします。 このメソッドは Windows
  では使えません。 このメソッドは、ImageMagick バージョン 6.3.6 以降で Imagick をコンパイルした場合
  に使用可能です。

<comment>Param:</comment>
  <info>string</info>  <strong>$x_server</strong>  X サーバーのアドレス。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。

<comment>See Also:</comment>
   * <strong>Imagick::displayImage()</strong>


id: Imagick::annotateImage
type: function
doc:
<comment>Description:</comment>
  画像にテキストによる注記を加える
  
  テキストによる注記を画像に加えます。

<comment>Param:</comment>
  <info>ImagickDraw</info>  <strong>$draw_settings</strong>  テキスト描画設定を含む ImagickDraw オブジェクト。
  <info>float</info>        <strong>$x</strong>              テキストの左端の水平オフセットをあらわすピクセル数。
  <info>float</info>        <strong>$y</strong>              テキストのベースラインの垂直オフセットをあらわすピクセル数。
  <info>float</info>        <strong>$angle</strong>          テキストを書き出す角度。
  <info>string</info>       <strong>$text</strong>           描画するテキスト。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。

<comment>See Also:</comment>
   * <strong>ImagickDraw::annotation()</strong>
   * <strong>ImagickDraw::setFont()</strong>


id: Imagick::appendImages
type: function
doc:
<comment>Description:</comment>
  画像群を追加する
  
  画像群を、ひとつの大きな画像に追加します。

<comment>Param:</comment>
  <info>bool</info>  <strong>$stack</strong>  画像を垂直方向に積むかどうか。デフォルト (あるいは <info>false</info> を指定した場合) は、画像を
                左から右に積みます。<strong>$stack</strong> が <info>true</info> の場合は、画像を上から下に積みます。

<comment>Return:</comment>
  <info>Imagick</info>  成功した場合に Imagick インスタンスを返します。


id: Imagick::autoLevelImage
type: function
doc:
<comment>Description:</comment>
  Adjusts the levels of a particular image channel
  
  Adjusts the levels of a particular image channel by scaling the minimum and maximum values to the
  full quantum range.

<comment>Param:</comment>
  <info>int</info>  <strong>$channel</strong>  Which channel should the auto-levelling should be done on.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::averageImages
type: function
doc:
<comment>Description:</comment>
  画像群を平均化する
  
  画像群を平均化します。

<comment>Return:</comment>
  <info>Imagick</info>  成功した場合に Imagick インスタンスを返します。


id: Imagick::blackThresholdImage
type: function
doc:
<comment>Description:</comment>
  閾値に満たないすべてのピクセルを黒にする
  
  Imagick::thresholdImage() と似ていますが、 これは閾値に満たないピクセルをすべて黒にし、その他のピ
  クセルはそのままにします。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$threshold</strong>  すべて黒にする閾値。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::blueShiftImage
type: function
doc:
<comment>Description:</comment>
  Mutes the colors of the image
  
  Mutes the colors of the image to simulate a scene at nighttime in the moonlight.

<comment>Param:</comment>
  <info>float</info>  <strong>$factor</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::blurImage
type: function
doc:
<comment>Description:</comment>
  blur (にじみ) フィルタを画像に追加する
  
  blur (にじみ) フィルタを画像に追加します。 オプションの 3 番目のパラメータを指定すると、 特定の
  チャネルにのみ適用します。

<comment>Param:</comment>
  <info>float</info>  <strong>$radius</strong>   にじみの半径。
  <info>float</info>  <strong>$sigma</strong>    標準偏差。
  <info>int</info>    <strong>$channel</strong>  チャネル 定数。 省略した場合は全チャネルが対象となります。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。

<comment>See Also:</comment>
   * <strong>Imagick::adaptiveBlurImage()</strong>
   * <strong>Imagick::motionBlurImage()</strong>
   * <strong>Imagick::radialBlurImage()</strong>


id: Imagick::borderImage
type: function
doc:
<comment>Description:</comment>
  画像の周りを枠線で囲む
  
  画像の周りを枠線で囲みます。枠線の色は ImagickPixel オブジェクトで指定します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$bordercolor</strong>  枠線の色を含む ImagickPixel オブジェクトあるいは文字列。
  <info>int</info>    <strong>$width</strong>        枠線の幅。
  <info>int</info>    <strong>$height</strong>       枠線の高さ。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::brightnessContrastImage
type: function
doc:
<comment>Description:</comment>
  Change the brightness and/or contrast of an image
  
  Change the brightness and/or contrast of an image. It converts the brightness and contrast
  parameters into slope and intercept and calls a polynomical function to apply to the image.

<comment>Param:</comment>
  <info>float</info>  <strong>$brightness</strong>  
  <info>float</info>  <strong>$contrast</strong>    
  <info>int</info>    <strong>$channel</strong>     

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::charcoalImage
type: function
doc:
<comment>Description:</comment>
  木炭画をシミュレートする
  
  木炭画をシミュレートします。

<comment>Param:</comment>
  <info>float</info>  <strong>$radius</strong>  ガウス分布の半径。中心を含まないピクセル数。
  <info>float</info>  <strong>$sigma</strong>   ガウス分布の標準偏差 (ピクセル単位)。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::chopImage
type: function
doc:
<comment>Description:</comment>
  画像の一部を取り除き、切り詰める
  
  画像の一部を削除し、そこにあった画像をなくします。

<comment>Param:</comment>
  <info>int</info>  <strong>$width</strong>   切り取る範囲の幅。
  <info>int</info>  <strong>$height</strong>  切り取る範囲の高さ。
  <info>int</info>  <strong>$x</strong>       切り取る範囲の X 座標。
  <info>int</info>  <strong>$y</strong>       切り取る範囲の Y 座標。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。

<comment>See Also:</comment>
   * <strong>Imagick::cropImage()</strong>


id: Imagick::clampImage
type: function
doc:
<comment>Description:</comment>
  Restricts the color range from 0 to the quantum depth.
  
  Restricts the color range from 0 to the quantum depth.

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

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: Imagick::clear
type: function
doc:
<comment>Description:</comment>
  Imagick オブジェクトに関連付けられたすべてのリソースをクリアする
  
  Imagick オブジェクトに関連付けられたすべてのリソースをクリアします。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::clipImage
type: function
doc:
<comment>Description:</comment>
  8BIM プロファイルの最初のパスにそって切り取る
  
  8BIM プロファイルの最初のパスが存在する場合に、それにそって切り取ります。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::clipImagePath
type: function
doc:
<comment>Description:</comment>
  Clips along the named paths from the 8BIM profile, if present
  
  Clips along the named paths from the 8BIM profile, if present. Later operations take effect inside
  the path.  Id may be a number if preceded with #, to work on a numbered path, e.g., "#1" to use
  the first path.
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$pathname</strong>  
  <info>string</info>  <strong>$inside</strong>    

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


id: Imagick::clipPathImage
type: function
doc:
<comment>Description:</comment>
  8BIM プロファイルの指定した名前のパスにそって切り取る
  
  8BIM プロファイルの指定した名前のパスが存在する場合に、それにそって切り取ります。 その後の操作はパ
  スの内部に対してのみ有効となります。 番号で指定する場合は、番号の前に # を付加します。つまり "#1"
  とすると最初のパスを使用します。

<comment>Param:</comment>
  <info>string</info>  <strong>$pathname</strong>  パスの名前。
  <info>bool</info>    <strong>$inside</strong>    true の場合は、その後の操作はクリップパスの内側に対して適用されます。 それ以外
                     の場合は、その後の操作はクリップパスの外側に対して適用されます。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::clone
type: function
doc:
<comment>Description:</comment>
  Imagick オブジェクトの完全なコピーを作成する
  
  Imagick オブジェクトの完全なコピーを作成します。
  
  この関数は imagick 3.1.0 で 非推奨 となりました。 かわりに clone キーワードを使います。

<comment>Return:</comment>
  <info>Imagick</info>  Imagick オブジェクトのコピーを返します。


id: Imagick::clutImage
type: function
doc:
<comment>Description:</comment>
  画像の色を置き換える
  
  画像の色を、ルックアップテーブルをもとに置き換えます。 オプションの 2 番目のパラメータを指定する
  と、 特定のチャネルの色を置き換えます。 このメソッドは、ImageMagick バージョン 6.3.6 以降で
  Imagick をコンパイルした場合に使用可能です。

<comment>Param:</comment>
  <info>Imagick</info>  <strong>$lookup_table</strong>  色ルックアップテーブルを含む Imagick オブジェクト。
  <info>int</info>      <strong>$channel</strong>       チャネルタイプ 定数。 省略した場合はデフォルトチャネルが対象となります。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。

<comment>See Also:</comment>
   * <strong>Imagick::adaptiveBlurImage()</strong>
   * <strong>Imagick::motionBlurImage()</strong>
   * <strong>Imagick::radialBlurImage()</strong>


id: Imagick::coalesceImages
type: function
doc:
<comment>Description:</comment>
  複数の画像を合成する
  
  ページオフセットや処理方法を指定して、複数の画像を合成します。 典型的な使用例としては、たとえば
  GIF や MIFF、MNG といった画像シーケンスを最初に背景として指定し、 それ以降にさまざまなサイズやオフ
  セットの画像を合成するというものがあります。 戻り値は、新規 Imagick オブジェクトとなります。 シー
  ケンスの各画像のサイズは、最初の画像のサイズと同じになります。

<comment>Return:</comment>
  <info>Imagick</info>  成功した場合に新規 Imagick オブジェクトを返します。


id: Imagick::colorFloodfillImage
type: function
doc:
<comment>Description:</comment>
  対象にマッチする任意の点の色の値を変更する
  
  対象にマッチする任意の点の色の値を変更します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$fill</strong>         塗りつぶし色を表す ImagickPixel オブジェクト。
  <info>float</info>  <strong>$fuzz</strong>         fuzz の量。たとえば fuzz を 10 に設定すると、 赤の輝度が 100 および 102 の点
                       は同じ色とみなされます。
  <info>mixed</info>  <strong>$bordercolor</strong>  枠線の色を表す ImagickPixel オブジェクト。
  <info>int</info>    <strong>$x</strong>            開始位置の X 座標。
  <info>int</info>    <strong>$y</strong>            開始位置の Y 座標。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::colorMatrixImage
type: function
doc:
<comment>Description:</comment>
  Apply color transformation to an image
  
  Apply color transformation to an image. The method permits saturation changes, hue rotation,
  luminance to alpha, and various other effects. Although variable-sized transformation matrices can
  be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6 for CMYKA (or RGBA with
  offsets). The matrix is similar to those used by Adobe Flash except offsets are in column 6 rather
  than 5 (in support of CMYKA images) and offsets are normalized (divide Flash offset by 255)

<comment>Param:</comment>
  <info>array</info>  <strong>$color_matrix</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::colorizeImage
type: function
doc:
<comment>Description:</comment>
  塗りつぶし色と画像を混合する
  
  画像の各ピクセルに、塗りつぶし色を混合します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$colorize</strong>  色を表す ImagickPixel オブジェクトあるいは文字列。
  <info>mixed</info>  <strong>$opacity</strong>   不透明度を表す ImagickPixel オブジェクトあるいは文字列。 1.0 は完全に不透明、0.0
                    は完全に透明であることを表します。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::combineImages
type: function
doc:
<comment>Description:</comment>
  ひとつあるいは複数の画像をひとつにまとめる
  
  ひとつあるいは複数の画像をひとつにまとめます。 一連の画像の各ピクセルのグレースケール値が、 合成し
  た画像の特定のチャネルの値となります。典型的なパターンでは 画像 1  =&gt; Red、画像 2 =&gt; Green、
  画像 3 =&gt; Blue などとなります。

<comment>Param:</comment>
  <info>int</info>  <strong>$channelType</strong>  そのチャネルモードで使用可能なチャネル定数のいずれか。 複数のチャネルを適用する
                     には、channeltype 定数をビット演算子でまとめます。 チャネル定数 の一覧を参照く
                     ださい。

<comment>Return:</comment>
  <info>Imagick</info>  成功した場合に <info>true</info> を返します。


id: Imagick::commentImage
type: function
doc:
<comment>Description:</comment>
  コメントを画像に追加する
  
  コメントを画像に追加します。

<comment>Param:</comment>
  <info>string</info>  <strong>$comment</strong>  追加するコメント。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::compareImageChannels
type: function
doc:
<comment>Description:</comment>
  ひとつあるいは複数の画像の差を返す
  
  ひとつあるいは複数の画像を比較し、差分の画像を返します。

<comment>Param:</comment>
  <info>Imagick</info>  <strong>$image</strong>        比較する画像を含む Imagick オブジェクト。
  <info>int</info>      <strong>$channelType</strong>  そのチャネルモードで使用可能なチャネル定数を指定します。 複数のチャネルを指
                         定するには、チャネル型定数をビット演算子で結合します。 チャネル定数 の一覧
                         を参照ください。
  <info>int</info>      <strong>$metricType</strong>   メトリック型定数 のいずれか。

<comment>Return:</comment>
  <info>array</info>  <return>new_wand</return> と <return>distortion</return> を含む配列を返します。


id: Imagick::compareImageLayers
type: function
doc:
<comment>Description:</comment>
  複数の画像の中で最大の境界範囲を返す
  
  各画像をシーケンス内の次の画像と比較し、 最大の境界範囲を返します。 このメソッドは、ImageMagick
  バージョン 6.2.9 以降で Imagick をコンパイルした場合に使用可能です。

<comment>Param:</comment>
  <info>int</info>  <strong>$method</strong>  レイヤメソッド定数 のいずれか。

<comment>Return:</comment>
  <info>Imagick</info>  成功した場合に <info>true</info> を返します。

<comment>See Also:</comment>
   * <strong>Imagick::optimizeImageLayers()</strong>
   * <strong>Imagick::writeImages()</strong>
   * <strong>Imagick::writeImage()</strong>


id: Imagick::compareImages
type: function
doc:
<comment>Description:</comment>
  ある画像を再構築された画像と比較する
  
  再構築された画像と画像の差異を含む配列を返します。

<comment>Param:</comment>
  <info>Imagick</info>  <strong>$compare</strong>  比較したい画像。
  <info>int</info>      <strong>$metric</strong>   メトリック定数を指定します。この メトリック定数 の一覧を参照ください。

<comment>Return:</comment>
  <info>array</info>  再構築された画像と画像の差異を含む配列を返します。


id: Imagick::compositeImage
type: function
doc:
<comment>Description:</comment>
  ある画像を別の画像に合成する
  
  ある画像を、別の画像の指定した位置に合成します。 合成アルゴリズムに指定する引数は、
  setImageArtifact の第一パラメータに 'compose:args'、第二パラメータにデータを渡す必要があります。

<comment>Param:</comment>
  <info>Imagick</info>  <strong>$composite_object</strong>  合成する画像を保持する Imagick オブジェクト。
  <info></info>         <strong>$compose</strong>           合成演算子。合成演算定数 を参照ください。
  <info>int</info>      <strong>$x</strong>                 合成する位置の列オフセット。
  <info>int</info>      <strong>$y</strong>                 合成する位置の行オフセット。
  <info>int</info>      <strong>$channel</strong>           そのチャネルモードで使用可能なチャネル定数を指定します。 複数のチャネ
                              ルを指定するには、チャネル型定数をビット演算子で結合します。 チャネル
                              定数 の一覧を参照ください。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。

<comment>See Also:</comment>
   * <strong>Imagick::setImageArtifact()</strong>


id: Imagick::contrastImage
type: function
doc:
<comment>Description:</comment>
  画像のコントラストを変更する
  
  画像の中の暗めの部分と明るめの部分の輝度の差を強調します。 sharpen に 0 以外を指定すると画像のコン
  トラストを上げ、 0 を指定するとコントラストを下げます。

<comment>Param:</comment>
  <info>bool</info>  <strong>$sharpen</strong>  シャープ値。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::contrastStretchImage
type: function
doc:
<comment>Description:</comment>
  カラー画像のコントラストを強調する
  
  とりうる色の範囲全体に色を調整することによって、 カラー画像のコントラストを強調します。 このメソッ
  ドは、ImageMagick バージョン 6.2.9 以降で Imagick をコンパイルした場合に使用可能です。

<comment>Param:</comment>
  <info>float</info>  <strong>$black_point</strong>  黒の点。
  <info>float</info>  <strong>$white_point</strong>  白の点。
  <info>int</info>    <strong>$channel</strong>      チャネルモードに対応したチャネル定数を指定します。 複数のチャネルに適用するに
                       は、 ビット演算子でチャネル型定数を組み合わせます。 デフォルトは
                       <info>Imagick::CHANNEL_ALL</info> です。 チャネル定数 の一覧を参照ください。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::convolveImage
type: function
doc:
<comment>Description:</comment>
  独自の畳み込み関数を画像に適用する
  
  独自の畳み込み関数を画像に適用します。

<comment>Param:</comment>
  <info>array</info>  <strong>$kernel</strong>   畳み込みの中心。
  <info>int</info>    <strong>$channel</strong>  そのチャネルモードで使用可能なチャネル定数を指定します。 複数のチャネルを適用する
                   には、定数をビット演算子で連結します。 チャネル定数 の一覧を参照ください。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::count
type: function
doc:
<comment>Description:</comment>
  Get the number of images
  
  Returns the number of images.

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  An unused argument. Currently there is a non-particularly well defined feature in PHP
              where calling count() on a countable object might (or might not) require this method
              to accept a parameter. This parameter is here to be conformant with the interface of
              countable, even though the param is not used.

<comment>Return:</comment>
  <info>int</info>  Returns the number of images.


id: Imagick::cropImage
type: function
doc:
<comment>Description:</comment>
  画像の一部を抽出する
  
  画像の一部を抽出します。

<comment>Param:</comment>
  <info>int</info>  <strong>$width</strong>   抽出する幅。
  <info>int</info>  <strong>$height</strong>  抽出する高さ。
  <info>int</info>  <strong>$x</strong>       抽出する領域の左上の X 座標。
  <info>int</info>  <strong>$y</strong>       抽出する領域の左上の Y 座標。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::cropThumbnailImage
type: function
doc:
<comment>Description:</comment>
  切り取ってサムネイルを作成する
  
  固定サイズのサムネイルを作成します。 まず画像のサイズを拡大あるいは縮小し、指定した範囲を中心から
  切り取ります。

<comment>Param:</comment>
  <info>int</info>  <strong>$width</strong>   サムネイルの幅。
  <info>int</info>  <strong>$height</strong>  サムネイルの高さ。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::current
type: function
doc:
<comment>Description:</comment>
  現在の Imagick オブジェクトへの参照を返す
  
  現在の imagick オブジェクトへの参照を返し、 画像ポインタを正しいシーケンスに設定します。

<comment>Return:</comment>
  <info>Imagick</info>  成功した場合に自分自身を返します。


id: Imagick::cycleColormapImage
type: function
doc:
<comment>Description:</comment>
  画像のカラーマップを移動する
  
  位置番号を指定して、画像のカラーマップを移動します。 カラーマップを何度か回転させると、サイケデ
  リックな効果が得られます。

<comment>Param:</comment>
  <info>int</info>  <strong>$displace</strong>  カラーマップを移動させる量。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::decipherImage
type: function
doc:
<comment>Description:</comment>
  画像を復号する
  
  暗号化された画像を復号します。画像の暗号化は <strong>Imagick::encipherImage()</strong> で行わなければなりません。
  このメソッドは、ImageMagick バージョン 6.3.9 以降で Imagick をコンパイルした場合に使用可能です。

<comment>Param:</comment>
  <info>string</info>  <strong>$passphrase</strong>  パスフレーズ。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。

<comment>See Also:</comment>
   * <strong>Imagick::encipherImage()</strong>


id: Imagick::deconstructImages
type: function
doc:
<comment>Description:</comment>
  画像間の特定のピクセルの差を返す
  
  各画像をシーケンス内の次の画像と比較し、 最大の境界範囲を返します。

<comment>Return:</comment>
  <info>Imagick</info>  成功した場合に新しい Imagick オブジェクトを返します。


id: Imagick::deleteImageArtifact
type: function
doc:
<comment>Description:</comment>
  画像のアーチファクトを削除する
  
  画像に関連づけられたアーチファクトを削除します。プロパティとアーチファクトの違いは、 プロパティは
  public であるのに対してアーチファクトは private であるという点です。 このメソッドは、ImageMagick
  バージョン 6.5.7 以降で Imagick をコンパイルした場合に使用可能です。

<comment>Param:</comment>
  <info>string</info>  <strong>$artifact</strong>  削除したいアーチファクトの名前。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。

<comment>See Also:</comment>
   * <strong>Imagick::setImageArtifact()</strong>
   * <strong>Imagick::getImageArtifact()</strong>


id: Imagick::deleteImageProperty
type: function
doc:
<comment>Description:</comment>
  Deletes an image property
  
  Deletes an image property.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name of the property to delete.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::deskewImage
type: function
doc:
<comment>Description:</comment>
  傾きを除去する
  
  このメソッドを使うと、スキャナでの読み込み時にうまく紙を置かなかった場合などの画像の傾きを除去する
  ことができます。 このメソッドは、ImageMagick バージョン 6.4.5 以降で Imagick をコンパイルした場合
  に使用可能です。

<comment>Param:</comment>
  <info>float</info>  <strong>$threshold</strong>  傾き除去の閾値。

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


id: Imagick::despeckleImage
type: function
doc:
<comment>Description:</comment>
  画像内のスペックルノイズを軽減する
  
  画像内のスペックルノイズを軽減します。ただし元画像の輪郭は保持します。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::destroy
type: function
doc:
<comment>Description:</comment>
  Imagick オブジェクトを破棄する
  
  Imagick オブジェクトを破棄し、関連するリソースをすべて開放します。 このメソッドは非推奨です。かわ
  りに Imagick::clear を使いましょう。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::displayImage
type: function
doc:
<comment>Description:</comment>
  画像を表示する
  
  このメソッドは、画像を X サーバーに表示します。

<comment>Param:</comment>
  <info>string</info>  <strong>$servername</strong>  X サーバーの名前。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::displayImages
type: function
doc:
<comment>Description:</comment>
  画像あるいは画像シーケンスを表示する
  
  画像あるいは画像シーケンスを X サーバーに表示します。

<comment>Param:</comment>
  <info>string</info>  <strong>$servername</strong>  X サーバーの名前。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::distortImage
type: function
doc:
<comment>Description:</comment>
  さまざまな方式で画像を歪める
  
  さまざまな方式で画像を歪めます。 これは、元画像の色を新たな画像の色に対応させることで行います。 新
  たな画像は、'bestfit' を true に設定しない限りは元画像と同じ大きさになります。
  
  'bestfit' を有効にし、使用する歪め方式がサイズ変更を許可していた場合は、 変換後の画像に合わせて画
  像のサイズやオフセットが調整されます。 多くの場合、元画像の仮想オフセットも考慮したマッピングが行
  われます。
  
  このメソッドは、ImageMagick バージョン 6.3.6 以降で Imagick をコンパイルした場合に使用可能です。

<comment>Param:</comment>
  <info>int</info>    <strong>$method</strong>     画像の歪め方式。 歪め定数 を参照ください。
  <info>array</info>  <strong>$arguments</strong>  歪め方式の引数。
  <info>bool</info>   <strong>$bestfit</strong>    元画像のサイズを変更する。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。

<comment>See Also:</comment>
   * <strong>Imagick::blurImage()</strong>
   * <strong>Imagick::motionBlurImage()</strong>
   * <strong>Imagick::radialBlurImage()</strong>


id: Imagick::drawImage
type: function
doc:
<comment>Description:</comment>
  現在の画像上の ImagickDraw オブジェクトをレンダリングする
  
  現在の画像上の ImagickDraw オブジェクトをレンダリングします。

<comment>Param:</comment>
  <info>ImagickDraw</info>  <strong>$draw</strong>  画像をレンダリングする描画操作。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::edgeImage
type: function
doc:
<comment>Description:</comment>
  画像の輪郭を強調する
  
  指定した半径の畳み込みフィルタを使用して、画像の輪郭を強調します。 radius に 0 を設定すると自動選
  択となります。

<comment>Param:</comment>
  <info>float</info>  <strong>$radius</strong>  操作の半径。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::embossImage
type: function
doc:
<comment>Description:</comment>
  グレースケール画像に三次元効果を施して返す
  
  グレースケール画像に三次元効果を施したものを返します。 指定した半径と標準偏差 (シグマ) によるガウ
  ス演算によって画像を畳み込みます。 意味のある結果を得るには、半径がシグマより大きくなければなりま
  せん。 radius に 0 を指定すると、適切な半径を自動的に設定します。

<comment>Param:</comment>
  <info>float</info>  <strong>$radius</strong>  効果の半径。
  <info>float</info>  <strong>$sigma</strong>   効果のシグマ。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::encipherImage
type: function
doc:
<comment>Description:</comment>
  画像を暗号化する
  
  プレーンなピクセル群を暗号化します。<strong>Imagick::decipherImage()</strong> で復号するまで、この画像は読めなくな
  ります。 このメソッドは、ImageMagick バージョン 6.3.9 以降で Imagick をコンパイルした場合に使用可
  能です。

<comment>Param:</comment>
  <info>string</info>  <strong>$passphrase</strong>  パスフレーズ。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。

<comment>See Also:</comment>
   * <strong>Imagick::decipherImage()</strong>


id: Imagick::enhanceImage
type: function
doc:
<comment>Description:</comment>
  ノイジーな画像の品質を向上させる
  
  デジタルフィルタを適用して、ノイジーな画像の品質を向上させます。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::equalizeImage
type: function
doc:
<comment>Description:</comment>
  画像ヒストグラムを均等化する
  
  画像ヒストグラムを均等化します。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::evaluateImage
type: function
doc:
<comment>Description:</comment>
  式を画像に適用する
  
  算術演算、関係演算、論理演算などを画像に適用します。 これらの演算子を使用すると、画像の明度を変え
  たりコントラストを変えたり、 あるいは画像の "ネガ" を作成したりすることができます。

<comment>Param:</comment>
  <info>int</info>    <strong>$op</strong>        評価演算子。
  <info>float</info>  <strong>$constant</strong>  演算子の値。
  <info>int</info>    <strong>$channel</strong>   チャネルモードに対応したチャネル定数を指定します。 複数のチャネルに適用するに
                    は、 ビット演算子でチャネル型定数を組み合わせます。 チャネル定数 の一覧を参照く
                    ださい。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::exportImagePixels
type: function
doc:
<comment>Description:</comment>
  画像の生のピクセルをエクスポートする
  
  画像のピクセルを配列にエクスポートします。map には、エクスポートするピクセルの順序を指定します。
  返される配列の大きさは <return>width * height * strlen(map)</return> となります。 このメソッドは、ImageMagick バー
  ジョン 6.4.7 以降で Imagick をコンパイルした場合に使用可能です。

<comment>Param:</comment>
  <info>int</info>     <strong>$x</strong>        エクスポートする範囲の X 座標。
  <info>int</info>     <strong>$y</strong>        エクスポートする範囲の Y 座標。
  <info>int</info>     <strong>$width</strong>    エクスポートする範囲の幅。
  <info>int</info>     <strong>$height</strong>   エクスポートする範囲の高さ。
  <info>string</info>  <strong>$map</strong>      エクスポートするピクセルの順序。<return>"RGB"</return> など。 map で使える文字は R, G, B, A, O,
                    C, Y, M, K, I および P です。
  <info>int</info>     <strong>$STORAGE</strong>  ピクセル型定数 を参照ください。

<comment>Return:</comment>
  <info>array</info>  ピクセルの値を含む配列を返します。


id: Imagick::extentImage
type: function
doc:
<comment>Description:</comment>
  画像のサイズを設定する
  
  画像のサイズを設定するための便利なメソッドです。 このメソッドは、画像のサイズおよび新しい領域を開
  始する x 座標、y 座標を設定することができます。 このメソッドは、ImageMagick バージョン 6.3.1 以降
  で Imagick をコンパイルした場合に使用可能です。
  
  ImageMagick 6.5.7-8 (1623) より前のバージョンでは、$x は、左にシフトするときが正で右にシフトすると
  きが負でした。 また $y は、上にシフトするときが正で下にシフトするときが負でした。
   ImageMagick 6.3.7 (1591) から ImageMagick 6.5.7-8 (1623) までのどこかで、$x と $y の座標が反転し
  ました。 つまり、$x は、左にシフトするときが負で右にシフトするときが正になりました。 また $y も、
  上にシフトするときが負で下にシフトするときが正になりました。
   そして ImageMagick 6.5.7-8 (1623) から ImageMagick 6.6.9-7 (1641) までのどこかで、$x と $y の座標
  が再び反転して、ImageMagick 6.5.7-8 (1623) より前のバージョンと同じ状態に戻りました。

<comment>Param:</comment>
  <info>int</info>  <strong>$width</strong>   新しい幅。
  <info>int</info>  <strong>$height</strong>  新しい高さ。
  <info>int</info>  <strong>$x</strong>       新しいサイズの X 座標。
  <info>int</info>  <strong>$y</strong>       新しいサイズの Y 座標。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。

<comment>See Also:</comment>
   * <strong>Imagick::resizeImage()</strong>
   * <strong>Imagick::thumbnailImage()</strong>
   * <strong>Imagick::cropImage()</strong>


id: Imagick::filter
type: function
doc:
<comment>Description:</comment>
  Applies a custom convolution kernel to the image
  
  Applies a custom convolution kernel to the image.

<comment>Param:</comment>
  <info>ImagickKernel</info>  <strong>$ImagickKernel</strong>  An instance of ImagickKernel that represents either a single kernel
                                 or a linked series of kernels.
  <info>int</info>            <strong>$channel</strong>        そのモードで有効なチャネル定数を指定します。
                                 複数のチャネルを適用するには、チャネル定数
                                 をビット演算子で組み合わせます。デフォルトは
                                 <info>Imagick::CHANNEL_DEFAULT</info> です。
                                 チャネル定数 の一覧を参照ください。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::flattenImages
type: function
doc:
<comment>Description:</comment>
  画像シーケンスをマージする
  
  画像シーケンスをマージします。 これは、たとえば Photoshop のレイヤを単一の画像にまとめる場合などに
  便利です。

<comment>Return:</comment>
  <info>Imagick</info>  成功した場合に <info>true</info> を返します。


id: Imagick::flipImage
type: function
doc:
<comment>Description:</comment>
  垂直方向に反転した画像を作成する
  
  中心の x 軸を基準してピクセルを反転させ、垂直方向のミラー画像を作成します。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。

<comment>See Also:</comment>
   * <strong>Imagick::flopimage()</strong>


id: Imagick::floodFillPaintImage
type: function
doc:
<comment>Description:</comment>
  対象にマッチする任意のピクセルの値を変更する
  
  対象にマッチするピクセルとその直接の近傍の任意のピクセルの色の値を変更します。 このメソッドは、廃
  止予定の <strong>Imagick::paintFloodFillImage()</strong> を置き換えるものです。 このメソッドは、ImageMagick バー
  ジョン 6.3.8 以降で Imagick をコンパイルした場合に使用可能です。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$fill</strong>     塗りつぶし色を表す ImagickPixel オブジェクトあるいは文字列。
  <info>float</info>  <strong>$fuzz</strong>     あいまいさをあらわす量。たとえば、これを 10 に設定すると、
                   赤色の値が 100 の色と 102 の色は同じものとみなされます。
  <info>mixed</info>  <strong>$target</strong>   対象の色を表す ImagickPixel オブジェクトあるいは文字列。
  <info>int</info>    <strong>$x</strong>        開始位置の X 座標。
  <info>int</info>    <strong>$y</strong>        開始位置の Y 座標。
  <info>bool</info>   <strong>$invert</strong>   <info>true</info> の場合は、対象の色にマッチしない任意のピクセルをペイントします。
  <info>int</info>    <strong>$channel</strong>  そのモードで有効なチャネル定数を指定します。
                   複数のチャネルを適用するには、チャネル定数
                   をビット演算子で組み合わせます。デフォルトは <info>Imagick::CHANNEL_DEFAULT</info> です。
                   チャネル定数 の一覧を参照ください。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::flopImage
type: function
doc:
<comment>Description:</comment>
  水平方向に反転した画像を作成する
  
  中心の y 軸を基準してピクセルを反転させ、水平方向のミラー画像を作成します。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。

<comment>See Also:</comment>
   * <strong>Imagick::flipimage()</strong>


id: Imagick::forwardFourierTransformImage
type: function
doc:
<comment>Description:</comment>
  Implements the discrete Fourier transform (DFT)
  
  Implements the discrete Fourier transform (DFT) of the image either as a magnitude / phase or real
  / imaginary image pair.

<comment>Param:</comment>
  <info>bool</info>  <strong>$magnitude</strong>  If true, return as magnitude / phase pair otherwise a real / imaginary image
                    pair.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::frameImage
type: function
doc:
<comment>Description:</comment>
  三次元の枠線をシミュレートする
  
  画像の周りに三次元の枠線を追加します。 width と height で、それぞれ縦の枠線と横の枠線の幅を指定し
  ます。 inner_bevel および outer_bevel は、 それぞれ枠の内側と外側の影の幅を指定します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$matte_color</strong>  マット色を表す ImagickPixel オブジェクトあるいは文字列。
  <info>int</info>    <strong>$width</strong>        枠の幅。
  <info>int</info>    <strong>$height</strong>       枠の高さ。
  <info>int</info>    <strong>$inner_bevel</strong>  内側の影の幅。
  <info>int</info>    <strong>$outer_bevel</strong>  外側の影の幅。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::functionImage
type: function
doc:
<comment>Description:</comment>
  画像に関数を適用する
  
  算術演算、関係演算、論理演算などを疑似画像に適用します。
  
  ImageMagick v6 Examples - Image Transformations — Function, Multi-Argument Evaluate も参照くださ
  い。
  
  このメソッドは、ImageMagick バージョン 6.4.9 以降で Imagick をコンパイルした場合に使用可能です。

<comment>Param:</comment>
  <info>int</info>    <strong>$function</strong>   関数定数 の一覧を参照ください。
  <info>array</info>  <strong>$arguments</strong>  この関数に渡す引数の配列。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::fxImage
type: function
doc:
<comment>Description:</comment>
  式を画像の各ピクセルに適用する
  
  式を画像の各ピクセルに適用します。 詳細は The Fx Special Effects Image Operator を参照ください。

<comment>Param:</comment>
  <info>string</info>  <strong>$expression</strong>  式。
  <info>int</info>     <strong>$channel</strong>     チャネルモードに対応したチャネル定数を指定します。 複数のチャネルに適用するに
                       は、 ビット演算子でチャネル型定数を組み合わせます。 チャネル定数 の一覧を参照
                       ください。

<comment>Return:</comment>
  <info>Imagick</info>  成功した場合に <info>true</info> を返します。


id: Imagick::gammaImage
type: function
doc:
<comment>Description:</comment>
  画像をガンマ補正する
  
  画像をガンマ補正します。同じ画像でも、 異なるデバイス上で見ると見た目が変わることがあります。 これ
  は、画面上に画像の輝度を表現する方法がことなるためです。 赤、緑、青の各チャネルに個別のガンマレベ
  ルを指定するか、 あるいはすべてのチャネルに共通のガンマレベルを指定します。 値の典型的な範囲は、
  0.8 から 2.3 の間となります。

<comment>Param:</comment>
  <info>float</info>  <strong>$gamma</strong>    ガンマ補正の量。
  <info>int</info>    <strong>$channel</strong>  チャネルモードに対応したチャネル定数を指定します。 複数のチャネルに適用するには、
                   ビット演算子でチャネル型定数を組み合わせます。 チャネル定数 の一覧を参照くださ
                   い。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::gaussianBlurImage
type: function
doc:
<comment>Description:</comment>
  画像をぼかす
  
  画像をぼかします。 指定した半径と標準偏差 (シグマ) によるガウス演算によって画像を畳み込みます。 意
  味のある結果を得るには、半径がシグマより大きくなければなりません。 radius に 0 を指定すると、適切
  な半径を自動的に設定します。

<comment>Param:</comment>
  <info>float</info>  <strong>$radius</strong>   ガウス演算の半径。ピクセル単位で指定し、中心は計算に入れません。
  <info>float</info>  <strong>$sigma</strong>    ガウス演算の標準偏差。ピクセル単位で指定します。
  <info>int</info>    <strong>$channel</strong>  チャネルモードに対応したチャネル定数を指定します。 複数のチャネルに適用するには、
                   ビット演算子でチャネル型定数を組み合わせます。 チャネル定数 の一覧を参照くださ
                   い。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::getColorspace
type: function
doc:
<comment>Description:</comment>
  色空間を取得する
  
  グローバル色空間の値を取得します。 このメソッドは、ImageMagick バージョン 6.5.7 以降で Imagick を
  コンパイルした場合に使用可能です。

<comment>Return:</comment>
  <info>int</info>  整数値を返します。この値を COLORSPACE 定数 と比較することができます。


id: Imagick::getCompression
type: function
doc:
<comment>Description:</comment>
  オブジェクトの圧縮形式を取得する
  
  オブジェクトの圧縮形式を取得します。

<comment>Return:</comment>
  <info>int</info>  圧縮定数を返します。


id: Imagick::getCompressionQuality
type: function
doc:
<comment>Description:</comment>
  オブジェクトの圧縮品質を取得する
  
  オブジェクトの圧縮品質を取得します。

<comment>Return:</comment>
  <info>int</info>  圧縮品質を表す整数値を返します。


id: Imagick::getCopyright
type: function
doc:
<comment>Description:</comment>
  ImageMagick API の著作権情報を文字列で返す
  
  ImageMagick API の著作権情報を文字列で返します。

<comment>Return:</comment>
  <info>string</info>  Imagemagick および Magickwand C API の著作権情報を含む文字列を返します。


id: Imagick::getFont
type: function
doc:
<comment>Description:</comment>
  フォントを取得する
  
  オブジェクトのフォントプロパティを返します。 このメソッドは、ImageMagick バージョン 6.3.7 以降で
  Imagick をコンパイルした場合に使用可能です。

<comment>Return:</comment>
  <info>string</info>  フォント名を表す文字列を返します。フォントが設定されていない場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>Imagick::setFont()</strong>
   * <strong>ImagickDraw::setFont()</strong>
   * <strong>ImagickDraw::getFont()</strong>


id: Imagick::getFormat
type: function
doc:
<comment>Description:</comment>
  Imagick オブジェクトのフォーマットを取得する
  
  Imagick オブジェクトのフォーマットを返します。

<comment>Return:</comment>
  <info>string</info>  画像フォーマットを返します。


id: Imagick::getGravity
type: function
doc:
<comment>Description:</comment>
  gravity を取得する
  
  Imagick オブジェクトのグローバル gravity プロパティを取得します。 このメソッドは、ImageMagick バー
  ジョン 6.4.0 以降で Imagick をコンパイルした場合に使用可能です。

<comment>Return:</comment>
  <info>int</info>  gravity プロパティを返します。 gravity 定数 の一覧を参照ください。


id: Imagick::getHomeURL
type: function
doc:
<comment>Description:</comment>
  ImageMagick のホーム URL を返す
  
  ImageMagick のホーム URL を返します。

<comment>Return:</comment>
  <info>string</info>  imagemagick のホームページへのリンクを返します。


id: Imagick::getImage
type: function
doc:
<comment>Description:</comment>
  新しい Imagick オブジェクトを返す
  
  現在の画像シーケンスを使用した新しい Imagick オブジェクトを返します。

<comment>Return:</comment>
  <info>Imagick</info>  現在の画像シーケンスを使用した新しい Imagick オブジェクトを返します。


id: Imagick::getImageAlphaChannel
type: function
doc:
<comment>Description:</comment>
  画像がアルファチャネルを持つかを調べる
  
  画像がアルファチャネルを持つかを返します。

<comment>Return:</comment>
  <info>bool</info>  画像がアルファチャネル値を持つ場合は <info>true</info> を返します。 持たない場合 つまり、画像が RGBA では
        なく RGB の場合。 または CMYKA ではなく、 CMYK である場合には、 <info>false</info> を返します。


id: Imagick::getImageArtifact
type: function
doc:
<comment>Description:</comment>
  画像のアーチファクトを取得する
  
  画像に関連づけられたアーチファクトを取得します。プロパティとアーチファクトの違いは、 プロパティは
  public であるのに対してアーチファクトは private であるという点です。 このメソッドは、ImageMagick
  バージョン 6.5.7 以降で Imagick をコンパイルした場合に使用可能です。

<comment>Param:</comment>
  <info>string</info>  <strong>$artifact</strong>  アーチファクトの名前。

<comment>Return:</comment>
  <info>string</info>  成功した場合にアーチファクトの値を返します。

<comment>See Also:</comment>
   * <strong>Imagick::setImageArtifact()</strong>
   * <strong>Imagick::deleteImageArtifact()</strong>


id: Imagick::getImageAttribute
type: function
doc:
<comment>Description:</comment>
  Returns a named attribute
  
  Returns a named attribute.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  The key of the attribute to get.

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


id: Imagick::getImageBackgroundColor
type: function
doc:
<comment>Description:</comment>
  画像の背景色を返す
  
  画像の背景色を返します。

<comment>Return:</comment>
  <info>ImagickPixel</info>  画像の背景色を設定した ImagickPixel を返します。


id: Imagick::getImageBlob
type: function
doc:
<comment>Description:</comment>
  画像シーケンスを blob で返す
  
  画像フォーマットを直接記憶します。 これは、画像シーケンスを文字列で返します。 画像のフォーマットに
  よって、返される blob の形式 (GIF, JPEG, PNG, など) が決まります。 別の画像フォーマットを返すには
  Imagick::SetImageFormat() を使用します。

<comment>Return:</comment>
  <info>string</info>  画像を含む文字列を返します。


id: Imagick::getImageBorderColor
type: function
doc:
<comment>Description:</comment>
  画像の前景色を返す
  
  画像の前景色を返します。

<comment>Return:</comment>
  <info>ImagickPixel</info>  成功した場合に <info>true</info> を返します。


id: Imagick::getImageChannelDepth
type: function
doc:
<comment>Description:</comment>
  特定の画像チャネルの深度を返す
  
  特定の画像チャネルの深度を返します。

<comment>Param:</comment>
  <info>int</info>  <strong>$channel</strong>  そのモードで有効なチャネル定数を指定します。
                 複数のチャネルを適用するには、チャネル定数
                 をビット演算子で組み合わせます。デフォルトは <info>Imagick::CHANNEL_DEFAULT</info> です。
                 チャネル定数 の一覧を参照ください。

<comment>Return:</comment>
  <info>int</info>  成功した場合に <info>true</info> を返します。


id: Imagick::getImageChannelDistortion
type: function
doc:
<comment>Description:</comment>
  画像のチャネルを再構築した画像と比較する
  
  ひとつあるいは複数のチャネルの内容を再構築した画像と比較し、 指定した歪み係数を返します。

<comment>Param:</comment>
  <info>Imagick</info>  <strong>$reference</strong>  比較する Imagick オブジェクト。
  <info>int</info>      <strong>$channel</strong>    チャネルモードに対応したチャネル定数を指定します。 複数のチャネルに適用するに
                       は、 ビット演算子でチャネル型定数を組み合わせます。 チャネル定数 の一覧を参照
                       ください。
  <info>int</info>      <strong>$metric</strong>     メトリック型定数 のいずれか。

<comment>Return:</comment>
  <info>float</info>  成功した場合に <info>true</info> を返します。


id: Imagick::getImageChannelDistortions
type: function
doc:
<comment>Description:</comment>
  チャネルの歪みを取得する
  
  ひとつあるいは複数のチャネルの内容を再構築した画像と比較し、 指定した歪み係数を返します。 このメ
  ソッドは、ImageMagick バージョン 6.4.4 以降で Imagick をコンパイルした場合に使用可能です。

<comment>Param:</comment>
  <info>Imagick</info>  <strong>$reference</strong>  比較する画像を含む Imagick オブジェクト。
  <info>int</info>      <strong>$metric</strong>     メトリック型定数 の一覧を参照ください。
  <info>int</info>      <strong>$channel</strong>    そのモードで有効なチャネル定数を指定します。
                       複数のチャネルを適用するには、チャネル定数
                       をビット演算子で組み合わせます。デフォルトは <info>Imagick::CHANNEL_DEFAULT</info> です。
                       チャネル定数 の一覧を参照ください。

<comment>Return:</comment>
  <info>float</info>  チャネルの歪みを表す <info>float</info> 型の値を返します。


id: Imagick::getImageChannelExtrema
type: function
doc:
<comment>Description:</comment>
  ひとつあるいは複数の画像チャネルの極値を取得する
  
  ひとつあるいは複数の画像チャネルの極値を取得します。 戻り値は連想配列で、"minima" および "maxima"
  というキーを含みます。

<comment>Param:</comment>
  <info>int</info>  <strong>$channel</strong>  チャネルモードに対応したチャネル定数を指定します。 複数のチャネルに適用するには、
                 ビット演算子でチャネル型定数を組み合わせます。 チャネル定数 の一覧を参照ください。

<comment>Return:</comment>
  <info>array</info>  成功した場合に <info>true</info> を返します。


id: Imagick::getImageChannelKurtosis
type: function
doc:
<comment>Description:</comment>
  getImageChannelKurtosis
  
  指定したチャネルの尖度と歪度を取得します。このメソッドは、ImageMagick バージョン 6.4.9 以降で
  Imagick をコンパイルした場合に使用可能です。

<comment>Param:</comment>
  <info>int</info>  <strong>$channel</strong>  そのモードで有効なチャネル定数を指定します。
                 複数のチャネルを適用するには、チャネル定数
                 をビット演算子で組み合わせます。デフォルトは <info>Imagick::CHANNEL_DEFAULT</info> です。
                 チャネル定数 の一覧を参照ください。

<comment>Return:</comment>
  <info>array</info>  <return>kurtosis</return> と <return>skewness</return> を要素に持つ配列を返します。


id: Imagick::getImageChannelMean
type: function
doc:
<comment>Description:</comment>
  平均値と標準偏差を取得する
  
  ひとつあるいは複数の画像チャネルの平均値および標準偏差を取得します。

<comment>Param:</comment>
  <info>int</info>  <strong>$channel</strong>  チャネルモードに対応したチャネル定数を指定します。 複数のチャネルに適用するには、
                 ビット演算子でチャネル型定数を組み合わせます。 チャネル定数 の一覧を参照ください。

<comment>Return:</comment>
  <info>array</info>  "mean" および "standardDeviation" というキーを含む配列を返します。


id: Imagick::getImageChannelRange
type: function
doc:
<comment>Description:</comment>
  チャネルの範囲を取得する
  
  ひとつあるいは複数のチャネルの範囲を取得します。 このメソッドは、ImageMagick バージョン 6.4.0 以降
  で Imagick をコンパイルした場合に使用可能です。

<comment>Param:</comment>
  <info>int</info>  <strong>$channel</strong>  そのモードで有効なチャネル定数を指定します。
                 複数のチャネルを適用するには、チャネル定数
                 をビット演算子で組み合わせます。デフォルトは <info>Imagick::CHANNEL_DEFAULT</info> です。
                 チャネル定数 の一覧を参照ください。

<comment>Return:</comment>
  <info>array</info>  チャネルの minima および maxima の値を含む配列を返します。


id: Imagick::getImageChannelStatistics
type: function
doc:
<comment>Description:</comment>
  画像の各チャネルの統計情報を返す
  
  画像の各チャネルの統計情報を返します。 この情報に含まれるのは、チャネルの深度、最小値と最大値、 平
  均値、そして標準偏差です。

<comment>Return:</comment>
  <info>array</info>  成功した場合に <info>true</info> を返します。


id: Imagick::getImageClipMask
type: function
doc:
<comment>Description:</comment>
  画像のクリップマスクを取得する
  
  画像のクリップマスクを含む Imagick オブジェクトを返します。 このメソッドは、ImageMagick バージョン
  6.3.6 以降で Imagick をコンパイルした場合に使用可能です。

<comment>Return:</comment>
  <info>Imagick</info>  画像のクリップマスクを含む Imagick オブジェクトを返します。


id: Imagick::getImageColormapColor
type: function
doc:
<comment>Description:</comment>
  指定したインデックスに対応する色マップ上の色を返す
  
  指定したインデックスに対応する色マップ上の色を返します。

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  画像の色マップ内のオフセット。

<comment>Return:</comment>
  <info>ImagickPixel</info>  成功した場合に <info>true</info> を返します。


id: Imagick::getImageColors
type: function
doc:
<comment>Description:</comment>
  画像で使われている色の数を取得する
  
  画像で使われている色の数を取得します。

<comment>Return:</comment>
  <info>int</info>  画像で使われているユニークな色の数を <info>int</info> で返します。


id: Imagick::getImageColorspace
type: function
doc:
<comment>Description:</comment>
  画像の色空間を取得する
  
  画像の色空間を取得します。

<comment>Return:</comment>
  <info>int</info>  COLORSPACE 定数 と比較できる整数を返します。


id: Imagick::getImageCompose
type: function
doc:
<comment>Description:</comment>
  画像の合成演算子を返す
  
  画像に関連付けられている合成演算子を返します。

<comment>Return:</comment>
  <info>int</info>  成功した場合に <info>true</info> を返します。


id: Imagick::getImageCompression
type: function
doc:
<comment>Description:</comment>
  現在の画像の圧縮形式を取得する
  
  現在の画像の圧縮形式を取得します。

<comment>Return:</comment>
  <info>int</info>  圧縮形式を表す定数を返します。


id: Imagick::getImageCompressionQuality
type: function
doc:
<comment>Description:</comment>
  現在の画像の圧縮品質を取得する
  
  現在の画像の圧縮品質を取得します。

<comment>Return:</comment>
  <info>int</info>  画像の圧縮品質を表す整数値を返します。


id: Imagick::getImageDispose
type: function
doc:
<comment>Description:</comment>
  画像の配置方法を取得する
  
  画像の配置方法を取得します。

<comment>Return:</comment>
  <info>int</info>  成功した場合に配置方法を返します。


id: Imagick::getImageDistortion
type: function
doc:
<comment>Description:</comment>
  ある画像と再構築した画像を比較する
  
  ある画像と再構築した画像を比較し、 指定した歪み係数を返します。

<comment>Param:</comment>
  <info>MagickWand</info>  <strong>$reference</strong>  比較する Imagick オブジェクト。
  <info>int</info>         <strong>$metric</strong>     メトリック型定数 のいずれか。

<comment>Return:</comment>
  <info>float</info>  その画像で使用する歪み係数 (あるいはその推測値) を返します。


id: Imagick::getImageGeometry
type: function
doc:
<comment>Description:</comment>
  幅と高さを連想配列で取得する
  
  幅と高さを連想配列で返します。

<comment>Return:</comment>
  <info>array</info>  画像の幅と高さを表す配列を返します。


id: Imagick::getImageGravity
type: function
doc:
<comment>Description:</comment>
  画像の gravity を取得する
  
  画像の原罪の current 値を取得します。 <strong>Imagick::getGravity()</strong> とは異なり、 このメソッドは原罪の画像
  シーケンスで定義された gravity を返します。 このメソッドは、ImageMagick バージョン 6.4.4 以降で
  Imagick をコンパイルした場合に使用可能です。

<comment>Return:</comment>
  <info>int</info>  画像の property プロパティを返します。 gravity 定数 の一覧を参照ください。


id: Imagick::getImageGreenPrimary
type: function
doc:
<comment>Description:</comment>
  緑が一番強い点を返す
  
  緑が一番強い点を返します。"x" および "y" というキーを持つ配列を返します。

<comment>Return:</comment>
  <info>array</info>  成功した場合に "x" および "y" というキーを持つ配列を返します。 失敗した場合は
         ImagickException をスローします。


id: Imagick::getImageHistogram
type: function
doc:
<comment>Description:</comment>
  画像のヒストグラムを取得する
  
  画像のヒストグラムを ImagickPixel オブジェクトの配列で返します。

<comment>Return:</comment>
  <info>array</info>  画像のヒストグラムを ImagickPixel オブジェクトの配列で返します。


id: Imagick::getImageIndex
type: function
doc:
<comment>Description:</comment>
  現在アクティブな画像のインデックスを取得する
  
  Imagick オブジェクト内で現在アクティブな画像のインデックスを取得します。 このメソッドは非推奨で
  す。 <strong>Imagick::getIteratorIndex()</strong> を参照ください。

<comment>Return:</comment>
  <info>int</info>  スタック内の画像のインデックスを表す整数値を返します。


id: Imagick::getImageInterlaceScheme
type: function
doc:
<comment>Description:</comment>
  画像のインターレース手法を取得する
  
  画像のインターレース手法を取得します。

<comment>Return:</comment>
  <info>int</info>  成功した場合に画像のインターレース手法を返します。 エラー時に
       <class>ImagickException</class> をスローします。


id: Imagick::getImageInterpolateMethod
type: function
doc:
<comment>Description:</comment>
  画像の補間方式を返す
  
  指定した画像の補間方式を返します。 方式は <info>Imagick::INTERPOLATE_*</info> 定数のいずれかで指定します。

<comment>Return:</comment>
  <info>int</info>  成功した場合に補間方式を返します。


id: Imagick::getImageLength
type: function
doc:
<comment>Description:</comment>
  画像の長さをバイト数で取得する
  
  画像の長さをバイト数で返します。

<comment>Return:</comment>
  <info>int</info>  現在の画像のサイズを整数値で返します。


id: Imagick::getImageMatte
type: function
doc:
<comment>Description:</comment>
  画像がマットチャネルを持っているかどうかを返す
  
  画像がマットチャネルを持っている場合に <info>true</info>、 そうでない場合に false を返します。 このメソッドは、
  ImageMagick バージョン 6.2.9 以降で Imagick をコンパイルした場合に使用可能です。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。


id: Imagick::getImageMatteColor
type: function
doc:
<comment>Description:</comment>
  画像のマット色を返す
  
  画像のマット色を返します。

<comment>Return:</comment>
  <info>ImagickPixel</info>  成功した場合に ImagickPixel オブジェクトを返します。


id: Imagick::getImageMimeType
type: function
doc:
<comment>Description:</comment>
  Returns the image mime-type
  
  Returns the image mime-type.

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


id: Imagick::getImageOrientation
type: function
doc:
<comment>Description:</comment>
  画像の方向を取得する
  
  画像の方向を取得します。戻り値は 方向定数 のいずれかとなります。

<comment>Return:</comment>
  <info>int</info>  成功した場合に整数値を返します。


id: Imagick::getImagePage
type: function
doc:
<comment>Description:</comment>
  ページのジオメトリを返す
  
  画像のページジオメトリを配列で返します。配列のキーは "width"、"height"、"x" および "y" です。

<comment>Return:</comment>
  <info>array</info>  画像のページジオメトリを配列で返します。配列のキーは "width"、"height"、"x" および "y" で
         す。


id: Imagick::getImagePixelColor
type: function
doc:
<comment>Description:</comment>
  指定したピクセルの色を返す
  
  指定したピクセルの色を返します。

<comment>Param:</comment>
  <info>int</info>  <strong>$x</strong>  ピクセルの x 座標。
  <info>int</info>  <strong>$y</strong>  ピクセルの y 座標。

<comment>Return:</comment>
  <info>ImagickPixel</info>  指定した座標の色を表す ImagickPixel のインスタンスを返します。


id: Imagick::getImageProfile
type: function
doc:
<comment>Description:</comment>
  指定した名前の画像プロファイルを返す
  
  指定した名前の画像プロファイルを返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  返したいプロファイルの名前。

<comment>Return:</comment>
  <info>string</info>  画像プロファイルを含む文字列を返します。


id: Imagick::getImageProfiles
type: function
doc:
<comment>Description:</comment>
  画像プロファイルを返す
  
  関連付けられているプロファイルのうち、パターンにマッチするものをすべて返します。 二番目の引数を
  <info>false</info> にすると、プロファイルの名前だけを返します。 このメソッドは、ImageMagick バージョン 6.3.6 以
  降で Imagick をコンパイルした場合に使用可能です。

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>         プロファイル名のパターン。
  <info>bool</info>    <strong>$include_values</strong>  プロファイル名のみを返すかどうか。<info>false</info> の場合は、プロファイル名のみを返
                           します。

<comment>Return:</comment>
  <info>array</info>  画像のプロファイルあるいはプロファイル名を含む連想配列を返します。


id: Imagick::getImageProperties
type: function
doc:
<comment>Description:</comment>
  画像のプロパティを返す
  
  関連付けられているプロパティのうち、パターンにマッチするものをすべて返します。 二番目の引数を
  <info>false</info> にすると、プロパティの名前だけを返します。 このメソッドは、ImageMagick バージョン 6.3.6 以降
  で Imagick をコンパイルした場合に使用可能です。

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>         プロパティ名のパターン。
  <info>bool</info>    <strong>$include_values</strong>  プロパティ名のみを返すかどうか。<info>false</info> の場合は、プロファイル名のみを返し
                           ます。

<comment>Return:</comment>
  <info>array</info>  画像のプロパティあるいはプロパティ名を含む連想配列を返します。


id: Imagick::getImageProperty
type: function
doc:
<comment>Description:</comment>
  指定した名前の画像のプロパティを返す
  
  指定した名前の画像プロパティを返します。 このメソッドは、ImageMagick バージョン 6.3.2 以降で
  Imagick をコンパイルした場合に使用可能です。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  プロパティの名前 (たとえば Exif:DateTime)。

<comment>Return:</comment>
  <info>string</info>  画像のプロパティを含む文字列を返します。 指定した名前のプロパティが存在しない場合に false
          を返します。

<comment>See Also:</comment>
   * <strong>Imagick::setImageProperty()</strong>


id: Imagick::getImageRedPrimary
type: function
doc:
<comment>Description:</comment>
  赤が一番強い点を返す
  
  赤が一番強い点を返します。"x" および "y" というキーを持つ配列を返します。

<comment>Return:</comment>
  <info>array</info>  赤が一番強い点を "x" および "y" というキーを持つ配列で返します。 エラー時に
         <class>ImagickException</class> をスローします。


id: Imagick::getImageRegion
type: function
doc:
<comment>Description:</comment>
  画像の一部を抽出する
  
  画像の一部を抽出し、新しい Imagick オブジェクトとして返します。

<comment>Param:</comment>
  <info>int</info>  <strong>$width</strong>   抽出する範囲の幅。
  <info>int</info>  <strong>$height</strong>  抽出する範囲の高さ。
  <info>int</info>  <strong>$x</strong>       抽出する範囲の左上の X 座標。
  <info>int</info>  <strong>$y</strong>       抽出する範囲の左上の Y 座標。

<comment>Return:</comment>
  <info>Imagick</info>  画像の一部を抽出し、新しい wand として返します。


id: Imagick::getImageRenderingIntent
type: function
doc:
<comment>Description:</comment>
  画像のレンダリング方向を取得する
  
  画像のレンダリング方向を取得します。

<comment>Return:</comment>
  <info>int</info>  画像の レンダリング方向 を返します。


id: Imagick::getImageResolution
type: function
doc:
<comment>Description:</comment>
  画像の X 方向と Y 方向の解像度を取得する
  
  X 方向および Y 方向の解像度を取得します。

<comment>Return:</comment>
  <info>array</info>  解像度を配列で返します。


id: Imagick::getImageSize
type: function
doc:
<comment>Description:</comment>
  画像の長さをバイト数で返す
  
  画像の長さをバイト数で返します。 非推奨です。かわりに Imagick::getImageLength() を使いましょう。

<comment>Return:</comment>
  <info>int</info>  現在の画像のサイズをバイト数で返します。


id: Imagick::getImageTicksPerSecond
type: function
doc:
<comment>Description:</comment>
  画像の ticks-per-second を取得する
  
  画像の ticks-per-second を取得します。

<comment>Return:</comment>
  <info>int</info>  画像の ticks-per-second を返します。


id: Imagick::getImageTotalInkDensity
type: function
doc:
<comment>Description:</comment>
  画像の総インク密度を取得する
  
  画像の総インク密度を取得します。

<comment>Return:</comment>
  <info>float</info>  画像の総インク密度を返します。 エラー時に
         <class>ImagickException</class> をスローします。


id: Imagick::getImageType
type: function
doc:
<comment>Description:</comment>
  画像の型を取得する
  
  画像の型を取得します。

<comment>Return:</comment>
  <info>int</info>  画像の型を返します。
       <info>imagick::IMGTYPE_UNDEFINED</info><info>imagick::IMGTYPE_BILEVEL</info><info>imagick::IMGTYPE_GRAYSCALE</info><info>imagick::IMGTYPE_GRAYSCALEMATTE</info><info>imagick::IMGTYPE_PALETTE</info><info>imagick::IMGTYPE_PALETTEMATTE</info><info>imagick::IMGTYPE_TRUECOLOR</info><info>imagick::IMGTYPE_TRUECOLORMATTE</info><info>imagick::IMGTYPE_COLORSEPARATION</info><info>imagick::IMGTYPE_COLORSEPARATIONMATTE</info><info>imagick::IMGTYPE_OPTIMIZE</info>
       
       <info>imagick::IMGTYPE_UNDEFINED</info>
       
       <info>imagick::IMGTYPE_BILEVEL</info>
       
       <info>imagick::IMGTYPE_GRAYSCALE</info>
       
       <info>imagick::IMGTYPE_GRAYSCALEMATTE</info>
       
       <info>imagick::IMGTYPE_PALETTE</info>
       
       <info>imagick::IMGTYPE_PALETTEMATTE</info>
       
       <info>imagick::IMGTYPE_TRUECOLOR</info>
       
       <info>imagick::IMGTYPE_TRUECOLORMATTE</info>
       
       <info>imagick::IMGTYPE_COLORSEPARATION</info>
       
       <info>imagick::IMGTYPE_COLORSEPARATIONMATTE</info>
       
       <info>imagick::IMGTYPE_OPTIMIZE</info>


id: Imagick::getImageVirtualPixelMethod
type: function
doc:
<comment>Description:</comment>
  仮想ピクセルメソッドを取得する
  
  指定した画像の仮想ピクセルメソッドを返します。

<comment>Return:</comment>
  <info>int</info>  成功した場合に仮想ピクセルメソッドを返します。


id: Imagick::getImagesBlob
type: function
doc:
<comment>Description:</comment>
  すべての画像シーケンスを blob で返す
  
  メモリ上の画像フォーマットを直接操作します。 すべての画像シーケンスを文字列として返します。 画像の
  フォーマット (GIF, JPEG, PNG など) に応じて返される blob の形式も異なります。 別の画像フォーマット
  で返すには Imagick::setImageFormat() を使用します。

<comment>Return:</comment>
  <info>string</info>  画像を文字列で返します。失敗した場合は ImagickException をスローします。


id: Imagick::getInterlaceScheme
type: function
doc:
<comment>Description:</comment>
  オブジェクトのインターレース方式を取得する
  
  オブジェクトのインターレース方式を取得します。

<comment>Return:</comment>
  <info>int</info>  インターレース方式 を返します。


id: Imagick::getIteratorIndex
type: function
doc:
<comment>Description:</comment>
  現在アクティブな画像のインデックスを取得する
  
  Imagick オブジェクト内で現在アクティブな画像のインデックスを取得します。 このメソッドは、
  ImageMagick バージョン 6.2.9 以降で Imagick をコンパイルした場合に使用可能です。

<comment>Return:</comment>
  <info>int</info>  スタック内の画像のインデックスを含む整数値を返します。

<comment>See Also:</comment>
   * <strong>Imagick::setIteratorIndex()</strong>
   * <strong>Imagick::getImageIndex()</strong>
   * <strong>Imagick::setImageIndex()</strong>


id: Imagick::getNumberImages
type: function
doc:
<comment>Description:</comment>
  オブジェクト内の画像の数を返す
  
  Imagick オブジェクトに関連付けられている画像の数を返します。

<comment>Return:</comment>
  <info>int</info>  Imagick オブジェクトに関連付けられている画像の数を返します。


id: Imagick::getOption
type: function
doc:
<comment>Description:</comment>
  指定したキーに対応する値を返す
  
  オブジェクト内の指定したキーに対応する値を返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  オプションの名前。

<comment>Return:</comment>
  <info>string</info>  指定したキーに対応する値を返します。


id: Imagick::getPackageName
type: function
doc:
<comment>Description:</comment>
  ImageMagick パッケージ名を返す
  
  ImageMagick パッケージ名を返します。

<comment>Return:</comment>
  <info>string</info>  ImageMagick パッケージ名を文字列で返します。


id: Imagick::getPage
type: function
doc:
<comment>Description:</comment>
  ページのジオメトリを返す
  
  Imagick オブジェクトに関連付けられたページのジオメトリを返します。 "width"、"height"、"x" そして
  "y" というキーを持つ連想配列となります。

<comment>Return:</comment>
  <info>array</info>  Imagick オブジェクトに関連付けられたページのジオメトリを返します。 "width"、"height"、"x"
         そして "y" というキーを持つ連想配列となります。 エラー時に ImagickException をスローしま
         す。


id: Imagick::getPixelIterator
type: function
doc:
<comment>Description:</comment>
  MagickPixelIterator を返す
  
  MagickPixelIterator を返します。

<comment>Return:</comment>
  <info>ImagickPixelIterator</info>  成功した場合に ImagickPixelIterator を返します。


id: Imagick::getPixelRegionIterator
type: function
doc:
<comment>Description:</comment>
  画像セクションの ImagickPixelIterator を取得する
  
  画像セクションの ImagickPixelIterator を取得します。

<comment>Param:</comment>
  <info>int</info>  <strong>$x</strong>        範囲の x 座標。
  <info>int</info>  <strong>$y</strong>        範囲の y 座標。
  <info>int</info>  <strong>$columns</strong>  範囲の幅。
  <info>int</info>  <strong>$rows</strong>     範囲の高さ。

<comment>Return:</comment>
  <info>ImagickPixelIterator</info>  画像セクションの ImagickPixelIterator を返します。


id: Imagick::getPointSize
type: function
doc:
<comment>Description:</comment>
  ポイントサイズを取得する
  
  オブジェクトのポイントサイズプロパティを返します。 このメソッドは、ImageMagick バージョン 6.3.7 以
  降で Imagick をコンパイルした場合に使用可能です。

<comment>Return:</comment>
  <info>float</info>  ポイントサイズを表す <info>float</info> 型の値を返します。

<comment>See Also:</comment>
   * <strong>Imagick::setPointSize()</strong>


id: Imagick::getQuantum
type: function
doc:
<comment>Description:</comment>
  Returns the ImageMagick quantum range
  
  Returns the ImageMagick quantum range. If HDRI was enabled then the type is a float, if not it is
  an int.

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


id: Imagick::getQuantumDepth
type: function
doc:
<comment>Description:</comment>
  quantum depth を取得する
  
  Imagick quantum depth を返します。

<comment>Return:</comment>
  <info>array</info>  <return>"quantumDepthLong"</return> と <return>"quantumDepthString"</return> をキーとして持つ配列を返します。


id: Imagick::getQuantumRange
type: function
doc:
<comment>Description:</comment>
  Imagick quantum range を返す
  
  Imagick インスタンスの quantum range を文字列で返します。

<comment>Return:</comment>
  <info>array</info>  quantum range を連想配列で返します。 <info>int</info> (<return>"quantumRangeLong"</return>) と <info>string</info>
         (<return>"quantumRangeString"</return>) が含まれます。


id: Imagick::getRegistry
type: function
doc:
<comment>Description:</comment>
  Get a StringRegistry entry
  
  Get the StringRegistry entry for the named key or false if not set.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  The entry to get.

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


id: Imagick::getReleaseDate
type: function
doc:
<comment>Description:</comment>
  ImageMagick のリリース日を返す
  
  ImageMagick のリリース日を文字列で返します。

<comment>Return:</comment>
  <info>string</info>  ImageMagick のリリース日を文字列で返します。


id: Imagick::getResource
type: function
doc:
<comment>Description:</comment>
  指定したリソースのメモリ使用状況を返す
  
  指定したリソースのメモリ使用状況をメガバイト単位で返します。

<comment>Param:</comment>
  <info>int</info>  <strong>$type</strong>  リソース型定数 の一覧を参照ください。

<comment>Return:</comment>
  <info>int</info>  指定したリソースのメモリ使用状況をメガバイト単位で返します。


id: Imagick::getResourceLimit
type: function
doc:
<comment>Description:</comment>
  指定したリソースの制限を返す
  
  指定したリソースの制限を返します。

<comment>Param:</comment>
  <info>int</info>  <strong>$type</strong>  リソース型定数 のうちのひとつ。 単位は制限されるリソースのタイプに依存します。

<comment>Return:</comment>
  <info>int</info>  指定したリソースの制限をメガバイト単位で返します。

<comment>See Also:</comment>
   * Imagick::setResourceLimit


id: Imagick::getSize
type: function
doc:
<comment>Description:</comment>
  Returns the size associated with the Imagick object
  
  Get the size in pixels associated with the Imagick object, previously set by <strong>Imagick::setSize()</strong>.
  
  This method just returns the size that was set using <strong>Imagick::setSize()</strong>. If you want to get the
  actual width / height of the image, use <strong>Imagick::getImageWidth()</strong> and <strong>Imagick::getImageHeight()</strong>.

<comment>Return:</comment>
  <info>array</info>  Returns the size associated with the Imagick object as an array with the keys "columns" and
         "rows".


id: Imagick::getSizeOffset
type: function
doc:
<comment>Description:</comment>
  サイズのオフセットを返す
  
  Imagick オブジェクトのサイズのオフセットを返します。 このメソッドは、ImageMagick バージョン 6.2.9
  以降で Imagick をコンパイルした場合に使用可能です。

<comment>Return:</comment>
  <info>int</info>  Imagick オブジェクトのサイズのオフセットを返します。


