PHP | ImagickDraw comment() Function

The ImagickDraw::comment() function is an inbuilt function in PHP which is used to add a comment to a vector output stream. The comment is appended at the end of the output stream.

Syntax:

bool ImagickDraw::comment( string $comment )

Parameters: This function accept a single parameter $comment which holds the comment.

Return Value: This function returns TRUE on success.

Exceptions: This function throws ImagickException on error.

Below given program illustrates the ImagickDraw::comment() function in PHP:

Program 1:

<?php

//Create a new Imagick object
$imagick = new Imagick();

// Create a image on imagick object
$imagick->newImage(800, 250, 'white');

// Create a new ImagickDraw object
$draw = new ImagickDraw();

// Add comment
$draw->comment('Hello ! This is my comment.');

// Get the vector graphics as string
$graphics = $draw->getVectorGraphics();

// Get comment from vector graphics
$comment = substr($graphics, 807);
echo $comment;
?>

Output:

Hello ! This is my comment.

Program 2:

<?php

//Create a new Imagick object
$imagick = new Imagick();

// Create a image on imagick object
$imagick->newImage(800, 250, 'white');

// Create a new ImagickDraw object
$draw = new ImagickDraw();

$string = 'This is my comment';

// Add comment
$draw->comment($string);

// Get the vector graphics
$graphics = $draw->getVectorGraphics();

// Get comment from vector graphics
$getComment = substr($graphics, 807, strlen($string));

// Set the font size
$draw->setFontSize(50);

// Write on image
$draw->annotation(50, 100, $getComment);

// Render the draw commands
$imagick->drawImage($draw);

// Show the output
$imagick->setImageFormat('png');
header("Content-Type: image/png");
echo $imagick->getImageBlob();
?>

Output:

Reference: https://www.php.net/manual/en/imagickdraw.comment.php