Refs #2360: Deprecated page_draw in favor of elgg_view_page. Updated packaged documentation to reflect this.

git-svn-id: http://code.elgg.org/elgg/trunk@7208 36083f99-b078-4883-b0ff-0f9b5a30f544

2 files changed, 14 insertions, 11 deletions

diff --git a/documentation/examples/hooks/register/advanced.php b/documentation/examples/hooks/register/advanced.php
index a21a2e232..627bb5454 100644
--- a/documentation/examples/hooks/register/advanced.php
+++ b/documentation/examples/hooks/register/advanced.php
@@ -1,6 +1,6 @@
 <?php
 
-// the output:page hook is triggered by page_draw().
+// the output:page hook is triggered by elgg_view_page().
 register_plugin_hook('output', 'page', 'example_plugin_hook_handler', 600);
 register_plugin_hook('output', 'page', 'example_plugin_hook_handler_2', 601);
 
@@ -11,7 +11,7 @@ function example_plugin_hook_handler($event, $type, $value, $params) {
 	return $value;
 }
 
-function example_plugin_hook_handler($event, $type, $value, $params) {
+function example_plugin_hook_handler_2($event, $type, $value, $params) {
 	// change S to $
 	$value = str_replace('S', '$', $value);
 	
@@ -20,4 +20,4 @@ function example_plugin_hook_handler($event, $type, $value, $params) {
 
 $content = 'This is some Sample Content.';
 
-page_draw('Title', $content);
\ No newline at end of file
+echo elgg_view_page('Title', $content);
\ No newline at end of file
diff --git a/engine/lib/views.php b/engine/lib/views.php
index 82be10118..f9ceafd2d 100644
--- a/engine/lib/views.php
+++ b/engine/lib/views.php
@@ -1303,9 +1303,10 @@ function autoregister_views($view_base, $folder, $base_location_path, $viewtype)
  * @param array  $vars       Optional vars array to pass to the page
  *                           shell. Automatically adds title, body, and sysmessages
  *
- * @return NULL
+ * @return string The contents of the page
+ * @since  1.8
  */
-function page_draw($title, $body, $page_shell = 'page_shells/default', $vars = array()) {
+function elgg_view_page($title, $body, $page_shell = 'page_shells/default', $vars = array()) {
 	// get messages - try for errors first
 	$sysmessages = system_messages(NULL, "errors");
 
@@ -1327,13 +1328,15 @@ function page_draw($title, $body, $page_shell = 'page_shells/default', $vars = a
 	$vars['page_shell'] = $page_shell;
 
 	// Allow plugins to mod output
-	$output = trigger_plugin_hook('output', 'page', $vars, $output);
-
-	$split_output = str_split($output, 1024);
+	return trigger_plugin_hook('output', 'page', $vars, $output);
+}
 
-	foreach ($split_output as $chunk) {
-		echo $chunk;
-	}
+/**
+ * @deprecated 1.8 Use elgg_view_page()
+ */
+function page_draw($title, $body, $page_shell = 'page_shells/default', $vars = array()) {
+	elgg_deprecated_notice("page_draw() was deprecated in favor of elgg_view_page() in 1.8.", 1.8);
+	echo elgg_view_page($title, $body, $page_shell, $vars);
 }
 
 /**