Get first line

Created by axiac, last update on 26/02/2008 17:32

Truncate a given multi-line string by returning only a limited length substring from its first line. Add suspension points or other (provided) continuation mark if the string is truncated in-process; the input string is returned as-is if it does not contain new-line characters and its length is smaller than required.

function ltGetFirstLine($text, $maxChars = 0, $cont = '...')
{
  // Verify parameters
  $maxChars = max(0, intval($maxChars));
  if ($maxChars > 0)
    $cont = substr($cont, 0, $maxChars);
 
  // If the text has more than one line then keep the first one 
  // and replace the rest with continuation fragment
  $text = preg_replace('/[\r\n].*$/s', $cont, $text, 1);
 
  // Keep only the required amount of characters (if specified) 
  // and append continuation if needed
  if ($maxChars > 0 && strlen($text) > $maxChars)
    return substr($text, 0, $maxChars - strlen($cont)) . $cont;
  else
    return $text;
}

Dependencies

No special requirements are needed by this snippet

By logging in you will be able to:

• Recommand this page to someone else
• Monitor changes on this item
• Rate this item
• Post comments
• Download this item