Add some documentation for import functions.

1 files changed, 46 insertions, 45 deletions

diff --git a/Zotlabs/Module/Import_items.php b/Zotlabs/Module/Import_items.php
index f20cbfe7e..133e37d9e 100644
--- a/Zotlabs/Module/Import_items.php
+++ b/Zotlabs/Module/Import_items.php
@@ -3,54 +3,58 @@ namespace Zotlabs\Module;
 
 require_once('include/import.php');
 
-
+/**
+ * @brief Module for importing items.
+ *
+ * Import existing posts and content from an export file.
+ */
 class Import_items extends \Zotlabs\Web\Controller {
 
 	function post() {
-	
+
 		if(! local_channel())
 			return;
-	
+
 		$data     = null;
-	
+
 		$src      = $_FILES['filename']['tmp_name'];
 		$filename = basename($_FILES['filename']['name']);
 		$filesize = intval($_FILES['filename']['size']);
 		$filetype = $_FILES['filename']['type'];
-	
+
 		if($src) {
 			// This is OS specific and could also fail if your tmpdir isn't very large
 			// mostly used for Diaspora which exports gzipped files.
-	
+
 			if(strpos($filename,'.gz')){
 				@rename($src,$src . '.gz');
 				@system('gunzip ' . escapeshellarg($src . '.gz'));
 			}
-	
+
 			if($filesize) {
 				$data = @file_get_contents($src);
 			}
 			unlink($src);
 		}
-	
+
 		if(! $src) {
-	
+
 			$old_address = ((x($_REQUEST,'old_address')) ? $_REQUEST['old_address'] : '');
-	
+
 			if(! $old_address) {
-				logger('mod_import: nothing to import.');
+				logger('Nothing to import.');
 				notice( t('Nothing to import.') . EOL);
 				return;
 			}
-	
+
 			$email    = ((x($_REQUEST,'email'))    ? $_REQUEST['email']    : '');
 			$password = ((x($_REQUEST,'password')) ? $_REQUEST['password'] : '');
-	
+
 			$year = ((x($_REQUEST,'year'))    ? $_REQUEST['year']    : '');
-	
+
 			$channelname = substr($old_address,0,strpos($old_address,'@'));
 			$servername  = substr($old_address,strpos($old_address,'@')+1);
-	
+
 			$scheme = 'https://';
 			$api_path = '/api/red/channel/export/items?f=&channel=' . $channelname . '&year=' . intval($year);
 			$binary = false;
@@ -64,68 +68,65 @@ class Import_items extends \Zotlabs\Web\Controller {
 				$data = $ret['body'];
 			else
 				notice( t('Unable to download data from old server') . EOL);
-	
 		}
-	
+
 		if(! $data) {
-			logger('mod_import: empty file.');
+			logger('Empty file.');
 			notice( t('Imported file is empty.') . EOL);
 			return;
 		}
-	
-		$data = json_decode($data,true);
-	
-	//	logger('import: data: ' . print_r($data,true));
-	//	print_r($data);
-	
+
+		$data = json_decode($data, true);
+
+		//logger('import: data: ' . print_r($data,true));
+		//print_r($data);
+
 		if(! is_array($data))
 			return;
-	
+
 		if(array_key_exists('compatibility',$data) && array_key_exists('database',$data['compatibility'])) {
 			$v1 = substr($data['compatibility']['database'],-4);
 			$v2 = substr(DB_UPDATE_VERSION,-4);
 			if($v2 > $v1) {
-				$t = sprintf( t('Warning: Database versions differ by %1$d updates.'), $v2 - $v1 ); 
-				notice($t);
+				$t = sprintf( t('Warning: Database versions differ by %1$d updates.'), $v2 - $v1 );
+				notice($t . EOL);
 			}
 		}
-	
+
 		$channel = \App::get_channel();
-	
-	
+
 		if(array_key_exists('item',$data) && $data['item']) {
 			import_items($channel,$data['item'],false,((array_key_exists('relocate',$data)) ? $data['relocate'] : null));
 		}
-	
+
 		if(array_key_exists('item_id',$data) && $data['item_id']) {
 			import_item_ids($channel,$data['item_id']);
 		}
-	
+
 		info( t('Import completed') . EOL);
-		return;
 	}
-	
-	
-	
-	
+
+
+	/**
+	 * @brief Generate item import page.
+	 *
+	 * @return string with parsed HTML.
+	 */
 	function get() {
-	
+
 		if(! local_channel()) {
 			notice( t('Permission denied') . EOL);
 			return login();
 		}
-	
-		$o = replace_macros(get_markup_template('item_import.tpl'),array(
+
+		$o = replace_macros(get_markup_template('item_import.tpl'), array(
 			'$title' => t('Import Items'),
 			'$desc' => t('Use this form to import existing posts and content from an export file.'),
 			'$label_filename' => t('File to Upload'),
 			'$submit' => t('Submit')
 		));
-	
+
 		return $o;
-	
 	}
-	
-	
-	
+
 }