How can I wrap text using Imagick in PHP so that it is drawn as multiline text?

Question

The Imagick library in PHP allows you to draw text on top of an image.

How can I tell Imagick to wrap the text based upon some bounded text box, so that the words appear as multiline text rather than a single line?

BMiner · Answer 1 · 2011-08-17T05:54:20.847

Usage:

list($lines, $lineHeight) = wordWrapAnnotation($image, $draw, $msg, 140);
for($i = 0; $i < count($lines); $i++)
    $image->annotateImage($draw, $xpos, $ypos + $i*$lineHeight, 0, $lines[$i]);

Function:

/* Implement word wrapping... Ughhh... why is this NOT done for me!!!
    OK... I know the algorithm sucks at efficiency, but it's for short messages, okay?

    Make sure to set the font on the ImagickDraw Object first!
    @param image the Imagick Image Object
    @param draw the ImagickDraw Object
    @param text the text you want to wrap
    @param maxWidth the maximum width in pixels for your wrapped "virtual" text box
    @return an array of lines and line heights
*/
function wordWrapAnnotation(&$image, &$draw, $text, $maxWidth)
{
    $words = explode(" ", $text);
    $lines = array();
    $i = 0;
    $lineHeight = 0;
    while($i < count($words) )
    {
        $currentLine = $words[$i];
        if($i+1 >= count($words))
        {
            $lines[] = $currentLine;
            break;
        }
        //Check to see if we can add another word to this line
        $metrics = $image->queryFontMetrics($draw, $currentLine . ' ' . $words[$i+1]);
        while($metrics['textWidth'] <= $maxWidth)
        {
            //If so, do it and keep doing it!
            $currentLine .= ' ' . $words[++$i];
            if($i+1 >= count($words))
                break;
            $metrics = $image->queryFontMetrics($draw, $currentLine . ' ' . $words[$i+1]);
        }
        //We can't add the next word to this line, so loop to the next line
        $lines[] = $currentLine;
        $i++;
        //Finally, update line height
        if($metrics['textHeight'] > $lineHeight)
            $lineHeight = $metrics['textHeight'];
    }
    return array($lines, $lineHeight);
}

I am trying this with non english words, but they keep showing up as 这 Any suggestions? — Kim Stacks, Jun 19 '12 at 12:58
well it is working good but when the words longer than canvas width the function can not do line break. it can not break "longwordsxxxxxyyyyyyzzzzzzzzz........." now i m working on some sollution. if i can i ll post — Onur Öztürk, Nov 04 '14 at 12:15

score 12 · Accepted Answer · edited May 23 '17 at 11:46

I have been using @Sarke's version successfully for a while, but I noticed there is an infinite loop if a word is longer than the $maxWidth. Here is a version that fixes the infinite loop:

function wordWrapAnnotation($image, $draw, $text, $maxWidth)
{   
    $text = trim($text);

    $words = preg_split('%\s%', $text, -1, PREG_SPLIT_NO_EMPTY);
    $lines = array();
    $i = 0;
    $lineHeight = 0;

    while (count($words) > 0)
    {   
        $metrics = $image->queryFontMetrics($draw, implode(' ', array_slice($words, 0, ++$i)));
        $lineHeight = max($metrics['textHeight'], $lineHeight);

        // check if we have found the word that exceeds the line width
        if ($metrics['textWidth'] > $maxWidth or count($words) < $i) 
        {   
            // handle case where a single word is longer than the allowed line width (just add this as a word on its own line?)
            if ($i == 1)
                $i++;

            $lines[] = implode(' ', array_slice($words, 0, --$i));
            $words = array_slice($words, $i);
            $i = 0;
        }   
    }   

    return array($lines, $lineHeight);
}

score 8 · Answer 3 · answered Feb 05 '14 at 08:53

I found a bug with @BMiner's function where it returns a lineheight of 0 when there is only one word.

I ended up re-writing it in one loop using array functions. I kept the parameters the same so it works with current implementations.

I used preg_split instead so it works well with extra or double spaces, tabs, and line-breaks.

function wordWrapAnnotation($image, $draw, $text, $maxWidth)
{
    $words = preg_split('%\s%', $text, -1, PREG_SPLIT_NO_EMPTY);
    $lines = array();
    $i = 0;
    $lineHeight = 0;

    while (count($words) > 0)
    {
        $metrics = $image->queryFontMetrics($draw, implode(' ', array_slice($words, 0, ++$i)));
        $lineHeight = max($metrics['textHeight'], $lineHeight);

        if ($metrics['textWidth'] > $maxWidth or count($words) < $i)
        {
            $lines[] = implode(' ', array_slice($words, 0, --$i));
            $words = array_slice($words, $i);
            $i = 0;
        }
    }

    return array($lines, $lineHeight);
}

score 1 · Answer 4 · answered Mar 20 '15 at 16:28

here is my version for one line text container

function GetTextSize($font,$text,$max_weight,$max_width){
$size = $max_weight;
$imagick=new Imagick();
while (true){
    $draw = new ImagickDraw();
    $draw->setFontSize($size);
    $draw->setfont($font);
    $bbox2=$imagick->queryFontMetrics($draw,$text);
    $width_of_text = $bbox2[textWidth];
    if ($width_of_text > $max_width){
        $size -= 1;
    }else{
        break;
        }
    }
    return $size;
}
$draw = new ImagickDraw();
$font="path_to_font.ttf";
$text="Love Happyness Freedom";
$output = new Imagick('path_to_image.jpg');
$output->setGravity(Imagick::GRAVITY_CENTER);
$fontsize=GetTextSize($font,$text,70,600);
$draw->setfont($font);
$draw->setFontSize($fontsize);
$draw->annotation(000, 000, $text);
$output->drawImage($draw);
$output->setImageFormat('jpg');
header('Content-Type: image/jpg');
print $output;

Onur Öztürk · Answer 5 · 2014-11-05T06:01:11.160

Hi i find some sollution thanks for BMinner for his code i edit his code and get good working sollution

USAGE

<?
   $w = 210;
 $h = 520;


$canvas = new Imagick();
$canvas->newImage($w,$h,new ImagickPixel('green'),'png');


$draw = new ImagickDraw();
$draw->setFontSize(25);

$text="SomeTextWithoutSpacesAndGoingOn..xxxxx <br><br>some short words with spaces <br><br>and some text<br>with manuel page<br>break <br><br>and also multiple spaces                      spaces end. also w i t o n e c ha ra c ter";

 list($lines, $lineHeight)= wordWrapAnnotation($canvas, $draw, $text, $w-20);

 $canvas->annotateImage($draw, 10, $lineHeight , 0, $lines);

 header("Content-Type: image/png");
   echo $canvas;

?>

FUNCTIONS REFERANCED FROM BMinner

<?
//this is unicode split method for out of english latin characters
function str_split_unicode($str, $l = 0) {
    if ($l > 0) {
        $ret = array();
        $len = mb_strlen($str, "UTF-8");
        for ($i = 0; $i < $len; $i += $l) {
            $ret[] = mb_substr($str, $i, $l, "UTF-8");
        }
        return $ret;
    }
    return preg_split("//u", $str, -1, PREG_SPLIT_NO_EMPTY);
} 










//this is my function detects long words and split them 

 function check_long_words($image,$draw,$text,$maxWidth) {
    $metrics = $image->queryFontMetrics($draw, $text);
    if($metrics['textWidth'] <= $maxWidth)
    return array($text);

$words = str_split_unicode($text);



$i = 0;

 while($i < count($words) )
    {
        $currentLine = $words[$i];
        if($i+1 >= count($words))
        {

             $lines[] = $currentLine;
            //$lines = $lines + $checked;
            break;
        }
        //Check to see if we can add another word to this line
        $metrics = $image->queryFontMetrics($draw, $currentLine . $words[$i+1]);

        while($metrics['textWidth'] <= $maxWidth)
        {
            //If so, do it and keep doing it!
            $currentLine .= $words[++$i];
            if($i+1 >= count($words))
                break;
            $metrics = $image->queryFontMetrics($draw, $currentLine . ' ' . $words[$i+1]);
            $t++;
        }
        //We can't add the next word to this line, so loop to the next line


            $lines[] = $currentLine;

        $i++;

    }


return $lines;

}   








//this is BMiner code some fixes for manule breaks
function wordWrapAnnotation(&$image, &$draw, $text, $maxWidth)
{
    $brler = explode("<br>", $text);
    $lines = array();


    foreach($brler as $br)
    {
        $i = 0;


$words = explode(" ", $br);


 while($i < count($words) )
    {

        $currentLine = $words[$i];


 $metrics = $image->queryFontMetrics($draw, $currentLine . ' ' . $words[$i+1]);        

        if($i+1 >= count($words))
        {
            $checked=check_long_words($image,$draw,$currentLine,$maxWidth);
            $lines = array_merge($lines, $checked);

            if($metrics['textHeight'] > $lineHeight)
            $lineHeight = $metrics['textHeight'];
            //$lines = $lines + $checked;
            break;
        }
        //Check to see if we can add another word to this line


        while($metrics['textWidth'] <= $maxWidth)
        {
            //If so, do it and keep doing it!
            $currentLine .= ' ' . $words[++$i];
            if($i+1 >= count($words))
                break;
            $metrics = $image->queryFontMetrics($draw, $currentLine . ' ' . $words[$i+1]);
            $t++;
        }
        //We can't add the next word to this line, so loop to the next line

        $checked=check_long_words($image,$draw,$currentLine,$maxWidth);
            $lines = array_merge($lines, $checked);

        $i++;
        //Finally, update line height
        if($metrics['textHeight'] > $lineHeight)
            $lineHeight = $metrics['textHeight'];
    }




    }
    return array(join("\n",$lines), $lineHeight);



}

?>

AND OUTPUT

enter image description here

I'm afraid your function does not work as expected. Errors like $t and some $i indexes are not defined. — Ivo Pereira, Nov 24 '14 at 20:04
disable notice error reporting from your php.ini as bellow error_reporting = E_ALL & ~E_NOTICE @IvoPereira — Onur Öztürk, Nov 25 '14 at 12:01
That is a bad practise Sir. You should fix your code with all error reporting tuned on. — Ivo Pereira, Nov 25 '14 at 12:16
notice error mostly not enabled in host packages so most of coders does not define variables. — Onur Öztürk, Nov 25 '14 at 13:08

How can I wrap text using Imagick in PHP so that it is drawn as multiline text?

5 Answers5

Linked