# php_manual

id: Imagick::adaptiveSharpenImage
type: function
doc:
<comment>Description:</comment>
  Adaptively sharpen the image
  
  Adaptively sharpen the image by sharpening more intensely near image edges and less intensely far
  from edges. 此方法在Imagick基于ImageMagick 6.2.9以上版本编译时可用。

<comment>Param:</comment>
  <info>float</info>  <strong>$radius</strong>   The radius of the Gaussian, in pixels, not counting the center pixel. Use 0 for
                   auto-select.
  <info>float</info>  <strong>$sigma</strong>    The standard deviation of the Gaussian, in pixels.
  <info>int</info>    <strong>$channel</strong>  Provide any channel constant that is valid for your channel mode. To apply to
                   more than one channel, combine channel constants using bitwise operators. 缺省为
                   <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>
  Selects a threshold for each pixel based on a range of intensity
  
  Selects an individual threshold for each pixel based on the range of intensity values in its local
  neighborhood.  This allows for thresholding of an image whose global intensity histogram doesn't
  contain distinctive peaks.

<comment>Param:</comment>
  <info>int</info>  <strong>$width</strong>   Width of the local neighborhood.
  <info>int</info>  <strong>$height</strong>  Height of the local neighborhood.
  <info>int</info>  <strong>$offset</strong>  The mean offset

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::addImage
type: function
doc:
<comment>Description:</comment>
  Adds new image to Imagick object image list
  
  Adds new image to Imagick object from the current position of the source object. After the
  operation iterator position is moved at the end of the list.

<comment>Param:</comment>
  <info>Imagick</info>  <strong>$source</strong>  The source Imagick object

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::addNoiseImage
type: function
doc:
<comment>Description:</comment>
  Adds random noise to the image
  
  Adds random noise to the image.

<comment>Param:</comment>
  <info>int</info>  <strong>$noise_type</strong>  The type of the noise. Refer to this list of noise constants.
  <info>int</info>  <strong>$channel</strong>     Provide any channel constant that is valid for your channel mode. To apply to
                    more than one channel, combine channel constants using bitwise operators. 缺省为
                    <info>Imagick::CHANNEL_DEFAULT</info>.
                    参考此 通道常数列表

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::affineTransformImage
type: function
doc:
<comment>Description:</comment>
  Transforms an image
  
  Transforms an image as dictated by the affine matrix.

<comment>Param:</comment>
  <info>ImagickDraw</info>  <strong>$matrix</strong>  The affine matrix

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::animateImages
type: function
doc:
<comment>Description:</comment>
  Animates an image or images
  
  This method animates the image onto a local or remote X server. This method is not available on
  Windows. 此方法在Imagick基于ImageMagick 6.3.6以上版本编译时可用。

<comment>Param:</comment>
  <info>string</info>  <strong>$x_server</strong>  X server address

<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>
  Annotates an image with text
  
  Annotates an image with text.

<comment>Param:</comment>
  <info>ImagickDraw</info>  <strong>$draw_settings</strong>  The ImagickDraw object that contains settings for drawing the text
  <info>float</info>        <strong>$x</strong>              Horizontal offset in pixels to the left of text
  <info>float</info>        <strong>$y</strong>              Vertical offset in pixels to the baseline of text
  <info>float</info>        <strong>$angle</strong>          The angle at which to write the text
  <info>string</info>       <strong>$text</strong>           The string to draw

<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>
  Append a set of images
  
  Append a set of images into one larger image.

<comment>Param:</comment>
  <info>bool</info>  <strong>$stack</strong>  Whether to stack the images vertically. By default (or if <info>false</info> is specified) images
                are stacked left-to-right. If <strong>$stack</strong> is <info>true</info>, images are stacked top-to-bottom.

<comment>Return:</comment>
  <info>Imagick</info>  Returns Imagick instance on success.


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>
  Average a set of images
  
  Average a set of images.

<comment>Return:</comment>
  <info>Imagick</info>  Returns a new Imagick object on success.


id: Imagick::blackThresholdImage
type: function
doc:
<comment>Description:</comment>
  Forces all pixels below the threshold into black
  
  Is like Imagick::thresholdImage() but forces all pixels below the threshold into black while
  leaving all pixels above the threshold unchanged.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$threshold</strong>  The threshold below which everything turns black

<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>
  Adds blur filter to image
  
  Adds blur filter to image. Optional third parameter to blur a specific channel.

<comment>Param:</comment>
  <info>float</info>  <strong>$radius</strong>   Blur radius
  <info>float</info>  <strong>$sigma</strong>    Standard deviation
  <info>int</info>    <strong>$channel</strong>  The Channeltype constant. When not supplied, all channels are blurred.

<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>
  Surrounds the image with a border
  
  Surrounds the image with a border of the color defined by the bordercolor ImagickPixel object.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$bordercolor</strong>  ImagickPixel object or a string containing the border color
  <info>int</info>    <strong>$width</strong>        Border width
  <info>int</info>    <strong>$height</strong>       Border height

<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>
  Simulates a charcoal drawing
  
  Simulates a charcoal drawing.

<comment>Param:</comment>
  <info>float</info>  <strong>$radius</strong>  The radius of the Gaussian, in pixels, not counting the center pixel
  <info>float</info>  <strong>$sigma</strong>   The standard deviation of the Gaussian, in pixels

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::chopImage
type: function
doc:
<comment>Description:</comment>
  Removes a region of an image and trims
  
  Removes a region of an image and collapses the image to occupy the removed portion.

<comment>Param:</comment>
  <info>int</info>  <strong>$width</strong>   Width of the chopped area
  <info>int</info>  <strong>$height</strong>  Height of the chopped area
  <info>int</info>  <strong>$x</strong>       X origo of the chopped area
  <info>int</info>  <strong>$y</strong>       Y origo of the chopped area

<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>
  Clears all resources associated to Imagick object
  
  Clears all resources associated to Imagick object

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::clipImage
type: function
doc:
<comment>Description:</comment>
  Clips along the first path from the 8BIM profile
  
  Clips along the first path from the 8BIM profile, if present.

<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>
  Clips along the named paths from the 8BIM profile
  
  Clips along the named paths from the 8BIM profile, if present. Later operations take effect inside
  the path. It 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>  The name of the path
  <info>bool</info>    <strong>$inside</strong>    If <info>true</info> later operations take effect inside clipping path. Otherwise later
                     operations take effect outside clipping path.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::clone
type: function
doc:
<comment>Description:</comment>
  Makes an exact copy of the Imagick object
  
  Makes an exact copy of the Imagick object.
  
  This function has been DEPRECATED as of imagick 3.1.0 in favour of using the clone keyword.

<comment>Return:</comment>
  <info>Imagick</info>  A copy of the Imagick object is returned.


id: Imagick::clutImage
type: function
doc:
<comment>Description:</comment>
  Replaces colors in the image
  
  Replaces colors in the image from a color lookup table. Optional second parameter to replace
  colors in a specific channel. 此方法在Imagick基于ImageMagick 6.3.6以上版本编译时可用。

<comment>Param:</comment>
  <info>Imagick</info>  <strong>$lookup_table</strong>  Imagick object containing the color lookup table
  <info>int</info>      <strong>$channel</strong>       The Channeltype constant. When not supplied, default channels are
                          replaced.

<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>
  Composites a set of images
  
  Composites a set of images while respecting any page offsets and disposal methods.  GIF, MIFF, and
  MNG animation sequences typically start with an image background and each subsequent image varies
  in size and offset.  Returns a new Imagick object where each image in the sequence is the same
  size as the first and composited with the next image in the sequence.

<comment>Return:</comment>
  <info>Imagick</info>  Returns a new Imagick object on success.


id: Imagick::colorFloodfillImage
type: function
doc:
<comment>Description:</comment>
  Changes the color value of any pixel that matches target
  
  Changes the color value of any pixel that matches target and is an immediate neighbor.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$fill</strong>         ImagickPixel object containing the fill color
  <info>float</info>  <strong>$fuzz</strong>         The amount of fuzz. For example, set fuzz to 10 and the color red at
                       intensities of 100 and 102 respectively are now interpreted as the same color
                       for the purposes of the floodfill.
  <info>mixed</info>  <strong>$bordercolor</strong>  ImagickPixel object containing the border color
  <info>int</info>    <strong>$x</strong>            X start position of the floodfill
  <info>int</info>    <strong>$y</strong>            Y start position of the floodfill

<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>
  Blends the fill color with the image
  
  Blends the fill color with each pixel in the image.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$colorize</strong>  ImagickPixel object or a string containing the colorize color
  <info>mixed</info>  <strong>$opacity</strong>   ImagickPixel object or an float containing the opacity value.  1.0 is fully
                    opaque and 0.0 is fully transparent.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::combineImages
type: function
doc:
<comment>Description:</comment>
  Combines one or more images into a single image
  
  Combines one or more images into a single image. The grayscale value of the pixels of each image
  in the sequence is assigned in order to the specified channels of the combined image. The typical
  ordering would be image 1 =&gt; Red, 2 =&gt; Green, 3 =&gt; Blue, etc.

<comment>Param:</comment>
  <info>int</info>  <strong>$channelType</strong>  Provide any channel constant that is valid for your channel mode. To apply to
                     more than one channel, combine channeltype constants using bitwise operators.
                     Refer to this list of  channel constants.

<comment>Return:</comment>
  <info>Imagick</info>  成功时返回 <info>true</info>。


id: Imagick::commentImage
type: function
doc:
<comment>Description:</comment>
  Adds a comment to your image
  
  Adds a comment to your image.

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

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::compareImageChannels
type: function
doc:
<comment>Description:</comment>
  Returns the difference in one or more images
  
  Compares one or more images and returns the difference image.

<comment>Param:</comment>
  <info>Imagick</info>  <strong>$image</strong>        Imagick object containing the image to compare.
  <info>int</info>      <strong>$channelType</strong>  Provide any channel constant that is valid for your channel mode. To apply
                         to more than one channel, combine channeltype constants using bitwise
                         operators. Refer to this list of channel constants.
  <info>int</info>      <strong>$metricType</strong>   One of the metric type constants.

<comment>Return:</comment>
  <info>array</info>  Array consisting of <return>new_wand</return> and <return>distortion</return>.


id: Imagick::compareImageLayers
type: function
doc:
<comment>Description:</comment>
  Returns the maximum bounding region between images
  
  Compares each image with the next in a sequence and returns the maximum bounding region of any
  pixel differences it discovers. 此方法在Imagick基于ImageMagick 6.2.9以上版本编译时可用。

<comment>Param:</comment>
  <info>int</info>  <strong>$method</strong>  One of the layer method constants.

<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>
  Compares an image to a reconstructed image
  
  Returns an array containing a reconstructed image and the difference between images.

<comment>Param:</comment>
  <info>Imagick</info>  <strong>$compare</strong>  An image to compare to.
  <info>int</info>      <strong>$metric</strong>   Provide a valid metric type constant. Refer to this list of  metric constants.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing a reconstructed image and the difference between images.


id: Imagick::compositeImage
type: function
doc:
<comment>Description:</comment>
  把一张图合并到一张图
  
  以指定的偏移量（offset）将一幅图像合成到另一幅图像上。组合算法所需的任何额外参数都应传递给
  setImageArtifact，其中“compose:args”作为第一个参数，数据作为第二个参数。

<comment>Param:</comment>
  <info>Imagick</info>  <strong>$composite_object</strong>  用于合并的图片的Imagick对象
  <info>int</info>      <strong>$composite</strong>         合并操作，定义操作常量。 具体请查看 合并操作常量列表
  <info>int</info>      <strong>$x</strong>                 相对图像顶点左上位置（0,0）的横坐标
  <info>int</info>      <strong>$y</strong>                 相对图像顶点左上位置（0,0）的纵坐标
  <info>int</info>      <strong>$channel</strong>           通过传入一个通道常量，来开启通道模式。为了支持多个通道，可以通过二进制
                              运算的操作来合并多个通道常量。（Provide any channel constant that is
                              valid for your channel mode. To apply to more than one channel,
                              combine channeltype constants using bitwise operators）可以参考这个列
                              表 通道常量列表.

<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>
  Change the contrast of the image
  
  Enhances the intensity differences between the lighter and darker elements of the image.  Set
  sharpen to a value other than 0 to increase the image contrast otherwise the contrast is reduced.

<comment>Param:</comment>
  <info>bool</info>  <strong>$sharpen</strong>  The sharpen value

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::contrastStretchImage
type: function
doc:
<comment>Description:</comment>
  Enhances the contrast of a color image
  
  Enhances the contrast of a color image by adjusting the pixels color to span the entire range of
  colors available. 此方法在Imagick基于ImageMagick 6.2.9以上版本编译时可用。

<comment>Param:</comment>
  <info>float</info>  <strong>$black_point</strong>  The black point.
  <info>float</info>  <strong>$white_point</strong>  The white point.
  <info>int</info>    <strong>$channel</strong>      Provide any channel constant that is valid for your channel mode. To apply to
                       more than one channel, combine channeltype constants using bitwise operators.
                       <info>Imagick::CHANNEL_ALL</info>. Refer to this list of  channel constants.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::convolveImage
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>array</info>  <strong>$kernel</strong>   The convolution kernel
  <info>int</info>    <strong>$channel</strong>  Provide any channel constant that is valid for your channel mode. To apply to
                   more than one channel, combine channeltype constants using bitwise operators.
                   Refer to this list of  channel constants.

<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>       裁剪区域左上角的 X 轴坐标（以原图的左上角为原点）

<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>
  Returns a reference to the current Imagick object
  
  Returns reference to the current imagick object with image pointer at the correct sequence.

<comment>Return:</comment>
  <info>Imagick</info>  Returns self on success.


id: Imagick::cycleColormapImage
type: function
doc:
<comment>Description:</comment>
  Displaces an image's colormap
  
  Displaces an image's colormap by a given number of positions.  If you cycle the colormap a number
  of times you can produce a psychedelic effect.

<comment>Param:</comment>
  <info>int</info>  <strong>$displace</strong>  The amount to displace the colormap.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::decipherImage
type: function
doc:
<comment>Description:</comment>
  Deciphers an image
  
  Deciphers image that has been enciphered before. The image must be enciphered using
  <strong>Imagick::encipherImage()</strong>. 此方法在Imagick基于ImageMagick 6.3.9以上版本编译时可用。

<comment>Param:</comment>
  <info>string</info>  <strong>$passphrase</strong>  The passphrase

<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>
  Returns certain pixel differences between images
  
  Compares each image with the next in a sequence and returns the maximum bounding region of any
  pixel differences it discovers.

<comment>Return:</comment>
  <info>Imagick</info>  Returns a new Imagick object on success.


id: Imagick::deleteImageArtifact
type: function
doc:
<comment>Description:</comment>
  Delete image artifact
  
  Deletes an artifact associated with the image.  The difference between image properties and  image
  artifacts is that properties are public and artifacts are private. 此方法在Imagick基于ImageMagick
  6.5.7以上版本编译时可用。

<comment>Param:</comment>
  <info>string</info>  <strong>$artifact</strong>  The name of the artifact to delete

<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>
  Removes skew from the image
  
  This method can be used to remove skew from for example scanned images where the paper was not
  properly placed on the scanning surface. 此方法在Imagick基于ImageMagick 6.4.5以上版本编译时可用。

<comment>Param:</comment>
  <info>float</info>  <strong>$threshold</strong>  Deskew threshold

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


id: Imagick::despeckleImage
type: function
doc:
<comment>Description:</comment>
  Reduces the speckle noise in an image
  
  Reduces the speckle noise in an image while preserving the edges of the original image.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::destroy
type: function
doc:
<comment>Description:</comment>
  Destroys the Imagick object
  
  Destroys the Imagick object and frees all resources associated with it.  This method is deprecated
  in favour of Imagick::clear.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::displayImage
type: function
doc:
<comment>Description:</comment>
  Displays an image
  
  This method displays an image on a X server.

<comment>Param:</comment>
  <info>string</info>  <strong>$servername</strong>  The X server name

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::displayImages
type: function
doc:
<comment>Description:</comment>
  Displays an image or image sequence
  
  Displays an image or image sequence on a X server.

<comment>Param:</comment>
  <info>string</info>  <strong>$servername</strong>  The X server name

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::distortImage
type: function
doc:
<comment>Description:</comment>
  Distorts an image using various distortion methods
  
  Distorts an image using various distortion methods, by mapping color lookups of the source image
  to a new destination image usually of the same size as the source image, unless 'bestfit' is set
  to <info>true</info>.
  
  If 'bestfit' is enabled, and distortion allows it, the destination image is adjusted to ensure the
  whole source 'image' will just fit within the final destination image, which will be sized and
  offset accordingly. Also in many cases the virtual offset of the source image will be taken into
  account in the mapping.
  
  此方法在Imagick基于ImageMagick 6.3.6以上版本编译时可用。

<comment>Param:</comment>
  <info>int</info>    <strong>$method</strong>     The method of image distortion. See distortion constants
  <info>array</info>  <strong>$arguments</strong>  The arguments for this distortion method
  <info>bool</info>   <strong>$bestfit</strong>    Attempt to resize destination to fit distorted source

<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>  被渲染到图片上的 ImagickDraw 对象（在经过各种绘画操作之后的 ImagickDraw 对象）

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::edgeImage
type: function
doc:
<comment>Description:</comment>
  Enhance edges within the image
  
  Enhance edges within the image with a convolution filter of the given radius. Use radius 0 and it
  will be auto-selected.

<comment>Param:</comment>
  <info>float</info>  <strong>$radius</strong>  The radius of the operation.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::embossImage
type: function
doc:
<comment>Description:</comment>
  Returns a grayscale image with a three-dimensional effect
  
  Returns a grayscale image with a three-dimensional effect.  We convolve the image with a Gaussian
  operator of the given radius and standard  deviation (sigma).  For reasonable results, radius
  should be larger than  sigma.  Use a radius of 0 and it will choose a suitable radius for you.

<comment>Param:</comment>
  <info>float</info>  <strong>$radius</strong>  The radius of the effect
  <info>float</info>  <strong>$sigma</strong>   The sigma of the effect

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::encipherImage
type: function
doc:
<comment>Description:</comment>
  Enciphers an image
  
  Converts plain pixels to enciphered pixels. The image is not readable until it has been deciphered
  using <strong>Imagick::decipherImage()</strong> 此方法在Imagick基于ImageMagick 6.3.9以上版本编译时可用。

<comment>Param:</comment>
  <info>string</info>  <strong>$passphrase</strong>  The passphrase

<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>
  Improves the quality of a noisy image
  
  Applies a digital filter that improves the quality of a noisy image.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::equalizeImage
type: function
doc:
<comment>Description:</comment>
  Equalizes the image histogram
  
  Equalizes the image histogram.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::evaluateImage
type: function
doc:
<comment>Description:</comment>
  Applies an expression to an image
  
  Applys an arithmetic, relational, or logical expression to an image.  Use these operators to
  lighten or darken an image, to increase or decrease contrast in an image, or to produce the
  "negative" of an image.

<comment>Param:</comment>
  <info>int</info>    <strong>$op</strong>        The evaluation operator
  <info>float</info>  <strong>$constant</strong>  The value of the operator
  <info>int</info>    <strong>$channel</strong>   Provide any channel constant that is valid for your channel mode. To apply to
                    more than one channel, combine channeltype constants using bitwise operators.
                    Refer to this list of  channel constants.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::exportImagePixels
type: function
doc:
<comment>Description:</comment>
  Exports raw image pixels
  
  Exports image pixels into an array. The map defines the ordering of the exported  pixels. The size
  of the returned array is <return>width * height * strlen(map)</return>. 此方法在Imagick基于ImageMagick 6.4.7以上版
  本编译时可用。

<comment>Param:</comment>
  <info>int</info>     <strong>$x</strong>        X-coordinate of the exported area
  <info>int</info>     <strong>$y</strong>        Y-coordinate of the exported area
  <info>int</info>     <strong>$width</strong>    Width of the exported aread
  <info>int</info>     <strong>$height</strong>   Height of the exported area
  <info>string</info>  <strong>$map</strong>      Ordering of the exported pixels. For example <return>"RGB"</return>.  Valid characters for the
                    map are R, G, B, A, O, C, Y, M, K, I and P.
  <info>int</info>     <strong>$STORAGE</strong>  Refer to this list of pixel type constants

<comment>Return:</comment>
  <info>array</info>  Returns an array containing the pixels values.


id: Imagick::extentImage
type: function
doc:
<comment>Description:</comment>
  Set image size
  
  Comfortability method for setting image size. The method sets the image size and allows setting
  x,y coordinates where the new area begins. 此方法在Imagick基于ImageMagick 6.3.1以上版本编译时可
  用。
  
  Prior to ImageMagick 6.5.7-8 (1623), $x was positive when shifting to the left and negative when
  shifting to the right, and $y was positive when shifting an image up and negative when shifting an
  image down.
   Somewhere betwen ImageMagick 6.3.7 (1591) and ImageMagick 6.5.7-8 (1623), the axes of $x and $y
  were flipped, so that $x was negative when shifting to the left and positive when shifting to the
  right, and $y was negative when shifting an image up and positive when shifting an image down.
   Somewhere between ImageMagick 6.5.7-8 (1623) and ImageMagick 6.6.9-7 (1641), the axes of $x and
  $y were flipped back to pre-ImageMagick 6.5.7-8 (1623) functionality.

<comment>Param:</comment>
  <info>int</info>  <strong>$width</strong>   The new width
  <info>int</info>  <strong>$height</strong>  The new height
  <info>int</info>  <strong>$x</strong>       X position for the new size
  <info>int</info>  <strong>$y</strong>       Y position for the new size

<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>        Provide any channel constant that is valid for your channel mode.
                                 To apply to more than one channel, combine channel constants using
                                 bitwise operators. 缺省为<info>Imagick::CHANNEL_DEFAULT</info>.
                                 参考此 通道常数列表

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::flattenImages
type: function
doc:
<comment>Description:</comment>
  Merges a sequence of images
  
  Merges a sequence of images.  This is useful for combining Photoshop layers into a single image.

<comment>Return:</comment>
  <info>Imagick</info>  成功时返回 <info>true</info>。


id: Imagick::flipImage
type: function
doc:
<comment>Description:</comment>
  Creates a vertical mirror image
  
  Creates a vertical mirror image by reflecting the pixels around the central x-axis.

<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>
  Changes the color value of any pixel that matches target
  
  Changes the color value of any pixel that matches target and is an immediate neighbor. This method
  is a replacement for deprecated  <strong>Imagick::paintFloodFillImage()</strong>. 此方法在Imagick基于ImageMagick
  6.3.8以上版本编译时可用。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$fill</strong>     ImagickPixel object or a string containing the fill color
  <info>float</info>  <strong>$fuzz</strong>     The amount of fuzz. For example, set fuzz to 10 and the color red at intensities
                   of 100 and 102 respectively are now interpreted as the same color.
  <info>mixed</info>  <strong>$target</strong>   ImagickPixel object or a string containing the target color to paint
  <info>int</info>    <strong>$x</strong>        X start position of the floodfill
  <info>int</info>    <strong>$y</strong>        Y start position of the floodfill
  <info>bool</info>   <strong>$invert</strong>   If <info>true</info> paints any pixel that does not match the target color.
  <info>int</info>    <strong>$channel</strong>  Provide any channel constant that is valid for your channel mode. To apply to
                   more than one channel, combine channel constants using bitwise operators. 缺省为
                   <info>Imagick::CHANNEL_DEFAULT</info>.
                   参考此 通道常数列表

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::flopImage
type: function
doc:
<comment>Description:</comment>
  Creates a horizontal mirror image
  
  Creates a horizontal mirror image by reflecting the pixels around the central y-axis.

<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>
  Adds a simulated three-dimensional border
  
  Adds a simulated three-dimensional border around the image. The width and height specify the
  border width of the vertical and horizontal sides of the frame.  The inner and outer bevels
  indicate the width of the inner and outer shadows of the frame.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$matte_color</strong>  ImagickPixel object or a string representing the matte color
  <info>int</info>    <strong>$width</strong>        The width of the border
  <info>int</info>    <strong>$height</strong>       The height of the border
  <info>int</info>    <strong>$inner_bevel</strong>  The inner bevel width
  <info>int</info>    <strong>$outer_bevel</strong>  The outer bevel width

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::functionImage
type: function
doc:
<comment>Description:</comment>
  Applies a function on the image
  
  Applies an arithmetic, relational, or logical expression to a pseudo image.
  
  See also ImageMagick v6 Examples - Image Transformations — Function, Multi-Argument Evaluate
  
  此方法在Imagick基于ImageMagick 6.4.9以上版本编译时可用。

<comment>Param:</comment>
  <info>int</info>    <strong>$function</strong>   Refer to this list of function constants
  <info>array</info>  <strong>$arguments</strong>  Array of arguments to pass to this function.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::fxImage
type: function
doc:
<comment>Description:</comment>
  Evaluate expression for each pixel in the image
  
  Evaluate expression for each pixel in the image. Consult The Fx Special Effects Image Operator for
  more information.

<comment>Param:</comment>
  <info>string</info>  <strong>$expression</strong>  The expression.
  <info>int</info>     <strong>$channel</strong>     Provide any channel constant that is valid for your channel mode. To apply to
                       more than one channel, combine channeltype constants using bitwise operators.
                       Refer to this list of  channel constants.

<comment>Return:</comment>
  <info>Imagick</info>  成功时返回 <info>true</info>。


id: Imagick::gammaImage
type: function
doc:
<comment>Description:</comment>
  Gamma-corrects an image
  
  Gamma-corrects an image.  The same image viewed on different devices will have perceptual
  differences in the way the image's intensities are represented on the screen.  Specify individual
  gamma levels for the red, green, and blue channels, or adjust all three with the gamma parameter.
  Values typically range from 0.8 to 2.3.

<comment>Param:</comment>
  <info>float</info>  <strong>$gamma</strong>    The amount of gamma-correction.
  <info>int</info>    <strong>$channel</strong>  Provide any channel constant that is valid for your channel mode. To apply to
                   more than one channel, combine channeltype constants using bitwise operators.
                   Refer to this list of  channel constants.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::gaussianBlurImage
type: function
doc:
<comment>Description:</comment>
  Blurs an image
  
  Blurs an image.  We convolve the image with a Gaussian operator of the given radius and standard
  deviation (sigma). For reasonable results, the radius should be larger than sigma.  Use a radius
  of 0 and selects a suitable radius for you.

<comment>Param:</comment>
  <info>float</info>  <strong>$radius</strong>   The radius of the Gaussian, in pixels, not counting the center pixel.
  <info>float</info>  <strong>$sigma</strong>    The standard deviation of the Gaussian, in pixels.
  <info>int</info>    <strong>$channel</strong>  Provide any channel constant that is valid for your channel mode. To apply to
                   more than one channel, combine channeltype constants using bitwise operators.
                   Refer to this list of  channel constants.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::getColorspace
type: function
doc:
<comment>Description:</comment>
  Gets the colorspace
  
  Gets the global colorspace value. 此方法在Imagick基于ImageMagick 6.5.7以上版本编译时可用。

<comment>Return:</comment>
  <info>int</info>  Returns an integer which can be compared against COLORSPACE constants.


id: Imagick::getCompression
type: function
doc:
<comment>Description:</comment>
  Gets the object compression type
  
  Gets the object compression type.

<comment>Return:</comment>
  <info>int</info>  Returns the compression constant


id: Imagick::getCompressionQuality
type: function
doc:
<comment>Description:</comment>
  Gets the object compression quality
  
  Gets the object compression quality.

<comment>Return:</comment>
  <info>int</info>  Returns integer describing the compression quality


id: Imagick::getCopyright
type: function
doc:
<comment>Description:</comment>
  Returns the ImageMagick API copyright as a string
  
  Returns the ImageMagick API copyright as a string.

<comment>Return:</comment>
  <info>string</info>  Returns a string containing the copyright notice of Imagemagick and Magickwand C API.


id: Imagick::getFont
type: function
doc:
<comment>Description:</comment>
  Gets font
  
  Returns the objects font property. 此方法在Imagick基于ImageMagick 6.3.7以上版本编译时可用。

<comment>Return:</comment>
  <info>string</info>  Returns the string containing the font name or <info>false</info> if not font is set.

<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>
  Returns the format of the Imagick object
  
  Returns the format of the Imagick object.

<comment>Return:</comment>
  <info>string</info>  Returns the format of the image.


id: Imagick::getGravity
type: function
doc:
<comment>Description:</comment>
  Gets the gravity
  
  Gets the global gravity property for the Imagick object. 此方法在Imagick基于ImageMagick 6.4.0以上
  版本编译时可用。

<comment>Return:</comment>
  <info>int</info>  Returns the gravity property. Refer to the list of  gravity constants.


id: Imagick::getHomeURL
type: function
doc:
<comment>Description:</comment>
  Returns the ImageMagick home URL
  
  Returns the ImageMagick home URL.

<comment>Return:</comment>
  <info>string</info>  Returns a link to the imagemagick homepage.


id: Imagick::getImage
type: function
doc:
<comment>Description:</comment>
  Returns a new Imagick object
  
  Returns a new Imagick object with the current image sequence.

<comment>Return:</comment>
  <info>Imagick</info>  Returns a new Imagick object with the current image sequence.


id: Imagick::getImageAlphaChannel
type: function
doc:
<comment>Description:</comment>
  检查图像是否有 alpha 通道
  
  返回图像是否有 alpha 通道。

<comment>Return:</comment>
  <info>bool</info>  如果图像具有 alpha 通道值，则返回 <info>true</info>，否则返回 <info>false</info>，即图像是 RGB 而不是 RGBA 或 CMYK 而
        不是 CMYKA。


id: Imagick::getImageArtifact
type: function
doc:
<comment>Description:</comment>
  Get image artifact
  
  Gets an artifact associated with the image.  The difference between image properties and  image
  artifacts is that properties are public and artifacts are private. 此方法在Imagick基于ImageMagick
  6.5.7以上版本编译时可用。

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

<comment>Return:</comment>
  <info>string</info>  Returns the artifact value on success.

<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>
  Returns the image background color
  
  Returns the image background color.

<comment>Return:</comment>
  <info>ImagickPixel</info>  Returns an ImagickPixel set to the background color of the image.


id: Imagick::getImageBlob
type: function
doc:
<comment>Description:</comment>
  Returns the image sequence as a blob
  
  Implements direct to memory image formats.  It returns the image sequence as a string.  The format
  of the image determines the format of the returned blob (GIF, JPEG, PNG, etc.). To return a
  different image format, use Imagick::setImageFormat().

<comment>Return:</comment>
  <info>string</info>  Returns a string containing the image.


id: Imagick::getImageBorderColor
type: function
doc:
<comment>Description:</comment>
  Returns the image border color
  
  Returns the image border color.

<comment>Return:</comment>
  <info>ImagickPixel</info>  成功时返回 <info>true</info>。


id: Imagick::getImageChannelDepth
type: function
doc:
<comment>Description:</comment>
  Gets the depth for a particular image channel
  
  Gets the depth for a particular image channel.

<comment>Param:</comment>
  <info>int</info>  <strong>$channel</strong>  Provide any channel constant that is valid for your channel mode. To apply to more
                 than one channel, combine channel constants using bitwise operators. 缺省为
                 <info>Imagick::CHANNEL_DEFAULT</info>.
                 参考此 通道常数列表

<comment>Return:</comment>
  <info>int</info>  成功时返回 <info>true</info>。


id: Imagick::getImageChannelDistortion
type: function
doc:
<comment>Description:</comment>
  Compares image channels of an image to a reconstructed image
  
  Compares one or more image channels of an image to a reconstructed image and returns the specified
  distortion metric.

<comment>Param:</comment>
  <info>Imagick</info>  <strong>$reference</strong>  Imagick object to compare to.
  <info>int</info>      <strong>$channel</strong>    Provide any channel constant that is valid for your channel mode. To apply to
                       more than one channel, combine channeltype constants using bitwise operators.
                       Refer to this list of  channel constants.
  <info>int</info>      <strong>$metric</strong>     One of the metric type constants.

<comment>Return:</comment>
  <info>float</info>  成功时返回 <info>true</info>。


id: Imagick::getImageChannelDistortions
type: function
doc:
<comment>Description:</comment>
  Gets channel distortions
  
  Compares one or more image channels of an image to a reconstructed image and returns the specified
  distortion metrics 此方法在Imagick基于ImageMagick 6.4.4以上版本编译时可用。

<comment>Param:</comment>
  <info>Imagick</info>  <strong>$reference</strong>  Imagick object containing the reference image
  <info>int</info>      <strong>$metric</strong>     Refer to this list of metric type constants.
  <info>int</info>      <strong>$channel</strong>    Provide any channel constant that is valid for your channel mode. To apply to
                       more than one channel, combine channel constants using bitwise operators. 缺
                       省为<info>Imagick::CHANNEL_DEFAULT</info>.
                       参考此 通道常数列表

<comment>Return:</comment>
  <info>float</info>  Returns a <info>float</info> describing the channel distortion.


id: Imagick::getImageChannelExtrema
type: function
doc:
<comment>Description:</comment>
  Gets the extrema for one or more image channels
  
  Gets the extrema for one or more image channels.  Return value is an associative array with the
  keys "minima" and "maxima".

<comment>Param:</comment>
  <info>int</info>  <strong>$channel</strong>  Provide any channel constant that is valid for your channel mode. To apply to more
                 than one channel, combine channeltype constants using bitwise operators. Refer to
                 this list of  channel constants.

<comment>Return:</comment>
  <info>array</info>  成功时返回 <info>true</info>。


id: Imagick::getImageChannelKurtosis
type: function
doc:
<comment>Description:</comment>
  The getImageChannelKurtosis purpose
  
  Get the kurtosis and skewness of a specific channel. 此方法在Imagick基于ImageMagick 6.4.9以上版本
  编译时可用。

<comment>Param:</comment>
  <info>int</info>  <strong>$channel</strong>  Provide any channel constant that is valid for your channel mode. To apply to more
                 than one channel, combine channel constants using bitwise operators. 缺省为
                 <info>Imagick::CHANNEL_DEFAULT</info>.
                 参考此 通道常数列表

<comment>Return:</comment>
  <info>array</info>  Returns an array with <return>kurtosis</return> and <return>skewness</return> members.


id: Imagick::getImageChannelMean
type: function
doc:
<comment>Description:</comment>
  Gets the mean and standard deviation
  
  Gets the mean and standard deviation of one or more image channels.

<comment>Param:</comment>
  <info>int</info>  <strong>$channel</strong>  Provide any channel constant that is valid for your channel mode. To apply to more
                 than one channel, combine channeltype constants using bitwise operators. Refer to
                 this list of  channel constants.

<comment>Return:</comment>
  <info>array</info>  Returns an array with <return>"mean"</return> and <return>"standardDeviation"</return> members.


id: Imagick::getImageChannelRange
type: function
doc:
<comment>Description:</comment>
  Gets channel range
  
  Gets the range for one or more image channels. 此方法在Imagick基于ImageMagick 6.4.0以上版本编译时
  可用。

<comment>Param:</comment>
  <info>int</info>  <strong>$channel</strong>  Provide any channel constant that is valid for your channel mode. To apply to more
                 than one channel, combine channel constants using bitwise operators. 缺省为
                 <info>Imagick::CHANNEL_DEFAULT</info>.
                 参考此 通道常数列表

<comment>Return:</comment>
  <info>array</info>  Returns an array containing minima and maxima values of the channel(s).


id: Imagick::getImageChannelStatistics
type: function
doc:
<comment>Description:</comment>
  Returns statistics for each channel in the image
  
  Returns statistics for each channel in the image.  The statistics include the channel depth, its
  minima and maxima, the mean, and the standard deviation.

<comment>Return:</comment>
  <info>array</info>  成功时返回 <info>true</info>。


id: Imagick::getImageClipMask
type: function
doc:
<comment>Description:</comment>
  Gets image clip mask
  
  Returns the image clip mask. The clip mask is an Imagick object containing the clip mask. 此方法在
  Imagick基于ImageMagick 6.3.6以上版本编译时可用。

<comment>Return:</comment>
  <info>Imagick</info>  Returns an Imagick object containing the clip mask.


id: Imagick::getImageColormapColor
type: function
doc:
<comment>Description:</comment>
  Returns the color of the specified colormap index
  
  Returns the color of the specified colormap index.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The offset into the image colormap.

<comment>Return:</comment>
  <info>ImagickPixel</info>  成功时返回 <info>true</info>。


id: Imagick::getImageColors
type: function
doc:
<comment>Description:</comment>
  Gets the number of unique colors in the image
  
  Gets the number of unique colors in the image.

<comment>Return:</comment>
  <info>int</info>  Returns an <info>int</info>, the number of unique colors in the image.


id: Imagick::getImageColorspace
type: function
doc:
<comment>Description:</comment>
  Gets the image colorspace
  
  Gets the image colorspace.

<comment>Return:</comment>
  <info>int</info>  Returns an integer which can be compared against COLORSPACE constants.


id: Imagick::getImageCompose
type: function
doc:
<comment>Description:</comment>
  Returns the composite operator associated with the image
  
  Returns the composite operator associated with the image.

<comment>Return:</comment>
  <info>int</info>  成功时返回 <info>true</info>。


id: Imagick::getImageCompression
type: function
doc:
<comment>Description:</comment>
  Gets the current image's compression type
  
  Gets the current image's compression type.

<comment>Return:</comment>
  <info>int</info>  Returns the compression constant


id: Imagick::getImageCompressionQuality
type: function
doc:
<comment>Description:</comment>
  Gets the current image's compression quality
  
  Gets the current image's compression quality

<comment>Return:</comment>
  <info>int</info>  Returns integer describing the images compression quality


id: Imagick::getImageDelay
type: function
doc:
<comment>Description:</comment>
  Gets the image delay
  
  Gets the image delay.

<comment>Return:</comment>
  <info>int</info>  Returns the image delay.


id: Imagick::getImageDepth
type: function
doc:
<comment>Description:</comment>
  Gets the image depth
  
  Gets the image depth.

<comment>Return:</comment>
  <info>int</info>  The image depth.


id: Imagick::getImageDispose
type: function
doc:
<comment>Description:</comment>
  Gets the image disposal method
  
  Gets the image disposal method.

<comment>Return:</comment>
  <info>int</info>  Returns the dispose method on success.


id: Imagick::getImageDistortion
type: function
doc:
<comment>Description:</comment>
  Compares an image to a reconstructed image
  
  Compares an image to a reconstructed image and returns the specified distortion metric.

<comment>Param:</comment>
  <info>MagickWand</info>  <strong>$reference</strong>  Imagick object to compare to.
  <info>int</info>         <strong>$metric</strong>     One of the metric type constants.

<comment>Return:</comment>
  <info>float</info>  Returns the distortion metric used on the image (or the best guess thereof).


id: Imagick::getImageExtrema
type: function
doc:
<comment>Description:</comment>
  Gets the extrema for the image
  
  Gets the extrema for the image.  Returns an associative array with the keys "min" and "max".

<comment>Return:</comment>
  <info>array</info>  Returns an associative array with the keys "min" and "max".


id: Imagick::getImageFilename
type: function
doc:
<comment>Description:</comment>
  Returns the filename of a particular image in a sequence
  
  Returns the filename of a particular image in a sequence.

<comment>Return:</comment>
  <info>string</info>  Returns a string with the filename of the image.


id: Imagick::getImageGamma
type: function
doc:
<comment>Description:</comment>
  Gets the image gamma
  
  Gets the image gamma.

<comment>Return:</comment>
  <info>float</info>  Returns the image gamma on success.


id: Imagick::getImageGeometry
type: function
doc:
<comment>Description:</comment>
  Gets the width and height as an associative array
  
  Returns the width and height as an associative array.

<comment>Return:</comment>
  <info>array</info>  Returns an array with the width/height of the image.


id: Imagick::getImageGravity
type: function
doc:
<comment>Description:</comment>
  Gets the image gravity
  
  Gets the current gravity value of the image. Unlike <strong>Imagick::getGravity()</strong>, this method returns the
  gravity defined for the current image sequence. 此方法在Imagick基于ImageMagick 6.4.4以上版本编译时
  可用。

<comment>Return:</comment>
  <info>int</info>  Returns the images gravity property. Refer to the list of  gravity constants.


id: Imagick::getImageGreenPrimary
type: function
doc:
<comment>Description:</comment>
  Returns the chromaticy green primary point
  
  Returns the chromaticity green primary point. Returns an array with the keys "x" and "y".

<comment>Return:</comment>
  <info>array</info>  Returns an array with the keys "x" and "y" on success, throws an ImagickException on
         failure.


id: Imagick::getImageHeight
type: function
doc:
<comment>Description:</comment>
  Returns the image height
  
  Returns the image height.

<comment>Return:</comment>
  <info>int</info>  Returns the image height in pixels.


id: Imagick::getImageHistogram
type: function
doc:
<comment>Description:</comment>
  Gets the image histogram
  
  Returns the image histogram as an array of ImagickPixel objects.

<comment>Return:</comment>
  <info>array</info>  Returns the image histogram as an array of ImagickPixel objects.


id: Imagick::getImageIndex
type: function
doc:
<comment>Description:</comment>
  Gets the index of the current active image
  
  Returns the index of the current active image within the Imagick object. This method has been
  deprecated. See <strong>Imagick::getIteratorIndex()</strong>.

<comment>Return:</comment>
  <info>int</info>  Returns an integer containing the index of the image in the stack.


id: Imagick::getImageInterlaceScheme
type: function
doc:
<comment>Description:</comment>
  Gets the image interlace scheme
  
  Gets the image interlace scheme.

<comment>Return:</comment>
  <info>int</info>  Returns the interlace scheme as an integer on success. 错误时抛出
       <class>ImagickException</class>。


id: Imagick::getImageInterpolateMethod
type: function
doc:
<comment>Description:</comment>
  Returns the interpolation method
  
  Returns the interpolation method for the specified image. The method is one of  the
  <info>Imagick::INTERPOLATE_*</info> constants.

<comment>Return:</comment>
  <info>int</info>  Returns the interpolate method on success.


id: Imagick::getImageLength
type: function
doc:
<comment>Description:</comment>
  Returns the image length in bytes
  
  Returns the image length in bytes

<comment>Return:</comment>
  <info>int</info>  Returns an int containing the current image size.


id: Imagick::getImageMatte
type: function
doc:
<comment>Description:</comment>
  Return if the image has a matte channel
  
  Returns <info>true</info> if the image has a matte channel otherwise false. 此方法在Imagick基于ImageMagick
  6.2.9以上版本编译时可用。

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::getImageMatteColor
type: function
doc:
<comment>Description:</comment>
  Returns the image matte color
  
  Returns the image matte color.

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


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>
  Gets the image orientation
  
  Gets the image orientation. The return value is one of the orientation constants.

<comment>Return:</comment>
  <info>int</info>  Returns an int on success.


id: Imagick::getImagePage
type: function
doc:
<comment>Description:</comment>
  Returns the page geometry
  
  Returns the page geometry associated with the image in an array with the keys "width", "height",
  "x", and "y".

<comment>Return:</comment>
  <info>array</info>  Returns the page geometry associated with the image in an array with the keys "width",
         "height", "x", and "y".


id: Imagick::getImagePixelColor
type: function
doc:
<comment>Description:</comment>
  Returns the color of the specified pixel
  
  Returns the color of the specified pixel.

<comment>Param:</comment>
  <info>int</info>  <strong>$x</strong>  The x-coordinate of the pixel
  <info>int</info>  <strong>$y</strong>  The y-coordinate of the pixel

<comment>Return:</comment>
  <info>ImagickPixel</info>  Returns an ImagickPixel instance for the color at the coordinates given.


id: Imagick::getImageProfile
type: function
doc:
<comment>Description:</comment>
  Returns the named image profile
  
  Returns the named image profile.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name of the profile to return.

<comment>Return:</comment>
  <info>string</info>  Returns a string containing the image profile.


id: Imagick::getImageProfiles
type: function
doc:
<comment>Description:</comment>
  Returns the image profiles
  
  Returns all associated profiles that match the pattern. If <info>false</info> is passed as second parameter
  only the profile names are returned. 此方法在Imagick基于ImageMagick 6.3.6以上版本编译时可用。

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>         The pattern for profile names.
  <info>bool</info>    <strong>$include_values</strong>  Whether to return only profile names. If <info>false</info> then only profile names
                           will be returned.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing the image profiles or profile names.


id: Imagick::getImageProperties
type: function
doc:
<comment>Description:</comment>
  Returns the image properties
  
  Returns all associated properties that match the pattern. If <info>false</info> is passed as second parameter
  only the property names are returned. 此方法在Imagick基于ImageMagick 6.3.6以上版本编译时可用。

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>         The pattern for property names.
  <info>bool</info>    <strong>$include_values</strong>  Whether to return only property names. If <info>false</info> then only property names
                           will be returned.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing the image properties or property names.


id: Imagick::getImageProperty
type: function
doc:
<comment>Description:</comment>
  Returns the named image property
  
  Returns the named image property. 此方法在Imagick基于ImageMagick 6.3.2以上版本编译时可用。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  name of the property (for example Exif:DateTime)

<comment>Return:</comment>
  <info>string</info>  Returns a string containing the image property, false if a property with the given name
          does not exist.

<comment>See Also:</comment>
   * <strong>Imagick::setImageProperty()</strong>


id: Imagick::getImageRedPrimary
type: function
doc:
<comment>Description:</comment>
  Returns the chromaticity red primary point
  
  Returns the chromaticity red primary point as an array with the keys "x" and "y".

<comment>Return:</comment>
  <info>array</info>  Returns the chromaticity red primary point as an array with the keys "x" and "y". 错误时抛
         出
         <class>ImagickException</class>。


id: Imagick::getImageRegion
type: function
doc:
<comment>Description:</comment>
  Extracts a region of the image
  
  Extracts a region of the image and returns it as a new Imagick object.

<comment>Param:</comment>
  <info>int</info>  <strong>$width</strong>   The width of the extracted region.
  <info>int</info>  <strong>$height</strong>  The height of the extracted region.
  <info>int</info>  <strong>$x</strong>       X-coordinate of the top-left corner of the extracted region.
  <info>int</info>  <strong>$y</strong>       Y-coordinate of the top-left corner of the extracted region.

<comment>Return:</comment>
  <info>Imagick</info>  Extracts a region of the image and returns it as a new wand.


id: Imagick::getImageRenderingIntent
type: function
doc:
<comment>Description:</comment>
  Gets the image rendering intent
  
  Gets the image rendering intent.

<comment>Return:</comment>
  <info>int</info>  Returns the image rendering intent.


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>
  Returns the image length in bytes
  
  Returns the image length in bytes. Deprecated in favour of Imagick::getImageLength()

<comment>Return:</comment>
  <info>int</info>  Returns an int containing the current image size.


id: Imagick::getImageTicksPerSecond
type: function
doc:
<comment>Description:</comment>
  Gets the image ticks-per-second
  
  Gets the image ticks-per-second.

<comment>Return:</comment>
  <info>int</info>  Returns the image ticks-per-second.


id: Imagick::getImageTotalInkDensity
type: function
doc:
<comment>Description:</comment>
  Gets the image total ink density
  
  Gets the image total ink density.

<comment>Return:</comment>
  <info>float</info>  Returns the image total ink density of the image. 错误时抛出
         <class>ImagickException</class>。


id: Imagick::getImageType
type: function
doc:
<comment>Description:</comment>
  Gets the potential image type
  
  Gets the potential image type.

<comment>Return:</comment>
  <info>int</info>  Returns the potential image type.
       <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::getImageUnits
type: function
doc:
<comment>Description:</comment>
  获取图像的分辨率单位
  
  获取图像的分辨率单位。

<comment>Return:</comment>
  <info>int</info>  返回分辨率的单位


id: Imagick::getImageVirtualPixelMethod
type: function
doc:
<comment>Description:</comment>
  Returns the virtual pixel method
  
  Returns the virtual pixel method for the specified image.

<comment>Return:</comment>
  <info>int</info>  Returns the virtual pixel method on success.


id: Imagick::getImageWidth
type: function
doc:
<comment>Description:</comment>
  Returns the image width
  
  Returns the image width.

<comment>Return:</comment>
  <info>int</info>  Returns the image width.


id: Imagick::getImagesBlob
type: function
doc:
<comment>Description:</comment>
  Returns all image sequences as a blob
  
  Implements direct to memory image formats.  It returns all image sequences as a string.  The
  format of the image determines the format of the returned blob (GIF, JPEG, PNG, etc.). To return a
  different image format, use Imagick::setImageFormat().

<comment>Return:</comment>
  <info>string</info>  Returns a string containing the images. On failure, throws ImagickException.


id: Imagick::getInterlaceScheme
type: function
doc:
<comment>Description:</comment>
  Gets the object interlace scheme
  
  Gets the object interlace scheme.

<comment>Return:</comment>
  <info>int</info>  Gets the wand interlace scheme.


id: Imagick::getIteratorIndex
type: function
doc:
<comment>Description:</comment>
  Gets the index of the current active image
  
  Returns the index of the current active image within the Imagick object. 此方法在Imagick基于
  ImageMagick 6.2.9以上版本编译时可用。

<comment>Return:</comment>
  <info>int</info>  Returns an integer containing the index of the image in the stack.

<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>
  Returns the number of images in the object
  
  Returns the number of images associated with Imagick object.

<comment>Return:</comment>
  <info>int</info>  Returns the number of images associated with Imagick object.


id: Imagick::getOption
type: function
doc:
<comment>Description:</comment>
  Returns a value associated with the specified key
  
  Returns a value associated within the object for the specified key.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  The name of the option

<comment>Return:</comment>
  <info>string</info>  Returns a value associated with a wand and the specified key.


id: Imagick::getPackageName
type: function
doc:
<comment>Description:</comment>
  Returns the ImageMagick package name
  
  Returns the ImageMagick package name.

<comment>Return:</comment>
  <info>string</info>  Returns the ImageMagick package name as a string.


id: Imagick::getPage
type: function
doc:
<comment>Description:</comment>
  Returns the page geometry
  
  Returns the page geometry associated with the Imagick object in an associative array with the keys
  "width", "height", "x", and "y".

<comment>Return:</comment>
  <info>array</info>  Returns the page geometry associated with the Imagick object in an associative array with
         the keys "width", "height", "x", and "y", throwing ImagickException on error.


id: Imagick::getPixelIterator
type: function
doc:
<comment>Description:</comment>
  Returns a MagickPixelIterator
  
  Returns a MagickPixelIterator.

<comment>Return:</comment>
  <info>ImagickPixelIterator</info>  Returns an ImagickPixelIterator on success.


id: Imagick::getPixelRegionIterator
type: function
doc:
<comment>Description:</comment>
  Get an ImagickPixelIterator for an image section
  
  Get an ImagickPixelIterator for an image section.

<comment>Param:</comment>
  <info>int</info>  <strong>$x</strong>        The x-coordinate of the region.
  <info>int</info>  <strong>$y</strong>        The y-coordinate of the region.
  <info>int</info>  <strong>$columns</strong>  The width of the region.
  <info>int</info>  <strong>$rows</strong>     The height of the region.

<comment>Return:</comment>
  <info>ImagickPixelIterator</info>  Returns an ImagickPixelIterator for an image section.


id: Imagick::getPointSize
type: function
doc:
<comment>Description:</comment>
  Gets point size
  
  Returns the objects point size property. 此方法在Imagick基于ImageMagick 6.3.7以上版本编译时可用。

<comment>Return:</comment>
  <info>float</info>  Returns a <info>float</info> containing the point size.

<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>
  Gets the quantum depth
  
  Returns the Imagick quantum depth.

<comment>Return:</comment>
  <info>array</info>  Returns an array with <return>"quantumDepthLong"</return> and <return>"quantumDepthString"</return> members.


id: Imagick::getQuantumRange
type: function
doc:
<comment>Description:</comment>
  Returns the Imagick quantum range
  
  Returns the quantum range for the Imagick instance.

<comment>Return:</comment>
  <info>array</info>  Returns an associative array containing the quantum range as an <info>int</info> (<return>"quantumRangeLong"</return>)
         and as a  <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>
  Returns the ImageMagick release date
  
  Returns the ImageMagick release date as a string.

<comment>Return:</comment>
  <info>string</info>  Returns the ImageMagick release date as a string.


id: Imagick::getResource
type: function
doc:
<comment>Description:</comment>
  Returns the specified resource's memory usage
  
  Returns the specified resource's memory usage in megabytes.

<comment>Param:</comment>
  <info>int</info>  <strong>$type</strong>  Refer to the list of resourcetype constants.

<comment>Return:</comment>
  <info>int</info>  Returns the specified resource's memory usage in megabytes.


id: Imagick::getResourceLimit
type: function
doc:
<comment>Description:</comment>
  Returns the specified resource limit
  
  Returns the specified resource limit.

<comment>Param:</comment>
  <info>int</info>  <strong>$type</strong>  One of the resourcetype constants. The unit depends on the type of the resource being
              limited.

<comment>Return:</comment>
  <info>int</info>  Returns the specified resource limit in megabytes.

<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>
  Returns the size offset
  
  Returns the size offset associated with the Imagick object. 此方法在Imagick基于ImageMagick 6.2.9以
  上版本编译时可用。

<comment>Return:</comment>
  <info>int</info>  Returns the size offset associated with the Imagick object.


id: Imagick::getVersion
type: function
doc:
<comment>Description:</comment>
  Returns the ImageMagick API version
  
  Returns the ImageMagick API version as a string and as a number.

<comment>Return:</comment>
  <info>array</info>  Returns the ImageMagick API version as a string and as a number.


id: Imagick::haldClutImage
type: function
doc:
<comment>Description:</comment>
  Replaces colors in the image
  
  Replaces colors in the image using a Hald lookup table. Hald images can be created using  HALD
  color coder.

<comment>Param:</comment>
  <info>Imagick</info>  <strong>$clut</strong>     Imagick object containing the Hald lookup image.
  <info>int</info>      <strong>$channel</strong>  Provide any channel constant that is valid for your channel mode. To apply to
                     more than one channel, combine channel constants using bitwise operators. 缺省
                     为<info>Imagick::CHANNEL_DEFAULT</info>.
                     参考此 通道常数列表

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::hasNextImage
type: function
doc:
<comment>Description:</comment>
  Checks if the object has more images
  
  Returns <info>true</info> if the object has more images when traversing the list in the forward direction.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the object has more images when traversing the list in the forward
        direction, returns <info>false</info> if there are none.


id: Imagick::hasPreviousImage
type: function
doc:
<comment>Description:</comment>
  Checks if the object has a previous image
  
  Returns <info>true</info> if the object has more images when traversing the list in the reverse direction

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the object has more images when traversing the list in the reverse
        direction, returns <info>false</info> if there are none.


id: Imagick::identifyFormat
type: function
doc:
<comment>Description:</comment>
  Formats a string with image details
  
  Replaces any embedded formatting characters with the appropriate image property and returns the
  interpreted text. See http://www.imagemagick.org/script/escape.php for escape sequences.

<comment>Param:</comment>
  <info>string</info>  <strong>$embedText</strong>  A string containing formatting sequences e.g. "Trim box: %@ number of unique
                      colors: %k".

<comment>Return:</comment>
  <info>string|false</info>  Returns format 或者在失败时返回 <info>false</info>.


id: Imagick::identifyImage
type: function
doc:
<comment>Description:</comment>
  Identifies an image and fetches attributes
  
  Identifies an image and returns the attributes.  Attributes include the image width, height, size,
  and others.

<comment>Param:</comment>
  <info>bool</info>  <strong>$appendRawOutput</strong>  If <info>true</info> then the raw output is appended to the array.

<comment>Return:</comment>
  <info>array</info>  Identifies an image and returns the attributes.  Attributes include the image width,
         height, size, and others.


id: Imagick::implodeImage
type: function
doc:
<comment>Description:</comment>
  Creates a new image as a copy
  
  Creates a new image that is a copy of an existing one with the image pixels "imploded" by the
  specified percentage.

<comment>Param:</comment>
  <info>float</info>  <strong>$radius</strong>  The radius of the implode

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::importImagePixels
type: function
doc:
<comment>Description:</comment>
  Imports image pixels
  
  Imports pixels from an array into an image. The <strong>$map</strong> is usually 'RGB'. This method imposes the
  following constraints for the parameters: amount of pixels in the array must match <strong>$width</strong> x
  <strong>$height</strong> x length of the map. 此方法在Imagick基于ImageMagick 6.4.5以上版本编译时可用。

<comment>Param:</comment>
  <info>int</info>     <strong>$x</strong>        The image x position
  <info>int</info>     <strong>$y</strong>        The image y position
  <info>int</info>     <strong>$width</strong>    The image width
  <info>int</info>     <strong>$height</strong>   The image height
  <info>string</info>  <strong>$map</strong>      Map of pixel ordering as a string. This can be for example <return>RGB</return>. The value can be
                    any combination or order of R = red, G = green, B = blue, A = alpha (0 is
                    transparent),  O = opacity (0 is opaque), C = cyan, Y = yellow, M = magenta, K =
                    black, I = intensity (for grayscale), P = pad.
  <info>int</info>     <strong>$storage</strong>  The pixel storage method.  Refer to this list of pixel constants.
  <info>array</info>   <strong>$pixels</strong>   The array of pixels

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::inverseFourierTransformImage
type: function
doc:
<comment>Description:</comment>
  Implements the inverse discrete Fourier transform (DFT)
  
  Implements the inverse discrete Fourier transform (DFT) of the image either as a magnitude / phase
  or real / imaginary image pair.
  
  本函数还未编写文档，仅有参数列表。

<comment>Param:</comment>
  <info>Imagick</info>  <strong>$complement</strong>  The second image to combine with this one to form either the magnitude /
                        phase or real / imaginary image pair.
  <info>bool</info>     <strong>$magnitude</strong>   If true, combine as magnitude / phase pair otherwise a real / imaginary
                        image pair.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::labelImage
type: function
doc:
<comment>Description:</comment>
  Adds a label to an image
  
  Adds a label to an image.

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

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::levelImage
type: function
doc:
<comment>Description:</comment>
  Adjusts the levels of an image
  
  Adjusts the levels of an image by scaling the colors falling between specified white and black
  points to the full available quantum range. The parameters provided represent the black, mid, and
  white points. The black point specifies the darkest color in the image. Colors darker than the
  black point are set to zero. Mid point specifies a gamma correction to apply to the image.  White
  point specifies the lightest color in the image. Colors brighter than the white point are set to
  the maximum quantum value.

<comment>Param:</comment>
  <info>float</info>  <strong>$blackPoint</strong>  The image black point
  <info>float</info>  <strong>$gamma</strong>       The gamma value
  <info>float</info>  <strong>$whitePoint</strong>  The image white point
  <info>int</info>    <strong>$channel</strong>     Provide any channel constant that is valid for your channel mode. To apply to
                      more than one channel, combine channeltype constants using bitwise operators.
                      Refer to this list of  channel constants.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::linearStretchImage
type: function
doc:
<comment>Description:</comment>
  Stretches with saturation the image intensity
  
  Stretches with saturation the image intensity.

<comment>Param:</comment>
  <info>float</info>  <strong>$blackPoint</strong>  The image black point
  <info>float</info>  <strong>$whitePoint</strong>  The image white point

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::liquidRescaleImage
type: function
doc:
<comment>Description:</comment>
  Animates an image or images
  
  This method scales the images using liquid rescaling method. This method is an implementation of a
  technique called seam carving. In order for this method to work as expected ImageMagick must be
  compiled with liblqr support. 此方法在Imagick基于ImageMagick 6.3.9以上版本编译时可用。

<comment>Param:</comment>
  <info>int</info>    <strong>$width</strong>     The width of the target size
  <info>int</info>    <strong>$height</strong>    The height of the target size
  <info>float</info>  <strong>$delta_x</strong>   How much the seam can traverse on x-axis.  Passing 0 causes the seams to be
                    straight.
  <info>float</info>  <strong>$rigidity</strong>  Introduces a bias for non-straight seams. This parameter is  typically 0.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。

<comment>See Also:</comment>
   * <strong>Imagick::resizeImage()</strong>


id: Imagick::listRegistry
type: function
doc:
<comment>Description:</comment>
  List all the registry settings
  
  List all the registry settings. Returns an array of all the key/value pairs in the registry

<comment>Return:</comment>
  <info>array</info>  An array containing the key/values from the registry.


id: Imagick::magnifyImage
type: function
doc:
<comment>Description:</comment>
  Scales an image proportionally 2x
  
  Is a convenience method that scales an image proportionally to twice its original size.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::mapImage
type: function
doc:
<comment>Description:</comment>
  Replaces the colors of an image with the closest color from a reference image

<comment>Param:</comment>
  <info>Imagick</info>  <strong>$map</strong>     
  <info>bool</info>     <strong>$dither</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::matteFloodfillImage
type: function
doc:
<comment>Description:</comment>
  Changes the transparency value of a color
  
  Changes the transparency value of any pixel that matches target and is an immediate neighbor.  If
  the method <info>FillToBorderMethod</info> is specified, the transparency value is changed for any neighbor
  pixel that does not match the bordercolor member of image.

<comment>Param:</comment>
  <info>float</info>  <strong>$alpha</strong>        The level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.
  <info>float</info>  <strong>$fuzz</strong>         The fuzz member of image defines how much tolerance is acceptable to consider
                       two colors as the same.
  <info>mixed</info>  <strong>$bordercolor</strong>  An <class>ImagickPixel</class> object or string representing the border color.
  <info>int</info>    <strong>$x</strong>            The starting x coordinate of the operation.
  <info>int</info>    <strong>$y</strong>            The starting y coordinate of the operation.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::medianFilterImage
type: function
doc:
<comment>Description:</comment>
  Applies a digital filter
  
  Applies a digital filter that improves the quality of a noisy image.  Each pixel is replaced by
  the median in a set of neighboring pixels as defined by radius.

<comment>Param:</comment>
  <info>float</info>  <strong>$radius</strong>  The radius of the pixel neighborhood.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::mergeImageLayers
type: function
doc:
<comment>Description:</comment>
  Merges image layers
  
  Merges image layers into one. This method is useful when working with image formats that use
  multiple layers such as PSD. The merging is controlled using the <strong>$layer_method</strong> which defines how
  the layers are merged. 此方法在Imagick基于ImageMagick 6.3.7以上版本编译时可用。

<comment>Param:</comment>
  <info>int</info>  <strong>$layer_method</strong>  One of the <info>Imagick::LAYERMETHOD_*</info> constants

<comment>Return:</comment>
  <info>Imagick</info>  Returns an Imagick object containing the merged image.

<comment>See Also:</comment>
   * <strong>Imagick::flattenImages()</strong>


id: Imagick::minifyImage
type: function
doc:
<comment>Description:</comment>
  Scales an image proportionally to half its size
  
  Is a convenience method that scales an image proportionally to one-half its original size

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::modulateImage
type: function
doc:
<comment>Description:</comment>
  Control the brightness, saturation, and hue
  
  Lets you control the brightness, saturation, and hue of an image.  Hue is the percentage of
  absolute rotation from the current position.  For example 50 results in a counter-clockwise
  rotation of 90 degrees, 150 results in a clockwise rotation of 90 degrees, with 0 and 200 both
  resulting in a rotation of 180 degrees.

<comment>Param:</comment>
  <info>float</info>  <strong>$brightness</strong>  
  <info>float</info>  <strong>$saturation</strong>  
  <info>float</info>  <strong>$hue</strong>         

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::montageImage
type: function
doc:
<comment>Description:</comment>
  Creates a composite image
  
  Creates a composite image by combining several separate images. The images are tiled on the
  composite image with the name of the image optionally appearing just below the individual tile.

<comment>Param:</comment>
  <info>ImagickDraw</info>  <strong>$draw</strong>                The font name, size, and color are obtained from this object.
  <info>string</info>       <strong>$tile_geometry</strong>       The number of tiles per row and page (e.g. 6x4+0+0).
  <info>string</info>       <strong>$thumbnail_geometry</strong>  Preferred image size and border size of each thumbnail (e.g.
                                    120x120+4+3).
  <info>int</info>          <strong>$mode</strong>                Thumbnail framing mode, see Montage Mode constants.
  <info>string</info>       <strong>$frame</strong>               Surround the image with an ornamental border (e.g. 15x15+3+3).
                                    The frame color is that of the thumbnail's matte color.

<comment>Return:</comment>
  <info>Imagick</info>  Creates a composite image and returns it as a new <class>Imagick</class> object.


id: Imagick::morphImages
type: function
doc:
<comment>Description:</comment>
  Method morphs a set of images
  
  Method morphs a set of images.  Both the image pixels and size are linearly interpolated to give
  the appearance of a meta-morphosis from one image to the next.

<comment>Param:</comment>
  <info>int</info>  <strong>$number_frames</strong>  The number of in-between images to generate.

<comment>Return:</comment>
  <info>Imagick</info>  This method returns a new Imagick object on success. 错误时抛出
           <class>ImagickException</class>。


id: Imagick::morphology
type: function
doc:
<comment>Description:</comment>
  Applies a user supplied kernel to the image according to the given morphology method.
  
  Applies a user supplied kernel to the image according to the given morphology method.

<comment>Param:</comment>
  <info>int</info>            <strong>$morphologyMethod</strong>  Which morphology method to use one of the \Imagick::MORPHOLOGY_*
                                    constants.
  <info>int</info>            <strong>$iterations</strong>        The number of iteration to apply the morphology function. A
                                    value of -1 means loop until no change found. How this is
                                    applied may depend on the morphology method. Typically this is a
                                    value of 1.
  <info>ImagickKernel</info>  <strong>$ImagickKernel</strong>     
  <info>int</info>            <strong>$channel</strong>           

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::mosaicImages
type: function
doc:
<comment>Description:</comment>
  Forms a mosaic from images
  
  Inlays an image sequence to form a single coherent picture. It returns a wand with each image in
  the sequence composited at the location defined by the page offset of the image.

<comment>Return:</comment>
  <info>Imagick</info>  成功时返回 <info>true</info>。


id: Imagick::motionBlurImage
type: function
doc:
<comment>Description:</comment>
  Simulates motion blur
  
  Simulates motion blur.  We convolve the image with a Gaussian operator of the given radius and
  standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a
  radius of 0 and MotionBlurImage() selects a suitable radius for you. Angle gives the angle of the
  blurring motion.

<comment>Param:</comment>
  <info>float</info>  <strong>$radius</strong>   The radius of the Gaussian, in pixels, not counting the center pixel.
  <info>float</info>  <strong>$sigma</strong>    The standard deviation of the Gaussian, in pixels.
  <info>float</info>  <strong>$angle</strong>    Apply the effect along this angle.
  <info>int</info>    <strong>$channel</strong>  Provide any channel constant that is valid for your channel mode. To apply to
                   more than one channel, combine channeltype constants using bitwise operators.
                   Refer to this list of channel constants. The channel argument affects only if
                   Imagick is compiled against ImageMagick version 6.4.4 or greater.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::negateImage
type: function
doc:
<comment>Description:</comment>
  Negates the colors in the reference image
  
  Negates the colors in the reference image. The Grayscale option means that only grayscale values
  within the image are negated.

<comment>Param:</comment>
  <info>bool</info>  <strong>$gray</strong>     Whether to only negate grayscale pixels within the image.
  <info>int</info>   <strong>$channel</strong>  Provide any channel constant that is valid for your channel mode. To apply to more
                  than one channel, combine channeltype constants using bitwise operators. Refer to
                  this list of channel constants.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::newImage
type: function
doc:
<comment>Description:</comment>
  创建一张图片
  
  创建一个 Imagick 图片对象，同时可以附带设置一个 ImagickPixel 值作为其背景色。

<comment>Param:</comment>
  <info>int</info>     <strong>$cols</strong>        新建图片对象列的值（宽多少像素）
  <info>int</info>     <strong>$rows</strong>        新建图片对象行的值（高多少像素）
  <info>mixed</info>   <strong>$background</strong>  新建图片独享的背景色
  <info>string</info>  <strong>$format</strong>      图片格式。这个参数是在 Imagick 2.0.1 版本添加的。

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::newPseudoImage
type: function
doc:
<comment>Description:</comment>
  Creates a new image
  
  Creates a new image using ImageMagick pseudo-formats.

<comment>Param:</comment>
  <info>int</info>     <strong>$columns</strong>       columns in the new image
  <info>int</info>     <strong>$rows</strong>          rows in the new image
  <info>string</info>  <strong>$pseudoString</strong>  string containing pseudo image definition.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::nextImage
type: function
doc:
<comment>Description:</comment>
  Moves to the next image
  
  Associates the next image in the image list with an Imagick object.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::normalizeImage
type: function
doc:
<comment>Description:</comment>
  Enhances the contrast of a color image
  
  Enhances the contrast of a color image by adjusting the pixels color to span the entire range of
  colors available.

<comment>Param:</comment>
  <info>int</info>  <strong>$channel</strong>  Provide any channel constant that is valid for your channel mode. To apply to more
                 than one channel, combine channeltype constants using bitwise operators. Refer to
                 this list of channel constants.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::oilPaintImage
type: function
doc:
<comment>Description:</comment>
  Simulates an oil painting
  
  Applies a special effect filter that simulates an oil painting. Each pixel is replaced by the most
  frequent color occurring in a circular region defined by radius.

<comment>Param:</comment>
  <info>float</info>  <strong>$radius</strong>  The radius of the circular neighborhood.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::opaquePaintImage
type: function
doc:
<comment>Description:</comment>
  Changes the color value of any pixel that matches target
  
  Changes any pixel that matches color with the color defined by fill. 此方法在Imagick基于
  ImageMagick 6.3.8以上版本编译时可用。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$target</strong>   ImagickPixel object or a string containing the color to change
  <info>mixed</info>  <strong>$fill</strong>     The replacement color
  <info>float</info>  <strong>$fuzz</strong>     The amount of fuzz. For example, set fuzz to 10 and the color red at intensities
                   of 100 and 102 respectively are now interpreted as the same color.
  <info>bool</info>   <strong>$invert</strong>   If <info>true</info> paints any pixel that does not match the target color.
  <info>int</info>    <strong>$channel</strong>  Provide any channel constant that is valid for your channel mode. To apply to
                   more than one channel, combine channel constants using bitwise operators. 缺省为
                   <info>Imagick::CHANNEL_DEFAULT</info>.
                   参考此 通道常数列表

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::optimizeImageLayers
type: function
doc:
<comment>Description:</comment>
  Removes repeated portions of images to optimize
  
  Compares each image the GIF disposed forms of the previous image in the sequence.  From this it
  attempts to select the smallest cropped image to replace each frame, while preserving the results
  of the animation.  此方法在Imagick基于ImageMagick 6.2.9以上版本编译时可用。

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。

<comment>See Also:</comment>
   * <strong>Imagick::compareImageLayers()</strong>
   * <strong>Imagick::writeImages()</strong>
   * <strong>Imagick::writeImage()</strong>


id: Imagick::orderedPosterizeImage
type: function
doc:
<comment>Description:</comment>
  Performs an ordered dither
  
  Performs an ordered dither based on a number of pre-defined dithering threshold maps,  but over
  multiple intensity levels, which can be different for different channels,  according to the input
  arguments. 此方法在Imagick基于ImageMagick 6.3.1以上版本编译时可用。

<comment>Param:</comment>
  <info>string</info>  <strong>$threshold_map</strong>  A string containing the name of the threshold dither map to use
  <info>int</info>     <strong>$channel</strong>        Provide any channel constant that is valid for your channel mode. To apply
                          to more than one channel, combine channeltype constants using bitwise
                          operators. Refer to this list of channel constants.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::paintFloodfillImage
type: function
doc:
<comment>Description:</comment>
  Changes the color value of any pixel that matches target
  
  Changes the color value of any pixel that matches target and is an immediate neighbor. As of
  ImageMagick 6.3.8 this method has been deprecated and <strong>Imagick::floodfillPaintImage()</strong> should be
  used instead.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$fill</strong>         ImagickPixel object or a string containing the fill color
  <info>float</info>  <strong>$fuzz</strong>         The amount of fuzz. For example, set fuzz to 10 and the color red at
                       intensities of 100 and 102 respectively are now interpreted as the same color
                       for the purposes of the floodfill.
  <info>mixed</info>  <strong>$bordercolor</strong>  ImagickPixel object or a string containing the border color
  <info>int</info>    <strong>$x</strong>            X start position of the floodfill
  <info>int</info>    <strong>$y</strong>            Y start position of the floodfill
  <info>int</info>    <strong>$channel</strong>      Provide any channel constant that is valid for your channel mode. To apply to
                       more than one channel, combine channel constants using bitwise operators. 缺
                       省为<info>Imagick::CHANNEL_DEFAULT</info>.
                       参考此 通道常数列表

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::paintOpaqueImage
type: function
doc:
<comment>Description:</comment>
  Change any pixel that matches color
  
  Changes any pixel that matches color with the color defined by fill.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$target</strong>   Change this target color to the fill color within the image. An ImagickPixel
                   object or a string representing the target color.
  <info>mixed</info>  <strong>$fill</strong>     An ImagickPixel object or a string representing the fill color.
  <info>float</info>  <strong>$fuzz</strong>     The fuzz member of image defines how much tolerance is acceptable to consider two
                   colors as the same.
  <info>int</info>    <strong>$channel</strong>  Provide any channel constant that is valid for your channel mode. To apply to
                   more than one channel, combine channeltype constants using bitwise operators.
                   Refer to this list of channel constants.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::paintTransparentImage
type: function
doc:
<comment>Description:</comment>
  Changes any pixel that matches color with the color defined by fill
  
  Changes any pixel that matches color with the color defined by fill.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$target</strong>  Change this target color to specified opacity value within the image.
  <info>float</info>  <strong>$alpha</strong>   The level of transparency: 1.0 is fully opaque and 0.0 is fully  transparent.
  <info>float</info>  <strong>$fuzz</strong>    The fuzz member of image defines how much tolerance is acceptable to consider two
                  colors as the same.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::pingImage
type: function
doc:
<comment>Description:</comment>
  Fetch basic attributes about the image
  
  This method can be used to query image width, height, size, and format without reading the whole
  image in to memory.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The filename to read the information from.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::pingImageBlob
type: function
doc:
<comment>Description:</comment>
  Quickly fetch attributes
  
  This method can be used to query image width, height, size, and format without reading the whole
  image to memory.  此方法在Imagick基于ImageMagick 6.2.9以上版本编译时可用。

<comment>Param:</comment>
  <info>string</info>  <strong>$image</strong>  A string containing the image.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。

<comment>See Also:</comment>
   * <strong>Imagick::pingImage()</strong>
   * <strong>Imagick::pingImageFile()</strong>
   * <strong>Imagick::readImage()</strong>
   * <strong>Imagick::readImageBlob()</strong>
   * <strong>Imagick::readImageFile()</strong>


id: Imagick::pingImageFile
type: function
doc:
<comment>Description:</comment>
  Get basic image attributes in a lightweight manner
  
  This method can be used to query image width, height, size, and format without reading the whole
  image to memory.  此方法在Imagick基于ImageMagick 6.2.9以上版本编译时可用。

<comment>Param:</comment>
  <info>resource</info>  <strong>$filehandle</strong>  An open filehandle to the image.
  <info>string</info>    <strong>$fileName</strong>    Optional filename for this image.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。

<comment>See Also:</comment>
   * <strong>Imagick::pingImage()</strong>
   * <strong>Imagick::pingImageBlob()</strong>
   * <strong>Imagick::readImage()</strong>
   * <strong>Imagick::readImageBlob()</strong>
   * <strong>Imagick::readImageFile()</strong>


id: Imagick::polaroidImage
type: function
doc:
<comment>Description:</comment>
  Simulates a Polaroid picture
  
  Simulates a Polaroid picture. 此方法在Imagick基于ImageMagick 6.3.2以上版本编译时可用。

<comment>Param:</comment>
  <info>ImagickDraw</info>  <strong>$properties</strong>  The polaroid properties
  <info>float</info>        <strong>$angle</strong>       The polaroid angle

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::posterizeImage
type: function
doc:
<comment>Description:</comment>
  Reduces the image to a limited number of color level
  
  Reduces the image to a limited number of color level.

<comment>Param:</comment>
  <info>int</info>   <strong>$levels</strong>  
  <info>bool</info>  <strong>$dither</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::previewImages
type: function
doc:
<comment>Description:</comment>
  Quickly pin-point appropriate parameters for image processing
  
  Tiles 9 thumbnails of the specified image with an image processing operation applied at varying
  strengths.  This is helpful to quickly pin-point an appropriate parameter for an image processing
  operation.

<comment>Param:</comment>
  <info>int</info>  <strong>$preview</strong>  Preview type. See Preview type constants

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::previousImage
type: function
doc:
<comment>Description:</comment>
  Move to the previous image in the object
  
  Associates the previous image in an image list with the Imagick object.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::profileImage
type: function
doc:
<comment>Description:</comment>
  Adds or removes a profile from an image
  
  Adds or removes a ICC, IPTC, or generic profile from an image. If the profile is NULL, it is
  removed from the image otherwise added.  Use a name of '*' and a profile of NULL to remove all
  profiles from the image.

<comment>Param:</comment>
  <info>string</info>   <strong>$name</strong>     
  <info>?string</info>  <strong>$profile</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::quantizeImage
type: function
doc:
<comment>Description:</comment>
  Analyzes the colors within a reference image

<comment>Param:</comment>
  <info>int</info>   <strong>$numberColors</strong>  
  <info>int</info>   <strong>$colorspace</strong>    
  <info>int</info>   <strong>$treedepth</strong>     
  <info>bool</info>  <strong>$dither</strong>        
  <info>bool</info>  <strong>$measureError</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::quantizeImages
type: function
doc:
<comment>Description:</comment>
  Analyzes the colors within a sequence of images

<comment>Param:</comment>
  <info>int</info>   <strong>$numberColors</strong>  
  <info>int</info>   <strong>$colorspace</strong>    
  <info>int</info>   <strong>$treedepth</strong>     
  <info>bool</info>  <strong>$dither</strong>        
  <info>bool</info>  <strong>$measureError</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::queryFontMetrics
type: function
doc:
<comment>Description:</comment>
  Returns an array representing the font metrics
  
  Returns a multi-dimensional array representing the font metrics.

<comment>Param:</comment>
  <info>ImagickDraw</info>  <strong>$properties</strong>  ImagickDraw object containing font properties
  <info>string</info>       <strong>$text</strong>        The text
  <info>bool</info>         <strong>$multiline</strong>   Multiline parameter. If left empty it is autodetected

<comment>Return:</comment>
  <info>array</info>  Returns a multi-dimensional array representing the font metrics.


id: Imagick::queryFonts
type: function
doc:
<comment>Description:</comment>
  Returns the configured fonts
  
  Returns the configured fonts.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  The query pattern

<comment>Return:</comment>
  <info>array</info>  Returns an array containing the configured fonts.


id: Imagick::queryFormats
type: function
doc:
<comment>Description:</comment>
  Returns formats supported by Imagick
  
  Returns formats supported by Imagick.

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

<comment>Return:</comment>
  <info>array</info>  Returns an array containing the formats supported by Imagick.


id: Imagick::radialBlurImage
type: function
doc:
<comment>Description:</comment>
  Radial blurs an image
  
  Radial blurs an image.

<comment>Param:</comment>
  <info>float</info>  <strong>$angle</strong>    
  <info>int</info>    <strong>$channel</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::raiseImage
type: function
doc:
<comment>Description:</comment>
  Creates a simulated 3d button-like effect
  
  Creates a simulated three-dimensional button-like effect by lightening and darkening the edges of
  the image. Members width and height of raise_info define the width of the vertical and horizontal
  edge of the effect.

<comment>Param:</comment>
  <info>int</info>   <strong>$width</strong>   
  <info>int</info>   <strong>$height</strong>  
  <info>int</info>   <strong>$x</strong>       
  <info>int</info>   <strong>$y</strong>       
  <info>bool</info>  <strong>$raise</strong>   

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::randomThresholdImage
type: function
doc:
<comment>Description:</comment>
  Creates a high-contrast, two-color image
  
  Changes the value of individual pixels based on the intensity of each pixel compared to threshold.
  The result is a high-contrast, two color image. 此方法在Imagick基于ImageMagick 6.2.9以上版本编译时
  可用。

<comment>Param:</comment>
  <info>float</info>  <strong>$low</strong>      The low point
  <info>float</info>  <strong>$high</strong>     The high point
  <info>int</info>    <strong>$channel</strong>  Provide any channel constant that is valid for your channel mode. To apply to
                   more than one channel, combine channeltype constants using bitwise operators.
                   Refer to this list of  channel constants.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::readImage
type: function
doc:
<comment>Description:</comment>
  Reads image from filename
  
  Reads image from filename

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

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::readImageBlob
type: function
doc:
<comment>Description:</comment>
  从二进制字符串里读取图片
  
  从二进制字符串里读取图片

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

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::readImageFile
type: function
doc:
<comment>Description:</comment>
  Reads image from open filehandle
  
  Reads image from open filehandle

<comment>Param:</comment>
  <info>resource</info>  <strong>$filehandle</strong>  
  <info>string</info>    <strong>$fileName</strong>    

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::readimages
type: function
doc:
<comment>Description:</comment>
  Reads image from an array of filenames
  
  Reads image from an array of filenames. All the images are held in a single Imagick object.

<comment>Param:</comment>
  <info>array</info>  <strong>$filenames</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::recolorImage
type: function
doc:
<comment>Description:</comment>
  Recolors image
  
  Translate, scale, shear, or rotate image colors. This method supports variable sized matrices but
  normally 5x5 matrix is used for RGBA and 6x6 is used for CMYK. The last row should contain the
  normalized values. 此方法在Imagick基于ImageMagick 6.3.6以上版本编译时可用。

<comment>Param:</comment>
  <info>array</info>  <strong>$matrix</strong>  The matrix containing the color values

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。

<comment>See Also:</comment>
   * <strong>Imagick::displayImage()</strong>


id: Imagick::reduceNoiseImage
type: function
doc:
<comment>Description:</comment>
  Smooths the contours of an image
  
  Smooths the contours of an image while still preserving edge information. The algorithm works by
  replacing each pixel with its neighbor closest in value. A neighbor is defined by radius. Use a
  radius of 0 and Imagick::reduceNoiseImage() selects a suitable radius for you.

<comment>Param:</comment>
  <info>float</info>  <strong>$radius</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::remapImage
type: function
doc:
<comment>Description:</comment>
  Remaps image colors
  
  Replaces colors an image with those defined by <strong>$replacement</strong>. The colors are replaced with the
  closest possible color. 此方法在Imagick基于ImageMagick 6.4.5以上版本编译时可用。

<comment>Param:</comment>
  <info>Imagick</info>  <strong>$replacement</strong>  An Imagick object containing the replacement colors
  <info>int</info>      <strong>$DITHER</strong>       Refer to this list of dither method constants

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::removeImage
type: function
doc:
<comment>Description:</comment>
  Removes an image from the image list
  
  Removes an image from the image list.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::removeImageProfile
type: function
doc:
<comment>Description:</comment>
  Removes the named image profile and returns it
  
  Removes the named image profile and returns it.

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

<comment>Return:</comment>
  <info>string</info>  Returns a string containing the profile of the image.


id: Imagick::render
type: function
doc:
<comment>Description:</comment>
  Renders all preceding drawing commands
  
  Renders all preceding drawing commands.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::resampleImage
type: function
doc:
<comment>Description:</comment>
  Resample image to desired resolution
  
  Resample image to desired resolution.

<comment>Param:</comment>
  <info>float</info>  <strong>$x_resolution</strong>  
  <info>float</info>  <strong>$y_resolution</strong>  
  <info>int</info>    <strong>$filter</strong>        
  <info>float</info>  <strong>$blur</strong>          

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::resetImagePage
type: function
doc:
<comment>Description:</comment>
  Reset image page
  
  The page definition as a string. The string is in format WxH+x+y. 此方法在Imagick基于ImageMagick
  6.3.6以上版本编译时可用。

<comment>Param:</comment>
  <info>string</info>  <strong>$page</strong>  The page definition. For example <return>7168x5147+0+0</return>

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::resizeImage
type: function
doc:
<comment>Description:</comment>
  Scales an image
  
  Scales an image to the desired dimensions with a filter.
  
  参数 <strong>$bestfit</strong> 的特性在 Imagick 3.0.0 中已改变。在此版本以前，当目标尺寸设为 400x400 时，原尺寸为
  200x150 的图像将不会被改变。自 Imagick 3.0.0 起，源图像将会被放大到 400x300 因为这将更好的适合目标
  尺寸。当使用参数 <strong>$bestfit</strong> 时，必须同时给出宽度和高度。

<comment>Param:</comment>
  <info>int</info>    <strong>$columns</strong>  Width of the image
  <info>int</info>    <strong>$rows</strong>     Height of the image
  <info>int</info>    <strong>$filter</strong>   Refer to the list of filter constants.
  <info>float</info>  <strong>$blur</strong>     The blur factor where &gt; 1 is blurry, \< 1 is sharp.
  <info>bool</info>   <strong>$bestfit</strong>  Optional fit parameter.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::rollImage
type: function
doc:
<comment>Description:</comment>
  Offsets an image
  
  Offsets an image as defined by x and y.

<comment>Param:</comment>
  <info>int</info>  <strong>$x</strong>  The X offset.
  <info>int</info>  <strong>$y</strong>  The Y offset.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::rotateImage
type: function
doc:
<comment>Description:</comment>
  Rotates an image
  
  Rotates an image the specified number of degrees. Empty triangles left over from rotating the
  image are filled with the background color.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$background</strong>  The background color
  <info>float</info>  <strong>$degrees</strong>     Rotation angle, in degrees. The rotation angle is interpreted as the number of
                      degrees to rotate the image clockwise.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::rotationalBlurImage
type: function
doc:
<comment>Description:</comment>
  Rotational blurs an image
  
  Rotational blurs an image.

<comment>Param:</comment>
  <info>float</info>  <strong>$angle</strong>    The angle to apply the blur over.
  <info>int</info>    <strong>$channel</strong>  Provide any channel constant that is valid for your channel mode. To apply to
                   more than one channel, combine channel constants using bitwise operators. 缺省为
                   <info>Imagick::CHANNEL_DEFAULT</info>.
                   参考此 通道常数列表

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::roundCorners
type: function
doc:
<comment>Description:</comment>
  Rounds image corners
  
  Rounds image corners. The first two parameters control the amount  of rounding and the three last
  parameters can be used to fine-tune  the rounding process. 此方法在Imagick基于ImageMagick 6.2.9以
  上版本编译时可用。 此方法在 Imagick 基于 ImageMagick 7.0.0 或以上版本编译时不可用。

<comment>Param:</comment>
  <info>float</info>  <strong>$x_rounding</strong>       x rounding
  <info>float</info>  <strong>$y_rounding</strong>       y rounding
  <info>float</info>  <strong>$stroke_width</strong>     stroke width
  <info>float</info>  <strong>$displace</strong>         image displace
  <info>float</info>  <strong>$size_correction</strong>  size correction

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::sampleImage
type: function
doc:
<comment>Description:</comment>
  Scales an image with pixel sampling
  
  Scales an image to the desired dimensions with pixel sampling. Unlike other scaling methods, this
  method does not introduce any additional color into the scaled image.

<comment>Param:</comment>
  <info>int</info>  <strong>$columns</strong>  
  <info>int</info>  <strong>$rows</strong>     

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::scaleImage
type: function
doc:
<comment>Description:</comment>
  Scales the size of an image
  
  Scales the size of an image to the given dimensions. The other parameter will be calculated if 0
  is passed as either param.
  
  参数 <strong>$bestfit</strong> 的特性在 Imagick 3.0.0 中已改变。在此版本以前，当目标尺寸设为 400x400 时，原尺寸为
  200x150 的图像将不会被改变。自 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>。


id: Imagick::segmentImage
type: function
doc:
<comment>Description:</comment>
  Segments an image
  
  Analyses the image and identifies units that are similar. 此方法在Imagick基于ImageMagick 6.4.5以上
  版本编译时可用。

<comment>Param:</comment>
  <info>int</info>    <strong>$COLORSPACE</strong>         One of the COLORSPACE constants.
  <info>float</info>  <strong>$cluster_threshold</strong>  A percentage describing minimum number of pixels  contained in hexedra
                             before it is considered valid.
  <info>float</info>  <strong>$smooth_threshold</strong>   Eliminates noise from the histogram.
  <info>bool</info>   <strong>$verbose</strong>            Whether to output detailed information about recognised classes.

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


id: Imagick::selectiveBlurImage
type: function
doc:
<comment>Description:</comment>
  Selectively blur an image within a contrast threshold
  
  Selectively blur an image within a contrast threshold. It is similar to the unsharpen mask that
  sharpens everything with contrast above a certain threshold.

<comment>Param:</comment>
  <info>float</info>  <strong>$radius</strong>     
  <info>float</info>  <strong>$sigma</strong>      
  <info>float</info>  <strong>$threshold</strong>  
  <info>int</info>    <strong>$channel</strong>    Provide any channel constant that is valid for your channel mode. To apply to
                     more than one channel, combine channel constants using bitwise operators. 缺省
                     为<info>Imagick::CHANNEL_DEFAULT</info>.
                     参考此 通道常数列表

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::separateImageChannel
type: function
doc:
<comment>Description:</comment>
  Separates a channel from the image
  
  Separates a channel from the image and returns a grayscale image. A channel is a particular color
  component of each pixel in the image.

<comment>Param:</comment>
  <info>int</info>  <strong>$channel</strong>  Which 'channel' to return. For colorspaces other than RGB, you can still use the
                 CHANNEL_RED, CHANNEL_GREEN, CHANNEL_BLUE constants to indicate the 1st, 2nd and 3rd
                 channels.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::sepiaToneImage
type: function
doc:
<comment>Description:</comment>
  Sepia tones an image
  
  Applies a special effect to the image, similar to the effect achieved in a photo darkroom by sepia
  toning.  Threshold ranges from 0 to QuantumRange and is a measure of the extent of the sepia
  toning. A threshold of 80 is a good starting point for a reasonable tone.

<comment>Param:</comment>
  <info>float</info>  <strong>$threshold</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setBackgroundColor
type: function
doc:
<comment>Description:</comment>
  Sets the object's default background color
  
  Sets the object's default background color.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$background</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setColorspace
type: function
doc:
<comment>Description:</comment>
  Set colorspace
  
  Sets the global colorspace value for the object. 此方法在Imagick基于ImageMagick 6.5.7以上版本编译
  时可用。

<comment>Param:</comment>
  <info>int</info>  <strong>$COLORSPACE</strong>  One of the COLORSPACE constants

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setCompression
type: function
doc:
<comment>Description:</comment>
  Sets the object's default compression type
  
  Sets the object's default compression type

<comment>Param:</comment>
  <info>int</info>  <strong>$compression</strong>  The compression type. See the Imagick::COMPRESSION_* constants.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setCompressionQuality
type: function
doc:
<comment>Description:</comment>
  Sets the object's default compression quality
  
  Sets the object's default compression quality.
  
  This method only works for new images e.g. those created through Imagick::newPseudoImage. For
  existing images you should use Imagick::setImageCompressionQuality.

<comment>Param:</comment>
  <info>int</info>  <strong>$quality</strong>  An <info>int</info> between 1 and 100, 1 = high compression, 100 low compression.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setFilename
type: function
doc:
<comment>Description:</comment>
  Sets the filename before you read or write the image
  
  Sets the filename before you read or write an image file.

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

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setFirstIterator
type: function
doc:
<comment>Description:</comment>
  Sets the Imagick iterator to the first image
  
  Sets the Imagick iterator to the first image.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setFont
type: function
doc:
<comment>Description:</comment>
  Sets font
  
  Sets object's font property. This method can be used for example to set font for  caption:
  pseudo-format. The font needs to be configured in ImageMagick configuration or a file by the name
  of <strong>$font</strong> must exist. This method should not be confused with <strong>ImagickDraw::setFont()</strong> which sets the
  font for a specific ImagickDraw object. 此方法在Imagick基于ImageMagick 6.3.7以上版本编译时可用。

<comment>Param:</comment>
  <info>string</info>  <strong>$font</strong>  Font name or a filename

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。

<comment>See Also:</comment>
   * <strong>Imagick::getFont()</strong>
   * <strong>ImagickDraw::setFont()</strong>
   * <strong>ImagickDraw::getFont()</strong>


id: Imagick::setFormat
type: function
doc:
<comment>Description:</comment>
  Sets the format of the Imagick object
  
  Sets the format of the Imagick object.

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

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setGravity
type: function
doc:
<comment>Description:</comment>
  Sets the gravity
  
  Sets the global gravity property for the Imagick object. 此方法在Imagick基于ImageMagick 6.4.0以上
  版本编译时可用。

<comment>Param:</comment>
  <info>int</info>  <strong>$gravity</strong>  The gravity property. Refer to the list of  gravity constants.

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: Imagick::setImage
type: function
doc:
<comment>Description:</comment>
  Replaces image in the object
  
  Replaces the current image sequence with the image from replace object.

<comment>Param:</comment>
  <info>Imagick</info>  <strong>$replace</strong>  The replace Imagick object

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageAlphaChannel
type: function
doc:
<comment>Description:</comment>
  Sets image alpha channel
  
  Activate or deactivate image alpha channel. The <strong>$mode</strong>  is one of the <info>Imagick::ALPHACHANNEL_*</info>
  constants. 此方法在Imagick基于ImageMagick 6.3.8以上版本编译时可用。

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  One of the <info>Imagick::ALPHACHANNEL_*</info> constants

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。

<comment>See Also:</comment>
   * <strong>Imagick::setImageMatte()</strong>
   * Imagick Alpha Channel Constants


id: Imagick::setImageArtifact
type: function
doc:
<comment>Description:</comment>
  Set image artifact
  
  Associates an artifact with the image. The difference between image properties and  image
  artifacts is that properties are public and artifacts are private. 此方法在Imagick基于ImageMagick
  6.5.7以上版本编译时可用。

<comment>Param:</comment>
  <info>string</info>  <strong>$artifact</strong>  The name of the artifact
  <info>string</info>  <strong>$value</strong>     The value of the artifact

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。

<comment>See Also:</comment>
   * <strong>Imagick::getImageArtifact()</strong>
   * <strong>Imagick::deleteImageArtifact()</strong>


id: Imagick::setImageAttribute
type: function
doc:
<comment>Description:</comment>
  Sets an image attribute
  
  Sets an image attribute.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>    
  <info>string</info>  <strong>$value</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageBackgroundColor
type: function
doc:
<comment>Description:</comment>
  Sets the image background color
  
  Sets the image background color.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$background</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageBias
type: function
doc:
<comment>Description:</comment>
  Sets the image bias for any method that convolves an image
  
  Sets the image bias for any method that convolves an image (e.g. Imagick::ConvolveImage()).

<comment>Param:</comment>
  <info>float</info>  <strong>$bias</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageBiasQuantum
type: function
doc:
<comment>Description:</comment>
  Sets the image bias
  
  Sets the image bias. Bias should be scaled with <return>0</return> (no adjustment) to <return>1</return> (quantum value).

<comment>Param:</comment>
  <info>float</info>  <strong>$bias</strong>  

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


id: Imagick::setImageBluePrimary
type: function
doc:
<comment>Description:</comment>
  Sets the image chromaticity blue primary point
  
  Sets the image chromaticity blue primary point.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  
  <info>float</info>  <strong>$y</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageBorderColor
type: function
doc:
<comment>Description:</comment>
  Sets the image border color
  
  Sets the image border color.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$border</strong>  The border color

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageChannelDepth
type: function
doc:
<comment>Description:</comment>
  Sets the depth of a particular image channel
  
  Sets the depth of a particular image channel.

<comment>Param:</comment>
  <info>int</info>  <strong>$channel</strong>  
  <info>int</info>  <strong>$depth</strong>    

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageClipMask
type: function
doc:
<comment>Description:</comment>
  Sets image clip mask
  
  Sets image clip mask from another Imagick object. 此方法在Imagick基于ImageMagick 6.3.6以上版本编译
  时可用。

<comment>Param:</comment>
  <info>Imagick</info>  <strong>$clip_mask</strong>  The Imagick object containing the clip mask

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageColormapColor
type: function
doc:
<comment>Description:</comment>
  Sets the color of the specified colormap index
  
  Sets the color of the specified colormap index.

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

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageColorspace
type: function
doc:
<comment>Description:</comment>
  Sets the image colorspace
  
  Sets the image colorspace. This method should be used when creating new images. To change the
  colorspace of an existing image, you should use Imagick::transformImageColorspace.

<comment>Param:</comment>
  <info>int</info>  <strong>$colorspace</strong>  One of the COLORSPACE constants

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageCompose
type: function
doc:
<comment>Description:</comment>
  Sets the image composite operator
  
  Sets the image composite operator, useful for specifying how to composite the image thumbnail when
  using the Imagick::montageImage() method.

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

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageCompression
type: function
doc:
<comment>Description:</comment>
  设置图片压缩的类型

<comment>Param:</comment>
  <info>int</info>  <strong>$compression</strong>  <info>COMPRESSION</info> 常量里的一种

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageCompressionQuality
type: function
doc:
<comment>Description:</comment>
  设置图片压缩的质量
  
  设置图片压缩的质量

<comment>Param:</comment>
  <info>int</info>  <strong>$quality</strong>  配置压缩质量的整数

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageDelay
type: function
doc:
<comment>Description:</comment>
  Sets the image delay
  
  Sets the image delay. For an animated image this is the amount of time that this frame of the
  image should be displayed for, before displaying the next frame.
  
  The delay can be set individually for each frame in an image.

<comment>Param:</comment>
  <info>int</info>  <strong>$delay</strong>  The amount of time expressed in 'ticks' that the image should be displayed for. For
               animated GIFs there are 100 ticks per second, so a value of 20 would be 20/100 of a
               second aka 1/5th of a second.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageDepth
type: function
doc:
<comment>Description:</comment>
  Sets the image depth
  
  Sets the image depth.

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

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageDispose
type: function
doc:
<comment>Description:</comment>
  Sets the image disposal method
  
  Sets the image disposal method.

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

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageExtent
type: function
doc:
<comment>Description:</comment>
  Sets the image size
  
  Sets the image size (i.e. columns & rows).

<comment>Param:</comment>
  <info>int</info>  <strong>$columns</strong>  
  <info>int</info>  <strong>$rows</strong>     

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageFilename
type: function
doc:
<comment>Description:</comment>
  Sets the filename of a particular image
  
  Sets the filename of a particular image in a sequence.

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

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageFormat
type: function
doc:
<comment>Description:</comment>
  为图片设置指定的格式
  
  为图片设置指定的格式

<comment>Param:</comment>
  <info>string</info>  <strong>$format</strong>  表示图片格式的一个字符串。支持的格式依赖于 ImageMagick 的安装。

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageGamma
type: function
doc:
<comment>Description:</comment>
  Sets the image gamma
  
  Sets the image gamma.

<comment>Param:</comment>
  <info>float</info>  <strong>$gamma</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageGravity
type: function
doc:
<comment>Description:</comment>
  Sets the image gravity
  
  Sets the gravity property for the current image. This method can be used  to set the gravity
  property for a single image sequence. 此方法在Imagick基于ImageMagick 6.4.4以上版本编译时可用。

<comment>Param:</comment>
  <info>int</info>  <strong>$gravity</strong>  The gravity property. Refer to the list of  gravity constants.

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: Imagick::setImageGreenPrimary
type: function
doc:
<comment>Description:</comment>
  Sets the image chromaticity green primary point
  
  Sets the image chromaticity green primary point.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  
  <info>float</info>  <strong>$y</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageIndex
type: function
doc:
<comment>Description:</comment>
  Set the iterator position
  
  Set the iterator to the position in the image list specified with the index parameter.
  
  This method has been deprecated. See <strong>Imagick::setIteratorIndex()</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The position to set the iterator to

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageInterlaceScheme
type: function
doc:
<comment>Description:</comment>
  Sets the image compression
  
  Sets the image compression.

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

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageInterpolateMethod
type: function
doc:
<comment>Description:</comment>
  Sets the image interpolate pixel method
  
  Sets the image interpolate pixel method.

<comment>Param:</comment>
  <info>int</info>  <strong>$method</strong>  The method is one of the <info>Imagick::INTERPOLATE_*</info> constants

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageIterations
type: function
doc:
<comment>Description:</comment>
  Sets the image iterations
  
  Sets the number of iterations an animated image is repeated.

<comment>Param:</comment>
  <info>int</info>  <strong>$iterations</strong>  The number of iterations the image should loop over. Set to '0' to loop
                    continuously.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageMatte
type: function
doc:
<comment>Description:</comment>
  Sets the image matte channel
  
  Sets the image matte channel.  此方法在Imagick基于ImageMagick 6.2.9以上版本编译时可用。

<comment>Param:</comment>
  <info>bool</info>  <strong>$matte</strong>  True activates the matte channel and false disables it.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageMatteColor
type: function
doc:
<comment>Description:</comment>
  Sets the image matte color
  
  Sets the image matte color.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$matte</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageOpacity
type: function
doc:
<comment>Description:</comment>
  Sets the image opacity level
  
  Sets the image to the specified opacity level. 此方法在Imagick基于ImageMagick 6.3.1以上版本编译时
  可用。 This method operates on all channels, which means that for example opacity value of 0.5
  will set all transparent areas to partially opaque. To add transparency to areas that are not
  already transparent use Imagick::evaluateImage()

<comment>Param:</comment>
  <info>float</info>  <strong>$opacity</strong>  The level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageOrientation
type: function
doc:
<comment>Description:</comment>
  Sets the image orientation
  
  Sets the image orientation.

<comment>Param:</comment>
  <info>int</info>  <strong>$orientation</strong>  One of the orientation constants

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImagePage
type: function
doc:
<comment>Description:</comment>
  Sets the page geometry of the image
  
  Sets the page geometry of the image.

<comment>Param:</comment>
  <info>int</info>  <strong>$width</strong>   
  <info>int</info>  <strong>$height</strong>  
  <info>int</info>  <strong>$x</strong>       
  <info>int</info>  <strong>$y</strong>       

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageProfile
type: function
doc:
<comment>Description:</comment>
  Adds a named profile to the Imagick object
  
  Adds a named profile to the Imagick object.  If a profile with the same name already exists, it is
  replaced. This method differs from the Imagick::ProfileImage() method in that it does not apply
  any CMS color profiles.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>     
  <info>string</info>  <strong>$profile</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageProperty
type: function
doc:
<comment>Description:</comment>
  Sets an image property
  
  Sets a named property to the image. 此方法在Imagick基于ImageMagick 6.3.2以上版本编译时可用。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   
  <info>string</info>  <strong>$value</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。

<comment>See Also:</comment>
   * <strong>Imagick::getImageProperty()</strong>


id: Imagick::setImageRedPrimary
type: function
doc:
<comment>Description:</comment>
  Sets the image chromaticity red primary point
  
  Sets the image chromaticity red primary point.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  
  <info>float</info>  <strong>$y</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageRenderingIntent
type: function
doc:
<comment>Description:</comment>
  Sets the image rendering intent
  
  Sets the image rendering intent.

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

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageResolution
type: function
doc:
<comment>Description:</comment>
  Sets the image resolution
  
  Sets the image resolution.

<comment>Param:</comment>
  <info>float</info>  <strong>$x_resolution</strong>  
  <info>float</info>  <strong>$y_resolution</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageScene
type: function
doc:
<comment>Description:</comment>
  Sets the image scene
  
  Sets the image scene.

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

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageTicksPerSecond
type: function
doc:
<comment>Description:</comment>
  Sets the image ticks-per-second
  
  Adjust the amount of time that a frame of an animated image is displayed for.
  
  For animated GIFs, this function does not change the number of 'image ticks' per second, which is
  always defined as 100. Instead it adjusts the amount of time that the frame is displayed for to
  simulate the change in 'ticks per second'.
  
  For example, for an animated GIF where each frame is displayed for 20 ticks (1/5 of a second) when
  this method is called on each frame of that image with an argument of <return>50</return> the frames are adjusted
  to be displayed for 40 ticks (2/5 of a second) and the animation will play at half the original
  speed.

<comment>Param:</comment>
  <info>int</info>  <strong>$ticks_per_second</strong>  The duration for which an image should be displayed expressed in ticks per
                          second.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageType
type: function
doc:
<comment>Description:</comment>
  Sets the image type
  
  Sets the image type.

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

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageUnits
type: function
doc:
<comment>Description:</comment>
  Sets the image units of resolution
  
  Sets the image units of resolution.

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

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageVirtualPixelMethod
type: function
doc:
<comment>Description:</comment>
  Sets the image virtual pixel method
  
  Sets the image virtual pixel method.

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

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setImageWhitePoint
type: function
doc:
<comment>Description:</comment>
  Sets the image chromaticity white point
  
  Sets the image chromaticity white point.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  
  <info>float</info>  <strong>$y</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setIteratorIndex
type: function
doc:
<comment>Description:</comment>
  Set the iterator position
  
  Set the iterator to the position in the image list specified with the index parameter. 此方法在
  Imagick基于ImageMagick 6.2.9以上版本编译时可用。

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The position to set the iterator to

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。

<comment>See Also:</comment>
   * <strong>Imagick::getIteratorIndex()</strong>
   * <strong>Imagick::getImageIndex()</strong>
   * <strong>Imagick::setImageIndex()</strong>


id: Imagick::setLastIterator
type: function
doc:
<comment>Description:</comment>
  Sets the Imagick iterator to the last image
  
  Sets the Imagick iterator to the last image.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setOption
type: function
doc:
<comment>Description:</comment>
  Set an option
  
  Associates one or more options with the wand.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>    
  <info>string</info>  <strong>$value</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setPage
type: function
doc:
<comment>Description:</comment>
  Sets the page geometry of the Imagick object
  
  Sets the page geometry of the Imagick object.

<comment>Param:</comment>
  <info>int</info>  <strong>$width</strong>   
  <info>int</info>  <strong>$height</strong>  
  <info>int</info>  <strong>$x</strong>       
  <info>int</info>  <strong>$y</strong>       

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setPointSize
type: function
doc:
<comment>Description:</comment>
  Sets point size
  
  Sets object's point size property. This method can be used for example to set font size for
  caption: pseudo-format. 此方法在Imagick基于ImageMagick 6.3.7以上版本编译时可用。

<comment>Param:</comment>
  <info>float</info>  <strong>$point_size</strong>  Point size

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。

<comment>See Also:</comment>
   * <strong>Imagick::getPointSize()</strong>


id: Imagick::setProgressMonitor
type: function
doc:
<comment>Description:</comment>
  Set a callback to be called during processing
  
  Set a callback that will be called during the processing of the Imagick image.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  The progress function to call. It should return true if image processing
                       should continue, or false if it should be cancelled. The offset parameter
                       indicates the progress and the span parameter indicates the total amount of
                       work needed to be done.
                       
                       The values passed to the callback function are not consistent. In particular
                       the span parameter can increase during image processing. Because of this
                       calculating the percentage complete of an image operation is not trivial.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setRegistry
type: function
doc:
<comment>Description:</comment>
  Sets the ImageMagick registry entry named key to value
  
  Sets the ImageMagick registry entry named key to value. This is most useful for setting
  "temporary-path" which controls where ImageMagick creates temporary images e.g. while processing
  PDFs.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>    
  <info>string</info>  <strong>$value</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setResolution
type: function
doc:
<comment>Description:</comment>
  Sets the image resolution
  
  Sets the image resolution.

<comment>Param:</comment>
  <info>float</info>  <strong>$x_resolution</strong>  The horizontal resolution.
  <info>float</info>  <strong>$y_resolution</strong>  The vertical resolution.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。

<comment>See Also:</comment>
   * Imagick::setImageResolution
   * Imagick::getImageResolution


id: Imagick::setResourceLimit
type: function
doc:
<comment>Description:</comment>
  Sets the limit for a particular resource
  
  This method is used to modify the resource limits of the underlying ImageMagick library.

<comment>Param:</comment>
  <info>int</info>  <strong>$type</strong>   Refer to the list of resourcetype constants.
  <info>int</info>  <strong>$limit</strong>  One of the resourcetype constants. The unit depends on the type of the resource being
               limited.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。

<comment>See Also:</comment>
   * Imagick::getResourceLimit


id: Imagick::setSamplingFactors
type: function
doc:
<comment>Description:</comment>
  Sets the image sampling factors
  
  Sets the image sampling factors.

<comment>Param:</comment>
  <info>array</info>  <strong>$factors</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setSize
type: function
doc:
<comment>Description:</comment>
  Sets the size of the Imagick object
  
  Sets the size of the Imagick object. Set it before you read a raw image format such as RGB, GRAY,
  or CMYK.

<comment>Param:</comment>
  <info>int</info>  <strong>$columns</strong>  
  <info>int</info>  <strong>$rows</strong>     

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setSizeOffset
type: function
doc:
<comment>Description:</comment>
  Sets the size and offset of the Imagick object
  
  Sets the size and offset of the Imagick object. Set it before you read a raw image format such as
  RGB, GRAY, or CMYK. 此方法在Imagick基于ImageMagick 6.2.9以上版本编译时可用。

<comment>Param:</comment>
  <info>int</info>  <strong>$columns</strong>  The width in pixels.
  <info>int</info>  <strong>$rows</strong>     The height in pixels.
  <info>int</info>  <strong>$offset</strong>   The image offset.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::setType
type: function
doc:
<comment>Description:</comment>
  Sets the image type attribute
  
  Sets the image type attribute.

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

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::shadeImage
type: function
doc:
<comment>Description:</comment>
  Creates a 3D effect
  
  Shines a distant light on an image to create a three-dimensional effect. You control the
  positioning of the light with azimuth and elevation; azimuth is measured in degrees off the x axis
  and elevation is measured in pixels above the Z axis. 此方法在Imagick基于ImageMagick 6.2.9以上版本
  编译时可用。

<comment>Param:</comment>
  <info>bool</info>   <strong>$gray</strong>       A value other than zero shades the intensity of each pixel.
  <info>float</info>  <strong>$azimuth</strong>    Defines the light source direction.
  <info>float</info>  <strong>$elevation</strong>  Defines the light source direction.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::shadowImage
type: function
doc:
<comment>Description:</comment>
  Simulates an image shadow
  
  Simulates an image shadow.

<comment>Param:</comment>
  <info>float</info>  <strong>$opacity</strong>  
  <info>float</info>  <strong>$sigma</strong>    
  <info>int</info>    <strong>$x</strong>        
  <info>int</info>    <strong>$y</strong>        

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::sharpenImage
type: function
doc:
<comment>Description:</comment>
  Sharpens an image
  
  Sharpens an image. We convolve the image with a Gaussian operator of the given radius and standard
  deviation (sigma). For reasonable results, the radius should be larger than sigma. Use a radius of
  0 and <strong>Imagick::sharpenImage()</strong> selects a suitable radius for you.

<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::shaveImage
type: function
doc:
<comment>Description:</comment>
  Shaves pixels from the image edges
  
  Shaves pixels from the image edges. It allocates the memory necessary for the new Image structure
  and returns a pointer to the new image.

<comment>Param:</comment>
  <info>int</info>  <strong>$columns</strong>  
  <info>int</info>  <strong>$rows</strong>     

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::shearImage
type: function
doc:
<comment>Description:</comment>
  Creating a parallelogram
  
  Slides one edge of an image along the X or Y axis, creating a parallelogram. An X direction shear
  slides an edge along the X axis, while a Y direction shear slides an edge along the Y axis.  The
  amount of the shear is controlled by a shear angle.  For X direction shears, x_shear is measured
  relative to the Y axis, and similarly, for Y direction shears y_shear is measured relative to the
  X axis.  Empty triangles left over from shearing the image are filled with the background color.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$background</strong>  The background color
  <info>float</info>  <strong>$x_shear</strong>     The number of degrees to shear on the x axis
  <info>float</info>  <strong>$y_shear</strong>     The number of degrees to shear on the y axis

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::sigmoidalContrastImage
type: function
doc:
<comment>Description:</comment>
  Adjusts the contrast of an image
  
  Adjusts the contrast of an image with a non-linear sigmoidal contrast algorithm. Increase the
  contrast of the image using a sigmoidal transfer function without saturating highlights or
  shadows. Contrast indicates how much to increase the contrast (0 is none; 3 is typical; 20 is
  pushing it); mid-point indicates where midtones fall in the resultant image (0 is white; 50 is
  middle-gray; 100 is black). Set sharpen to <info>true</info> to increase the image contrast otherwise the
  contrast is reduced.
  
  See also ImageMagick v6 Examples - Image Transformations — Sigmoidal Non-linearity Contrast

<comment>Param:</comment>
  <info>bool</info>   <strong>$sharpen</strong>  If true increase the contrast, if false decrease the contrast.
  <info>float</info>  <strong>$alpha</strong>    The amount of contrast to apply. 1 is very little, 5 is a significant amount, 20
                   is extreme.
  <info>float</info>  <strong>$beta</strong>     Where the midpoint of the gradient will be. This value should be in the range 0
                   to 1 - mutliplied by the quantum value for ImageMagick.
  <info>int</info>    <strong>$channel</strong>  Which color channels the contrast will be applied to.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::sketchImage
type: function
doc:
<comment>Description:</comment>
  Simulates a pencil sketch
  
  Simulates a pencil sketch. We convolve the image with a Gaussian operator of the given radius and
  standard deviation (sigma). For reasonable results, radius should be larger than sigma.  Use a
  radius of 0 and Imagick::sketchImage() selects a suitable radius for you. Angle gives the angle of
  the blurring motion.  此方法在Imagick基于ImageMagick 6.2.9以上版本编译时可用。

<comment>Param:</comment>
  <info>float</info>  <strong>$radius</strong>  The radius of the Gaussian, in pixels, not counting the center pixel
  <info>float</info>  <strong>$sigma</strong>   The standard deviation of the Gaussian, in pixels.
  <info>float</info>  <strong>$angle</strong>   Apply the effect along this angle.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::smushImages
type: function
doc:
<comment>Description:</comment>
  Takes all images from the current image pointer to the end of the image list and smushs them
  
  Takes all images from the current image pointer to the end of the image list and smushs them to
  each other top-to-bottom if the stack parameter is true, otherwise left-to-right.

<comment>Param:</comment>
  <info>bool</info>  <strong>$stack</strong>   
  <info>int</info>   <strong>$offset</strong>  

<comment>Return:</comment>
  <info>Imagick</info>  The new smushed image.


id: Imagick::solarizeImage
type: function
doc:
<comment>Description:</comment>
  Applies a solarizing effect to the image
  
  Applies a special effect to the image, similar to the effect achieved in a photo darkroom by
  selectively exposing areas of photo sensitive paper to light. Threshold ranges from 0 to
  QuantumRange and is a measure of the extent of the solarization.

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

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::sparseColorImage
type: function
doc:
<comment>Description:</comment>
  Interpolates colors
  
  Given the arguments array containing numeric values this method interpolates the colors found at
  those coordinates across the whole image using <strong>$sparse_method</strong>. 此方法在Imagick基于ImageMagick
  6.4.5以上版本编译时可用。

<comment>Param:</comment>
  <info>int</info>    <strong>$SPARSE_METHOD</strong>  Refer to this list of sparse method constants
  <info>array</info>  <strong>$arguments</strong>      An array containing the coordinates.  The array is in format <return>array(1,1,
                         2,45)</return>
  <info>int</info>    <strong>$channel</strong>        Provide any channel constant that is valid for your channel mode. To apply
                         to more than one channel, combine channel constants using bitwise
                         operators. 缺省为<info>Imagick::CHANNEL_DEFAULT</info>.
                         参考此 通道常数列表

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::spliceImage
type: function
doc:
<comment>Description:</comment>
  Splices a solid color into the image
  
  Splices a solid color into the image.

<comment>Param:</comment>
  <info>int</info>  <strong>$width</strong>   
  <info>int</info>  <strong>$height</strong>  
  <info>int</info>  <strong>$x</strong>       
  <info>int</info>  <strong>$y</strong>       

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::spreadImage
type: function
doc:
<comment>Description:</comment>
  Randomly displaces each pixel in a block
  
  Special effects method that randomly displaces each pixel in a block defined by the radius
  parameter.

<comment>Param:</comment>
  <info>float</info>  <strong>$radius</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::statisticImage
type: function
doc:
<comment>Description:</comment>
  Modifies image using a statistics function
  
  Replace each pixel with corresponding statistic from the neighborhood of the specified width and
  height.

<comment>Param:</comment>
  <info>int</info>  <strong>$type</strong>     
  <info>int</info>  <strong>$width</strong>    
  <info>int</info>  <strong>$height</strong>   
  <info>int</info>  <strong>$channel</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::steganoImage
type: function
doc:
<comment>Description:</comment>
  Hides a digital watermark within the image
  
  Hides a digital watermark within the image. Recover the hidden watermark later to prove that the
  authenticity of an image. Offset defines the start position within the image to hide the
  watermark.

<comment>Param:</comment>
  <info>Imagick</info>  <strong>$watermark_wand</strong>  
  <info>int</info>      <strong>$offset</strong>          

<comment>Return:</comment>
  <info>Imagick</info>  成功时返回 <info>true</info>。


id: Imagick::stereoImage
type: function
doc:
<comment>Description:</comment>
  Composites two images
  
  Composites two images and produces a single image that is the composite of a left and right image
  of a stereo pair.

<comment>Param:</comment>
  <info>Imagick</info>  <strong>$offset_wand</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::stripImage
type: function
doc:
<comment>Description:</comment>
  去掉图片的所有配置和设置
  
  去掉图片的所有配置和设置

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::subImageMatch
type: function
doc:
<comment>Description:</comment>
  Searches for a subimage in the current image and returns a similarity image
  
  Searches for a subimage in the current image and returns a similarity image such that an exact
  match location is completely white and if none of the pixels match, black, otherwise some gray
  level in-between. You can also pass in the optional parameters bestMatch and similarity. After
  calling the function similarity will be set to the 'score' of the similarity between the subimage
  and the matching position in the larger image, bestMatch will contain an associative array with
  elements x, y, width, height that describe the matching region.

<comment>Param:</comment>
  <info>Imagick</info>  <strong>$Imagick</strong>     
  <info>array</info>    <strong>$offset</strong>      
  <info>float</info>    <strong>$similarity</strong>  A new image that displays the amount of similarity at each pixel.

<comment>Return:</comment>
  <info>Imagick</info>  


id: Imagick::swirlImage
type: function
doc:
<comment>Description:</comment>
  Swirls the pixels about the center of the image
  
  Swirls the pixels about the center of the image, where degrees indicates the sweep of the arc
  through which each pixel is moved. You get a more dramatic effect as the degrees move from 1 to
  360.

<comment>Param:</comment>
  <info>float</info>  <strong>$degrees</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::textureImage
type: function
doc:
<comment>Description:</comment>
  Repeatedly tiles the texture image
  
  Repeatedly tiles the texture image across and down the image canvas.

<comment>Param:</comment>
  <info>Imagick</info>  <strong>$texture_wand</strong>  Imagick object to use as texture image

<comment>Return:</comment>
  <info>Imagick</info>  Returns a new Imagick object that has the repeated texture applied.


id: Imagick::thresholdImage
type: function
doc:
<comment>Description:</comment>
  Changes the value of individual pixels based on a threshold
  
  Changes the value of individual pixels based on the intensity of each pixel compared to threshold.
  The result is a high-contrast, two color image.

<comment>Param:</comment>
  <info>float</info>  <strong>$threshold</strong>  
  <info>int</info>    <strong>$channel</strong>    

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::thumbnailImage
type: function
doc:
<comment>Description:</comment>
  Changes the size of an image
  
  Changes the size of an image to the given dimensions and removes any associated profiles. The goal
  is to produce small, low cost thumbnail images suited for display on the Web.
   If <info>true</info> is given as a third parameter then columns and rows parameters are used as maximums for
  each side. Both sides will be scaled down until they match or are smaller than the parameter given
  for the side.
  
  参数 <strong>$bestfit</strong> 的特性在 Imagick 3.0.0 中已改变。在此版本以前，当目标尺寸设为 400x400 时，原尺寸为
  200x150 的图像将不会被改变。自 Imagick 3.0.0 起，源图像将会被放大到 400x300 因为这将更好的适合目标
  尺寸。当使用参数 <strong>$bestfit</strong> 时，必须同时给出宽度和高度。

<comment>Param:</comment>
  <info>int</info>   <strong>$columns</strong>  Image width
  <info>int</info>   <strong>$rows</strong>     Image height
  <info>bool</info>  <strong>$bestfit</strong>  Whether to force maximum values

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::tintImage
type: function
doc:
<comment>Description:</comment>
  Applies a color vector to each pixel in the image
  
  Applies a color vector to each pixel in the image. The length of the vector is 0 for black and
  white and at its maximum for the midtones. The vector weighing function is
  f(x)=(1-(4.0*((x-0.5)*(x-0.5)))).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$tint</strong>     
  <info>mixed</info>  <strong>$opacity</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::transformImage
type: function
doc:
<comment>Description:</comment>
  Convenience method for setting crop size and the image geometry
  
  A convenience method for setting crop size and the image geometry from strings. 此方法在Imagick基
  于ImageMagick 6.2.9以上版本编译时可用。

<comment>Param:</comment>
  <info>string</info>  <strong>$crop</strong>      A crop geometry string. This geometry defines a subregion of the image to crop.
  <info>string</info>  <strong>$geometry</strong>  An image geometry string. This geometry defines the final size of the image.

<comment>Return:</comment>
  <info>Imagick</info>  Returns an Imagick object containing the transformed image.

<comment>See Also:</comment>
   * <strong>Imagick::cropImage()</strong>
   * <strong>Imagick::resizeImage()</strong>
   * <strong>Imagick::thumbnailImage()</strong>


id: Imagick::transformImageColorspace
type: function
doc:
<comment>Description:</comment>
  Transforms an image to a new colorspace
  
  Transforms an image to a new colorspace.

<comment>Param:</comment>
  <info>int</info>  <strong>$colorspace</strong>  The colorspace the image should be transformed to, one of the COLORSPACE
                    constants e.g. Imagick::COLORSPACE_CMYK.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。

<comment>See Also:</comment>
   * Imagick::setColorSpace


id: Imagick::transparentPaintImage
type: function
doc:
<comment>Description:</comment>
  Paints pixels transparent
  
  Paints pixels matching the target color transparent. 此方法在Imagick基于ImageMagick 6.3.8以上版本
  编译时可用。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$target</strong>  The target color to paint
  <info>float</info>  <strong>$alpha</strong>   透明级别：1.0 是完全不透明，0.0 是完全透明。
  <info>float</info>  <strong>$fuzz</strong>    The amount of fuzz. For example, set fuzz to 10 and the color red at intensities
                  of 100 and 102 respectively are now interpreted as the same color.
  <info>bool</info>   <strong>$invert</strong>  If <info>true</info> paints any pixel that does not match the target color.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::transposeImage
type: function
doc:
<comment>Description:</comment>
  Creates a vertical mirror image
  
  Creates a vertical mirror image by reflecting the pixels  around the central x-axis while rotating
  them 90-degrees. 此方法在Imagick基于ImageMagick 6.2.9以上版本编译时可用。

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。

<comment>See Also:</comment>
   * <strong>Imagick::transverseImage()</strong>


id: Imagick::transverseImage
type: function
doc:
<comment>Description:</comment>
  Creates a horizontal mirror image
  
  Creates a horizontal mirror image by reflecting the pixels around the central y-axis while
  rotating them 270-degrees. 此方法在Imagick基于ImageMagick 6.2.9以上版本编译时可用。

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。

<comment>See Also:</comment>
   * <strong>Imagick::transposeImage()</strong>


id: Imagick::trimImage
type: function
doc:
<comment>Description:</comment>
  Remove edges from the image
  
  Remove edges that are the background color from the image.  此方法在Imagick基于ImageMagick 6.2.9以
  上版本编译时可用。

<comment>Param:</comment>
  <info>float</info>  <strong>$fuzz</strong>  By default target must match a particular pixel color exactly. However, in many
                cases two colors may differ by a small amount. The fuzz member of image defines how
                much tolerance is acceptable to consider two colors as the same. This parameter
                represents the variation on the quantum range.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。

<comment>See Also:</comment>
   * <strong>Imagick::getQuantumDepth()</strong>
   * <strong>Imagick::getQuantumRange()</strong>
   * <strong>imagecropauto()</strong>


id: Imagick::uniqueImageColors
type: function
doc:
<comment>Description:</comment>
  Discards all but one of any pixel color
  
  Discards all but one of any pixel color.  此方法在Imagick基于ImageMagick 6.2.9以上版本编译时可用。

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::unsharpMaskImage
type: function
doc:
<comment>Description:</comment>
  Sharpens an image
  
  Sharpens an image. We convolve the image with a Gaussian operator of the given radius and standard
  deviation (sigma). For reasonable results, radius should be larger than sigma.  Use a radius of 0
  and Imagick::UnsharpMaskImage() selects a suitable radius for you.

<comment>Param:</comment>
  <info>float</info>  <strong>$radius</strong>     
  <info>float</info>  <strong>$sigma</strong>      
  <info>float</info>  <strong>$amount</strong>     
  <info>float</info>  <strong>$threshold</strong>  
  <info>int</info>    <strong>$channel</strong>    

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::valid
type: function
doc:
<comment>Description:</comment>
  Checks if the current item is valid
  
  Checks if the current item is valid.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::vignetteImage
type: function
doc:
<comment>Description:</comment>
  Adds vignette filter to the image
  
  Softens the edges of the image in vignette style.  此方法在Imagick基于ImageMagick 6.2.9以上版本编
  译时可用。

<comment>Param:</comment>
  <info>float</info>  <strong>$blackPoint</strong>  The black point.
  <info>float</info>  <strong>$whitePoint</strong>  The white point
  <info>int</info>    <strong>$x</strong>           X offset of the ellipse
  <info>int</info>    <strong>$y</strong>           Y offset of the ellipse

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。

<comment>See Also:</comment>
   * <strong>Imagick::waveImage()</strong>
   * <strong>Imagick::swirlImage()</strong>


id: Imagick::waveImage
type: function
doc:
<comment>Description:</comment>
  Applies wave filter to the image
  
  Applies a wave filter to the image.  此方法在Imagick基于ImageMagick 6.2.9以上版本编译时可用。

<comment>Param:</comment>
  <info>float</info>  <strong>$amplitude</strong>  The amplitude of the wave.
  <info>float</info>  <strong>$length</strong>     The length of the wave.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。

<comment>See Also:</comment>
   * <strong>Imagick::solarizeImage()</strong>
   * <strong>Imagick::oilpaintImage()</strong>
   * <strong>Imagick::embossImage()</strong>
   * <strong>Imagick::addNoiseImage()</strong>
   * <strong>Imagick::swirlImage()</strong>


id: Imagick::whiteThresholdImage
type: function
doc:
<comment>Description:</comment>
  Force all pixels above the threshold into white
  
  Is like Imagick::ThresholdImage() but force all pixels above the threshold into white while
  leaving all pixels below the threshold unchanged.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$threshold</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::writeImage
type: function
doc:
<comment>Description:</comment>
  把图片写入指定的文件
  
  把图片写入指定的文件。如果指定文件参数的值是 NULL ，图片将会写入通过 Imagick::readImage() 或者
  Imagick::setImageFilename() 设定的文件。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  图片将被写入的文件名。文件的后缀指定了文件的类型。 可以强制指定图片的格式而不管
                     文件的后缀名。在文件名前面加上一个前缀，例如 “jpg:test.png”。

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::writeImageFile
type: function
doc:
<comment>Description:</comment>
  Writes an image to a filehandle
  
  Writes the image sequence to an open filehandle. The handle must be opened with for example fopen.
  此方法在Imagick基于ImageMagick 6.3.6以上版本编译时可用。

<comment>Param:</comment>
  <info>resource</info>  <strong>$filehandle</strong>  Filehandle where to write the image.
  <info>string</info>    <strong>$format</strong>      The image format. The list of valid format specifiers depends on the
                         compiled feature set of ImageMagick, and can be queried at runtime via
                         Imagick::queryFormats.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。

<comment>See Also:</comment>
   * Imagick::queryFormats


id: Imagick::writeImages
type: function
doc:
<comment>Description:</comment>
  Writes an image or image sequence
  
  Writes an image or image sequence.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  
  <info>bool</info>    <strong>$adjoin</strong>    

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: Imagick::writeImagesFile
type: function
doc:
<comment>Description:</comment>
  Writes frames to a filehandle
  
  Writes all image frames into an open filehandle. This method can be used to write animated gifs or
  other multiframe images into open filehandle. 此方法在Imagick基于ImageMagick 6.3.6以上版本编译时可
  用。

<comment>Param:</comment>
  <info>resource</info>  <strong>$filehandle</strong>  Filehandle where to write the images.
  <info>string</info>    <strong>$format</strong>      The image format. The list of valid format specifiers depends on the
                         compiled feature set of ImageMagick, and can be queried at runtime via
                         Imagick::queryFormats.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。

<comment>See Also:</comment>
   * Imagick::queryFormats


id: ImagickDraw::__construct
type: function
doc:
<comment>Description:</comment>
  The ImagickDraw constructor
  
  本函数还未编写文档，仅有参数列表。
  
  The <class>ImagickDraw</class> constructor.

<comment>Return:</comment>
  <info>unknown</info>  没有返回值。


id: ImagickDraw::affine
type: function
doc:
<comment>Description:</comment>
  Adjusts the current affine transformation matrix
  
  本函数还未编写文档，仅有参数列表。
  
  Adjusts the current affine transformation matrix with the specified affine transformation matrix.

<comment>Param:</comment>
  <info>array</info>  <strong>$affine</strong>  Affine matrix parameters

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::annotation
type: function
doc:
<comment>Description:</comment>
  Draws text on the image
  
  本函数还未编写文档，仅有参数列表。
  
  Draws text on the image.

<comment>Param:</comment>
  <info>float</info>   <strong>$x</strong>     The x coordinate where text is drawn
  <info>float</info>   <strong>$y</strong>     The y coordinate where text is drawn
  <info>string</info>  <strong>$text</strong>  The text to draw on the image

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::arc
type: function
doc:
<comment>Description:</comment>
  Draws an arc
  
  本函数还未编写文档，仅有参数列表。
  
  Draws an arc falling within a specified bounding rectangle on the image.

<comment>Param:</comment>
  <info>float</info>  <strong>$sx</strong>  Starting x ordinate of bounding rectangle
  <info>float</info>  <strong>$sy</strong>  starting y ordinate of bounding rectangle
  <info>float</info>  <strong>$ex</strong>  ending x ordinate of bounding rectangle
  <info>float</info>  <strong>$ey</strong>  ending y ordinate of bounding rectangle
  <info>float</info>  <strong>$sd</strong>  starting degrees of rotation
  <info>float</info>  <strong>$ed</strong>  ending degrees of rotation

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::bezier
type: function
doc:
<comment>Description:</comment>
  Draws a bezier curve
  
  本函数还未编写文档，仅有参数列表。
  
  Draws a bezier curve through a set of points on the image.

<comment>Param:</comment>
  <info>array</info>  <strong>$coordinates</strong>  Multidimensional array like array( array( 'x' =&gt; 1, 'y' =&gt; 2 ),  array(
                       'x' =&gt; 3, 'y' =&gt; 4 ) )

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::circle
type: function
doc:
<comment>Description:</comment>
  Draws a circle
  
  本函数还未编写文档，仅有参数列表。
  
  Draws a circle on the image.

<comment>Param:</comment>
  <info>float</info>  <strong>$ox</strong>  origin x coordinate
  <info>float</info>  <strong>$oy</strong>  origin y coordinate
  <info>float</info>  <strong>$px</strong>  perimeter x coordinate
  <info>float</info>  <strong>$py</strong>  perimeter y coordinate

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::clear
type: function
doc:
<comment>Description:</comment>
  Clears the ImagickDraw
  
  本函数还未编写文档，仅有参数列表。
  
  Clears the ImagickDraw object of any accumulated commands, and resets the settings it contains to
  their defaults.

<comment>Return:</comment>
  <info>bool</info>  Returns an <class>ImagickDraw</class> object.


id: ImagickDraw::clone
type: function
doc:
<comment>Description:</comment>
  Makes an exact copy of the specified ImagickDraw object
  
  本函数还未编写文档，仅有参数列表。
  
  Makes an exact copy of the specified <class>ImagickDraw</class> object.

<comment>Return:</comment>
  <info>ImagickDraw</info>  returns an exact copy of the specified <class>ImagickDraw</class> object.


id: ImagickDraw::color
type: function
doc:
<comment>Description:</comment>
  Draws color on image
  
  本函数还未编写文档，仅有参数列表。
  
  Draws color on image using the current fill color, starting at specified position, and using
  specified paint method.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>            x coordinate of the paint
  <info>float</info>  <strong>$y</strong>            y coordinate of the paint
  <info>int</info>    <strong>$paintMethod</strong>  One of the PAINT constant (<return>imagick::PAINT_*</return>).

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::comment
type: function
doc:
<comment>Description:</comment>
  Adds a comment
  
  本函数还未编写文档，仅有参数列表。
  
  Adds a comment to a vector output stream.

<comment>Param:</comment>
  <info>string</info>  <strong>$comment</strong>  The comment string to add to vector output stream

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::composite
type: function
doc:
<comment>Description:</comment>
  Composites an image onto the current image
  
  本函数还未编写文档，仅有参数列表。
  
  Composites an image onto the current image, using the specified composition operator, specified
  position, and at the specified size.

<comment>Param:</comment>
  <info>int</info>      <strong>$compose</strong>        composition operator. One of the Composite Operator constant
                           (<return>imagick::COMPOSITE_*</return>).
  <info>float</info>    <strong>$x</strong>              x coordinate of the top left corner.
  <info>float</info>    <strong>$y</strong>              y coordinate of the top left corner.
  <info>float</info>    <strong>$width</strong>          width of the composition image.
  <info>float</info>    <strong>$height</strong>         height of the composition image.
  <info>Imagick</info>  <strong>$compositeWand</strong>  the <class>Imagick</class> object where composition image is taken from.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: ImagickDraw::destroy
type: function
doc:
<comment>Description:</comment>
  Frees all associated resources
  
  本函数还未编写文档，仅有参数列表。
  
  Frees all resources associated with the <class>ImagickDraw</class> object.

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::ellipse
type: function
doc:
<comment>Description:</comment>
  Draws an ellipse on the image
  
  本函数还未编写文档，仅有参数列表。
  
  Draws an ellipse on the image.

<comment>Param:</comment>
  <info>float</info>  <strong>$ox</strong>     
  <info>float</info>  <strong>$oy</strong>     
  <info>float</info>  <strong>$rx</strong>     
  <info>float</info>  <strong>$ry</strong>     
  <info>float</info>  <strong>$start</strong>  
  <info>float</info>  <strong>$end</strong>    

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::getClipPath
type: function
doc:
<comment>Description:</comment>
  Obtains the current clipping path ID
  
  本函数还未编写文档，仅有参数列表。
  
  Obtains the current clipping path ID.

<comment>Return:</comment>
  <info>string</info>  Returns a string containing the clip path ID or false if no clip path exists.


id: ImagickDraw::getClipRule
type: function
doc:
<comment>Description:</comment>
  Returns the current polygon fill rule
  
  本函数还未编写文档，仅有参数列表。
  
  Returns the current polygon fill rule to be used by the clipping path.

<comment>Return:</comment>
  <info>int</info>  Returns a FILLRULE constant (<return>imagick::FILLRULE_*</return>).


id: ImagickDraw::getClipUnits
type: function
doc:
<comment>Description:</comment>
  Returns the interpretation of clip path units
  
  本函数还未编写文档，仅有参数列表。
  
  Returns the interpretation of clip path units.

<comment>Return:</comment>
  <info>int</info>  Returns an <info>int</info> on success.


id: ImagickDraw::getFillColor
type: function
doc:
<comment>Description:</comment>
  Returns the fill color
  
  本函数还未编写文档，仅有参数列表。
  
  Returns the fill color used for drawing filled objects.

<comment>Return:</comment>
  <info>ImagickPixel</info>  Returns an <class>ImagickPixel</class> object.


id: ImagickDraw::getFillOpacity
type: function
doc:
<comment>Description:</comment>
  Returns the opacity used when drawing
  
  本函数还未编写文档，仅有参数列表。
  
  Returns the opacity used when drawing using the fill color or fill texture.  Fully opaque is 1.0.

<comment>Return:</comment>
  <info>float</info>  The opacity.


id: ImagickDraw::getFillRule
type: function
doc:
<comment>Description:</comment>
  Returns the fill rule
  
  本函数还未编写文档，仅有参数列表。
  
  Returns the fill rule used while drawing polygons.

<comment>Return:</comment>
  <info>int</info>  Returns a FILLRULE constant (<return>imagick::FILLRULE_*</return>).


id: ImagickDraw::getFont
type: function
doc:
<comment>Description:</comment>
  Returns the font
  
  本函数还未编写文档，仅有参数列表。
  
  Returns a string specifying the font used when annotating with text.

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and false if no font is set.


id: ImagickDraw::getFontFamily
type: function
doc:
<comment>Description:</comment>
  Returns the font family
  
  本函数还未编写文档，仅有参数列表。
  
  Returns the font family to use when annotating with text.

<comment>Return:</comment>
  <info>string</info>  Returns the font family currently selected or false if font family is not set.


id: ImagickDraw::getFontSize
type: function
doc:
<comment>Description:</comment>
  Returns the font pointsize
  
  本函数还未编写文档，仅有参数列表。
  
  Returns the font pointsize used when annotating with text.

<comment>Return:</comment>
  <info>float</info>  Returns the font size associated with the current <class>ImagickDraw</class> object.


id: ImagickDraw::getFontStretch
type: function
doc:
<comment>Description:</comment>
  Gets the font stretch to use when annotating with text
  
  Gets the font stretch to use when annotating with text. Returns a StretchType.

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


id: ImagickDraw::getFontStyle
type: function
doc:
<comment>Description:</comment>
  Returns the font style
  
  本函数还未编写文档，仅有参数列表。
  
  Returns the font style used when annotating with text.

<comment>Return:</comment>
  <info>int</info>  Returns a STYLE constant (<return>imagick::STYLE_*</return>) associated with the <class>ImagickDraw</class> object  or 0 if
       no style is set.


id: ImagickDraw::getFontWeight
type: function
doc:
<comment>Description:</comment>
  Returns the font weight
  
  本函数还未编写文档，仅有参数列表。
  
  Returns the font weight used when annotating with text.

<comment>Return:</comment>
  <info>int</info>  Returns an <info>int</info> on success and 0 if no weight is set.


id: ImagickDraw::getGravity
type: function
doc:
<comment>Description:</comment>
  Returns the text placement gravity
  
  本函数还未编写文档，仅有参数列表。
  
  Returns the text placement gravity used when annotating with text.

<comment>Return:</comment>
  <info>int</info>  Returns a GRAVITY constant (<return>imagick::GRAVITY_*</return>) on success and 0 if no gravity is set.


id: ImagickDraw::getStrokeAntialias
type: function
doc:
<comment>Description:</comment>
  Returns the current stroke antialias setting
  
  本函数还未编写文档，仅有参数列表。
  
  Returns the current stroke antialias setting. Stroked outlines are antialiased by default. When
  antialiasing is disabled stroked pixels are thresholded to determine if the stroke color or
  underlying canvas color should be used.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if antialiasing is on and <info>false</info> if it is off.


id: ImagickDraw::getStrokeColor
type: function
doc:
<comment>Description:</comment>
  Returns the color used for stroking object outlines
  
  本函数还未编写文档，仅有参数列表。
  
  Returns the color used for stroking object outlines.

<comment>Param:</comment>
  <info></info>  <strong>$stroke_color</strong>  

<comment>Return:</comment>
  <info>ImagickPixel</info>  Returns an <class>ImagickPixel</class> object which describes the color.


id: ImagickDraw::getStrokeDashArray
type: function
doc:
<comment>Description:</comment>
  Returns an array representing the pattern of dashes and gaps used to stroke paths
  
  本函数还未编写文档，仅有参数列表。
  
  Returns an array representing the pattern of dashes and gaps used to stroke paths.

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and empty array if not set.


id: ImagickDraw::getStrokeDashOffset
type: function
doc:
<comment>Description:</comment>
  Returns the offset into the dash pattern to start the dash
  
  本函数还未编写文档，仅有参数列表。
  
  Returns the offset into the dash pattern to start the dash.

<comment>Return:</comment>
  <info>float</info>  Returns a float representing the offset and 0 if it's not set.


id: ImagickDraw::getStrokeLineCap
type: function
doc:
<comment>Description:</comment>
  Returns the shape to be used at the end of open subpaths when they are stroked
  
  本函数还未编写文档，仅有参数列表。
  
  Returns the shape to be used at the end of open subpaths when they are stroked.

<comment>Return:</comment>
  <info>int</info>  Returns a LINECAP constant (<return>imagick::LINECAP_*</return>), or 0 if stroke linecap is not set.


id: ImagickDraw::getStrokeLineJoin
type: function
doc:
<comment>Description:</comment>
  Returns the shape to be used at the corners of paths when they are stroked
  
  本函数还未编写文档，仅有参数列表。
  
  Returns the shape to be used at the corners of paths (or other vector shapes) when they are
  stroked.

<comment>Return:</comment>
  <info>int</info>  Returns a LINEJOIN constant (<return>imagick::LINEJOIN_*</return>), or 0 if stroke line join is not set.


id: ImagickDraw::getStrokeMiterLimit
type: function
doc:
<comment>Description:</comment>
  Returns the stroke miter limit
  
  本函数还未编写文档，仅有参数列表。
  
  Returns the miter limit. When two line segments meet at a sharp angle and miter joins have been
  specified for 'lineJoin', it is possible for the miter to extend far beyond the thickness of the
  line stroking the path. The 'miterLimit' imposes a limit on the ratio of the miter length to the
  'lineWidth'.

<comment>Return:</comment>
  <info>int</info>  Returns an int describing the miter limit and 0 if no miter limit is set.


id: ImagickDraw::getStrokeOpacity
type: function
doc:
<comment>Description:</comment>
  Returns the opacity of stroked object outlines
  
  本函数还未编写文档，仅有参数列表。
  
  Returns the opacity of stroked object outlines.

<comment>Return:</comment>
  <info>float</info>  Returns a <info>float</info> describing the opacity.


id: ImagickDraw::getStrokeWidth
type: function
doc:
<comment>Description:</comment>
  Returns the width of the stroke used to draw object outlines
  
  本函数还未编写文档，仅有参数列表。
  
  Returns the width of the stroke used to draw object outlines.

<comment>Return:</comment>
  <info>float</info>  Returns a <info>float</info> describing the stroke width.


id: ImagickDraw::getTextAlignment
type: function
doc:
<comment>Description:</comment>
  Returns the text alignment
  
  本函数还未编写文档，仅有参数列表。
  
  Returns the alignment applied when annotating with text.

<comment>Return:</comment>
  <info>int</info>  Returns a ALIGN constant (<return>imagick::ALIGN_*</return>), and 0 if no align is set.


id: ImagickDraw::getTextAntialias
type: function
doc:
<comment>Description:</comment>
  Returns the current text antialias setting
  
  本函数还未编写文档，仅有参数列表。
  
  Returns the current text antialias setting, which determines whether text is antialiased. Text is
  antialiased by default.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if text is antialiased and <info>false</info> if not.


id: ImagickDraw::getTextDecoration
type: function
doc:
<comment>Description:</comment>
  Returns the text decoration
  
  本函数还未编写文档，仅有参数列表。
  
  Returns the decoration applied when annotating with text.

<comment>Return:</comment>
  <info>int</info>  Returns a DECORATION constant (<return>imagick::DECORATION_*</return>), and 0 if no decoration is set.


id: ImagickDraw::getTextEncoding
type: function
doc:
<comment>Description:</comment>
  Returns the code set used for text annotations
  
  本函数还未编写文档，仅有参数列表。
  
  Returns a string which specifies the code set used for text annotations.

<comment>Return:</comment>
  <info>string</info>  Returns a string specifying the code set or false if text encoding is not set.


id: ImagickDraw::getTextInterlineSpacing
type: function
doc:
<comment>Description:</comment>
  Gets the text interword spacing
  
  Gets the text interword spacing.

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


id: ImagickDraw::getTextKerning
type: function
doc:
<comment>Description:</comment>
  Gets the text kerning
  
  Gets the text kerning.

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


id: ImagickDraw::getTextUnderColor
type: function
doc:
<comment>Description:</comment>
  Returns the text under color
  
  本函数还未编写文档，仅有参数列表。
  
  Returns the color of a background rectangle to place under text annotations.

<comment>Return:</comment>
  <info>ImagickPixel</info>  Returns an <class>ImagickPixel</class> object describing the color.


id: ImagickDraw::getVectorGraphics
type: function
doc:
<comment>Description:</comment>
  Returns a string containing vector graphics
  
  本函数还未编写文档，仅有参数列表。
  
  Returns a string which specifies the vector graphics generated by any graphics calls made since
  the <class>ImagickDraw</class> object was instantiated.

<comment>Return:</comment>
  <info>string</info>  Returns a string containing the vector graphics.


id: ImagickDraw::line
type: function
doc:
<comment>Description:</comment>
  Draws a line
  
  本函数还未编写文档，仅有参数列表。
  
  Draws a line on the image using the current stroke color, stroke opacity, and stroke width.

<comment>Param:</comment>
  <info>float</info>  <strong>$sx</strong>  starting x coordinate
  <info>float</info>  <strong>$sy</strong>  starting y coordinate
  <info>float</info>  <strong>$ex</strong>  ending x coordinate
  <info>float</info>  <strong>$ey</strong>  ending y coordinate

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::matte
type: function
doc:
<comment>Description:</comment>
  Paints on the image's opacity channel
  
  本函数还未编写文档，仅有参数列表。
  
  Paints on the image's opacity channel in order to set effected pixels to transparent, to influence
  the opacity of pixels.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>            x coordinate of the matte
  <info>float</info>  <strong>$y</strong>            y coordinate of the matte
  <info>int</info>    <strong>$paintMethod</strong>  One of the PAINT constant (<return>imagick::PAINT_*</return>).

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>， 或者在失败时返回 <info>false</info>。


id: ImagickDraw::pathClose
type: function
doc:
<comment>Description:</comment>
  Adds a path element to the current path
  
  本函数还未编写文档，仅有参数列表。
  
  Adds a path element to the current path which closes the current subpath by drawing a straight
  line from the current point to the current subpath's most recent starting point (usually, the most
  recent moveto point).

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::pathCurveToAbsolute
type: function
doc:
<comment>Description:</comment>
  Draws a cubic Bezier curve
  
  本函数还未编写文档，仅有参数列表。
  
  Draws a cubic Bezier curve from the current point to (x,y) using (x1,y1) as the control point at
  the beginning of the curve and (x2,y2) as the control point at the end of the curve using absolute
  coordinates. At the end of the command, the new current point becomes the final (x,y) coordinate
  pair used in the polybezier.

<comment>Param:</comment>
  <info>float</info>  <strong>$x1</strong>  x coordinate of the first control point
  <info>float</info>  <strong>$y1</strong>  y coordinate of the first control point
  <info>float</info>  <strong>$x2</strong>  x coordinate of the second control point
  <info>float</info>  <strong>$y2</strong>  y coordinate of the first control point
  <info>float</info>  <strong>$x</strong>   x coordinate of the curve end
  <info>float</info>  <strong>$y</strong>   y coordinate of the curve end

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::pathCurveToQuadraticBezierAbsolute
type: function
doc:
<comment>Description:</comment>
  Draws a quadratic Bezier curve
  
  本函数还未编写文档，仅有参数列表。
  
  Draws a quadratic Bezier curve from the current point to (x,y) using (x1,y1) as the control point
  using absolute coordinates. At the end of the command, the new current point becomes the final
  (x,y) coordinate pair used in the polybezier.

<comment>Param:</comment>
  <info>float</info>  <strong>$x1</strong>  x coordinate of the control point
  <info>float</info>  <strong>$y1</strong>  y coordinate of the  control point
  <info>float</info>  <strong>$x</strong>   x coordinate of the end point
  <info>float</info>  <strong>$y</strong>   y coordinate of the end point

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::pathCurveToQuadraticBezierRelative
type: function
doc:
<comment>Description:</comment>
  Draws a quadratic Bezier curve
  
  本函数还未编写文档，仅有参数列表。
  
  Draws a quadratic Bezier curve from the current point to (x,y) using (x1,y1) as the control point
  using relative coordinates. At the end of the command, the new current point becomes the final
  (x,y) coordinate pair used in the polybezier.

<comment>Param:</comment>
  <info>float</info>  <strong>$x1</strong>  starting x coordinate
  <info>float</info>  <strong>$y1</strong>  starting y coordinate
  <info>float</info>  <strong>$x</strong>   ending x coordinate
  <info>float</info>  <strong>$y</strong>   ending y coordinate

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::pathCurveToQuadraticBezierSmoothAbsolute
type: function
doc:
<comment>Description:</comment>
  Draws a quadratic Bezier curve
  
  Draws a quadratic Bezier curve (using absolute coordinates) from the current point to (x,y). The
  control point is assumed to be the reflection of the control point on the previous command
  relative to the current point. (If there is no previous command or if the previous command was not
  a DrawPathCurveToQuadraticBezierAbsolute, DrawPathCurveToQuadraticBezierRelative,
  DrawPathCurveToQuadraticBezierSmoothAbsolut or DrawPathCurveToQuadraticBezierSmoothRelative,
  assume the control point is coincident with the current point.). At the end of the command, the
  new current point becomes the final (x,y) coordinate pair used in the polybezier.
  
  This function cannot be used to continue a cubic Bezier curve smoothly. It can only continue from
  a quadratic curve smoothly.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  ending x coordinate
  <info>float</info>  <strong>$y</strong>  ending y coordinate

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::pathCurveToQuadraticBezierSmoothRelative
type: function
doc:
<comment>Description:</comment>
  Draws a quadratic Bezier curve
  
  本函数还未编写文档，仅有参数列表。
  
  Draws a quadratic Bezier curve (using relative coordinates) from the current point to (x, y). The
  control point is assumed to be the reflection of the control point on the previous command
  relative to the current point. (If there is no previous command or if the previous command was not
  a DrawPathCurveToQuadraticBezierAbsolute,  DrawPathCurveToQuadraticBezierRelative,
  DrawPathCurveToQuadraticBezierSmoothAbsolut or  DrawPathCurveToQuadraticBezierSmoothRelative,
  assume the control point is coincident with the current point). At the end of the command, the new
  current point becomes the final (x, y) coordinate pair used in the polybezier.
  
  This function cannot be used to continue a cubic Bezier curve smoothly. It can only continue from
  a quadratic curve smoothly.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  ending x coordinate
  <info>float</info>  <strong>$y</strong>  ending y coordinate

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::pathCurveToRelative
type: function
doc:
<comment>Description:</comment>
  Draws a cubic Bezier curve
  
  本函数还未编写文档，仅有参数列表。
  
  Draws a cubic Bezier curve from the current point to (x,y) using (x1,y1) as the control point at
  the beginning of the curve and (x2,y2) as the control point at the end of the curve using relative
  coordinates. At the end of the command, the new current point becomes the final (x,y)  coordinate
  pair used in the polybezier.

<comment>Param:</comment>
  <info>float</info>  <strong>$x1</strong>  x coordinate of starting control point
  <info>float</info>  <strong>$y1</strong>  y coordinate of starting control point
  <info>float</info>  <strong>$x2</strong>  x coordinate of ending control point
  <info>float</info>  <strong>$y2</strong>  y coordinate of ending control point
  <info>float</info>  <strong>$x</strong>   ending x coordinate
  <info>float</info>  <strong>$y</strong>   ending y coordinate

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::pathCurveToSmoothAbsolute
type: function
doc:
<comment>Description:</comment>
  Draws a cubic Bezier curve
  
  本函数还未编写文档，仅有参数列表。
  
  Draws a cubic Bezier curve from the current point to (x,y) using absolute coordinates. The first
  control point is assumed to be the reflection of the second control point on the previous command
  relative to the current point. (If there is no previous command or if the previous command was not
  an  DrawPathCurveToAbsolute, DrawPathCurveToRelative,  DrawPathCurveToSmoothAbsolute or
  DrawPathCurveToSmoothRelative, assume the first control point is coincident with the current
  point.) (x2,y2) is the second control point (i.e., the control point at the end of the curve). At
  the end of the command, the new current point becomes the final (x,y) coordinate pair used in the
  polybezier.

<comment>Param:</comment>
  <info>float</info>  <strong>$x2</strong>  x coordinate of the second control point
  <info>float</info>  <strong>$y2</strong>  y coordinate of the second control point
  <info>float</info>  <strong>$x</strong>   x coordinate of the ending point
  <info>float</info>  <strong>$y</strong>   y coordinate of the ending point

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::pathCurveToSmoothRelative
type: function
doc:
<comment>Description:</comment>
  Draws a cubic Bezier curve
  
  本函数还未编写文档，仅有参数列表。
  
  Draws a cubic Bezier curve from the current point to (x,y) using relative coordinates. The first
  control point is assumed to be the reflection of the second control point on the previous command
  relative to the current point. (If there is no previous command or if the previous command was not
  an DrawPathCurveToAbsolute, DrawPathCurveToRelative,  DrawPathCurveToSmoothAbsolute or
  DrawPathCurveToSmoothRelative, assume the first control point is coincident with the current
  point.) (x2,y2) is the second control point (i.e., the control point at the end of the curve). At
  the end of the command, the new current point becomes the final (x,y) coordinate pair used in the
  polybezier.

<comment>Param:</comment>
  <info>float</info>  <strong>$x2</strong>  x coordinate of the second control point
  <info>float</info>  <strong>$y2</strong>  y coordinate of the second control point
  <info>float</info>  <strong>$x</strong>   x coordinate of the ending point
  <info>float</info>  <strong>$y</strong>   y coordinate of the ending point

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::pathEllipticArcAbsolute
type: function
doc:
<comment>Description:</comment>
  Draws an elliptical arc
  
  本函数还未编写文档，仅有参数列表。
  
  Draws an elliptical arc from the current point to (x, y) using absolute coordinates. The size and
  orientation of the ellipse are defined by two radii (rx, ry) and an xAxisRotation, which indicates
  how the ellipse as a whole is rotated relative to the current coordinate system. The center (cx,
  cy) of the ellipse is calculated automatically to satisfy the constraints imposed by the other
  parameters. largeArcFlag and sweepFlag contribute to the automatic calculations and help determine
  how the arc is drawn. If <strong>$large_arc_flag</strong> is <info>true</info> then draw the larger of the available arcs. If
  <strong>$sweep_flag</strong> is true, then draw the arc matching a clock-wise rotation.

<comment>Param:</comment>
  <info>float</info>  <strong>$rx</strong>               x radius
  <info>float</info>  <strong>$ry</strong>               y radius
  <info>float</info>  <strong>$x_axis_rotation</strong>  x axis rotation
  <info>bool</info>   <strong>$large_arc_flag</strong>   large arc flag
  <info>bool</info>   <strong>$sweep_flag</strong>       sweep flag
  <info>float</info>  <strong>$x</strong>                x coordinate
  <info>float</info>  <strong>$y</strong>                y coordinate

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::pathEllipticArcRelative
type: function
doc:
<comment>Description:</comment>
  Draws an elliptical arc
  
  本函数还未编写文档，仅有参数列表。
  
  Draws an elliptical arc from the current point to (x, y) using relative coordinates. The size and
  orientation of the ellipse are defined by two radii (rx, ry) and an xAxisRotation, which indicates
  how the ellipse as a whole is rotated relative to the current coordinate system. The center (cx,
  cy) of the ellipse is calculated automatically to satisfy the constraints imposed by the other
  parameters. largeArcFlag and sweepFlag contribute to the automatic calculations and help determine
  how the arc is drawn. If <strong>$large_arc_flag</strong> is <info>true</info> then draw the larger of the available arcs. If
  <strong>$sweep_flag</strong> is true, then draw the arc matching a clock-wise rotation.

<comment>Param:</comment>
  <info>float</info>  <strong>$rx</strong>               x radius
  <info>float</info>  <strong>$ry</strong>               y radius
  <info>float</info>  <strong>$x_axis_rotation</strong>  x axis rotation
  <info>bool</info>   <strong>$large_arc_flag</strong>   large arc flag
  <info>bool</info>   <strong>$sweep_flag</strong>       sweep flag
  <info>float</info>  <strong>$x</strong>                x coordinate
  <info>float</info>  <strong>$y</strong>                y coordinate

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::pathFinish
type: function
doc:
<comment>Description:</comment>
  Terminates the current path
  
  本函数还未编写文档，仅有参数列表。
  
  Terminates the current path.

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::pathLineToAbsolute
type: function
doc:
<comment>Description:</comment>
  Draws a line path
  
  本函数还未编写文档，仅有参数列表。
  
  Draws a line path from the current point to the given coordinate using absolute coordinates. The
  coordinate then becomes the new current point.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  starting x coordinate
  <info>float</info>  <strong>$y</strong>  ending x coordinate

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::pathLineToHorizontalAbsolute
type: function
doc:
<comment>Description:</comment>
  Draws a horizontal line path
  
  本函数还未编写文档，仅有参数列表。
  
  Draws a horizontal line path from the current point to the target point using absolute
  coordinates.  The target point then becomes the new current point.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  x coordinate

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::pathLineToHorizontalRelative
type: function
doc:
<comment>Description:</comment>
  Draws a horizontal line
  
  本函数还未编写文档，仅有参数列表。
  
  Draws a horizontal line path from the current point to the target point using relative
  coordinates.  The target point then becomes the new current point.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  x coordinate

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::pathLineToRelative
type: function
doc:
<comment>Description:</comment>
  Draws a line path
  
  本函数还未编写文档，仅有参数列表。
  
  Draws a line path from the current point to the given coordinate using relative coordinates. The
  coordinate then becomes the new current point.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  starting x coordinate
  <info>float</info>  <strong>$y</strong>  starting y coordinate

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::pathLineToVerticalAbsolute
type: function
doc:
<comment>Description:</comment>
  Draws a vertical line
  
  本函数还未编写文档，仅有参数列表。
  
  Draws a vertical line path from the current point to the target point using absolute coordinates.
  The target point then becomes the new current point.

<comment>Param:</comment>
  <info>float</info>  <strong>$y</strong>  y coordinate

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::pathLineToVerticalRelative
type: function
doc:
<comment>Description:</comment>
  Draws a vertical line path
  
  本函数还未编写文档，仅有参数列表。
  
  Draws a vertical line path from the current point to the target point using relative coordinates.
  The target point then becomes the new current point.

<comment>Param:</comment>
  <info>float</info>  <strong>$y</strong>  y coordinate

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::pathMoveToAbsolute
type: function
doc:
<comment>Description:</comment>
  Starts a new sub-path
  
  本函数还未编写文档，仅有参数列表。
  
  Starts a new sub-path at the given coordinate using absolute coordinates. The current point then
  becomes the specified coordinate.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  x coordinate of the starting point
  <info>float</info>  <strong>$y</strong>  y coordinate of the starting point

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::pathMoveToRelative
type: function
doc:
<comment>Description:</comment>
  Starts a new sub-path
  
  本函数还未编写文档，仅有参数列表。
  
  Starts a new sub-path at the given coordinate using relative coordinates. The current point then
  becomes the specified coordinate.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  target x coordinate
  <info>float</info>  <strong>$y</strong>  target y coordinate

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::pathStart
type: function
doc:
<comment>Description:</comment>
  Declares the start of a path drawing list
  
  本函数还未编写文档，仅有参数列表。
  
  Declares the start of a path drawing list which is terminated by a matching DrawPathFinish()
  command. All other DrawPath commands must be enclosed between a and a DrawPathFinish() command.
  This is because path drawing commands are subordinate commands and they do not function by
  themselves.

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::point
type: function
doc:
<comment>Description:</comment>
  Draws a point
  
  本函数还未编写文档，仅有参数列表。
  
  Draws a point using the current stroke color and stroke thickness at the specified coordinates.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  point's x coordinate
  <info>float</info>  <strong>$y</strong>  point's y coordinate

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::polygon
type: function
doc:
<comment>Description:</comment>
  Draws a polygon
  
  本函数还未编写文档，仅有参数列表。
  
  Draws a polygon using the current stroke, stroke width, and fill color or texture, using the
  specified array of coordinates.

<comment>Param:</comment>
  <info>array</info>  <strong>$coordinates</strong>  multidimensional array like array( array( 'x' =&gt; 3, 'y' =&gt; 4 ), array(
                       'x' =&gt; 2, 'y' =&gt; 6 ) );

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: ImagickDraw::polyline
type: function
doc:
<comment>Description:</comment>
  Draws a polyline
  
  本函数还未编写文档，仅有参数列表。
  
  Draws a polyline using the current stroke, stroke width, and fill color or texture, using the
  specified array of coordinates.

<comment>Param:</comment>
  <info>array</info>  <strong>$coordinates</strong>  array of x and y coordinates: array( array( 'x' =&gt; 4, 'y' =&gt; 6 ),
                       array( 'x' =&gt; 8, 'y' =&gt; 10 ) )

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: ImagickDraw::pop
type: function
doc:
<comment>Description:</comment>
  Destroys the current ImagickDraw in the stack, and returns to the previously pushed ImagickDraw
  
  本函数还未编写文档，仅有参数列表。
  
  Destroys the current ImagickDraw in the stack, and returns to the previously pushed ImagickDraw.
  Multiple ImagickDraws may exist. It is an error to attempt to pop more ImagickDraws than have been
  pushed, and it is proper form to pop all ImagickDraws which have been pushed.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>， 或者在失败时返回 <info>false</info>。


id: ImagickDraw::popClipPath
type: function
doc:
<comment>Description:</comment>
  Terminates a clip path definition
  
  本函数还未编写文档，仅有参数列表。
  
  Terminates a clip path definition.

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::popDefs
type: function
doc:
<comment>Description:</comment>
  Terminates a definition list
  
  本函数还未编写文档，仅有参数列表。
  
  Terminates a definition list.

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::popPattern
type: function
doc:
<comment>Description:</comment>
  Terminates a pattern definition
  
  本函数还未编写文档，仅有参数列表。
  
  Terminates a pattern definition.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>， 或者在失败时返回 <info>false</info>。


id: ImagickDraw::push
type: function
doc:
<comment>Description:</comment>
  Clones the current ImagickDraw and pushes it to the stack
  
  本函数还未编写文档，仅有参数列表。
  
  Clones the current ImagickDraw to create a new ImagickDraw, which is then added to the ImagickDraw
  stack. The original drawing ImagickDraw(s) may be returned to by invoking ImagickDraw::pop. The
  ImagickDraws are stored on a ImagickDraw stack. For every Pop there must have already been an
  equivalent Push.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>， 或者在失败时返回 <info>false</info>。


id: ImagickDraw::pushClipPath
type: function
doc:
<comment>Description:</comment>
  Starts a clip path definition
  
  本函数还未编写文档，仅有参数列表。
  
  Starts a clip path definition which is comprised of any number of drawing commands and terminated
  by a ImagickDraw::popClipPath command.

<comment>Param:</comment>
  <info>string</info>  <strong>$clip_mask_id</strong>  Clip mask Id

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::pushDefs
type: function
doc:
<comment>Description:</comment>
  Indicates that following commands create named elements for early processing
  
  本函数还未编写文档，仅有参数列表。
  
  Indicates that commands up to a terminating ImagickDraw::popDefs command create named elements
  (e.g. clip-paths, textures, etc.) which may safely be processed earlier for the sake of
  efficiency.

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::pushPattern
type: function
doc:
<comment>Description:</comment>
  Indicates that subsequent commands up to a ImagickDraw::opPattern() command comprise the
  definition
  of a named pattern
  
  本函数还未编写文档，仅有参数列表。
  
  Indicates that subsequent commands up to a DrawPopPattern() command comprise the definition of a
  named pattern. The pattern space is assigned top left corner coordinates, a width and height, and
  becomes its own drawing space.  Anything which can be drawn may be used in a pattern definition.
  Named patterns may be used as stroke or brush definitions.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern_id</strong>  the pattern Id
  <info>float</info>   <strong>$x</strong>           x coordinate of the top-left corner
  <info>float</info>   <strong>$y</strong>           y coordinate of the top-left corner
  <info>float</info>   <strong>$width</strong>       width of the pattern
  <info>float</info>   <strong>$height</strong>      height of the pattern

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>， 或者在失败时返回 <info>false</info>。


id: ImagickDraw::rectangle
type: function
doc:
<comment>Description:</comment>
  Draws a rectangle
  
  本函数还未编写文档，仅有参数列表。
  
  Draws a rectangle given two coordinates and using the current stroke, stroke width, and fill
  settings.

<comment>Param:</comment>
  <info>float</info>  <strong>$x1</strong>  x coordinate of the top left corner
  <info>float</info>  <strong>$y1</strong>  y coordinate of the top left corner
  <info>float</info>  <strong>$x2</strong>  x coordinate of the bottom right corner
  <info>float</info>  <strong>$y2</strong>  y coordinate of the bottom right corner

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::render
type: function
doc:
<comment>Description:</comment>
  Renders all preceding drawing commands onto the image
  
  本函数还未编写文档，仅有参数列表。
  
  Renders all preceding drawing commands onto the image.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>， 或者在失败时返回 <info>false</info>。


id: ImagickDraw::resetVectorGraphics
type: function
doc:
<comment>Description:</comment>
  Resets the vector graphics
  
  Resets the vector graphics.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: ImagickDraw::rotate
type: function
doc:
<comment>Description:</comment>
  Applies the specified rotation to the current coordinate space
  
  本函数还未编写文档，仅有参数列表。
  
  Applies the specified rotation to the current coordinate space.

<comment>Param:</comment>
  <info>float</info>  <strong>$degrees</strong>  degrees to rotate.

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::roundRectangle
type: function
doc:
<comment>Description:</comment>
  Draws a rounded rectangle
  
  本函数还未编写文档，仅有参数列表。
  
  Draws a rounded rectangle given two coordinates, x & y corner radiuses and using the current
  stroke, stroke width, and fill settings.

<comment>Param:</comment>
  <info>float</info>  <strong>$x1</strong>  x coordinate of the top left corner
  <info>float</info>  <strong>$y1</strong>  y coordinate of the top left corner
  <info>float</info>  <strong>$x2</strong>  x coordinate of the bottom right
  <info>float</info>  <strong>$y2</strong>  y coordinate of the bottom right
  <info>float</info>  <strong>$rx</strong>  x rounding
  <info>float</info>  <strong>$ry</strong>  y rounding

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::scale
type: function
doc:
<comment>Description:</comment>
  Adjusts the scaling factor
  
  本函数还未编写文档，仅有参数列表。
  
  Adjusts the scaling factor to apply in the horizontal and vertical directions to the current
  coordinate space.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  horizontal factor
  <info>float</info>  <strong>$y</strong>  vertical factor

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::setClipPath
type: function
doc:
<comment>Description:</comment>
  Associates a named clipping path with the image
  
  本函数还未编写文档，仅有参数列表。
  
  Associates a named clipping path with the image.  Only the areas drawn on by the clipping path
  will be modified as long as it remains in effect.

<comment>Param:</comment>
  <info>string</info>  <strong>$clip_mask</strong>  the clipping path name

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::setClipRule
type: function
doc:
<comment>Description:</comment>
  Set the polygon fill rule to be used by the clipping path
  
  本函数还未编写文档，仅有参数列表。
  
  Set the polygon fill rule to be used by the clipping path.

<comment>Param:</comment>
  <info>int</info>  <strong>$fill_rule</strong>  One of the FILLRULE constant (<return>imagick::FILLRULE_*</return>).

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::setClipUnits
type: function
doc:
<comment>Description:</comment>
  Sets the interpretation of clip path units
  
  本函数还未编写文档，仅有参数列表。
  
  Sets the interpretation of clip path units.

<comment>Param:</comment>
  <info>int</info>  <strong>$clip_units</strong>  the number of clip units

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::setFillAlpha
type: function
doc:
<comment>Description:</comment>
  Sets the opacity to use when drawing using the fill color or fill texture
  
  本函数还未编写文档，仅有参数列表。
  
  Sets the opacity to use when drawing using the fill color or fill texture. Fully opaque is 1.0.

<comment>Param:</comment>
  <info>float</info>  <strong>$opacity</strong>  fill alpha

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::setFillColor
type: function
doc:
<comment>Description:</comment>
  Sets the fill color to be used for drawing filled objects
  
  本函数还未编写文档，仅有参数列表。
  
  Sets the fill color to be used for drawing filled objects.

<comment>Param:</comment>
  <info>ImagickPixel</info>  <strong>$fill_pixel</strong>  ImagickPixel to use to set the color

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::setFillOpacity
type: function
doc:
<comment>Description:</comment>
  Sets the opacity to use when drawing using the fill color or fill texture
  
  本函数还未编写文档，仅有参数列表。
  
  Sets the opacity to use when drawing using the fill color or fill texture. Fully opaque is 1.0.

<comment>Param:</comment>
  <info>float</info>  <strong>$fillOpacity</strong>  the fill opacity

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::setFillPatternURL
type: function
doc:
<comment>Description:</comment>
  Sets the URL to use as a fill pattern for filling objects
  
  本函数还未编写文档，仅有参数列表。
  
  Sets the URL to use as a fill pattern for filling objects. Only local URLs ("#identifier") are
  supported at this time. These local URLs are normally created by defining a named fill pattern
  with DrawPushPattern/DrawPopPattern.

<comment>Param:</comment>
  <info>string</info>  <strong>$fill_url</strong>  URL to use to obtain fill pattern.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>， 或者在失败时返回 <info>false</info>。


id: ImagickDraw::setFillRule
type: function
doc:
<comment>Description:</comment>
  Sets the fill rule to use while drawing polygons
  
  本函数还未编写文档，仅有参数列表。
  
  Sets the fill rule to use while drawing polygons.

<comment>Param:</comment>
  <info>int</info>  <strong>$fill_rule</strong>  One of the FILLRULE constant (<return>imagick::FILLRULE_*</return>).

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::setFont
type: function
doc:
<comment>Description:</comment>
  Sets the fully-specified font to use when annotating with text
  
  本函数还未编写文档，仅有参数列表。
  
  Sets the fully-specified font to use when annotating with text.

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

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: ImagickDraw::setFontFamily
type: function
doc:
<comment>Description:</comment>
  Sets the font family to use when annotating with text
  
  本函数还未编写文档，仅有参数列表。
  
  Sets the font family to use when annotating with text.

<comment>Param:</comment>
  <info>string</info>  <strong>$font_family</strong>  the font family

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: ImagickDraw::setFontSize
type: function
doc:
<comment>Description:</comment>
  Sets the font pointsize to use when annotating with text
  
  本函数还未编写文档，仅有参数列表。
  
  Sets the font pointsize to use when annotating with text.

<comment>Param:</comment>
  <info>float</info>  <strong>$pointsize</strong>  the point size

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::setFontStretch
type: function
doc:
<comment>Description:</comment>
  Sets the font stretch to use when annotating with text
  
  本函数还未编写文档，仅有参数列表。
  
  Sets the font stretch to use when annotating with text. The AnyStretch enumeration acts as a
  wild-card "don't care" option.

<comment>Param:</comment>
  <info>int</info>  <strong>$fontStretch</strong>  One of the STRETCH constant (<return>imagick::STRETCH_*</return>).

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::setFontStyle
type: function
doc:
<comment>Description:</comment>
  Sets the font style to use when annotating with text
  
  本函数还未编写文档，仅有参数列表。
  
  Sets the font style to use when annotating with text. The AnyStyle enumeration acts as a wild-card
  "don't care" option.

<comment>Param:</comment>
  <info>int</info>  <strong>$style</strong>  One of the STYLE constant (<return>imagick::STYLE_*</return>).

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::setFontWeight
type: function
doc:
<comment>Description:</comment>
  Sets the font weight
  
  本函数还未编写文档，仅有参数列表。
  
  Sets the font weight to use when annotating with text.

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

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


id: ImagickDraw::setGravity
type: function
doc:
<comment>Description:</comment>
  Sets the text placement gravity
  
  本函数还未编写文档，仅有参数列表。
  
  Sets the text placement gravity to use when annotating with text.

<comment>Param:</comment>
  <info>int</info>  <strong>$gravity</strong>  One of the GRAVITY constant (<return>imagick::GRAVITY_*</return>).

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::setResolution
type: function
doc:
<comment>Description:</comment>
  Sets the resolution
  
  Sets the resolution.

<comment>Param:</comment>
  <info>float</info>  <strong>$x_resolution</strong>  
  <info>float</info>  <strong>$y_resolution</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: ImagickDraw::setStrokeAlpha
type: function
doc:
<comment>Description:</comment>
  Specifies the opacity of stroked object outlines
  
  本函数还未编写文档，仅有参数列表。
  
  Specifies the opacity of stroked object outlines.

<comment>Param:</comment>
  <info>float</info>  <strong>$opacity</strong>  opacity

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::setStrokeAntialias
type: function
doc:
<comment>Description:</comment>
  Controls whether stroked outlines are antialiased
  
  本函数还未编写文档，仅有参数列表。
  
  Controls whether stroked outlines are antialiased. Stroked outlines are antialiased by default.
  When antialiasing is disabled stroked pixels are thresholded to determine if the stroke color or
  underlying canvas color should be used.

<comment>Param:</comment>
  <info>bool</info>  <strong>$stroke_antialias</strong>  the antialias setting

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::setStrokeColor
type: function
doc:
<comment>Description:</comment>
  Sets the color used for stroking object outlines
  
  本函数还未编写文档，仅有参数列表。
  
  Sets the color used for stroking object outlines.

<comment>Param:</comment>
  <info>ImagickPixel</info>  <strong>$stroke_pixel</strong>  the stroke color

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::setStrokeDashArray
type: function
doc:
<comment>Description:</comment>
  Specifies the pattern of dashes and gaps used to stroke paths
  
  本函数还未编写文档，仅有参数列表。
  
  Specifies the pattern of dashes and gaps used to stroke paths. The strokeDashArray represents an
  array of numbers that specify the lengths of alternating dashes and gaps in pixels. If an odd
  number of values is provided, then the list of values is repeated to yield an even number of
  values. To remove an existing dash array, pass a zero number_elements argument and null
  dash_array. A typical strokeDashArray_ array might contain the members 5 3 2.

<comment>Param:</comment>
  <info>array</info>  <strong>$dashArray</strong>  array of floats

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: ImagickDraw::setStrokeDashOffset
type: function
doc:
<comment>Description:</comment>
  Specifies the offset into the dash pattern to start the dash
  
  本函数还未编写文档，仅有参数列表。
  
  Specifies the offset into the dash pattern to start the dash.

<comment>Param:</comment>
  <info>float</info>  <strong>$dash_offset</strong>  dash offset

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::setStrokeLineCap
type: function
doc:
<comment>Description:</comment>
  Specifies the shape to be used at the end of open subpaths when they are stroked
  
  本函数还未编写文档，仅有参数列表。
  
  Specifies the shape to be used at the end of open subpaths when they are stroked.

<comment>Param:</comment>
  <info>int</info>  <strong>$linecap</strong>  One of the LINECAP constant (<return>imagick::LINECAP_*</return>).

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::setStrokeLineJoin
type: function
doc:
<comment>Description:</comment>
  Specifies the shape to be used at the corners of paths when they are stroked
  
  本函数还未编写文档，仅有参数列表。
  
  Specifies the shape to be used at the corners of paths (or other vector  shapes) when they are
  stroked.

<comment>Param:</comment>
  <info>int</info>  <strong>$linejoin</strong>  One of the LINEJOIN constant (<return>imagick::LINEJOIN_*</return>).

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::setStrokeMiterLimit
type: function
doc:
<comment>Description:</comment>
  Specifies the miter limit
  
  本函数还未编写文档，仅有参数列表。
  
  Specifies the miter limit. When two line segments meet at a sharp angle and miter joins have been
  specified for 'lineJoin', it is possible for the miter to extend far beyond the thickness of the
  line stroking the  path. The miterLimit' imposes a limit on the ratio of the miter length to the
  'lineWidth'.

<comment>Param:</comment>
  <info>int</info>  <strong>$miterlimit</strong>  the miter limit

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::setStrokeOpacity
type: function
doc:
<comment>Description:</comment>
  Specifies the opacity of stroked object outlines
  
  本函数还未编写文档，仅有参数列表。
  
  Specifies the opacity of stroked object outlines.

<comment>Param:</comment>
  <info>float</info>  <strong>$stroke_opacity</strong>  stroke opacity. 1.0 is fully opaque

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::setStrokePatternURL
type: function
doc:
<comment>Description:</comment>
  Sets the pattern used for stroking object outlines
  
  本函数还未编写文档，仅有参数列表。
  
  Sets the pattern used for stroking object outlines.

<comment>Param:</comment>
  <info>string</info>  <strong>$stroke_url</strong>  stroke URL

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: ImagickDraw::setStrokeWidth
type: function
doc:
<comment>Description:</comment>
  Sets the width of the stroke used to draw object outlines
  
  本函数还未编写文档，仅有参数列表。
  
  Sets the width of the stroke used to draw object outlines.

<comment>Param:</comment>
  <info>float</info>  <strong>$stroke_width</strong>  stroke width

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::setTextAlignment
type: function
doc:
<comment>Description:</comment>
  Specifies a text alignment
  
  本函数还未编写文档，仅有参数列表。
  
  Specifies a text alignment to be applied when annotating with text.

<comment>Param:</comment>
  <info>int</info>  <strong>$alignment</strong>  One of the ALIGN constant (<return>imagick::ALIGN_*</return>).

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::setTextAntialias
type: function
doc:
<comment>Description:</comment>
  Controls whether text is antialiased
  
  本函数还未编写文档，仅有参数列表。
  
  Controls whether text is antialiased. Text is antialiased by default.

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

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::setTextDecoration
type: function
doc:
<comment>Description:</comment>
  Specifies a decoration
  
  本函数还未编写文档，仅有参数列表。
  
  Specifies a decoration to be applied when annotating with text.

<comment>Param:</comment>
  <info>int</info>  <strong>$decoration</strong>  One of the DECORATION constant (<return>imagick::DECORATION_*</return>).

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::setTextEncoding
type: function
doc:
<comment>Description:</comment>
  Specifies the text code set
  
  本函数还未编写文档，仅有参数列表。
  
  Specifies the code set to use for text annotations. The only character encoding which may be
  specified at this time is "UTF-8" for representing Unicode as a sequence of bytes. Specify an
  empty string to set text encoding to the system's default. Successful text annotation using
  Unicode may require fonts designed to support Unicode.

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

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::setTextInterlineSpacing
type: function
doc:
<comment>Description:</comment>
  Sets the text interline spacing
  
  Sets the text interline spacing.
  
  本函数还未编写文档，仅有参数列表。

<comment>Param:</comment>
  <info>float</info>  <strong>$spacing</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: ImagickDraw::setTextInterwordSpacing
type: function
doc:
<comment>Description:</comment>
  Sets the text interword spacing
  
  Sets the text interword spacing.

<comment>Param:</comment>
  <info>float</info>  <strong>$spacing</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: ImagickDraw::setTextKerning
type: function
doc:
<comment>Description:</comment>
  Sets the text kerning
  
  Sets the text kerning
  
  本函数还未编写文档，仅有参数列表。

<comment>Param:</comment>
  <info>float</info>  <strong>$kerning</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: ImagickDraw::setTextUnderColor
type: function
doc:
<comment>Description:</comment>
  Specifies the color of a background rectangle
  
  本函数还未编写文档，仅有参数列表。
  
  Specifies the color of a background rectangle to place under text annotations.

<comment>Param:</comment>
  <info>ImagickPixel</info>  <strong>$under_color</strong>  the under color

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::setVectorGraphics
type: function
doc:
<comment>Description:</comment>
  Sets the vector graphics
  
  本函数还未编写文档，仅有参数列表。
  
  Sets the vector graphics associated with the specified ImagickDraw object. Use this method with
  ImagickDraw::getVectorGraphics as a method to persist the vector graphics state.

<comment>Param:</comment>
  <info>string</info>  <strong>$xml</strong>  xml containing the vector graphics

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>， 或者在失败时返回 <info>false</info>。


id: ImagickDraw::setViewbox
type: function
doc:
<comment>Description:</comment>
  Sets the overall canvas size
  
  本函数还未编写文档，仅有参数列表。
  
  Sets the overall canvas size to be recorded with the drawing vector data. Usually this will be
  specified using the same size as the canvas image. When the vector data is saved to SVG or MVG
  formats, the viewbox is use to specify the size of the canvas image that a viewer will render the
  vector data on.

<comment>Param:</comment>
  <info>int</info>  <strong>$x1</strong>  left x coordinate
  <info>int</info>  <strong>$y1</strong>  left y coordinate
  <info>int</info>  <strong>$x2</strong>  right x coordinate
  <info>int</info>  <strong>$y2</strong>  right y coordinate

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::skewX
type: function
doc:
<comment>Description:</comment>
  Skews the current coordinate system in the horizontal direction
  
  本函数还未编写文档，仅有参数列表。
  
  Skews the current coordinate system in the horizontal direction.

<comment>Param:</comment>
  <info>float</info>  <strong>$degrees</strong>  degrees to skew

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::skewY
type: function
doc:
<comment>Description:</comment>
  Skews the current coordinate system in the vertical direction
  
  本函数还未编写文档，仅有参数列表。
  
  Skews the current coordinate system in the vertical direction.

<comment>Param:</comment>
  <info>float</info>  <strong>$degrees</strong>  degrees to skew

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickDraw::translate
type: function
doc:
<comment>Description:</comment>
  Applies a translation to the current coordinate system
  
  本函数还未编写文档，仅有参数列表。
  
  Applies a translation to the current coordinate system which moves the coordinate system origin to
  the specified coordinate.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  horizontal translation
  <info>float</info>  <strong>$y</strong>  vertical translation

<comment>Return:</comment>
  <info>bool</info>  没有返回值。


id: ImagickKernel::addKernel
type: function
doc:
<comment>Description:</comment>
  Attach another kernel to a kernel list
  
  Attach another kernel to this kernel to allow them to both be applied in a single morphology or
  filter function. Returns the new combined kernel.

<comment>Param:</comment>
  <info>ImagickKernel</info>  <strong>$ImagickKernel</strong>  

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


id: ImagickKernel::addUnityKernel
type: function
doc:
<comment>Description:</comment>
  Adds a Unity Kernel to the kernel list
  
  Adds a given amount of the 'Unity' Convolution Kernel to the given pre-scaled and normalized
  Kernel. This in effect adds that amount of the original image into the resulting convolution
  kernel. The resulting effect is to convert the defined kernels into blended soft-blurs, unsharp
  kernels or into sharpening kernels.

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


id: ImagickKernel::fromBuiltIn
type: function
doc:
<comment>Description:</comment>
  Create a kernel from a builtin in kernel
  
  Create a kernel from a builtin in kernel. See http://www.imagemagick.org/Usage/morphology/#kernel
  for examples. Currently the 'rotation' symbols are not supported. Example: $diamondKernel =
  ImagickKernel::fromBuiltIn(\Imagick::KERNEL_DIAMOND, "2");

<comment>Param:</comment>
  <info></info>        <strong>$kerneltype</strong>    The type of kernel to build e.g. \Imagick::KERNEL_DIAMOND
  <info>string</info>  <strong>$kernelString</strong>  A string that describes the parameters e.g. "4,2.5"

<comment>Return:</comment>
  <info>ImagickKernel</info>  


id: ImagickKernel::fromMatrix
type: function
doc:
<comment>Description:</comment>
  Create a kernel from a 2d matrix of values
  
  Create a kernel from an 2d matrix of values. Each value should either be a float (if the element
  should be used) or 'false' if the element should be skipped. For matrices that are odd sizes in
  both dimensions the origin pixel will default to the centre of the kernel. For all other kernel
  sizes the origin pixel must be specified.

<comment>Param:</comment>
  <info></info>  <strong>$array</strong>  A matrix (i.e. 2d array) of values that define the kernel. Each element should be either
            a float value, or FALSE if that element shouldn't be used by the kernel.
  <info></info>  <strong>$array</strong>  Which element of the kernel should be used as the origin pixel. e.g. For a 3x3 matrix
            specifying the origin as [2, 2] would specify that the bottom right element should be
            the origin pixel.

<comment>Return:</comment>
  <info>ImagickKernel</info>  The generated ImagickKernel.


id: ImagickKernel::getMatrix
type: function
doc:
<comment>Description:</comment>
  Get the 2d matrix of values used in this kernel
  
  Get the 2d matrix of values used in this kernel. The elements are either float for elements that
  are used or 'false' if the element should be skipped.

<comment>Return:</comment>
  <info>array</info>  A matrix (2d array) of the values that represent the kernel.


id: ImagickKernel::scale
type: function
doc:
<comment>Description:</comment>
  Scales a kernel list by the given amount
  
  Scales the given kernel list by the given amount, with or without normalization of the sum of the
  kernel values (as per given flags).
   The exact behaviour of this function depends on the normalization type being used please see
  http://www.imagemagick.org/api/morphology.php#ScaleKernelInfo for details.

<comment>Param:</comment>
  <info>float</info>  <strong>$scale</strong>          
  <info>int</info>    <strong>$normalizeFlag</strong>  
                         Imagick::NORMALIZE_KERNEL_NONEImagick::NORMALIZE_KERNEL_VALUEImagick::NORMALIZE_KERNEL_CORRELATEImagick::NORMALIZE_KERNEL_PERCENT

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


id: ImagickKernel::separate
type: function
doc:
<comment>Description:</comment>
  Separates a linked set of kernels and returns an array of ImagickKernels
  
  Separates a linked set of kernels and returns an array of ImagickKernels.

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


id: ImagickPixel::__construct
type: function
doc:
<comment>Description:</comment>
  The ImagickPixel constructor
  
  本函数还未编写文档，仅有参数列表。
  
  Constructs an ImagickPixel object. If a color is specified, the object is constructed and then
  initialised with that color before being returned.

<comment>Param:</comment>
  <info>string</info>  <strong>$color</strong>  The optional color string to use as the initial value of this object.

<comment>Return:</comment>
  <info>unknown</info>  Returns an ImagickPixel object on success, throwing ImagickPixelException on failure.


id: ImagickPixel::clear
type: function
doc:
<comment>Description:</comment>
  Clears resources associated with this object
  
  本函数还未编写文档，仅有参数列表。
  
  Clears the ImagickPixel object, leaving it in a fresh state. This also unsets any color associated
  with the object.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: ImagickPixel::destroy
type: function
doc:
<comment>Description:</comment>
  Deallocates resources associated with this object
  
  本函数还未编写文档，仅有参数列表。
  
  Deallocates any resources used by the ImagickPixel object, and unsets any associated color. The
  object should not be used after the destroy function has been called.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: ImagickPixel::getColor
type: function
doc:
<comment>Description:</comment>
  Returns the color
  
  Returns the color described by the ImagickPixel object, as an array. If the color has an opacity
  channel set, this is provided as a fourth value in the list.

<comment>Param:</comment>
  <info>int</info>  <strong>$normalized</strong>  Normalize the color values. Possible values are <return>0</return>, <return>1</return> or <return>2</return>.

<comment>Return:</comment>
  <info>array</info>  An array of channel values. Throws ImagickPixelException on error.


id: ImagickPixel::getColorAsString
type: function
doc:
<comment>Description:</comment>
  Returns the color as a string
  
  Returns the color of the ImagickPixel object as a string.

<comment>Return:</comment>
  <info>string</info>  Returns the color of the ImagickPixel object as a string.


id: ImagickPixel::getColorCount
type: function
doc:
<comment>Description:</comment>
  Returns the color count associated with this color
  
  Returns the color count associated with this color.
  
  The color count is the number of pixels in the image that have the same color as this
  ImagickPixel.
  
  ImagickPixel::getColorCount appears to only work for ImagickPixel objects created through
  Imagick::getImageHistogram()

<comment>Return:</comment>
  <info>int</info>  Returns the color count as an integer on success, throws ImagickPixelException on failure.


id: ImagickPixel::getColorQuantum
type: function
doc:
<comment>Description:</comment>
  Returns the color of the pixel in an array as Quantum values
  
  Returns the color of the pixel in an array as Quantum values. If ImageMagick was compiled as HDRI
  these will be floats, otherwise they will be integers.
  
  本函数还未编写文档，仅有参数列表。

<comment>Return:</comment>
  <info>array</info>  Returns an array with keys <return>"r"</return>, <return>"g"</return>, <return>"b"</return>, <return>"a"</return>.


id: ImagickPixel::getColorValue
type: function
doc:
<comment>Description:</comment>
  Gets the normalized value of the provided color channel
  
  Retrieves the value of the color channel specified, as a floating-point number between 0 and 1.

<comment>Param:</comment>
  <info>int</info>  <strong>$color</strong>  The color to get the value of, specified as one of the Imagick color constants. This
               can be one of the RGB colors, CMYK colors, alpha and opacity e.g
               (Imagick::COLOR_BLUE, Imagick::COLOR_MAGENTA).

<comment>Return:</comment>
  <info>float</info>  The value of the channel, as a normalized floating-point number, throwing
         ImagickPixelException on error.


id: ImagickPixel::getColorValueQuantum
type: function
doc:
<comment>Description:</comment>
  Gets the quantum value of a color in the ImagickPixel
  
  Gets the quantum value of a color in the ImagickPixel. Return value is a float if ImageMagick was
  compiled with HDRI, otherwise an integer.

<comment>Return:</comment>
  <info>int|float</info>  The quantum value of the color element. Float if ImageMagick was compiled with HDRI,
             otherwise an int.


id: ImagickPixel::getHSL
type: function
doc:
<comment>Description:</comment>
  Returns the normalized HSL color of the ImagickPixel object
  
  Returns the normalized HSL color described by the ImagickPixel object, with each of the three
  values as floating point numbers between 0.0 and 1.0.

<comment>Return:</comment>
  <info>array</info>  Returns the HSL value in an array with the keys "hue", "saturation", and "luminosity".
         Throws ImagickPixelException on failure.


id: ImagickPixel::getIndex
type: function
doc:
<comment>Description:</comment>
  Gets the colormap index of the pixel wand
  
  Gets the colormap index of the pixel wand.

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


id: ImagickPixel::isPixelSimilar
type: function
doc:
<comment>Description:</comment>
  Check the distance between this color and another
  
  Checks the distance between the color described by this ImagickPixel object and that of the
  provided object, by plotting their RGB values on the color cube. If the distance between the two
  points is less than the fuzz value given, the colors are similar. This method replaces
  ImagickPixel::isSimilar() and correctly normalises the fuzz value to ImageMagick QuantumRange.

<comment>Param:</comment>
  <info>ImagickPixel</info>  <strong>$color</strong>  The ImagickPixel object to compare this object against.
  <info>float</info>         <strong>$fuzz</strong>   The maximum distance within which to consider these colors as similar. The
                        theoretical maximum for this value is the square root of three (1.732).

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: ImagickPixel::isPixelSimilarQuantum
type: function
doc:
<comment>Description:</comment>
  Returns whether two colors differ by less than the specified distance
  
  Returns true if the distance between two colors is less than the specified distance. The fuzz
  value should be in the range 0-QuantumRange. The maximum value represents the longest possible
  distance in the colorspace. e.g. from RGB(0, 0, 0) to RGB(255, 255, 255) for the RGB colorspace

<comment>Param:</comment>
  <info>string</info>  <strong>$color</strong>  
  <info>string</info>  <strong>$fuzz</strong>   

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


id: ImagickPixel::isSimilar
type: function
doc:
<comment>Description:</comment>
  Check the distance between this color and another
  
  本函数还未编写文档，仅有参数列表。
  
  Checks the distance between the color described by this ImagickPixel object and that of the
  provided object, by plotting their RGB values on the color cube. If the distance between the two
  points is less than the fuzz value given, the colors are similar. Deprecated in favour of
  ImagickPixel::isPixelSimilar().

<comment>Param:</comment>
  <info>ImagickPixel</info>  <strong>$color</strong>  The ImagickPixel object to compare this object against.
  <info>float</info>         <strong>$fuzz</strong>   The maximum distance within which to consider these colors as similar. The
                        theoretical maximum for this value is the square root of three (1.732).

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: ImagickPixel::setColor
type: function
doc:
<comment>Description:</comment>
  Sets the color
  
  本函数还未编写文档，仅有参数列表。
  
  Sets the color described by the ImagickPixel object, with a string (e.g. "blue", "#0000ff",
  "rgb(0,0,255)", "cmyk(100,100,100,10)", etc.).

<comment>Param:</comment>
  <info>string</info>  <strong>$color</strong>  The color definition to use in order to initialise the ImagickPixel object.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the specified color was set, <info>false</info> otherwise.


id: ImagickPixel::setColorCount
type: function
doc:
<comment>Description:</comment>
  Sets the color count associated with this color
  
  Sets the color count associated with this color.

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

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: ImagickPixel::setColorValue
type: function
doc:
<comment>Description:</comment>
  Sets the normalized value of one of the channels
  
  Sets the value of the specified channel of this object to the provided value, which should be
  between 0 and 1. This function can be used to provide an opacity channel to an ImagickPixel
  object.

<comment>Param:</comment>
  <info>int</info>    <strong>$color</strong>  One of the Imagick color constants e.g. \Imagick::COLOR_GREEN or
                 \Imagick::COLOR_ALPHA.
  <info>float</info>  <strong>$value</strong>  The value to set this channel to, ranging from 0 to 1.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: ImagickPixel::setColorValueQuantum
type: function
doc:
<comment>Description:</comment>
  Sets the quantum value of a color element of the ImagickPixel
  
  Sets the quantum value of a color element of the ImagickPixel.
  
  本函数还未编写文档，仅有参数列表。

<comment>Param:</comment>
  <info>int</info>        <strong>$color</strong>  Which color element to set e.g. \Imagick::COLOR_GREEN.
  <info>int|float</info>  <strong>$value</strong>  The quantum value to set the color element to. This should be a float if
                     ImageMagick was compiled with HDRI otherwise an int in the range 0 to
                     Imagick::getQuantum().

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: ImagickPixel::setHSL
type: function
doc:
<comment>Description:</comment>
  Sets the normalized HSL color
  
  Sets the color described by the ImagickPixel object using normalized values for hue, saturation
  and luminosity.

<comment>Param:</comment>
  <info>float</info>  <strong>$hue</strong>         The normalized value for hue, described as a fractional arc (between 0 and 1)
                      of the hue circle, where the zero value is red.
  <info>float</info>  <strong>$saturation</strong>  The normalized value for saturation, with 1 as full saturation.
  <info>float</info>  <strong>$luminosity</strong>  The normalized value for luminosity, on a scale from black at 0 to white at 1,
                      with the full HS value at 0.5 luminosity.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: ImagickPixel::setIndex
type: function
doc:
<comment>Description:</comment>
  Sets the colormap index of the pixel wand
  
  Sets the colormap index of the pixel wand.

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

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: ImagickPixelIterator::__construct
type: function
doc:
<comment>Description:</comment>
  The ImagickPixelIterator constructor
  
  本函数还未编写文档，仅有参数列表。
  
  The ImagickPixelIterator constructor

<comment>Return:</comment>
  <info>unknown</info>  成功时返回 <info>true</info>。


id: ImagickPixelIterator::clear
type: function
doc:
<comment>Description:</comment>
  Clear resources associated with a PixelIterator
  
  本函数还未编写文档，仅有参数列表。
  
  Clear resources associated with a PixelIterator.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: ImagickPixelIterator::destroy
type: function
doc:
<comment>Description:</comment>
  Deallocates resources associated with a PixelIterator
  
  本函数还未编写文档，仅有参数列表。
  
  Deallocates resources associated with a PixelIterator.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: ImagickPixelIterator::getCurrentIteratorRow
type: function
doc:
<comment>Description:</comment>
  Returns the current row of ImagickPixel objects
  
  本函数还未编写文档，仅有参数列表。
  
  Returns the current row as an array of ImagickPixel objects from the pixel iterator.

<comment>Return:</comment>
  <info>array</info>  Returns a row as an array of ImagickPixel objects that can themselves be iterated.


id: ImagickPixelIterator::getIteratorRow
type: function
doc:
<comment>Description:</comment>
  Returns the current pixel iterator row
  
  本函数还未编写文档，仅有参数列表。
  
  Returns the current pixel iterator row.

<comment>Return:</comment>
  <info>int</info>  Returns the integer offset of the row, throwing ImagickPixelIteratorException on error.


id: ImagickPixelIterator::getNextIteratorRow
type: function
doc:
<comment>Description:</comment>
  Returns the next row of the pixel iterator
  
  本函数还未编写文档，仅有参数列表。
  
  Returns the next row as an array of pixel wands from the pixel iterator.

<comment>Return:</comment>
  <info>array</info>  Returns the next row as an array of ImagickPixel objects, throwing
         ImagickPixelIteratorException on error.


id: ImagickPixelIterator::getPreviousIteratorRow
type: function
doc:
<comment>Description:</comment>
  Returns the previous row
  
  本函数还未编写文档，仅有参数列表。
  
  Returns the previous row as an array of pixel wands from the pixel iterator.

<comment>Return:</comment>
  <info>array</info>  Returns the previous row as an array of ImagickPixelWand objects from the
         ImagickPixelIterator, throwing ImagickPixelIteratorException on error.


id: ImagickPixelIterator::newPixelIterator
type: function
doc:
<comment>Description:</comment>
  Returns a new pixel iterator
  
  本函数还未编写文档，仅有参数列表。
  
  Returns a new pixel iterator.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。 Throwing ImagickPixelIteratorException.


id: ImagickPixelIterator::newPixelRegionIterator
type: function
doc:
<comment>Description:</comment>
  Returns a new pixel iterator
  
  本函数还未编写文档，仅有参数列表。
  
  Returns a new pixel iterator.

<comment>Param:</comment>
  <info>Imagick</info>  <strong>$wand</strong>     
  <info>int</info>      <strong>$x</strong>        
  <info>int</info>      <strong>$y</strong>        
  <info>int</info>      <strong>$columns</strong>  
  <info>int</info>      <strong>$rows</strong>     

<comment>Return:</comment>
  <info>bool</info>  Returns a new ImagickPixelIterator on success; on failure, throws
        ImagickPixelIteratorException.


id: ImagickPixelIterator::resetIterator
type: function
doc:
<comment>Description:</comment>
  Resets the pixel iterator
  
  本函数还未编写文档，仅有参数列表。
  
  Resets the pixel iterator.  Use it in conjunction with ImagickPixelIterator::getNextIteratorRow()
  to iterate over all the pixels in a pixel container.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: ImagickPixelIterator::setIteratorFirstRow
type: function
doc:
<comment>Description:</comment>
  Sets the pixel iterator to the first pixel row
  
  本函数还未编写文档，仅有参数列表。
  
  Sets the pixel iterator to the first pixel row.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: ImagickPixelIterator::setIteratorLastRow
type: function
doc:
<comment>Description:</comment>
  Sets the pixel iterator to the last pixel row
  
  本函数还未编写文档，仅有参数列表。
  
  Sets the pixel iterator to the last pixel row.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: ImagickPixelIterator::setIteratorRow
type: function
doc:
<comment>Description:</comment>
  Set the pixel iterator row
  
  本函数还未编写文档，仅有参数列表。
  
  Set the pixel iterator row.

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

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: ImagickPixelIterator::syncIterator
type: function
doc:
<comment>Description:</comment>
  Syncs the pixel iterator
  
  本函数还未编写文档，仅有参数列表。
  
  Syncs the pixel iterator.

<comment>Return:</comment>
  <info>bool</info>  成功时返回 <info>true</info>。


id: InfiniteIterator
type: class
doc:
<comment>Description:</comment>
  The <class>InfiniteIterator</class> allows one to infinitely iterate over an iterator without having to manually
  rewind the iterator upon reaching its end.


id: InfiniteIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs an InfiniteIterator
  
  Constructs an <class>InfiniteIterator</class> from an <class>Iterator</class>.

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>  The iterator to infinitely iterate over.

<comment>See Also:</comment>
   * InfiniteIterator::next


id: InfiniteIterator::next
type: function
doc:
<comment>Description:</comment>
  Moves the inner Iterator forward or rewinds it
  
  Moves the inner <class>Iterator</class> forward to its next element if there is one, otherwise rewinds the inner
  <class>Iterator</class> back to the beginning.
  
  Even an <class>InfiniteIterator</class> stops if  its inner <class>Iterator</class> is empty.

<comment>Return:</comment>
  <info>void</info>  没有返回值。

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


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


id: InternalIterator
type: class
doc:
<comment>Description:</comment>
  Class to ease implementing IteratorAggregate for internal classes.


id: InternalIterator::current
type: function
doc:
<comment>Description:</comment>
  返回当前元素
  
  返回当前元素。

<comment>Return:</comment>
  <info>mixed</info>  返回当前元素。


id: InternalIterator::key
type: function
doc:
<comment>Description:</comment>
  返回当前元素的键
  
  返回当前元素的键。

<comment>Return:</comment>
  <info>mixed</info>  返回当前元素的键。


id: InternalIterator::next
type: function
doc:
<comment>Description:</comment>
  向前移动到下一个元素
  
  移动当前位置到下一个元素。

<comment>Return:</comment>
  <info>void</info>  没有返回值。


id: InternalIterator::rewind
type: function
doc:
<comment>Description:</comment>
  迭代器返回到第一个元素
  
  迭代器返回到第一个元素。

<comment>Return:</comment>
  <info>void</info>  没有返回值。


id: InternalIterator::valid
type: function
doc:
<comment>Description:</comment>
  检测当前位置是否有效
  
  检测当前位置是否有效。

<comment>Return:</comment>
  <info>bool</info>  返回当前位置是否有效。


id: IntlBreakIterator
type: class
doc:
<comment>Description:</comment>
  A “break iterator” is an ICU object that exposes methods for locating boundaries in text (e.g.
  word or sentence boundaries). The PHP <class>IntlBreakIterator</class> serves as the base class for all types of
  ICU break iterators. Where extra functionality is available, the intl extension may expose the ICU
  break iterator with suitable subclasses, such as <class>IntlRuleBasedBreakIterator</class> or
  <class>IntlCodePointBreakIterator</class>.
  
  This class implements IteratorAggregate. Traversing an <class>IntlBreakIterator</class> yields non-negative
  integer values representing the successive locations of the text boundaries, expressed as UTF-8
  code units (byte) counts, taken from the beginning of the text (which has the location <return>0</return>). The
  keys yielded by the iterator simply form the sequence of natural numbers <return>{0, 1, 2, …}</return>.


id: IntlBreakIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Private constructor for disallowing instantiation
  
  <info>IntlBreakIterator</info> instances should be created by using one of the static factory methods.

<comment>See Also:</comment>
   * IntlBreakIterator::createCharacterInstance
   * IntlBreakIterator::createCodePointInstance
   * IntlBreakIterator::createLineInstance
   * IntlBreakIterator::createSentenceInstance
   * IntlBreakIterator::createTitleInstance
   * IntlBreakIterator::createWordInstance


id: IntlBreakIterator::createCharacterInstance
type: function
doc:
<comment>Description:</comment>
  Create break iterator for boundaries of combining character sequences
    
  
  本函数还未编写文档，仅有参数列表。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$locale</strong>  

<comment>Return:</comment>
  <info>IntlBreakIterator|null</info>  


id: IntlBreakIterator::createCodePointInstance
type: function
doc:
<comment>Description:</comment>
  Create break iterator for boundaries of code points
  
  本函数还未编写文档，仅有参数列表。

<comment>Return:</comment>
  <info>IntlCodePointBreakIterator</info>  


id: IntlBreakIterator::createLineInstance
type: function
doc:
<comment>Description:</comment>
  Create break iterator for logically possible line breaks
    
  
  本函数还未编写文档，仅有参数列表。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$locale</strong>  

<comment>Return:</comment>
  <info>IntlBreakIterator|null</info>  


id: IntlBreakIterator::createSentenceInstance
type: function
doc:
<comment>Description:</comment>
  Create break iterator for sentence breaks
  
  本函数还未编写文档，仅有参数列表。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$locale</strong>  

<comment>Return:</comment>
  <info>IntlBreakIterator|null</info>  


id: IntlBreakIterator::createTitleInstance
type: function
doc:
<comment>Description:</comment>
  Create break iterator for title-casing breaks
  
  本函数还未编写文档，仅有参数列表。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$locale</strong>  

<comment>Return:</comment>
  <info>IntlBreakIterator|null</info>  


id: IntlBreakIterator::createWordInstance
type: function
doc:
<comment>Description:</comment>
  Create break iterator for word breaks
  
  本函数还未编写文档，仅有参数列表。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$locale</strong>  

<comment>Return:</comment>
  <info>IntlBreakIterator|null</info>  


id: IntlBreakIterator::current
type: function
doc:
<comment>Description:</comment>
  Get index of current position
  
  本函数还未编写文档，仅有参数列表。

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


id: IntlBreakIterator::first
type: function
doc:
<comment>Description:</comment>
  Set position to the first character in the text
  
  本函数还未编写文档，仅有参数列表。

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


id: IntlBreakIterator::following
type: function
doc:
<comment>Description:</comment>
  Advance the iterator to the first boundary following specified offset
    
  
  本函数还未编写文档，仅有参数列表。

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

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


id: IntlBreakIterator::getErrorCode
type: function
doc:
<comment>Description:</comment>
  Get last error code on the object
  
  面向对象风格 (method):
  
  过程化风格:
  
  本函数还未编写文档，仅有参数列表。

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


id: IntlBreakIterator::getErrorMessage
type: function
doc:
<comment>Description:</comment>
  Get last error message on the object
  
  面向对象风格 (method):
  
  过程化风格:
  
  本函数还未编写文档，仅有参数列表。

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


id: IntlBreakIterator::getLocale
type: function
doc:
<comment>Description:</comment>
  Get the locale associated with the object
  
  本函数还未编写文档，仅有参数列表。

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

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


id: IntlBreakIterator::getPartsIterator
type: function
doc:
<comment>Description:</comment>
  Create iterator for navigating fragments between boundaries
  
  本函数还未编写文档，仅有参数列表。

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  Optional key type. Possible values are: <info>IntlPartsIterator::KEY_SEQUENTIAL</info> - The
                 default. Sequentially increasing integers used as key. <info>IntlPartsIterator::KEY_LEFT</info>
                 - Byte offset left of current part used as key. <info>IntlPartsIterator::KEY_RIGHT</info> - Byte
                 offset right of current part used as key.

<comment>Return:</comment>
  <info>IntlPartsIterator</info>  


id: IntlBreakIterator::getText
type: function
doc:
<comment>Description:</comment>
  Get the text being scanned
  
  本函数还未编写文档，仅有参数列表。

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


id: IntlBreakIterator::isBoundary
type: function
doc:
<comment>Description:</comment>
  Tell whether an offset is a boundaryʼs offset
  
  本函数还未编写文档，仅有参数列表。

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

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


id: IntlBreakIterator::last
type: function
doc:
<comment>Description:</comment>
  Set the iterator position to index beyond the last character
  
  本函数还未编写文档，仅有参数列表。

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


id: IntlBreakIterator::next
type: function
doc:
<comment>Description:</comment>
  Advance the iterator the next boundary
  
  本函数还未编写文档，仅有参数列表。

<comment>Param:</comment>
  <info>int|null</info>  <strong>$offset</strong>  

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


id: IntlBreakIterator::preceding
type: function
doc:
<comment>Description:</comment>
  Set the iterator position to the first boundary before an offset
  
  本函数还未编写文档，仅有参数列表。

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

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


id: IntlBreakIterator::previous
type: function
doc:
<comment>Description:</comment>
  Set the iterator position to the boundary immediately before the current
  
  本函数还未编写文档，仅有参数列表。

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


id: IntlBreakIterator::setText
type: function
doc:
<comment>Description:</comment>
  Set the text being scanned
  
  本函数还未编写文档，仅有参数列表。

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

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


id: IntlCalendar::DOW_TYPE_WEEKDAY
type: constant
doc:
<comment>Description:</comment>
  Output of <strong>IntlCalendar::getDayOfWeekType()</strong> indicating a day of week is a weekday.


id: IntlCalendar::DOW_TYPE_WEEKEND
type: constant
doc:
<comment>Description:</comment>
  Output of <strong>IntlCalendar::getDayOfWeekType()</strong> indicating a day of week belongs to the weekend.


id: IntlCalendar::DOW_TYPE_WEEKEND_CEASE
type: constant
doc:
<comment>Description:</comment>
  Output of <strong>IntlCalendar::getDayOfWeekType()</strong> indicating the weekend ends during the given day of
  week.


id: IntlCalendar::DOW_TYPE_WEEKEND_OFFSET
type: constant
doc:
<comment>Description:</comment>
  Output of <strong>IntlCalendar::getDayOfWeekType()</strong> indicating the weekend begins during the given day of
  week.


id: IntlCalendar::FIELD_AM_PM
type: constant
doc:
<comment>Description:</comment>
  Calendar field indicating whether a time is before noon (value <return>0</return>, AM) or after (<return>1</return>). Midnight is
  AM, noon is PM.


id: IntlCalendar::FIELD_DATE
type: constant
doc:
<comment>Description:</comment>
  Calendar field for the day of the month. The same as <info>IntlCalendar::FIELD_DAY_OF_MONTH</info>, which has a
  clearer name.


id: IntlCalendar::FIELD_DAY_OF_WEEK
type: constant
doc:
<comment>Description:</comment>
  Calendar field for the day of the week. Its values start with <return>1</return> (Sunday, see
  <info>IntlCalendar::DOW_SUNDAY</info> and subsequent constants) and the last valid value is 7 (Saturday).


id: IntlCalendar::FIELD_DAY_OF_WEEK_IN_MONTH
type: constant
doc:
<comment>Description:</comment>
  Given a day of the week (Sunday, Monday, …), this calendar field assigns an ordinal to such a day
  of the week in a specific month. Thus, if the value of this field is <return>1</return> and the value of the day of
  the week is <return>2</return> (Monday), then the set day of the month is the 1st Monday of the month; the maximum
  value is <return>5</return>.
  
  Additionally, the value <return>0</return> and negative values are also allowed. The value <return>0</return> encompasses the seven
  days that occur immediately before the first seven days of a month (which therefore have a ‘day of
  week in month’ with value <return>1</return>). Negative values starts counting from the end of the month – <return>-1</return>
  points to the last occurrence of a day of the week in a month, <return>-2</return> to the second last, and so on.
  
  Unlike <info>IntlCalendar::FIELD_WEEK_OF_MONTH</info> and  <info>IntlCalendar::FIELD_WEEK_OF_YEAR</info>, this value does
  not depend on <strong>IntlCalendar::getFirstDayOfWeek()</strong> or on <strong>IntlCalendar::getMinimalDaysInFirstWeek()</strong>.
  The first Monday is the first Monday, even if it occurs in a week that belongs to the previous
  month.


id: IntlCalendar::FIELD_DAY_OF_YEAR
type: constant
doc:
<comment>Description:</comment>
  Calendar field for the day of the year. For the Gregorian calendar, starts with <info>1</info> and ends with
  <info>365</info> or <info>366</info>.


id: IntlCalendar::FIELD_DOW_LOCAL
type: constant
doc:
<comment>Description:</comment>
  Calendar field for the localized day of the week. This is a value between <return>1</return> and <return>7</return>, <return>1</return> being used
  for the day of the week that matches the value returned by <strong>IntlCalendar::getFirstDayOfWeek()</strong>.


id: IntlCalendar::FIELD_DST_OFFSET
type: constant
doc:
<comment>Description:</comment>
  Calendar field for the daylight saving time offset of the calendarʼs timezone, in milliseconds, if
  active for calendarʼs time.


id: IntlCalendar::FIELD_ERA
type: constant
doc:
<comment>Description:</comment>
  Calendar field numerically representing an era, for instance <return>1</return> for AD and <return>0</return> for BC in the
  Gregorian/Julian calendars and <return>235</return> for the Heisei (平成) era in the Japanese calendar. Not all
  calendars have more than one era.


id: IntlCalendar::FIELD_EXTENDED_YEAR
type: constant
doc:
<comment>Description:</comment>
  Calendar field for a year number representation that is continuous across eras. For the Gregorian
  calendar, the value of this field matches that of <info>IntlCalendar::FIELD_YEAR</info> for AD years; a BC year
  <return>y</return> is represented by <return>-y + 1</return>.


id: IntlCalendar::FIELD_HOUR
type: constant
doc:
<comment>Description:</comment>
  Calendar field for the hour, without specifying whether itʼs in the morning or in the afternoon.
  Valid values are <return>0</return> to <return>11</return>.


id: IntlCalendar::FIELD_HOUR_OF_DAY
type: constant
doc:
<comment>Description:</comment>
  Calendar field for the full (24h) hour of the day. Valid values are <return>0</return> to <return>23</return>.


id: IntlCalendar::FIELD_IS_LEAP_MONTH
type: constant
doc:
<comment>Description:</comment>
  Calendar field whose value is <return>1</return> for indicating a leap month and <return>0</return> otherwise.


id: IntlCalendar::FIELD_JULIAN_DAY
type: constant
doc:
<comment>Description:</comment>
  Calendar field for a modified Julian day number. It is different from a conventional Julian day
  number in that its transitions occur at local zone midnight rather than at noon UTC. It uniquely
  identifies a date.


id: IntlCalendar::FIELD_MILLISECONDS_IN_DAY
type: constant
doc:
<comment>Description:</comment>
  Calendar field encompassing the information in <info>IntlCalendar::FIELD_HOUR_OF_DAY</info>,
  <info>IntlCalendar::FIELD_MINUTE</info>, <info>IntlCalendar::FIELD_SECOND</info> and <info>IntlCalendar::FIELD_MILLISECOND</info>. Range
  is from the <return>0</return> to <return>24 * 3600 * 1000 - 1</return>. It is not the amount of milliseconds elapsed in the day
  since on DST transitions it will have discontinuities analog to those of the wall time.


id: IntlCalendar::FIELD_MONTH
type: constant
doc:
<comment>Description:</comment>
  Calendar field for the month. The month sequence is zero-based, so January (here used to signify
  the first month of the calendar; this may be called another name, such as Muharram in the Islamic
  calendar) is represented by <return>0</return>, February by <return>1</return>, …, December by <return>11</return> and, for calendars that have it,
  the 13th or leap month by <return>12</return>.


id: IntlCalendar::FIELD_WEEK_OF_MONTH
type: constant
doc:
<comment>Description:</comment>
  Calendar field for the number of the week of the month. This depends on which day of the week is
  deemed to start the week and the minimal number of days in a week.


id: IntlCalendar::FIELD_WEEK_OF_YEAR
type: constant
doc:
<comment>Description:</comment>
  Calendar field for the number of the week of the year. This depends on which day of the week is
  deemed to start the week and the minimal number of days in a week.


id: IntlCalendar::FIELD_YEAR
type: constant
doc:
<comment>Description:</comment>
  Calendar field for the year. This is not unique across eras.  If the calendar type has more than
  one era, generally the minimum value for this field will be <return>1</return>.


id: IntlCalendar::FIELD_ZONE_OFFSET
type: constant
doc:
<comment>Description:</comment>
  Calendar field indicating the raw offset of the timezone, in milliseconds. The raw offset is the
  timezone offset, excluding any offset due to daylight saving time.


id: IntlCalendar::WALLTIME_FIRST
type: constant
doc:
<comment>Description:</comment>
  Output of <strong>IntlCalendar::getSkippedWallTimeOption()</strong> indicating that wall times in the skipped range
  should refer to the same instant as wall times with one hour less and of
  <strong>IntlCalendar::getRepeatedWallTimeOption()</strong> indicating the wall times in the repeated range should
  refer to the instant of the first occurrence of such wall time.


id: IntlCalendar::WALLTIME_LAST
type: constant
doc:
<comment>Description:</comment>
  Output of <strong>IntlCalendar::getSkippedWallTimeOption()</strong> indicating that wall times in the skipped range
  should refer to the same instant as wall times with one hour after and of
  <strong>IntlCalendar::getRepeatedWallTimeOption()</strong> indicating the wall times in the repeated range should
  refer to the instant of the second occurrence of such wall time.


id: IntlCalendar::WALLTIME_NEXT_VALID
type: constant
doc:
<comment>Description:</comment>
  Output of <strong>IntlCalendar::getSkippedWallTimeOption()</strong> indicating that wall times in the skipped range
  should refer to the instant when the daylight saving time transition occurs (begins).


id: IntlCalendar::__construct
type: function
doc:
<comment>Description:</comment>
  Private constructor for disallowing instantiation
  
  A private constructor for disallowing instantiation with the new operator.
  
  Call <strong>IntlCalendar::createInstance()</strong> instead.


id: IntlCalendar::add
type: function
doc:
<comment>Description:</comment>
  Add a (signed) amount of time to a field
  
  面向对象风格
  
  过程化风格
  
  Add a signed amount to a field. Adding a positive amount allows advances in time, even if the
  numeric value of the field decreases (e.g. when working with years in BC dates).
  
  Other fields may need to adjusted – for instance, adding a month to the 31st of January will
  result in the 28th (or 29th) of February. Contrary to <strong>IntlCalendar::roll()</strong>, when a value wraps
  around, more significant fields may change. For instance, adding a day to the 31st of January will
  result in the 1st of February, not the 1st of January.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>  <class>IntlCalendar</class> 实例。
  <info>int</info>           <strong>$field</strong>     One of the <class>IntlCalendar</class> date/time field constants. These are integer
                           values between <return>0</return> and <info>IntlCalendar::FIELD_COUNT</info>.
  <info>int</info>           <strong>$value</strong>     The signed amount to add to the current field. If the amount is positive,
                           the instant will be moved forward; if it is negative, the instant will be
                           moved into the past. The unit is implicit to the field type. For
                           instance, hours for <info>IntlCalendar::FIELD_HOUR_OF_DAY</info>.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success 或者在失败时返回 <info>false</info>.


id: IntlCalendar::after
type: function
doc:
<comment>Description:</comment>
  Whether this objectʼs time is after that of the passed object
  
  面向对象风格
  
  过程化风格
  
  Returns whether this objectʼs time succeeds the argumentʼs time.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>  <class>IntlCalendar</class> 实例。
  <info>IntlCalendar</info>  <strong>$other</strong>     The calendar whose time will be checked against the primary objectʼs
                           time.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if this objectʼs current time is after that of the <strong>$calendar</strong> argumentʼs time.
        Returns <info>false</info> otherwise.
        
        On failure <info>false</info> is also returned. To detect error conditions use <strong>intl_get_error_code()</strong>, or
        set up Intl to throw exceptions.


id: IntlCalendar::before
type: function
doc:
<comment>Description:</comment>
  Whether this objectʼs time is before that of the passed object
  
  面向对象风格
  
  过程化风格
  
  Returns whether this objectʼs time precedes the argumentʼs time.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>  <class>IntlCalendar</class> 实例。
  <info>IntlCalendar</info>  <strong>$other</strong>     The calendar whose time will be checked against the primary objectʼs
                           time.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if this objectʼs current time is before that of the <strong>$calendar</strong> argumentʼs time.
        Returns <info>false</info> otherwise.
        
        On failure <info>false</info> is also returned. To detect error conditions use <strong>intl_get_error_code()</strong>, or
        set up Intl to throw exceptions.


id: IntlCalendar::clear
type: function
doc:
<comment>Description:</comment>
  Clear a field or all fields
  
  面向对象风格
  
  过程化风格
  
  Clears either all of the fields or a specific field. A cleared field is marked as unset, giving it
  the lowest priority against overlapping fields or even default values when calculating the time.
  Additionally, its value is set to <return>0</return>, though given the fieldʼs low priority, its value may have
  been internally set to another value by the time the field has finished been queried.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>  <class>IntlCalendar</class> 实例。
  <info>int|null</info>      <strong>$field</strong>     One of the <class>IntlCalendar</class> date/time field constants. These are integer
                           values between <return>0</return> and <info>IntlCalendar::FIELD_COUNT</info>.

<comment>Return:</comment>
  <info>true</info>  总是返回 <info>true</info>。


id: IntlCalendar::createInstance
type: function
doc:
<comment>Description:</comment>
  Create a new IntlCalendar
  
  面向对象风格
  
  过程化风格
  
  Given a timezone and locale, this method creates an <class>IntlCalendar</class> object. This factory method may
  return a subclass of <class>IntlCalendar</class>.
  
  The calendar created will represent the time instance at which it was created, based on the system
  time. The fields can all be cleared by calling <strong>IntCalendar::clear()</strong> with no arguments. See also
  <strong>IntlGregorianCalendar::__construct()</strong>.

<comment>Param:</comment>
  <info>IntlTimeZone|DateTimeZone|string|null</info>  <strong>$timezone</strong>  The timezone to use.
                                                    
                                                    <info>null</info>, in which case the default timezone will be
                                                    used, as specified in the ini setting
                                                    date.timezone or through the function
                                                    <strong>date_default_timezone_set()</strong> and as returned by
                                                    <strong>date_default_timezone_get()</strong>.
                                                    
                                                    An <class>IntlTimeZone</class>, which will be used directly.
                                                    
                                                    A <class>DateTimeZone</class>. Its identifier will be extracted
                                                    and an ICU timezone object will be created; the
                                                    timezone will be backed by ICUʼs database, not
                                                    PHPʼs.
                                                    
                                                    A <info>string</info>, which should be a valid ICU timezone
                                                    identifier. See
                                                    <strong>IntlTimeZone::createTimeZoneIDEnumeration()</strong>. Raw
                                                    offsets such as <return>"GMT+08:30"</return> are also accepted.
  <info>string|null</info>                            <strong>$locale</strong>    A locale to use or <info>null</info> to use the default
                                                    locale.

<comment>Return:</comment>
  <info>IntlCalendar|null</info>  The created <class>IntlCalendar</class> instance or <info>null</info> on failure.

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


id: IntlCalendar::equals
type: function
doc:
<comment>Description:</comment>
  Compare time of two IntlCalendar objects for equality
  
  面向对象风格
  
  过程化风格
  
  Returns true if this calendar and the given calendar have the same time. The settings, calendar
  types and field states do not have to be the same.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>  <class>IntlCalendar</class> 实例。
  <info>IntlCalendar</info>  <strong>$other</strong>     The calendar to compare with the primary object.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the current time of both this and the passed in <class>IntlCalendar</class> object are the
        same, or <info>false</info> otherwise.
        
        On failure <info>false</info> is also returned. To detect error conditions use <strong>intl_get_error_code()</strong>, or
        set up Intl to throw exceptions.


id: IntlCalendar::fieldDifference
type: function
doc:
<comment>Description:</comment>
  Calculate difference between given time and this objectʼs time
  
  面向对象风格
  
  过程化风格
  
  Return the difference between the given time and the time this object is set to, with respect to
  the quantity specified the <strong>$field</strong> parameter.
  
  This method is meant to be called successively, first with the most significant field of interest
  down to the least significant field. To this end, as a side effect, this calendarʼs value for the
  field specified is advanced by the amount returned.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>   <class>IntlCalendar</class> 实例。
  <info>float</info>         <strong>$timestamp</strong>  The time against which to compare the quantity represented by the
                            <strong>$field</strong>. For the result to be positive, the time given for this parameter
                            must be ahead of the time of the object the method is being invoked on.
  <info>int</info>           <strong>$field</strong>      The field that represents the quantity being compared.
                            
                            One of the <class>IntlCalendar</class> date/time field constants. These are integer
                            values between <return>0</return> and <info>IntlCalendar::FIELD_COUNT</info>.

<comment>Return:</comment>
  <info>int|false</info>  Returns a (signed) difference of time in the unit associated with the specified field
             或者在失败时返回 <info>false</info>.


id: IntlCalendar::fromDateTime
type: function
doc:
<comment>Description:</comment>
  Create an IntlCalendar from a DateTime object or string
  
  面向对象风格
  
  过程化风格
  
  Creates an <class>IntlCalendar</class> object either from a <class>DateTime</class> object or from a string from which a
  <class>DateTime</class> object can be built.
  
  The new calendar will represent not only the same instant as the given <class>DateTime</class> (subject to
  precision loss for dates very far into the past or future), but also the same timezone (subject to
  the caveat that different timezone databases will be used, and therefore the results may differ).

<comment>Param:</comment>
  <info>DateTime|string</info>  <strong>$datetime</strong>  A <class>DateTime</class> object or a <info>string</info> that can be passed to
                              <strong>DateTime::__construct()</strong>.

<comment>Return:</comment>
  <info>IntlCalendar|null</info>  The created <class>IntlCalendar</class> object or <info>null</info> in case of failure. If a <info>string</info> is
                     passed, any exception that occurs inside the <class>DateTime</class> constructor is
                     propagated.


id: IntlCalendar::get
type: function
doc:
<comment>Description:</comment>
  Get the value for a field
  
  面向对象风格
  
  过程化风格
  
  Gets the value for a specific field.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>  <class>IntlCalendar</class> 实例。
  <info>int</info>           <strong>$field</strong>     One of the <class>IntlCalendar</class> date/time field constants. These are integer
                           values between <return>0</return> and <info>IntlCalendar::FIELD_COUNT</info>.

<comment>Return:</comment>
  <info>int|false</info>  An integer with the value of the time field.


id: IntlCalendar::getActualMaximum
type: function
doc:
<comment>Description:</comment>
  The maximum value for a field, considering the objectʼs current time
  
  面向对象风格
  
  过程化风格
  
  Returns a fieldʼs relative maximum value around the current time. The exact semantics vary by
  field, but in the general case this is the value that would be obtained if one would set the field
  value into the smallest relative maximum for the field and would increment it until reaching the
  global maximum or the field value wraps around, in which the value returned would be the global
  maximum or the value before the wrapping, respectively.
  
  For instance, in the gregorian calendar, the actual maximum value for the day of month would vary
  between <return>28</return> and <return>31</return>, depending on the month and year of the current time.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>  <class>IntlCalendar</class> 实例。
  <info>int</info>           <strong>$field</strong>     One of the <class>IntlCalendar</class> date/time field constants. These are integer
                           values between <return>0</return> and <info>IntlCalendar::FIELD_COUNT</info>.

<comment>Return:</comment>
  <info>int|false</info>  An <info>int</info> representing the maximum value in the units associated with the given <strong>$field</strong> 或
             者在失败时返回 <info>false</info>.

<comment>See Also:</comment>
   * IntlCalendar::getMaximum
   * IntlCalendar::getLeastMaximum
   * IntlCalendar::getActualMinimum


id: IntlCalendar::getActualMinimum
type: function
doc:
<comment>Description:</comment>
  The minimum value for a field, considering the objectʼs current time
  
  面向对象风格
  
  过程化风格
  
  Returns a fieldʼs relative minimum value around the current time. The exact semantics vary by
  field, but in the general case this is the value that would be obtained if one would set the field
  value into the greatest relative minimum for the field and would decrement it until reaching the
  global minimum or the field value wraps around, in which the value returned would be the global
  minimum or the value before the wrapping, respectively.
  
  For the Gregorian calendar, this is always the same as <strong>IntlCalendar::getMinimum()</strong>.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>  <class>IntlCalendar</class> 实例。
  <info>int</info>           <strong>$field</strong>     One of the <class>IntlCalendar</class> date/time field constants. These are integer
                           values between <return>0</return> and <info>IntlCalendar::FIELD_COUNT</info>.

<comment>Return:</comment>
  <info>int|false</info>  An <info>int</info> representing the minimum value in the fieldʼs unit 或者在失败时返回 <info>false</info>.

<comment>See Also:</comment>
   * IntlCalendar::getMinimum
   * IntlCalendar::getGreatestMinimum
   * IntlCalendar::getActualMaximum


id: IntlCalendar::getAvailableLocales
type: function
doc:
<comment>Description:</comment>
  Get array of locales for which there is data
  
  面向对象风格
  
  过程化风格
  
  Gives the list of locales for which calendars are installed. As of ICU 51, this is the list of all
  installed ICU locales.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> of <info>string</info>s, one for which locale.


id: IntlCalendar::getDayOfWeekType
type: function
doc:
<comment>Description:</comment>
  Tell whether a day is a weekday, weekend or a day that has a transition between the two
  
  面向对象风格
  
  过程化风格
  
  Returns whether the passed day is a weekday (<info>IntlCalendar::DOW_TYPE_WEEKDAY</info>), a weekend day
  (<info>IntlCalendar::DOW_TYPE_WEEKEND</info>), a day during which a transition occurs into the weekend
  (<info>IntlCalendar::DOW_TYPE_WEEKEND_OFFSET</info>) or a day during which the weekend ceases
  (<info>IntlCalendar::DOW_TYPE_WEEKEND_CEASE</info>).
  
  If the return is either <info>IntlCalendar::DOW_TYPE_WEEKEND_OFFSET</info> or
  <info>IntlCalendar::DOW_TYPE_WEEKEND_CEASE</info>, then <strong>IntlCalendar::getWeekendTransition()</strong> can be called to
  obtain the time of the transition.
  
  This function requires ICU 4.4 or later.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>   <class>IntlCalendar</class> 实例。
  <info>int</info>           <strong>$dayOfWeek</strong>  One of the constants <info>IntlCalendar::DOW_SUNDAY</info>, <info>IntlCalendar::DOW_MONDAY</info>,
                            …, <info>IntlCalendar::DOW_SATURDAY</info>.

<comment>Return:</comment>
  <info>int|false</info>  Returns one of the constants  <info>IntlCalendar::DOW_TYPE_WEEKDAY</info>,
             <info>IntlCalendar::DOW_TYPE_WEEKEND</info>, <info>IntlCalendar::DOW_TYPE_WEEKEND_OFFSET</info> or
             <info>IntlCalendar::DOW_TYPE_WEEKEND_CEASE</info> 或者在失败时返回 <info>false</info>.


id: IntlCalendar::getErrorCode
type: function
doc:
<comment>Description:</comment>
  Get last error code on the object
  
  面向对象风格 (method):
  
  过程化风格:
  
  Returns the numeric ICU error code for the last call on this object (including cloning) or the
  <class>IntlCalendar</class> given for the <strong>$calendar</strong> parameter (in the procedural‒style version). This may
  indicate only a warning (negative error code) or no error at all (<info>U_ZERO_ERROR</info>). The actual
  presence of an error can be tested with <strong>intl_is_failure()</strong>.
  
  Invalid arguments detected on the PHP side (before invoking functions of the ICU library) are not
  recorded for the purposes of this function.
  
  The last error that occurred in any call to a function of the intl extension, including early
  argument errors, can be obtained with <strong>intl_get_error_code()</strong>. This function resets the global error
  code, but not the objectʼs error code.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>  The calendar object, on the procedural style interface.

<comment>Return:</comment>
  <info>int|false</info>  An ICU error code indicating either success, failure or a warning. Returns <info>false</info> on
             failure.

<comment>See Also:</comment>
   * IntlCalendar::getErrorMessage
   * intl_is_failure
   * intl_error_name
   * intl_get_error_code
   * intl_get_error_message


id: IntlCalendar::getErrorMessage
type: function
doc:
<comment>Description:</comment>
  Get last error message on the object
  
  面向对象风格 (method):
  
  过程化风格:
  
  Returns the error message (if any) associated with the error reported by
  <strong>IntlCalendar::getErrorCode()</strong> or <strong>intlcal_get_error_code()</strong>. If there is no associated error message,
  only the string representation of the name of the error constant will be returned.  Otherwise, the
  message also includes a message set on the side of the PHP binding.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>  The calendar object, on the procedural style interface.

<comment>Return:</comment>
  <info>string|false</info>  The error message associated with last error that occurred in a function call on
                this object, or a string indicating the non-existence of an error. Returns <info>false</info> on
                failure.


id: IntlCalendar::getFirstDayOfWeek
type: function
doc:
<comment>Description:</comment>
  Get the first day of the week for the calendarʼs locale
  
  面向对象风格
  
  过程化风格
  
  The week day deemed to start a week, either the default value for this locale or the value set
  with <strong>IntlCalendar::setFirstDayOfWeek()</strong>.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>  <class>IntlCalendar</class> 实例。

<comment>Return:</comment>
  <info>int|false</info>  One of the constants <info>IntlCalendar::DOW_SUNDAY</info>, <info>IntlCalendar::DOW_MONDAY</info>, …,
             <info>IntlCalendar::DOW_SATURDAY</info> 或者在失败时返回 <info>false</info>.

<comment>See Also:</comment>
   * IntlCalendar::setFirstDayOfWeek


id: IntlCalendar::getGreatestMinimum
type: function
doc:
<comment>Description:</comment>
  Get the largest local minimum value for a field
  
  面向对象风格
  
  过程化风格
  
  Returns the largest local minimum for a field. This should be a value larger or equal to that
  returned by <strong>IntlCalendar::getActualMinimum()</strong>, which is in its turn larger or equal to that
  returned by <strong>IntlCalendar::getMinimum()</strong>. All these three functions return the same value for the
  Gregorian calendar.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>  <class>IntlCalendar</class> 实例。
  <info>int</info>           <strong>$field</strong>     One of the <class>IntlCalendar</class> date/time field constants. These are integer
                           values between <return>0</return> and <info>IntlCalendar::FIELD_COUNT</info>.

<comment>Return:</comment>
  <info>int|false</info>  An <info>int</info> representing a field value, in the fieldʼs unit, 或者在失败时返回 <info>false</info>.


id: IntlCalendar::getKeywordValuesForLocale
type: function
doc:
<comment>Description:</comment>
  Get set of locale keyword values
  
  面向对象风格
  
  过程化风格
  
  For a given locale key, get the set of values for that key that would result in a different
  behavior. For now, only the <return>'calendar'</return> keyword is supported.
  
  This function requires ICU 4.2 or later.

<comment>Param:</comment>
  <info>string</info>  <strong>$keyword</strong>     The locale keyword for which relevant values are to be queried. Only
                       <return>'calendar'</return> is supported.
  <info>string</info>  <strong>$locale</strong>      The locale onto which the keyword/value pair are to be appended.
  <info>bool</info>    <strong>$onlyCommon</strong>  Whether to show only the values commonly used for the specified locale.

<comment>Return:</comment>
  <info>IntlIterator|false</info>  An iterator that yields strings with the locale keyword values 或者在失败时返
                      回 <info>false</info>.


id: IntlCalendar::getLeastMaximum
type: function
doc:
<comment>Description:</comment>
  Get the smallest local maximum for a field
  
  面向对象风格
  
  过程化风格
  
  Returns the smallest local maximumw for a field. This should be a value smaller or equal to that
  returned by <strong>IntlCalendar::getActualMaxmimum()</strong>, which is in its turn smaller or equal to that
  returned by <strong>IntlCalendar::getMaximum()</strong>.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>  <class>IntlCalendar</class> 实例。
  <info>int</info>           <strong>$field</strong>     One of the <class>IntlCalendar</class> date/time field constants. These are integer
                           values between <return>0</return> and <info>IntlCalendar::FIELD_COUNT</info>.

<comment>Return:</comment>
  <info>int|false</info>  An <info>int</info> representing a field value in the fieldʼs unit 或者在失败时返回 <info>false</info>.

<comment>See Also:</comment>
   * IntlCalendar::getActualMaximum
   * IntlCalendar::getMaximum
   * IntlCalendar::getGreatestMinimum


id: IntlCalendar::getLocale
type: function
doc:
<comment>Description:</comment>
  Get the locale associated with the object
  
  面向对象风格
  
  过程化风格
  
  Returns the locale used by this calendar object.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>  <class>IntlCalendar</class> 实例。
  <info>int</info>           <strong>$type</strong>      Whether to fetch the actual locale (the locale from which the calendar
                           data originates, with <info>Locale::ACTUAL_LOCALE</info>) or the valid locale, i.e.,
                           the most specific locale supported by ICU relatively to the requested
                           locale – see <info>Locale::VALID_LOCALE</info>. From the most general to the most
                           specific, the locales are ordered in this fashion – actual locale, valid
                           locale, requested locale.

<comment>Return:</comment>
  <info>string|false</info>  A locale string 或者在失败时返回 <info>false</info>.


id: IntlCalendar::getMaximum
type: function
doc:
<comment>Description:</comment>
  Get the global maximum value for a field
  
  面向对象风格
  
  过程化风格
  
  Gets the global maximum for a field, in this specific calendar. This value is larger or equal to
  that returned by <strong>IntlCalendar::getActualMaximum()</strong>, which is in its turn larger or equal to that
  returned by <strong>IntlCalendar::getLeastMaximum()</strong>.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>  <class>IntlCalendar</class> 实例。
  <info>int</info>           <strong>$field</strong>     One of the <class>IntlCalendar</class> date/time field constants. These are integer
                           values between <return>0</return> and <info>IntlCalendar::FIELD_COUNT</info>.

<comment>Return:</comment>
  <info>int|false</info>  An <info>int</info> representing a field value in the fieldʼs unit 或者在失败时返回 <info>false</info>.

<comment>See Also:</comment>
   * IntlCalendar::getActualMaximum
   * IntlCalendar::getLeastMaximum
   * IntlCalendar::getMinimum


id: IntlCalendar::getMinimalDaysInFirstWeek
type: function
doc:
<comment>Description:</comment>
  Get minimal number of days the first week in a year or month can have
  
  面向对象风格
  
  过程化风格
  
  Returns the smallest number of days the first week of a year or month must have in the new year or
  month.  For instance, in the Gregorian calendar, if this value is 1, then the first week of the
  year will necessarily include January 1st, while if this value is 7, then the week with January
  1st will be the first week of the year only if the day of the week for January 1st matches the day
  of the week returned by <strong>IntlCalendar::getFirstDayOfWeek()</strong>; otherwise it will be the previous
  yearʼs last week.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>  <class>IntlCalendar</class> 实例。

<comment>Return:</comment>
  <info>int|false</info>  An <info>int</info> representing a number of days 或者在失败时返回 <info>false</info>.


id: IntlCalendar::getMinimum
type: function
doc:
<comment>Description:</comment>
  Get the global minimum value for a field
  
  面向对象风格
  
  过程化风格
  
  Gets the global minimum for a field, in this specific calendar. This value is smaller or equal to
  that returned by <strong>IntlCalendar::getActualMinimum()</strong>, which is in its turn smaller or equal to that
  returned by <strong>IntlCalendar::getGreatestMinimum()</strong>. For the Gregorian calendar, these three functions
  always return the same value (for each field).

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>  <class>IntlCalendar</class> 实例。
  <info>int</info>           <strong>$field</strong>     One of the <class>IntlCalendar</class> date/time field constants. These are integer
                           values between <return>0</return> and <info>IntlCalendar::FIELD_COUNT</info>.

<comment>Return:</comment>
  <info>int|false</info>  An <info>int</info> representing a value for the given field in the fieldʼs unit 或者在失败时返回
             <info>false</info>.


id: IntlCalendar::getNow
type: function
doc:
<comment>Description:</comment>
  Get number representing the current time
  
  面向对象风格
  
  过程化风格
  
  The number of milliseconds  that have passed since the reference date. This number is derived from
  the system time.

<comment>Return:</comment>
  <info>float</info>  A <info>float</info> representing a number of milliseconds since the epoch, not counting leap seconds.


id: IntlCalendar::getRepeatedWallTimeOption
type: function
doc:
<comment>Description:</comment>
  Get behavior for handling repeating wall time
  
  面向对象风格
  
  过程化风格
  
  Gets the current strategy for dealing with wall times that are repeated whenever the clock is set
  back during dailight saving time end transitions. The default value is
  <info>IntlCalendar::WALLTIME_LAST</info>.
  
  This function requires ICU 4.9 or later.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>  <class>IntlCalendar</class> 实例。

<comment>Return:</comment>
  <info>int</info>  One of the constants <info>IntlCalendar::WALLTIME_FIRST</info> or <info>IntlCalendar::WALLTIME_LAST</info>.

<comment>See Also:</comment>
   * IntlCalendar::getSkippedWallTimeOption
   * IntlCalendar::setSkippedWallTimeOption
   * IntlCalendar::setRepeatedWallTimeOption


id: IntlCalendar::getSkippedWallTimeOption
type: function
doc:
<comment>Description:</comment>
  Get behavior for handling skipped wall time
  
  面向对象风格
  
  过程化风格
  
  Gets the current strategy for dealing with wall times that are skipped whenever the clock is
  forwarded during dailight saving time start transitions. The default value is
  <info>IntlCalendar::WALLTIME_LAST</info>.
  
  The calendar must be lenient for this option to have any effect, otherwise attempting to set a
  non-existing time will cause an error.
  
  This function requires ICU 4.9 or later.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>  <class>IntlCalendar</class> 实例。

<comment>Return:</comment>
  <info>int</info>  One of the constants <info>IntlCalendar::WALLTIME_FIRST</info>, <info>IntlCalendar::WALLTIME_LAST</info> or
       <info>IntlCalendar::WALLTIME_NEXT_VALID</info>.

<comment>See Also:</comment>
   * IntlCalendar::getRepeatedWallTimeOption
   * IntlCalendar::setSkippedWallTimeOption
   * IntlCalendar::setRepeatedWallTimeOption


id: IntlCalendar::getTime
type: function
doc:
<comment>Description:</comment>
  Get time currently represented by the object
  
  面向对象风格
  
  过程化风格
  
  Returns the time associated with this object, expressed as the number of milliseconds since the
  epoch.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>  <class>IntlCalendar</class> 实例。

<comment>Return:</comment>
  <info>float|false</info>  A <info>float</info> representing the number of milliseconds elapsed since the reference time (1
               Jan 1970 00:00:00 UTC), 或者在失败时返回 <info>false</info>

<comment>See Also:</comment>
   * IntlCalendar::getNow


id: IntlCalendar::getTimeZone
type: function
doc:
<comment>Description:</comment>
  Get the objectʼs timezone
  
  面向对象风格
  
  过程化风格
  
  Returns the <class>IntlTimeZone</class> object associated with this calendar.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>  <class>IntlCalendar</class> 实例。

<comment>Return:</comment>
  <info>IntlTimeZone|false</info>  An <class>IntlTimeZone</class> object corresponding to the one used internally in this
                      object.  Returns <info>false</info> on failure.

<comment>See Also:</comment>
   * IntlCalendar::setTimeZone
   * IntlCalendar::createInstance
   * IntlGregorianCalendar::__construct


id: IntlCalendar::getType
type: function
doc:
<comment>Description:</comment>
  Get the calendar type
  
  面向对象风格
  
  过程化风格
  
  A string describing the type of this calendar. This is one of the valid values for the calendar
  keyword value <return>'calendar'</return>.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>  <class>IntlCalendar</class> 实例。

<comment>Return:</comment>
  <info>string</info>  A <info>string</info> representing the calendar type, such as <return>'gregorian'</return>, <return>'islamic'</return>, etc.


id: IntlCalendar::getWeekendTransition
type: function
doc:
<comment>Description:</comment>
  Get time of the day at which weekend begins or ends
  
  面向对象风格
  
  过程化风格
  
  Returns the number of milliseconds after midnight at which the weekend begins or ends.
  
  This is only applicable for days of the week for which <strong>IntlCalendar::getDayOfWeekType()</strong> returns
  either <info>IntlCalendar::DOW_TYPE_WEEKEND_OFFSET</info> or <info>IntlCalendar::DOW_TYPE_WEEKEND_CEASE</info>. Calling this
  function for other days of the week is an error condition.
  
  This function requires ICU 4.4 or later.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>   <class>IntlCalendar</class> 实例。
  <info>int</info>           <strong>$dayOfWeek</strong>  One of the constants <info>IntlCalendar::DOW_SUNDAY</info>, <info>IntlCalendar::DOW_MONDAY</info>,
                            …, <info>IntlCalendar::DOW_SATURDAY</info>.

<comment>Return:</comment>
  <info>int|false</info>  The number of milliseconds into the day at which the weekend begins or ends 或者在失败
             时返回 <info>false</info>.


id: IntlCalendar::inDaylightTime
type: function
doc:
<comment>Description:</comment>
  Whether the objectʼs time is in Daylight Savings Time
  
  面向对象风格
  
  过程化风格
  
  Whether, for the instant represented by this object and for this objectʼs timezone, daylight
  saving time is in place.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>  <class>IntlCalendar</class> 实例。

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the date is in Daylight Savings Time, <info>false</info> otherwise.
        
        On failure <info>false</info> is also returned. To detect error conditions use <strong>intl_get_error_code()</strong>, or
        set up Intl to throw exceptions.


id: IntlCalendar::isEquivalentTo
type: function
doc:
<comment>Description:</comment>
  Whether another calendar is equal but for a different time
  
  面向对象风格
  
  过程化风格
  
  Returns whether this and the given object are equivalent for all purposes except as to the time
  they have set. The locales do not have to match, as long as no change in behavior results from
  such mismatch. This includes the timezone, whether the lenient mode is set, the repeated and
  skipped wall time settings, the days of the week when the weekend starts and ceases and the times
  where such transitions occur. It may also include other calendar specific settings, such as the
  Gregorian/Julian transition instant.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>  <class>IntlCalendar</class> 实例。
  <info>IntlCalendar</info>  <strong>$other</strong>     The other calendar against which the comparison is to be made.

<comment>Return:</comment>
  <info>bool</info>  Assuming there are no argument errors, returns <info>true</info> if the calendars are equivalent except
        possibly for their set time.

<comment>See Also:</comment>
   * IntlCalendar::equals


id: IntlCalendar::isLenient
type: function
doc:
<comment>Description:</comment>
  Whether date/time interpretation is in lenient mode
  
  面向对象风格
  
  过程化风格
  
  Returns whether the current date/time interpretations is lenient (the default). If that is case,
  some out of range values for fields will be accepted instead of raising an error.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>  <class>IntlCalendar</class> 实例。

<comment>Return:</comment>
  <info>bool</info>  A <info>bool</info> representing whether the calendar is set to lenient mode.


id: IntlCalendar::isSet
type: function
doc:
<comment>Description:</comment>
  Whether a field is set
  
  面向对象风格
  
  过程化风格
  
  Returns whether a field is set (as opposed to clear). Set fields take priority over unset fields
  and their default values when the date/time is being calculated. Fields set later take priority
  over fields set earlier.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>  <class>IntlCalendar</class> 实例。
  <info>int</info>           <strong>$field</strong>     One of the <class>IntlCalendar</class> date/time field constants. These are integer
                           values between <return>0</return> and <info>IntlCalendar::FIELD_COUNT</info>.

<comment>Return:</comment>
  <info>bool</info>  Assuming there are no argument errors, returns <info>true</info> if the field is set.

<comment>See Also:</comment>
   * IntlCalendar::clear
   * IntlCalendar::set


id: IntlCalendar::isWeekend
type: function
doc:
<comment>Description:</comment>
  Whether a certain date/time is in the weekend
  
  面向对象风格
  
  过程化风格
  
  Returns whether either the obejctʼs current time or the provided timestamp occur during a weekend
  in this objectʼs calendar system.
  
  This function requires ICU 4.4 or later.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>   <class>IntlCalendar</class> 实例。
  <info>float|null</info>    <strong>$timestamp</strong>  An optional timestamp representing the number of milliseconds since the
                            epoch, excluding leap seconds. If <info>null</info>, this objectʼs current time is
                            used instead.

<comment>Return:</comment>
  <info>bool</info>  A <info>bool</info> indicating whether the given or this objectʼs time occurs in a weekend.
        
        On failure <info>false</info> is also returned. To detect error conditions use <strong>intl_get_error_code()</strong>, or
        set up Intl to throw exceptions.

<comment>See Also:</comment>
   * IntlCalendar::getDayOfWeekType
   * IntlCalendar::getWeekendTransition


id: IntlCalendar::roll
type: function
doc:
<comment>Description:</comment>
  Add value to field without carrying into more significant fields
  
  面向对象风格
  
  过程化风格
  
  Adds a (signed) amount to a field. The difference with respect to <strong>IntlCalendar::add()</strong> is that when
  the field value overflows, it does not carry into more significant fields.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>  <class>IntlCalendar</class> 实例。
  <info>int</info>           <strong>$field</strong>     One of the <class>IntlCalendar</class> date/time field constants. These are integer
                           values between <return>0</return> and <info>IntlCalendar::FIELD_COUNT</info>.
  <info>int|bool</info>      <strong>$value</strong>     The (signed) amount to add to the field, <info>true</info> for rolling up (adding <return>1</return>),
                           or <info>false</info> for rolling down (subtracting <return>1</return>).

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success or <info>false</info> on failure.

<comment>See Also:</comment>
   * IntlCalendar::add
   * IntlCalendar::set


id: IntlCalendar::set
type: function
doc:
<comment>Description:</comment>
  Set a time field or several common fields at once
  
  面向对象风格
  
  过程化风格
  
  Sets either a specific field to the given value, or sets at once several common fields. The range
  of values that are accepted depend on whether the calendar is using the lenient mode.
  
  For fields that conflict, the fields that are set later have priority.
  
  This method cannot be called with exactly four arguments.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$cal</strong>         <class>IntlCalendar</class> 实例。
  <info>int</info>           <strong>$field</strong>       One of the <class>IntlCalendar</class> date/time field constants. These are integer
                             values between <return>0</return> and <info>IntlCalendar::FIELD_COUNT</info>.
  <info>int</info>           <strong>$value</strong>       The new value of the given field.
  <info>int</info>           <strong>$year</strong>        The new value for <info>IntlCalendar::FIELD_YEAR</info>.
  <info>int</info>           <strong>$month</strong>       The new value for <info>IntlCalendar::FIELD_MONTH</info>. The month sequence is
                             zero-based, i.e., January is represented by 0, February by 1, …,
                             December is 11 and Undecember (if the calendar has it) is 12.
  <info>int</info>           <strong>$dayOfMonth</strong>  The new value for <info>IntlCalendar::FIELD_DAY_OF_MONTH</info>.
  <info>int</info>           <strong>$hour</strong>        The new value for <info>IntlCalendar::FIELD_HOUR_OF_DAY</info>.
  <info>int</info>           <strong>$minute</strong>      The new value for <info>IntlCalendar::FIELD_MINUTE</info>.
  <info>int</info>           <strong>$second</strong>      The new value for <info>IntlCalendar::FIELD_SECOND</info>.

<comment>Return:</comment>
  <info>true</info>  总是返回 <info>true</info>。

<comment>See Also:</comment>
   * IntlCalendar::get
   * IntlCalendar::add
   * IntlCalendar::roll


id: IntlCalendar::setDate
type: function
doc:
<comment>Description:</comment>
  Set a date fields
  
  Sets a date fields to the given value.

<comment>Param:</comment>
  <info>int</info>  <strong>$year</strong>        The new value for <info>IntlCalendar::FIELD_YEAR</info>.
  <info>int</info>  <strong>$month</strong>       The new value for <info>IntlCalendar::FIELD_MONTH</info>. The month sequence is zero-based,
                    i.e., January is represented by 0, February by 1, …, December is 11 and
                    Undecember (if the calendar has it) is 12.
  <info>int</info>  <strong>$dayOfMonth</strong>  The new value for <info>IntlCalendar::FIELD_DAY_OF_MONTH</info>.

<comment>Return:</comment>
  <info>void</info>  没有返回值。


id: IntlCalendar::setDateTime
type: function
doc:
<comment>Description:</comment>
  Set a date and time fields
  
  Sets a date and time fields to the given value.

<comment>Param:</comment>
  <info>int</info>  <strong>$year</strong>        The new value for <info>IntlCalendar::FIELD_YEAR</info>.
  <info>int</info>  <strong>$month</strong>       The new value for <info>IntlCalendar::FIELD_MONTH</info>. The month sequence is zero-based,
                    i.e., January is represented by 0, February by 1, …, December is 11 and
                    Undecember (if the calendar has it) is 12.
  <info>int</info>  <strong>$dayOfMonth</strong>  The new value for <info>IntlCalendar::FIELD_DAY_OF_MONTH</info>.
  <info>int</info>  <strong>$hour</strong>        The new value for <info>IntlCalendar::FIELD_HOUR_OF_DAY</info>.
  <info>int</info>  <strong>$minute</strong>      The new value for <info>IntlCalendar::FIELD_MINUTE</info>.
  <info>int</info>  <strong>$second</strong>      The new value for <info>IntlCalendar::FIELD_SECOND</info>.

<comment>Return:</comment>
  <info>void</info>  没有返回值。


id: IntlCalendar::setFirstDayOfWeek
type: function
doc:
<comment>Description:</comment>
  Set the day on which the week is deemed to start
  
  面向对象风格
  
  过程化风格
  
  Defines the day of week deemed to start the week. This affects the behavior of fields that depend
  on the concept of week start and end such as <info>IntlCalendar::FIELD_WEEK_OF_YEAR</info> and
  <info>IntlCalendar::FIELD_YEAR_WOY</info>.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>   <class>IntlCalendar</class> 实例。
  <info>int</info>           <strong>$dayOfWeek</strong>  One of the constants <info>IntlCalendar::DOW_SUNDAY</info>, <info>IntlCalendar::DOW_MONDAY</info>,
                            …, <info>IntlCalendar::DOW_SATURDAY</info>.

<comment>Return:</comment>
  <info>true</info>  总是返回 <info>true</info>。


id: IntlCalendar::setLenient
type: function
doc:
<comment>Description:</comment>
  Set whether date/time interpretation is to be lenient
  
  面向对象风格
  
  过程化风格
  
  Defines whether the calendar is ‘lenient mode’. In such a mode, some of out-of-bounds values for
  some fields are accepted, the behavior being similar to that of <strong>IntlCalendar::add()</strong> (i.e., the
  value wraps around, carrying into more significant fields each time). If the lenient mode is off,
  then such values will generate an error.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>  <class>IntlCalendar</class> 实例。
  <info>bool</info>          <strong>$lenient</strong>   Use <info>true</info> to activate the lenient mode; <info>false</info> otherwise.

<comment>Return:</comment>
  <info>true</info>  总是返回 <info>true</info>。


id: IntlCalendar::setMinimalDaysInFirstWeek
type: function
doc:
<comment>Description:</comment>
  Set minimal number of days the first week in a year or month can have
  
  面向对象风格
  
  过程化风格
  
  Sets the smallest number of days the first week of a year or month must have in the new year or
  month.  For instance, in the Gregorian calendar, if this value is 1, then the first week of the
  year will necessarily include January 1st, while if this value is 7, then the week with January
  1st will be the first week of the year only if the day of the week for January 1st matches the day
  of the week returned by <strong>IntlCalendar::getFirstDayOfWeek()</strong>; otherwise it will be the previous
  yearʼs last week.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>  <class>IntlCalendar</class> 实例。
  <info>int</info>           <strong>$days</strong>      The number of minimal days to set.

<comment>Return:</comment>
  <info>true</info>  总是返回 <info>true</info>。


id: IntlCalendar::setRepeatedWallTimeOption
type: function
doc:
<comment>Description:</comment>
  Set behavior for handling repeating wall times at negative timezone offset transitions
  
  面向对象风格
  
  过程化风格
  
  Sets the current strategy for dealing with wall times that are repeated whenever the clock is set
  back during dailight saving time end transitions. The default value is <info>IntlCalendar::WALLTIME_LAST</info>
  (take the post-DST instant). The other possible value is <info>IntlCalendar::WALLTIME_FIRST</info> (take the
  instant that occurs during DST).
  
  This function requires ICU 4.9 or later.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>  <class>IntlCalendar</class> 实例。
  <info>int</info>           <strong>$option</strong>    One of the constants <info>IntlCalendar::WALLTIME_FIRST</info> or
                           <info>IntlCalendar::WALLTIME_LAST</info>.

<comment>Return:</comment>
  <info>true</info>  总是返回 <info>true</info>。

<comment>See Also:</comment>
   * intlCalendar::getRepeatedWallTimeOption
   * intlCalendar::setSkippedWallTimeOption
   * intlCalendar::getSkippedWallTimeOption


id: IntlCalendar::setSkippedWallTimeOption
type: function
doc:
<comment>Description:</comment>
  Set behavior for handling skipped wall times at positive timezone offset transitions
  
  面向对象风格
  
  过程化风格
  
  Sets the current strategy for dealing with wall times that are skipped whenever the clock is
  forwarded during dailight saving time start transitions. The default value is
  <info>IntlCalendar::WALLTIME_LAST</info> (take it as being the same instant as the one when the wall time is
  one hour more).  Alternative values are <info>IntlCalendar::WALLTIME_FIRST</info> (same instant as the one with
  a wall time of one hour less) and <info>IntlCalendar::WALLTIME_NEXT_VALID</info> (same instant as when DST
  begins).
  
  This affects only the instant represented by the calendar (as reported by
  <strong>IntlCalendar::getTime()</strong>), the field values will not be rewritten accordingly.
  
  The calendar must be lenient for this option to have any effect, otherwise attempting to set a
  non-existing time will cause an error.
  
  This function requires ICU 4.9 or later.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>  <class>IntlCalendar</class> 实例。
  <info>int</info>           <strong>$option</strong>    One of the constants <info>IntlCalendar::WALLTIME_FIRST</info>,
                           <info>IntlCalendar::WALLTIME_LAST</info> or <info>IntlCalendar::WALLTIME_NEXT_VALID</info>.

<comment>Return:</comment>
  <info>true</info>  总是返回 <info>true</info>。

<comment>See Also:</comment>
   * intlCalendar::getSkippedWallTimeOption
   * intlCalendar::setRepeatedWallTimeOption
   * intlCalendar::getRepeatedWallTimeOption


id: IntlCalendar::setTime
type: function
doc:
<comment>Description:</comment>
  Set the calendar time in milliseconds since the epoch
  
  面向对象风格
  
  过程化风格
  
  Sets the instant represented by this object. The instant is represented by a <info>float</info> whose value
  should be an integer number of milliseconds since the epoch (1 Jan 1970 00:00:00.000 UTC),
  ignoring leap seconds. All the field values will be recalculated accordingly.

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>   <class>IntlCalendar</class> 实例。
  <info>float</info>         <strong>$timestamp</strong>  An instant represented by the number of number of milliseconds between
                            such instant and the epoch, ignoring leap seconds.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success and <info>false</info> on failure.


id: IntlCalendar::setTimeZone
type: function
doc:
<comment>Description:</comment>
  Set the timezone used by this calendar
  
  面向对象风格
  
  过程化风格
  
  Defines a new timezone for this calendar. The time represented by the object is preserved to the
  detriment of the field values.

<comment>Param:</comment>
  <info>IntlCalendar</info>                           <strong>$calendar</strong>  <class>IntlCalendar</class> 实例。
  <info>IntlTimeZone|DateTimeZone|string|null</info>  <strong>$timezone</strong>  The new timezone to be used by this calendar. It
                                                    can be specified in the following ways:
                                                    
                                                    <info>null</info>, in which case the default timezone will be
                                                    used, as specified in the ini setting
                                                    date.timezone or through the function
                                                    <strong>date_default_timezone_set()</strong> and as returned by
                                                    <strong>date_default_timezone_get()</strong>.  An <class>IntlTimeZone</class>,
                                                    which will be used directly.  A <class>DateTimeZone</class>.
                                                    Its identifier will be extracted and an ICU
                                                    timezone object will be created; the timezone
                                                    will be backed by ICUʼs database, not PHPʼs.  A
                                                    <info>string</info>, which should be a valid ICU timezone
                                                    identifier. See
                                                    <strong>IntlTimeZone::createTimeZoneIDEnumeration()</strong>. Raw
                                                    offsets such as <return>"GMT+08:30"</return> are also accepted.
                                                    
                                                    <info>null</info>, in which case the default timezone will be
                                                    used, as specified in the ini setting
                                                    date.timezone or through the function
                                                    <strong>date_default_timezone_set()</strong> and as returned by
                                                    <strong>date_default_timezone_get()</strong>.
                                                    
                                                    An <class>IntlTimeZone</class>, which will be used directly.
                                                    
                                                    A <class>DateTimeZone</class>. Its identifier will be extracted
                                                    and an ICU timezone object will be created; the
                                                    timezone will be backed by ICUʼs database, not
                                                    PHPʼs.
                                                    
                                                    A <info>string</info>, which should be a valid ICU timezone
                                                    identifier. See
                                                    <strong>IntlTimeZone::createTimeZoneIDEnumeration()</strong>. Raw
                                                    offsets such as <return>"GMT+08:30"</return> are also accepted.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success and <info>false</info> on failure.


id: IntlCalendar::toDateTime
type: function
doc:
<comment>Description:</comment>
  Convert an IntlCalendar into a DateTime object
  
  面向对象风格
  
  过程化风格
  
  Create a <class>DateTime</class> object that represents the same instant (up to second precision, with a rounding
  error of less than 1 second) and has an analog timezone to this object (the difference being
  <class>DateTime</class>ʼs timezone will be backed by PHPʼs timezone while <class>IntlCalendar</class>ʼs timezone is backed by
  ICUʼs).

<comment>Param:</comment>
  <info>IntlCalendar</info>  <strong>$calendar</strong>  <class>IntlCalendar</class> 实例。

<comment>Return:</comment>
  <info>DateTime|false</info>  A <class>DateTime</class> object with the same timezone as this object (though using PHPʼs
                  database instead of ICUʼs) and the same time, except for the smaller precision
                  (second precision instead of millisecond). Returns <info>false</info> on failure.

<comment>See Also:</comment>
   * IntlCalendar::fromDateTime
   * IntlCalendar::getTime
   * IntlCalendar::createInstance
   * DateTime::__construct


id: IntlChar
type: class
doc:
<comment>Description:</comment>
  <class>IntlChar</class> provides access to a number of utility methods that can be used to access information
  about Unicode characters.
  
  The methods and constants adhere closely to the names and behavior used by the underlying ICU
  library.


id: IntlChar::NO_NUMERIC_VALUE
type: constant
doc:
<comment>Description:</comment>
  Special value that is returned by IntlChar::getNumericValue when no numeric value is defined for a
  code point.


id: IntlChar::charAge
type: function
doc:
<comment>Description:</comment>
  Get the "age" of the code point
  
  Gets the "age" of the code point.
  
  The "age" is the Unicode version when the code point was first designated (as a non-character or
  for Private Use) or assigned a character. This can be useful to avoid emitting code points to
  receiving processes that do not accept newer characters.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>array|null</info>  The Unicode version number, as an <info>array</info>. For example, version 1.3.31.2 would be
              represented as <return>[1, 3, 31, 2]</return>. Returns <info>null</info> on failure.

<comment>See Also:</comment>
   * <strong>IntlChar::getUnicodeVersion()</strong>
   * <strong>IntlChar::getIntPropertyMinValue()</strong>
   * <strong>IntlChar::getIntPropertyValue()</strong>


id: IntlChar::charDigitValue
type: function
doc:
<comment>Description:</comment>
  Get the decimal digit value of a decimal digit character
  
  Returns the decimal digit value of a decimal digit character.
  
  Such characters have the general category "Nd" (decimal digit numbers) and a Numeric_Type of
  Decimal.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>int|null</info>  The decimal digit value of <strong>$codepoint</strong>, or <return>-1</return> if it is not a decimal digit character.
            Returns <info>null</info> on failure.

<comment>See Also:</comment>
   * <strong>IntlChar::getNumericValue()</strong>


id: IntlChar::charDirection
type: function
doc:
<comment>Description:</comment>
  Get bidirectional category value for a code point
  
  Returns the bidirectional category value for the code point, which is used in the Unicode
  bidirectional algorithm (UAX #9).
  
  Some unassigned code points have bidi values of R or AL because they are in blocks that are
  reserved for Right-To-Left scripts.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>int|null</info>  The bidirectional category value; one of the following constants:
            <info>IntlChar::CHAR_DIRECTION_LEFT_TO_RIGHT</info><info>IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT</info><info>IntlChar::CHAR_DIRECTION_EUROPEAN_NUMBER</info><info>IntlChar::CHAR_DIRECTION_EUROPEAN_NUMBER_SEPARATOR</info><info>IntlChar::CHAR_DIRECTION_EUROPEAN_NUMBER_TERMINATOR</info><info>IntlChar::CHAR_DIRECTION_ARABIC_NUMBER</info><info>IntlChar::CHAR_DIRECTION_COMMON_NUMBER_SEPARATOR</info><info>IntlChar::CHAR_DIRECTION_BLOCK_SEPARATOR</info><info>IntlChar::CHAR_DIRECTION_SEGMENT_SEPARATOR</info><info>IntlChar::CHAR_DIRECTION_WHITE_SPACE_NEUTRAL</info><info>IntlChar::CHAR_DIRECTION_OTHER_NEUTRAL</info><info>IntlChar::CHAR_DIRECTION_LEFT_TO_RIGHT_EMBEDDING</info><info>IntlChar::CHAR_DIRECTION_LEFT_TO_RIGHT_OVERRIDE</info><info>IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT_ARABIC</info><info>IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT_EMBEDDING</info><info>IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT_OVERRIDE</info><info>IntlChar::CHAR_DIRECTION_POP_DIRECTIONAL_FORMAT</info><info>IntlChar::CHAR_DIRECTION_DIR_NON_SPACING_MARK</info><info>IntlChar::CHAR_DIRECTION_BOUNDARY_NEUTRAL</info><info>IntlChar::CHAR_DIRECTION_FIRST_STRONG_ISOLATE</info><info>IntlChar::CHAR_DIRECTION_LEFT_TO_RIGHT_ISOLATE</info><info>IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT_ISOLATE</info><info>IntlChar::CHAR_DIRECTION_POP_DIRECTIONAL_ISOLATE</info><info>IntlChar::CHAR_DIRECTION_CHAR_DIRECTION_COUNT</info>
             Returns <info>null</info> on failure.


id: IntlChar::charFromName
type: function
doc:
<comment>Description:</comment>
  Find Unicode character by name and return its code point value
  
  Finds a Unicode character by its name and returns its code point value.
  
  The name is matched exactly and completely. If the name does not correspond to a code point, <info>null</info>
  is returned.
  
  A Unicode 1.0 name is matched only if it differs from the modern name. Unicode names are all
  uppercase. Extended names are lowercase followed by an uppercase hexadecimal number, and within
  angle brackets.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Full name of the Unicode character.
  <info>int</info>     <strong>$type</strong>  Which set of names to use for the lookup. Can be any of these constants:
                 <info>IntlChar::UNICODE_CHAR_NAME</info>
                 (default)<info>IntlChar::UNICODE_10_CHAR_NAME</info><info>IntlChar::EXTENDED_CHAR_NAME</info><info>IntlChar::CHAR_NAME_ALIAS</info><info>IntlChar::CHAR_NAME_CHOICE_COUNT</info>

<comment>Return:</comment>
  <info>int|null</info>  The Unicode value of the code point with the given name (as an <info>int</info>), or <info>null</info> if there is
            no such code point.

<comment>See Also:</comment>
   * <strong>IntlChar::charName()</strong>
   * <strong>IntlChar::enumCharNames()</strong>


id: IntlChar::charMirror
type: function
doc:
<comment>Description:</comment>
  Get the "mirror-image" character for a code point
  
  Maps the specified character to a "mirror-image" character.
  
  For characters with the Bidi_Mirrored property, implementations sometimes need a "poor man's"
  mapping to another Unicode character (code point) such that the default glyph may serve as the
  mirror-image of the default glyph of the specified character. This is useful for text conversion
  to and from codepages with visual order, and for displays without glyph selection capabilities.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>int|string|null</info>  Returns another Unicode code point that may serve as a mirror-image substitute,
                   or <strong>$codepoint</strong> itself if there is no such mapping or <strong>$codepoint</strong> does not have the
                   Bidi_Mirrored property.
                   
                   返回类型是 <info>int</info>，如果代码点作为 UTF-8 <info>string</info> 传递，则会返回 <info>string</info> 。失败时返回
                   <info>null</info>。

<comment>See Also:</comment>
   * <strong>IntlChar::isMirrored()</strong>
   * <info>IntlChar::PROPERTY_BIDI_MIRRORED</info>


id: IntlChar::charName
type: function
doc:
<comment>Description:</comment>
  Retrieve the name of a Unicode character
  
  Retrieves the name of a Unicode character.
  
  Depending on <strong>$type</strong>, the resulting character name is the "modern" name or the name that was defined
  in Unicode version 1.0. The name contains only "invariant" characters like A-Z, 0-9, space, and
  '-'. Unicode 1.0 names are only retrieved if they are different from the modern names and if ICU
  contains the data for them.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)
  <info>int</info>         <strong>$type</strong>       Which set of names to use for the lookup. Can be any of these constants:
                          <info>IntlChar::UNICODE_CHAR_NAME</info>
                          (default)<info>IntlChar::UNICODE_10_CHAR_NAME</info><info>IntlChar::EXTENDED_CHAR_NAME</info><info>IntlChar::CHAR_NAME_ALIAS</info><info>IntlChar::CHAR_NAME_CHOICE_COUNT</info>

<comment>Return:</comment>
  <info>string|null</info>  The corresponding name, or an empty string if there is no name for this character, or
               <info>null</info> if there is no such code point.

<comment>See Also:</comment>
   * <strong>IntlChar::charFromName()</strong>
   * <strong>IntlChar::enumCharNames()</strong>


id: IntlChar::charType
type: function
doc:
<comment>Description:</comment>
  Get the general category value for a code point
  
  Returns the general category value for the code point.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>int|null</info>  Returns the general category type, which may be one of the following constants:
            <info>IntlChar::CHAR_CATEGORY_UNASSIGNED</info><info>IntlChar::CHAR_CATEGORY_GENERAL_OTHER_TYPES</info><info>IntlChar::CHAR_CATEGORY_UPPERCASE_LETTER</info><info>IntlChar::CHAR_CATEGORY_LOWERCASE_LETTER</info><info>IntlChar::CHAR_CATEGORY_TITLECASE_LETTER</info><info>IntlChar::CHAR_CATEGORY_MODIFIER_LETTER</info><info>IntlChar::CHAR_CATEGORY_OTHER_LETTER</info><info>IntlChar::CHAR_CATEGORY_NON_SPACING_MARK</info><info>IntlChar::CHAR_CATEGORY_ENCLOSING_MARK</info><info>IntlChar::CHAR_CATEGORY_COMBINING_SPACING_MARK</info><info>IntlChar::CHAR_CATEGORY_DECIMAL_DIGIT_NUMBER</info><info>IntlChar::CHAR_CATEGORY_LETTER_NUMBER</info><info>IntlChar::CHAR_CATEGORY_OTHER_NUMBER</info><info>IntlChar::CHAR_CATEGORY_SPACE_SEPARATOR</info><info>IntlChar::CHAR_CATEGORY_LINE_SEPARATOR</info><info>IntlChar::CHAR_CATEGORY_PARAGRAPH_SEPARATOR</info><info>IntlChar::CHAR_CATEGORY_CONTROL_CHAR</info><info>IntlChar::CHAR_CATEGORY_FORMAT_CHAR</info><info>IntlChar::CHAR_CATEGORY_PRIVATE_USE_CHAR</info><info>IntlChar::CHAR_CATEGORY_SURROGATE</info><info>IntlChar::CHAR_CATEGORY_DASH_PUNCTUATION</info><info>IntlChar::CHAR_CATEGORY_START_PUNCTUATION</info><info>IntlChar::CHAR_CATEGORY_END_PUNCTUATION</info><info>IntlChar::CHAR_CATEGORY_CONNECTOR_PUNCTUATION</info><info>IntlChar::CHAR_CATEGORY_OTHER_PUNCTUATION</info><info>IntlChar::CHAR_CATEGORY_MATH_SYMBOL</info><info>IntlChar::CHAR_CATEGORY_CURRENCY_SYMBOL</info><info>IntlChar::CHAR_CATEGORY_MODIFIER_SYMBOL</info><info>IntlChar::CHAR_CATEGORY_OTHER_SYMBOL</info><info>IntlChar::CHAR_CATEGORY_INITIAL_PUNCTUATION</info><info>IntlChar::CHAR_CATEGORY_FINAL_PUNCTUATION</info><info>IntlChar::CHAR_CATEGORY_CHAR_CATEGORY_COUNT</info>


id: IntlChar::chr
type: function
doc:
<comment>Description:</comment>
  Return Unicode character by code point value
  
  Returns a string containing the character specified by the Unicode code point value.
  
  This function complements <strong>IntlChar::ord()</strong>.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>string|null</info>  A string containing the single character specified by the Unicode code point value,
               or <info>null</info> on failure.

<comment>See Also:</comment>
   * <strong>IntlChar::ord()</strong>
   * <strong>mb_chr()</strong>
   * <strong>chr()</strong>


id: IntlChar::digit
type: function
doc:
<comment>Description:</comment>
  Get the decimal digit value of a code point for a given radix
  
  Returns the decimal digit value of the code point in the specified radix.
  
  If the radix is not in the range <return>2\<=radix\<=36</return> or if the value of <strong>$codepoint</strong> is not a valid digit in the specified radix, <info>false</info> is returned. A character is a valid digit if at least one of the following is true: The character has a decimal digit value. Such characters have the general category "Nd" (decimal digit numbers) and a Numeric_Type of Decimal. In this case the value is the character's decimal digit value.The character is one of the uppercase Latin letters 'A' through 'Z'. In this case the value is c-'A'+10.The character is one of the lowercase Latin letters 'a' through 'z'. In this case the value is ch-'a'+10.Latin letters from both the ASCII range (0061..007A, 0041..005A) as well as from the Fullwidth ASCII range (FF41..FF5A, FF21..FF3A) are recognized.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)
  <info>int</info>         <strong>$base</strong>       The radix (defaults to <return>10</return>).

<comment>Return:</comment>
  <info>int|false|null</info>  Returns the numeric value represented by the character in the specified radix, or
                  <info>false</info> if there is no value or if the value exceeds the radix. Returns <info>null</info> on
                  failure.
                  
                  此函数可能返回布尔值
                  <info>false</info>，但也可能返回等同于 <info>false</info> 的非布尔值。请阅读 布尔类型章节以获取更多信息。应
                  使用
                  ===
                  运算符来测试此函数的返回值。

<comment>See Also:</comment>
   * <strong>IntlChar::forDigit()</strong>
   * <strong>IntlChar::charDigitValue()</strong>
   * <strong>IntlChar::isdigit()</strong>
   * <info>IntlChar::PROPERTY_NUMERIC_TYPE</info>


id: IntlChar::enumCharNames
type: function
doc:
<comment>Description:</comment>
  Enumerate all assigned Unicode characters within a range
  
  Enumerate all assigned Unicode characters between the start and limit code points (start
  inclusive, limit exclusive) and call a function for each, passing the code point value and the
  character name.
  
  For Unicode 1.0 names, only those are enumerated that differ from the modern names.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$start</strong>     The first code point in the enumeration range.
  <info>int|string</info>  <strong>$end</strong>       One more than the last code point in the enumeration range (the first one
                         after the range).
  <info>callable</info>    <strong>$callback</strong>  The function that is to be called for each character name.  The following
                         three arguments will be passed into it: <info>int</info><return>$codepoint</return> - The numeric code
                         point value<info>int</info><return>$nameChoice</return> - The same value as the <strong>$type</strong> parameter
                         below<info>string</info><return>$name</return> - The name of the character
  <info>int</info>         <strong>$type</strong>      Selector for which kind of names to enumerate.  Can be any of these
                         constants: <info>IntlChar::UNICODE_CHAR_NAME</info>
                         (default)<info>IntlChar::UNICODE_10_CHAR_NAME</info><info>IntlChar::EXTENDED_CHAR_NAME</info><info>IntlChar::CHAR_NAME_ALIAS</info><info>IntlChar::CHAR_NAME_CHOICE_COUNT</info>

<comment>Return:</comment>
  <info>bool|null</info>  成功时返回 <info>null</info>， 或者在失败时返回 <info>false</info>。

<comment>See Also:</comment>
   * <strong>IntlChar::charName()</strong>
   * <strong>IntlChar::charFromName()</strong>


id: IntlChar::enumCharTypes
type: function
doc:
<comment>Description:</comment>
  Enumerate all code points with their Unicode general categories
  
  Enumerates efficiently all code points with their Unicode general categories. This is useful for
  building data structures, for enumerating all assigned code points, etc.
  
  For each contiguous range of code points with a given general category ("character type"), the
  <strong>$callback</strong> function is called. Adjacent ranges have different types. The Unicode Standard
  guarantees that the numeric value of the type is 0..31.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  The function that is to be called for each contiguous range of code points
                       with the same general category. The following three arguments will be passed
                       into it: <info>int</info><return>$start</return> - The starting code point of the range<info>int</info><return>$end</return> - The ending
                       code point of the range<info>int</info><return>$name</return> - The category type (one of the
                       <return>IntlChar::CHAR_CATEGORY_*</return> constants)

<comment>Return:</comment>
  <info>void</info>  没有返回值。


id: IntlChar::foldCase
type: function
doc:
<comment>Description:</comment>
  Perform case folding on a code point
  
  The given character is mapped to its case folding equivalent; if the character has no case folding
  equivalent, the character itself is returned.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)
  <info>int</info>         <strong>$options</strong>    Either <info>IntlChar::FOLD_CASE_DEFAULT</info> (default) or
                          <info>IntlChar::FOLD_CASE_EXCLUDE_SPECIAL_I</info>.

<comment>Return:</comment>
  <info>int|string|null</info>  Returns the Simple_Case_Folding of the code point, if any; otherwise the code
                   point itself on success, or <info>null</info> on failure.


id: IntlChar::forDigit
type: function
doc:
<comment>Description:</comment>
  Get character representation for a given digit and radix
  
  Determines the character representation for a specific digit in the specified radix.
  
  If the value of radix is not a valid radix, or the value of digit is not a valid digit in the
  specified radix, the null character (<return>U+0000</return>) is returned.
  
  The radix argument is valid if it is greater than or equal to <return>2</return> and less than or equal to <return>36</return>. The
  digit argument is valid if <return>0 \<= digit \< radix</return>.
  
  If the digit is less than <return>10</return>, then '0' + digit is returned. Otherwise, the value 'a' + digit - 10
  is returned.

<comment>Param:</comment>
  <info>int</info>  <strong>$digit</strong>  The number to convert to a character.
  <info>int</info>  <strong>$base</strong>   The radix (defaults to <return>10</return>).

<comment>Return:</comment>
  <info>int</info>  The character representation (as a <info>string</info>) of the specified digit in the specified radix.

<comment>See Also:</comment>
   * <strong>IntlChar::digit()</strong>
   * <strong>IntlChar::charDigitValue()</strong>
   * <strong>IntlChar::isdigit()</strong>
   * <info>IntlChar::PROPERTY_NUMERIC_TYPE</info>


id: IntlChar::getBidiPairedBracket
type: function
doc:
<comment>Description:</comment>
  Get the paired bracket character for a code point
  
  Maps the specified character to its paired bracket character.
  
  For <return>Bidi_Paired_Bracket_Type!=None</return>, this is the same as <strong>IntlChar::charMirror()</strong>. Otherwise
  <strong>$codepoint</strong> itself is returned.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>int|string|null</info>  Returns the paired bracket code point, or <strong>$codepoint</strong> itself if there is no such
                   mapping. Returns <info>null</info> on failure.
                   
                   返回类型是 <info>int</info>，如果代码点作为 UTF-8 <info>string</info> 传递，则会返回 <info>string</info> 。失败时返回
                   <info>null</info>。

<comment>See Also:</comment>
   * <strong>IntlChar::charMirror()</strong>
   * <info>IntlChar::PROPERTY_BIDI_PAIRED_BRACKET</info>
   * <info>IntlChar::PROPERTY_BIDI_PAIRED_BRACKET_TYPE</info>


id: IntlChar::getBlockCode
type: function
doc:
<comment>Description:</comment>
  Get the Unicode allocation block containing a code point
  
  Returns the Unicode allocation block that contains the character.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>int|null</info>  Returns the block value for <strong>$codepoint</strong>. See the <return>IntlChar::BLOCK_CODE_*</return> constants for
            possible return values. Returns <info>null</info> on failure.


id: IntlChar::getCombiningClass
type: function
doc:
<comment>Description:</comment>
  Get the combining class of a code point
  
  Returns the combining class of the code point.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>int|null</info>  Returns the combining class of the character. Returns <info>null</info> on failure.


id: IntlChar::getFC_NFKC_Closure
type: function
doc:
<comment>Description:</comment>
  Get the FC_NFKC_Closure property for a code point
  
  Gets the FC_NFKC_Closure property string for a character.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>string|false|null</info>  Returns the FC_NFKC_Closure property string for the <strong>$codepoint</strong>, or an empty
                     string if there is none. Returns <info>null</info> or <info>false</info> on failure.


id: IntlChar::getIntPropertyMaxValue
type: function
doc:
<comment>Description:</comment>
  Get the max value for a Unicode property
  
  Gets the maximum value for an enumerated/integer/binary Unicode property.

<comment>Param:</comment>
  <info>int</info>  <strong>$property</strong>  The Unicode property to lookup (see the <return>IntlChar::PROPERTY_*</return> constants).

<comment>Return:</comment>
  <info>int</info>  The maximum value returned by <strong>IntlChar::getIntPropertyValue()</strong> for a Unicode property. <return>\<=0</return> if the property selector is out of range.

<comment>See Also:</comment>
   * <strong>IntlChar::hasBinaryProperty()</strong>
   * <strong>IntlChar::getIntPropertyMinValue()</strong>
   * <strong>IntlChar::getIntPropertyValue()</strong>
   * <strong>IntlChar::getUnicodeVersion()</strong>


id: IntlChar::getIntPropertyMinValue
type: function
doc:
<comment>Description:</comment>
  Get the min value for a Unicode property
  
  Gets the minimum value for an enumerated/integer/binary Unicode property.

<comment>Param:</comment>
  <info>int</info>  <strong>$property</strong>  The Unicode property to lookup (see the <return>IntlChar::PROPERTY_*</return> constants).

<comment>Return:</comment>
  <info>int</info>  The minimum value returned by <strong>IntlChar::getIntPropertyValue()</strong> for a Unicode property. <return>0</return> if
       the property selector is out of range.

<comment>See Also:</comment>
   * <strong>IntlChar::hasBinaryProperty()</strong>
   * <strong>IntlChar::getIntPropertyMaxValue()</strong>
   * <strong>IntlChar::getIntPropertyValue()</strong>
   * <strong>IntlChar::getUnicodeVersion()</strong>


id: IntlChar::getIntPropertyValue
type: function
doc:
<comment>Description:</comment>
  Get the value for a Unicode property for a code point
  
  Gets the property value for an enumerated or integer Unicode property for a code point. Also
  returns binary and mask property values.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)
  <info>int</info>         <strong>$property</strong>   The Unicode property to lookup (see the <return>IntlChar::PROPERTY_*</return> constants).

<comment>Return:</comment>
  <info>int|null</info>  Returns the numeric value that is directly the property value or, for enumerated
            properties, corresponds to the numeric value of the enumerated constant of the
            respective property value enumeration type. Returns <info>null</info> on failure.
            
            Returns <return>0</return> or <return>1</return> (for <info>false</info>/<info>true</info>) for binary Unicode properties.
            
            Returns a bit-mask for mask properties.
            
            Returns <return>0</return> if <strong>$property</strong> is out of bounds or if the Unicode version does not have data for
            the property at all, or not for this code point.

<comment>See Also:</comment>
   * <strong>IntlChar::hasBinaryProperty()</strong>
   * <strong>IntlChar::getIntPropertyMinValue()</strong>
   * <strong>IntlChar::getIntPropertyMaxValue()</strong>
   * <strong>IntlChar::getUnicodeVersion()</strong>


id: IntlChar::getNumericValue
type: function
doc:
<comment>Description:</comment>
  Get the numeric value for a Unicode code point
  
  Gets the numeric value for a Unicode code point as defined in the Unicode Character Database.
  
  For characters without any numeric values in the Unicode Character Database, this function will
  return <info>IntlChar::NO_NUMERIC_VALUE</info>.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>float|null</info>  Numeric value of <strong>$codepoint</strong>, or <info>IntlChar::NO_NUMERIC_VALUE</info> if none is defined. This
              constant was added in PHP 7.0.6, prior to this version the literal value
              (<info>float</info>)<return>-123456789</return> may be used instead. Returns <info>null</info> on failure.


id: IntlChar::getPropertyEnum
type: function
doc:
<comment>Description:</comment>
  Get the property constant value for a given property name
  
  Returns the property constant value for a given property name, as specified in the Unicode
  database file PropertyAliases.txt. Short, long, and any other variants are recognized.
  
  In addition, this function maps the synthetic names "gcm" / "General_Category_Mask" to the
  property <info>IntlChar::PROPERTY_GENERAL_CATEGORY_MASK</info>. These names are not in PropertyAliases.txt.
  
  This function complements <strong>IntlChar::getPropertyName()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$alias</strong>  The property name to be matched. The name is compared using "loose matching" as
                  described in PropertyAliases.txt.

<comment>Return:</comment>
  <info>int</info>  Returns an <return>IntlChar::PROPERTY_</return> constant value, or <info>IntlChar::PROPERTY_INVALID_CODE</info> if the
       given name does not match any property.

<comment>See Also:</comment>
   * <strong>IntlChar::getPropertyName()</strong>


id: IntlChar::getPropertyName
type: function
doc:
<comment>Description:</comment>
  Get the Unicode name for a property
  
  Returns the Unicode name for a given property, as given in the Unicode database file
  PropertyAliases.txt.
  
  In addition, this function maps the property <info>IntlChar::PROPERTY_GENERAL_CATEGORY_MASK</info> to the
  synthetic names "gcm" / "General_Category_Mask". These names are not in PropertyAliases.txt.
  
  This function complements <strong>IntlChar::getPropertyEnum()</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$property</strong>  The Unicode property to lookup (see the <return>IntlChar::PROPERTY_*</return> constants).
                  
                  <info>IntlChar::PROPERTY_INVALID_CODE</info> should not be used. Also, if <strong>$property</strong> is out of
                  range, <info>false</info> is returned.
  <info>int</info>  <strong>$type</strong>      Selector for which name to get. If out of range, <info>false</info> is returned.
                  
                  All properties have a long name. Most have a short name, but some do not. Unicode
                  allows for additional names; if present these will be returned by adding 1, 2,
                  etc. to <info>IntlChar::LONG_PROPERTY_NAME</info>.

<comment>Return:</comment>
  <info>string|false</info>  Returns the name, or <info>false</info> if either the <strong>$property</strong> or the <strong>$type</strong> is out of range.
                
                If a given <strong>$type</strong> returns <info>false</info>, then all larger values of <strong>$type</strong> will return <info>false</info>,
                with one exception: if <info>false</info> is returned for <info>IntlChar::SHORT_PROPERTY_NAME</info>, then
                <info>IntlChar::LONG_PROPERTY_NAME</info> (and higher) may still return a non-<info>false</info> value.

<comment>See Also:</comment>
   * <strong>IntlChar::getPropertyEnum()</strong>


id: IntlChar::getPropertyValueEnum
type: function
doc:
<comment>Description:</comment>
  Get the property value for a given value name
  
  Returns the property value integer for a given value name, as specified in the Unicode database
  file PropertyValueAliases.txt. Short, long, and any other variants are recognized.
  
  Some of the names in PropertyValueAliases.txt will only be recognized with
  <info>IntlChar::PROPERTY_GENERAL_CATEGORY_MASK</info>, not <info>IntlChar::PROPERTY_GENERAL_CATEGORY</info>. These include:
  "C" / "Other""L" / "Letter""LC" / "Cased_Letter""M" / "Mark""N" / "Number""P" / "Punctuation""S" /
  "Symbol" "Z" / "Separator"

<comment>Param:</comment>
  <info>int</info>     <strong>$property</strong>  The Unicode property to lookup (see the <return>IntlChar::PROPERTY_*</return> constants).
                     
                     If out of range, or this method doesn't work with the given value,
                     <info>IntlChar::PROPERTY_INVALID_CODE</info> is returned.
  <info>string</info>  <strong>$name</strong>      The value name to be matched.  The name is compared using "loose matching" as
                     described in PropertyValueAliases.txt.

<comment>Return:</comment>
  <info>int</info>  Returns the corresponding value integer, or <info>IntlChar::PROPERTY_INVALID_CODE</info> if the given name
       does not match any value of the given property, or if the property is invalid.


id: IntlChar::getPropertyValueName
type: function
doc:
<comment>Description:</comment>
  Get the Unicode name for a property value
  
  Returns the Unicode name for a given property value, as given in the Unicode database file
  PropertyValueAliases.txt.
  
  Some of the names in PropertyValueAliases.txt can only be retrieved using
  <info>IntlChar::PROPERTY_GENERAL_CATEGORY_MASK</info>, not <info>IntlChar::PROPERTY_GENERAL_CATEGORY</info>. These include:
  "C" / "Other""L" / "Letter""LC" / "Cased_Letter""M" / "Mark""N" / "Number""P" / "Punctuation""S" /
  "Symbol" "Z" / "Separator"

<comment>Param:</comment>
  <info>int</info>  <strong>$property</strong>  The Unicode property to lookup (see the <return>IntlChar::PROPERTY_*</return> constants).
                  
                  If out of range, or this method doesn't work with the given value, <info>false</info> is
                  returned.
  <info>int</info>  <strong>$value</strong>     Selector for a value for the given property. If out of range, <info>false</info> is returned.
                  
                  In general, valid values range from <return>0</return> up to some maximum. There are a couple
                  exceptions: <info>IntlChar::PROPERTY_BLOCK</info> values begin at the non-zero value
                  <info>IntlChar::BLOCK_CODE_BASIC_LATIN</info> <info>IntlChar::PROPERTY_CANONICAL_COMBINING_CLASS</info>
                  values are not contiguous and range from 0..240.
  <info>int</info>  <strong>$type</strong>      Selector for which name to get. If out of range, <info>false</info> is returned.
                  
                  All values have a long name. Most have a short name, but some do not. Unicode
                  allows for additional names; if present these will be returned by adding 1, 2,
                  etc. to <info>IntlChar::LONG_PROPERTY_NAME</info>.

<comment>Return:</comment>
  <info>string|false</info>  Returns the name, or <info>false</info> if either the <strong>$property</strong> or the <strong>$type</strong> is out of range.
                Returns <info>null</info> on failure.
                
                If a given <strong>$type</strong> returns <info>false</info>, then all larger values of <strong>$type</strong> will return <info>false</info>,
                with one exception: if <info>false</info> is returned for <info>IntlChar::SHORT_PROPERTY_NAME</info>, then
                <info>IntlChar::LONG_PROPERTY_NAME</info> (and higher) may still return a non-<info>false</info> value.


id: IntlChar::getUnicodeVersion
type: function
doc:
<comment>Description:</comment>
  Get the Unicode version
  
  Gets the Unicode version information.
  
  The version array is filled in with the version information for the Unicode standard that is
  currently used by ICU. For example, Unicode version 3.1.1 is represented as an array with the
  values <return>[3, 1, 1, 0]</return>.

<comment>Return:</comment>
  <info>array</info>  An array containing the Unicode version number.

<comment>See Also:</comment>
   * <strong>IntlChar::charAge()</strong>


id: IntlChar::hasBinaryProperty
type: function
doc:
<comment>Description:</comment>
  Check a binary Unicode property for a code point
  
  Checks a binary Unicode property for a code point.
  
  Unicode, especially in version 3.2, defines many more properties than the original set in
  UnicodeData.txt.
  
  The properties APIs are intended to reflect Unicode properties as defined in the Unicode Character
  Database (UCD) and Unicode Technical Reports (UTR). For details about the properties see
  http://www.unicode.org/ucd/. For names of Unicode properties see the UCD file PropertyAliases.txt.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)
  <info>int</info>         <strong>$property</strong>   The Unicode property to lookup (see the <return>IntlChar::PROPERTY_*</return> constants).

<comment>Return:</comment>
  <info>bool|null</info>  Returns <info>true</info> or <info>false</info> according to the binary Unicode property value for <strong>$codepoint</strong>.
             Also <info>false</info> if <strong>$property</strong> is out of bounds or if the Unicode version does not have data
             for the property at all, or not for this code point. Returns <info>null</info> on failure.

<comment>See Also:</comment>
   * <strong>IntlChar::getIntPropertyValue()</strong>
   * <strong>IntlChar::getUnicodeVersion()</strong>


id: IntlChar::isIDIgnorable
type: function
doc:
<comment>Description:</comment>
  Check if code point is an ignorable character
  
  Determines if the specified character should be regarded as an ignorable character in an
  identifier.
  
  <info>true</info> for characters with general category "Cf" (format controls) as well as non-whitespace ISO
  controls (U+0000..U+0008, U+000E..U+001B, U+007F..U+009F).
  
  Note that Unicode just recommends to ignore Cf (format controls).

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool|null</info>  Returns <info>true</info> if <strong>$codepoint</strong> is ignorable in identifiers, <info>false</info> if not. Returns <info>null</info> on
             failure.

<comment>See Also:</comment>
   * <strong>IntlChar::isIDStart()</strong>
   * <strong>IntlChar::isIDPart()</strong>
   * <info>IntlChar::PROPERTY_DEFAULT_IGNORABLE_CODE_POINT</info>


id: IntlChar::isIDPart
type: function
doc:
<comment>Description:</comment>
  Check if code point is permissible in an identifier
  
  Determines if the specified character is permissible in an identifier.
  
  <info>true</info> for characters with general categories "L" (letters), "Nl" (letter numbers), "Nd" (decimal
  digits), "Mc" and "Mn" (combining marks), "Pc" (connecting punctuation), and u_isIDIgnorable(c).
  
  This is almost the same as Unicode's ID_Continue (<info>IntlChar::PROPERTY_ID_CONTINUE</info>) except that
  Unicode recommends to ignore Cf which is less than <strong>IntlChar::isIDIgnorable()</strong>.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool|null</info>  Returns <info>true</info> if <strong>$codepoint</strong> is the code point may occur in an identifier, <info>false</info> if not.
             Returns <info>null</info> on failure.

<comment>See Also:</comment>
   * <strong>IntlChar::isIDIgnorable()</strong>
   * <strong>IntlChar::isIDStart()</strong>
   * <info>IntlChar::PROPERTY_ID_CONTINUE</info>


id: IntlChar::isIDStart
type: function
doc:
<comment>Description:</comment>
  Check if code point is permissible as the first character in an identifier
  
  Determines if the specified character is permissible as the first character in an identifier
  according to Unicode (The Unicode Standard, Version 3.0, chapter 5.16 Identifiers).
  
  <info>true</info> for characters with general categories "L" (letters) and "Nl" (letter numbers).

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool|null</info>  Returns <info>true</info> if <strong>$codepoint</strong> may start an identifier, <info>false</info> if not. Returns <info>null</info> on
             failure.

<comment>See Also:</comment>
   * <strong>IntlChar::isalpha()</strong>
   * <strong>IntlChar::isIDPart()</strong>
   * <info>IntlChar::PROPERTY_ID_START</info>


id: IntlChar::isISOControl
type: function
doc:
<comment>Description:</comment>
  Check if code point is an ISO control code
  
  Determines whether the specified code point is an ISO control code.
  
  <info>true</info> for U+0000..U+001f and U+007f..U+009f (general category "Cc").

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool|null</info>  Returns <info>true</info> if <strong>$codepoint</strong> is an ISO control code, <info>false</info> if not. Returns <info>null</info> on
             failure.

<comment>See Also:</comment>
   * <strong>IntlChar::iscntrl()</strong>


id: IntlChar::isJavaIDPart
type: function
doc:
<comment>Description:</comment>
  Check if code point is permissible in a Java identifier
  
  Determines if the specified character is permissible in a Java identifier.
  
  In addition to <strong>IntlChar::isIDPart()</strong>, <info>true</info> for characters with general category "Sc" (currency
  symbols).

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool|null</info>  Returns <info>true</info> if <strong>$codepoint</strong> may occur in a Java identifier, <info>false</info> if not. Returns <info>null</info>
             on failure.

<comment>See Also:</comment>
   * <strong>IntlChar::isIDIgnorable()</strong>
   * <strong>IntlChar::isIDPart()</strong>
   * <strong>IntlChar::isJavaIDStart()</strong>
   * <strong>IntlChar::isalpha()</strong>
   * <strong>IntlChar::isdigit()</strong>


id: IntlChar::isJavaIDStart
type: function
doc:
<comment>Description:</comment>
  Check if code point is permissible as the first character in a Java identifier
  
  Determines if the specified character is permissible as the start of a Java identifier.
  
  In addition to <strong>IntlChar::isIDStart()</strong>, <info>true</info> for characters with general categories "Sc" (currency
  symbols) and "Pc" (connecting punctuation).

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool|null</info>  Returns <info>true</info> if <strong>$codepoint</strong> may start a Java identifier, <info>false</info> if not. Returns <info>null</info> on
             failure.

<comment>See Also:</comment>
   * <strong>IntlChar::isIDStart()</strong>
   * <strong>IntlChar::isJavaIDPart()</strong>
   * <strong>IntlChar::isalpha()</strong>


id: IntlChar::isJavaSpaceChar
type: function
doc:
<comment>Description:</comment>
  Check if code point is a space character according to Java
  
  Determine if the specified code point is a space character according to Java.
  
  <info>true</info> for characters with general categories "Z" (separators), which does not include control codes
  (e.g., TAB or Line Feed).

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool|null</info>  Returns <info>true</info> if <strong>$codepoint</strong> is a space character according to Java, <info>false</info> if not.
             Returns <info>null</info> on failure.

<comment>See Also:</comment>
   * <strong>IntlChar::isspace()</strong>
   * <strong>IntlChar::isWhitespace()</strong>
   * <strong>IntlChar::isUWhiteSpace()</strong>


id: IntlChar::isMirrored
type: function
doc:
<comment>Description:</comment>
  Check if code point has the Bidi_Mirrored property
  
  Determines whether the code point has the Bidi_Mirrored property.
  
  This property is set for characters that are commonly used in Right-To-Left contexts and need to
  be displayed with a "mirrored" glyph.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool|null</info>  Returns <info>true</info> if <strong>$codepoint</strong> has the Bidi_Mirrored property, <info>false</info> if not. Returns <info>null</info>
             on failure.

<comment>See Also:</comment>
   * <strong>IntlChar::charMirror()</strong>
   * <info>IntlChar::PROPERTY_BIDI_MIRRORED</info>


id: IntlChar::isUAlphabetic
type: function
doc:
<comment>Description:</comment>
  Check if code point has the Alphabetic Unicode property
  
  Check if a code point has the Alphabetic Unicode property.
  
  This is the same as <return>IntlChar::hasBinaryProperty($codepoint, IntlChar::PROPERTY_ALPHABETIC)</return>

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool|null</info>  Returns <info>true</info> if <strong>$codepoint</strong> has the Alphabetic Unicode property, <info>false</info> if not. Returns
             <info>null</info> on failure.

<comment>See Also:</comment>
   * <strong>IntlChar::isalpha()</strong>
   * <strong>IntlChar::hasBinaryProperty()</strong>
   * <info>IntlChar::PROPERTY_ALPHABETIC</info>


id: IntlChar::isULowercase
type: function
doc:
<comment>Description:</comment>
  Check if code point has the Lowercase Unicode property
  
  Check if a code point has the Lowercase Unicode property.
  
  This is the same as <return>IntlChar::hasBinaryProperty($codepoint, IntlChar::PROPERTY_LOWERCASE)</return>
  
  This is different than <strong>IntlChar::islower()</strong> and will return <info>true</info> for more characters.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool|null</info>  Returns <info>true</info> if <strong>$codepoint</strong> has the Lowercase Unicode property, <info>false</info> if not. Returns
             <info>null</info> on failure.

<comment>See Also:</comment>
   * <strong>IntlChar::islower()</strong>
   * <strong>IntlChar::hasBinaryProperty()</strong>
   * <info>IntlChar::PROPERTY_LOWERCASE</info>


id: IntlChar::isUUppercase
type: function
doc:
<comment>Description:</comment>
  Check if code point has the Uppercase Unicode property
  
  Check if a code point has the Uppercase Unicode property.
  
  This is the same as <return>IntlChar::hasBinaryProperty($codepoint, IntlChar::PROPERTY_UPPERCASE)</return>
  
  This is different than <strong>IntlChar::isupper()</strong> and will return <info>true</info> for more characters.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool|null</info>  Returns <info>true</info> if <strong>$codepoint</strong> has the Uppercase Unicode property, <info>false</info> if not. Returns
             <info>null</info> on failure.

<comment>See Also:</comment>
   * <strong>IntlChar::isupper()</strong>
   * <strong>IntlChar::hasBinaryProperty()</strong>
   * <info>IntlChar::PROPERTY_UPPERCASE</info>


id: IntlChar::isUWhiteSpace
type: function
doc:
<comment>Description:</comment>
  Check if code point has the White_Space Unicode property
  
  Check if a code point has the White_Space Unicode property.
  
  This is the same as <return>IntlChar::hasBinaryProperty($codepoint, IntlChar::PROPERTY_WHITE_SPACE)</return>
  
  This is different from both <strong>IntlChar::isspace()</strong> and <strong>IntlChar::isWhitespace()</strong>.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool|null</info>  Returns <info>true</info> if <strong>$codepoint</strong> has the White_Space Unicode property, <info>false</info> if not. Returns
             <info>null</info> on failure.

<comment>See Also:</comment>
   * <strong>IntlChar::isspace()</strong>
   * <strong>IntlChar::isWhitespace()</strong>
   * <strong>IntlChar::isJavaSpaceChar()</strong>
   * <strong>IntlChar::hasBinaryProperty()</strong>
   * <info>IntlChar::PROPERTY_WHITE_SPACE</info>


id: IntlChar::isWhitespace
type: function
doc:
<comment>Description:</comment>
  Check if code point is a whitespace character according to ICU
  
  Determines if the specified code point is a whitespace character according to ICU.
  
  A character is considered to be a ICU whitespace character if and only if it satisfies one of the
  following criteria: It is a Unicode Separator character (categories "Z" = "Zs" or "Zl" or "Zp"),
  but is not also a non-breaking space (U+00A0 NBSP or U+2007 Figure Space or U+202F Narrow NBSP).It
  is U+0009 HORIZONTAL TABULATION.It is U+000A LINE FEED.It is U+000B VERTICAL TABULATION.It is
  U+000C FORM FEED.It is U+000D CARRIAGE RETURN.It is U+001C FILE SEPARATOR.It is U+001D GROUP
  SEPARATOR.It is U+001E RECORD SEPARATOR.It is U+001F UNIT SEPARATOR.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool|null</info>  Returns <info>true</info> if <strong>$codepoint</strong> is a whitespace character according to ICU, <info>false</info> if not.
             Returns <info>null</info> on failure.

<comment>See Also:</comment>
   * <strong>IntlChar::isspace()</strong>
   * <strong>IntlChar::isJavaSpaceChar()</strong>
   * <strong>IntlChar::isUWhiteSpace()</strong>


id: IntlChar::isalnum
type: function
doc:
<comment>Description:</comment>
  Check if code point is an alphanumeric character
  
  Determines whether the specified code point is an alphanumeric character (letter or digit).  <info>true</info>
  for characters with general categories "L" (letters) and "Nd" (decimal digit numbers).

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool|null</info>  Returns <info>true</info> if <strong>$codepoint</strong> is an alphanumeric character, <info>false</info> if not. Returns <info>null</info> on
             failure.

<comment>See Also:</comment>
   * <strong>IntlChar::isalpha()</strong>
   * <strong>IntlChar::isdigit()</strong>
   * <strong>ctype_alnum()</strong>


id: IntlChar::isalpha
type: function
doc:
<comment>Description:</comment>
  Check if code point is a letter character
  
  Determines whether the specified code point is a letter character.  <info>true</info> for general categories
  "L" (letters).

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool|null</info>  Returns <info>true</info> if <strong>$codepoint</strong> is a letter character, <info>false</info> if not. Returns <info>null</info> on
             failure.

<comment>See Also:</comment>
   * <strong>IntlChar::isalnum()</strong>
   * <strong>IntlChar::isdigit()</strong>
   * <strong>ctype_alpha()</strong>


id: IntlChar::isbase
type: function
doc:
<comment>Description:</comment>
  Check if code point is a base character
  
  Determines whether the specified code point is a base character.  <info>true</info> for general categories "L"
  (letters), "N" (numbers), "Mc" (spacing combining marks), and "Me" (enclosing marks).
  
  This is different from the Unicode definition in chapter 3.5, conformance clause D13, which
  defines base characters to be all characters (not Cn) that do not graphically combine with
  preceding characters (M) and that are neither control (Cc) or format (Cf) characters.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool|null</info>  Returns <info>true</info> if <strong>$codepoint</strong> is a base character, <info>false</info> if not. Returns <info>null</info> on failure.

<comment>See Also:</comment>
   * <strong>IntlChar::isalpha()</strong>
   * <strong>IntlChar::isdigit()</strong>


id: IntlChar::isblank
type: function
doc:
<comment>Description:</comment>
  Check if code point is a "blank" or "horizontal space" character
  
  Determines whether the specified code point is a "blank" or "horizontal space", a character that
  visibly separates words on a line.
  
  The following are equivalent definitions: <info>true</info> for Unicode White_Space characters except for
  "vertical space controls" where "vertical space controls" are the following characters: U+000A
  (LF) U+000B (VT) U+000C (FF) U+000D (CR) U+0085 (NEL) U+2028 (LS) U+2029 (PS) <info>true</info> for U+0009
  (TAB) and characters with general category "Zs" (space separators) except Zero Width Space (ZWSP,
  U+200B).

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool|null</info>  Returns <info>true</info> if <strong>$codepoint</strong> is either a "blank" or "horizontal space" character, <info>false</info>
             if not. Returns <info>null</info> on failure.

<comment>See Also:</comment>
   * <strong>IntlChar::isspace()</strong>
   * <strong>IntlChar::isJavaSpaceChar()</strong>
   * <strong>IntlChar::isUWhiteSpace()</strong>
   * <strong>IntlChar::isWhitespace()</strong>


id: IntlChar::iscntrl
type: function
doc:
<comment>Description:</comment>
  Check if code point is a control character
  
  Determines whether the specified code point is a control character.
  
  A control character is one of the following: ISO 8-bit control character (U+0000..U+001f and
  U+007f..U+009f)<info>IntlChar::CHAR_CATEGORY_CONTROL_CHAR</info> (Cc)<info>IntlChar::CHAR_CATEGORY_FORMAT_CHAR</info>
  (Cf)<info>IntlChar::CHAR_CATEGORY_LINE_SEPARATOR</info> (Zl)<info>IntlChar::CHAR_CATEGORY_PARAGRAPH_SEPARATOR</info> (Zp)

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool|null</info>  Returns <info>true</info> if <strong>$codepoint</strong> is a control character, <info>false</info> if not. Returns <info>null</info> on
             failure.

<comment>See Also:</comment>
   * <strong>IntlChar::isprint()</strong>
   * <info>IntlChar::PROPERTY_DEFAULT_IGNORABLE_CODE_POINT</info>
   * <strong>ctype_cntrl()</strong>


id: IntlChar::isdefined
type: function
doc:
<comment>Description:</comment>
  Check whether the code point is defined
  
  Determines whether the specified code point is "defined", which usually means that it is assigned
  a character.
  
  <info>true</info> for general categories other than "Cn" (other, not assigned).
  
  Note that non-character code points (e.g., U+FDD0) are not "defined" (they are Cn), but surrogate
  code points are "defined" (Cs).

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool|null</info>  Returns <info>true</info> if <strong>$codepoint</strong> is a defined character, <info>false</info> if not. Returns <info>null</info> on
             failure.

<comment>See Also:</comment>
   * <strong>IntlChar::isdigit()</strong>
   * <strong>IntlChar::isalpha()</strong>
   * <strong>IntlChar::isalnum()</strong>
   * <strong>IntlChar::isupper()</strong>
   * <strong>IntlChar::islower()</strong>
   * <strong>IntlChar::istitle()</strong>


id: IntlChar::isdigit
type: function
doc:
<comment>Description:</comment>
  Check if code point is a digit character
  
  Determines whether the specified code point is a digit character.
  
  <info>true</info> for characters with general category "Nd" (decimal digit numbers). Beginning with Unicode 4,
  this is the same as testing for the Numeric_Type of Decimal.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool|null</info>  Returns <info>true</info> if <strong>$codepoint</strong> is a digit character, <info>false</info> if not. Returns <info>null</info> on failure.

<comment>See Also:</comment>
   * <strong>IntlChar::isalpha()</strong>
   * <strong>IntlChar::isalnum()</strong>
   * <strong>IntlChar::isxdigit()</strong>
   * <strong>ctype_digit()</strong>


id: IntlChar::isgraph
type: function
doc:
<comment>Description:</comment>
  Check if code point is a graphic character
  
  Determines whether the specified code point is a "graphic" character (printable, excluding
  spaces).
  
  <info>true</info> for all characters except those with general categories "Cc" (control codes), "Cf" (format
  controls), "Cs" (surrogates), "Cn" (unassigned), and "Z" (separators).

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool|null</info>  Returns <info>true</info> if <strong>$codepoint</strong> is a "graphic" character, <info>false</info> if not. Returns <info>null</info> on
             failure.

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


id: IntlChar::islower
type: function
doc:
<comment>Description:</comment>
  Check if code point is a lowercase letter
  
  Determines whether the specified code point has the general category "Ll" (lowercase letter).
  
  This misses some characters that are also lowercase but have a different general category value.
  In order to include those, use <strong>IntlChar::isULowercase()</strong>.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool|null</info>  Returns <info>true</info> if <strong>$codepoint</strong> is an Ll lowercase letter, <info>false</info> if not. Returns <info>null</info> on
             failure.

<comment>See Also:</comment>
   * <strong>IntlChar::isupper()</strong>
   * <strong>IntlChar::istitle()</strong>
   * <strong>IntlChar::tolower()</strong>
   * <strong>IntlChar::toupper()</strong>
   * <info>IntlChar::PROPERTY_LOWERCASE</info>
   * <strong>ctype_lower()</strong>


id: IntlChar::isprint
type: function
doc:
<comment>Description:</comment>
  Check if code point is a printable character
  
  Determines whether the specified code point is a printable character.
  
  <info>true</info> for general categories other than "C" (controls).

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool|null</info>  Returns <info>true</info> if <strong>$codepoint</strong> is a printable character, <info>false</info> if not. Returns <info>null</info> on
             failure.

<comment>See Also:</comment>
   * <strong>IntlChar::iscntrl()</strong>
   * <info>IntlChar::PROPERTY_DEFAULT_IGNORABLE_CODE_POINT</info>
   * <strong>ctype_print()</strong>


id: IntlChar::ispunct
type: function
doc:
<comment>Description:</comment>
  Check if code point is punctuation character
  
  Determines whether the specified code point is a punctuation character.
  
  <info>true</info> for characters with general categories "P" (punctuation).

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool|null</info>  Returns <info>true</info> if <strong>$codepoint</strong> is a punctuation character, <info>false</info> if not. Returns <info>null</info> on
             failure.

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


id: IntlChar::isspace
type: function
doc:
<comment>Description:</comment>
  Check if code point is a space character
  
  Determines if the specified character is a space character or not.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool|null</info>  Returns <info>true</info> if <strong>$codepoint</strong> is a space character, <info>false</info> if not. Returns <info>null</info> on failure.

<comment>See Also:</comment>
   * <strong>IntlChar::isJavaSpaceChar()</strong>
   * <strong>IntlChar::isWhitespace()</strong>
   * <strong>IntlChar::isUWhiteSpace()</strong>
   * <strong>ctype_space()</strong>


id: IntlChar::istitle
type: function
doc:
<comment>Description:</comment>
  Check if code point is a titlecase letter
  
  Determines whether the specified code point is a titlecase letter.
  
  <info>true</info> for general category "Lt" (titlecase letter).

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool|null</info>  Returns <info>true</info> if <strong>$codepoint</strong> is a titlecase letter, <info>false</info> if not. Returns <info>null</info> on
             failure.

<comment>See Also:</comment>
   * <strong>IntlChar::isupper()</strong>
   * <strong>IntlChar::islower()</strong>
   * <strong>IntlChar::totitle()</strong>


id: IntlChar::isupper
type: function
doc:
<comment>Description:</comment>
  Check if code point has the general category "Lu" (uppercase letter)
  
  Determines whether the specified code point has the general category "Lu" (uppercase letter).
  
  This misses some characters that are also uppercase but have a different general category value.
  In order to include those, use <strong>IntlChar::isUUppercase()</strong>.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool|null</info>  Returns <info>true</info> if <strong>$codepoint</strong> is an Lu uppercase letter, <info>false</info> if not. Returns <info>null</info> on
             failure.

<comment>See Also:</comment>
   * <strong>IntlChar::islower()</strong>
   * <strong>IntlChar::istitle()</strong>
   * <strong>IntlChar::tolower()</strong>
   * <strong>IntlChar::toupper()</strong>
   * <info>IntlChar::PROPERTY_UPPERCASE</info>
   * <strong>ctype_upper()</strong>


id: IntlChar::isxdigit
type: function
doc:
<comment>Description:</comment>
  Check if code point is a hexadecimal digit
  
  Determines whether the specified code point is a hexadecimal digit.
  
  <info>true</info> for characters with general category "Nd" (decimal digit numbers) as well as Latin letters
  a-f and A-F in both ASCII and Fullwidth ASCII. (That is, for letters with code points 0041..0046,
  0061..0066, FF21..FF26, FF41..FF46.)
  
  This is equivalent to <return>IntlChar::digit($codepoint, 16) &gt;= 0</return>.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool|null</info>  Returns <info>true</info> if <strong>$codepoint</strong> is a hexadecimal character, <info>false</info> if not. Returns <info>null</info> on
             failure.

<comment>See Also:</comment>
   * <strong>IntlChar::isdigit()</strong>
   * <strong>ctype_xdigit()</strong>


id: IntlChar::ord
type: function
doc:
<comment>Description:</comment>
  Return Unicode code point value of character
  
  Returns the Unicode code point value of the given character.
  
  This function complements <strong>IntlChar::chr()</strong>.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$character</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>int|null</info>  Returns the Unicode code point value as an integer.

<comment>See Also:</comment>
   * <strong>IntlChar::chr()</strong>
   * <strong>mb_ord()</strong>
   * <strong>ord()</strong>


id: IntlChar::tolower
type: function
doc:
<comment>Description:</comment>
  Make Unicode character lowercase
  
  The given character is mapped to its lowercase equivalent. If the character has no lowercase
  equivalent, the original character itself is returned.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>int|string|null</info>  Returns the Simple_Lowercase_Mapping of the code point, if any; otherwise the
                   code point itself. Returns <info>null</info> on failure.
                   
                   返回类型是 <info>int</info>，如果代码点作为 UTF-8 <info>string</info> 传递，则会返回 <info>string</info> 。失败时返回
                   <info>null</info>。

<comment>See Also:</comment>
   * <strong>IntlChar::totitle()</strong>
   * <strong>IntlChar::toupper()</strong>
   * <strong>mb_strtolower()</strong>


id: IntlChar::totitle
type: function
doc:
<comment>Description:</comment>
  Make Unicode character titlecase
  
  The given character is mapped to its titlecase equivalent. If the character has no titlecase
  equivalent, the original character itself is returned.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>int|string|null</info>  Returns the Simple_Titlecase_Mapping of the code point, if any; otherwise the
                   code point itself. Returns <info>null</info> on failure.
                   
                   返回类型是 <info>int</info>，如果代码点作为 UTF-8 <info>string</info> 传递，则会返回 <info>string</info> 。失败时返回
                   <info>null</info>。

<comment>See Also:</comment>
   * <strong>IntlChar::tolower()</strong>
   * <strong>IntlChar::toupper()</strong>
   * <strong>mb_convert_case()</strong>


id: IntlChar::toupper
type: function
doc:
<comment>Description:</comment>
  Make Unicode character uppercase
  
  The given character is mapped to its uppercase equivalent. If the character has no uppercase
  equivalent, the character itself is returned.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$codepoint</strong>  The <info>int</info> codepoint value (e.g. <return>0x2603</return> for U+2603 SNOWMAN), or the character
                          encoded as a UTF-8 <info>string</info> (e.g. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>int|string|null</info>  Returns the Simple_Uppercase_Mapping of the code point, if any; otherwise the
                   code point itself.
                   
                   返回类型是 <info>int</info>，如果代码点作为 UTF-8 <info>string</info> 传递，则会返回 <info>string</info> 。失败时返回
                   <info>null</info>。

<comment>See Also:</comment>
   * <strong>IntlChar::tolower()</strong>
   * <strong>IntlChar::totitle()</strong>
   * <strong>mb_strtoupper()</strong>


