Add doc comments on saveHTMLFile; drop the extra <div> wrapping the contents to make it easier to extract without getting extra markup.

This commit is contained in:
Brion Vibber 2010-03-17 15:49:10 -07:00 committed by Sarven Capadisli
parent 511a164c99
commit 013647f0ba
1 changed files with 9 additions and 1 deletions

View File

@ -1676,10 +1676,18 @@ class Ostatus_profile extends Memcached_DataObject
throw new Exception("Couldn't find a valid profile for '$addr'");
}
/**
* Store the full-length scrubbed HTML of a remote notice to an attachment
* file on our server. We'll link to this at the end of the cropped version.
*
* @param string $title plaintext for HTML page's title
* @param string $rendered HTML fragment for HTML page's body
* @return File
*/
function saveHTMLFile($title, $rendered)
{
$final = sprintf("<!DOCTYPE html>\n<html><head><title>%s</title></head>".
'<body><div>%s</div></body></html>',
'<body>%s</body></html>',
htmlspecialchars($title),
$rendered);