Imagick::borderImage() method in PHP

The Imagick::borderImage() method is a PHP intrinsic function that draws a border around an image. This method adds a border around the image in the specified colour.

Syntax:

Parameters

This function takes three parameters, which are listed above and described below:

$bordercolor: This argument is either an ImagickPixel object or a string that contains the border colour.

$width:The border width is controlled by the $width option.

$height: This argument is used to specify the height of the border.

Return Type

The return type of the border Image function in PHP is of the Boolean type, which means the return type of this function will be either true or false depending upon the success or failure of the operation. The return type of the border Image function is true if the border is successfully created around the specified input image on the other hand if the border creation operation around the specified input image is failed then the return type of the border Image function is changed to false.

Code

<?php
function borderImage($imagePath, $color, $width, $height) {
    $imagick = new \Imagick(realpath($imagePath));
    $imagick->borderImage($color, $width, $height);
    header("Content-Type: image/jpg");
    echo $imagick->getImageBlob();
}

?>

Output:

Example:

class QRimage {


    //----------------------------------------------------------------------
    public static function png($frame, $filename = false, $pixelPerPoint = 4, $outerFrame = 4,$save = TRUE, $print = false) 
    {
        $image = self::image($frame, $pixelPerPoint, $outerFrame, "png", 85, $filename, $save, $print);
    }

    //----------------------------------------------------------------------
    public static function jpg($frame, $filename = false, $pixelPerPoint = 8, $outerFrame = 4, $q = 85,$save = TRUE, $print = false) 
    {
        $image = self::image($frame, $pixelPerPoint, $outerFrame, "jpeg", $q, $filename, $save, $print);
    }

    //----------------------------------------------------------------------
    private static function image($frame, $pixelPerPoint = 4, $outerFrame = 4, $format = "png", $quality = 85, $filename = FALSE, $save = TRUE, $print = false) 
    {
        $imgH = count($frame);
        $imgW = strlen($frame[0]);

        $col[0] = new \ImagickPixel("white");
        $col[1] = new \ImagickPixel("black");

        $image = new \Imagick();
        $image->newImage($imgW, $imgH, $col[0]);

        $image->setCompressionQuality($quality);
        $image->setImageFormat($format); 

        $draw = new \ImagickDraw();
        $draw->setFillColor($col[1]);

        for($y=0; $y<$imgH; $y++) {
            for($x=0; $x<$imgW; $x++) {
                if ($frame[$y][$x] == '1') {
                    $draw->point($x,$y); 
                }
            }
        }

        $image->drawImage($draw);
        $image->borderImage($col[0],$outerFrame,$outerFrame);
        $image->scaleImage( ($imgW + 2*$outerFrame) * $pixelPerPoint, 0 );

        if($save){
            if($filename === false){
                throw new Exception("QR Code filename can't be empty");
            }
            $image->writeImages($filename, true); 
        }

        if($print){
                Header("Content-type: image/" . $format);
                echo $image;
        }
    }    
}

Output:

In this example, we have seen the use of the Border image function in PHP along with other major functions provided by PHP like set compress quality set image format set the fill colour and some others so in this example we have followed the sequence like that first of all we have created two image pixel objects one is of white and another is of black colour after the creation of these two image pixel objects we have used the draw image function to draw the basic image after the successful creation of the image that next function that we have used as a Border image function the border Image function is used to fill the border of the image with a particular colour specified by us after the successful filling of the border colour of that particular image the next step is to scale that image and save the result with the use of write Image function.

Example2:

 protected function _save_function($extension, &$quality)
 {
     switch (strtolower($extension)) {
         case 'jpg':
         case 'jpeg':
             $type = IMAGETYPE_JPEG;
             if ($this->type == "png" || $this->type == "gif") {
                 $this->im->borderImage(new ImagickPixel("white"), 1, 1);
             }
             $this->im->setImageFormat('jpeg');
             break;
         case 'gif':
             $type = IMAGETYPE_GIF;
             $this->im->setImageFormat('gif');
             break;
         case 'png':
             $type = IMAGETYPE_PNG;
             $this->im->setImageFormat('png');
             break;
         default:
             throw new waException(_ws(sprintf('Installed ImageMagick does not support %s images', $extension)));
             break;
     }
     $quality = $quality - 5;
     return $type;
 }

Output:

This is another example in which we have used the border Image function to distinguish between the different types of the extensions of our input image file. here in this example we have different cases depending upon the file extension of the input image file these cases are like assuming the input extension of the input image file is of gif format or PNG format or it is of JPG or JPEG format. depending upon the input Image extension we have defined the different set of instructions for each of these cases and for that we have used border-image function provided by PHP to change the border colour of the input image having different type of extension as specified in our above written example.

Thus, in this article, we have seen how we can use the border Image function in PHP to change the colour of the border of the input image we can change the border colour of the input image according to our need by specifying the particular colour as a parameter to our border Image function.

Next TopicImagick rotateImage() Function

← prev next →