evolution-cms / evolution

install/instprocessor.php

Doc Comments +1 added lines, -1 removed lines

@@ -130,7 +130,7 @@
      * duplicate of method in documentParser class
      *
      * @param string $propertyString
-     * @return array
+     * @return string
      */
     function parseProperties($propertyString) {
         $parameter= array ();

manager/actions/files.dynamic.php

Doc Comments +2 added lines, -2 removed lines

@@ -719,7 +719,7 @@ 
 
 /**
  * @param string $string
- * @return bool|string
+ * @return string|false
  */
 function removeLastPath($string)
 {
@@ -734,7 +734,7 @@ 
 
 /**
  * @param string $string
- * @return bool|string
+ * @return string|false
  */
 function getExtension($string)
 {

manager/actions/import_site.static.php

Doc Comments +1 added lines, -1 removed lines

@@ -344,7 +344,7 @@
 
 /**
  * @param string $filepath
- * @return bool|string
+ * @return null|string
  */
 function getFileContent($filepath) {
 	global $_lang;

Indentation +333 added lines, -333 removed lines

@@ -1,17 +1,17 @@ 
 <?php
 if( ! defined('IN_MANAGER_MODE') || IN_MANAGER_MODE !== true) {
-	die("<b>INCLUDE_ORDERING_ERROR</b><br /><br />Please use the EVO Content Manager instead of accessing this file directly.");
+    die("<b>INCLUDE_ORDERING_ERROR</b><br /><br />Please use the EVO Content Manager instead of accessing this file directly.");
 }
 if(!$modx->hasPermission('import_static')) {
-	$modx->webAlertAndQuit($_lang["error_no_privileges"]);
+    $modx->webAlertAndQuit($_lang["error_no_privileges"]);
 }
 
 // Files to upload
 $allowedfiles = array(
-	'html',
-	'htm',
-	'shtml',
-	'xml'
+    'html',
+    'htm',
+    'shtml',
+    'xml'
 );
 ?>
 	<script language="javascript">
@@ -43,9 +43,9 @@ 
 	<div class="tab-page">
 		<div class="container container-body">
 			<?php
-			if(!isset($_POST['import'])) {
-				echo "<div class=\"element-edit-message\">" . $_lang['import_site_message'] . "</div>";
-				?>
+            if(!isset($_POST['import'])) {
+                echo "<div class=\"element-edit-message\">" . $_lang['import_site_message'] . "</div>";
+                ?>
 				<form action="index.php" method="post" name="importFrm">
 					<input type="hidden" name="import" value="import" />
 					<input type="hidden" name="a" value="95" />
@@ -85,18 +85,18 @@ 
 					<a href="javascript:;" class="btn btn-primary" onclick="window.importFrm.submit();"><i class="<?= $_style["actions_save"] ?>"></i> <?= $_lang["import_site_start"] ?></a>
 				</form>
 			<?php
-			} else {
-			run();
-			$modx->clearCache('full');
-			?>
+            } else {
+            run();
+            $modx->clearCache('full');
+            ?>
 				<a href="javascript:;" class="btn btn-primary" onclick="window.location.href='index.php?a=2';"><i class="<?= $_style["actions_close"] ?>"></i> <?= $_lang["close"] ?></a>
 				<script type="text/javascript">
 					top.mainMenu.reloadtree();
 					parent.tree.ca = 'open';
 				</script>
 				<?php
-			}
-			?>
+            }
+            ?>
 		</div>
 	</div>
 
@@ -105,64 +105,64 @@ 
  * @return string
  */
 function run() {
-	global $modx, $_lang;
+    global $modx, $_lang;
 
-	$tbl_site_content = $modx->getFullTableName('site_content');
-	$output = '';
-	$maxtime = $_POST['maxtime'];
+    $tbl_site_content = $modx->getFullTableName('site_content');
+    $output = '';
+    $maxtime = $_POST['maxtime'];
 
-	if(!is_numeric($maxtime)) {
-		$maxtime = 30;
-	}
+    if(!is_numeric($maxtime)) {
+        $maxtime = 30;
+    }
 
-	@set_time_limit($maxtime);
+    @set_time_limit($maxtime);
 
-	$mtime = microtime();
-	$mtime = explode(' ', $mtime);
-	$mtime = $mtime[1] + $mtime[0];
-	$importstart = $mtime;
+    $mtime = microtime();
+    $mtime = explode(' ', $mtime);
+    $mtime = $mtime[1] + $mtime[0];
+    $importstart = $mtime;
 
-	if($_POST['reset'] == 'on') {
-		$modx->db->truncate($tbl_site_content);
-		$modx->db->query("ALTER TABLE {$tbl_site_content} AUTO_INCREMENT = 1");
-	}
+    if($_POST['reset'] == 'on') {
+        $modx->db->truncate($tbl_site_content);
+        $modx->db->query("ALTER TABLE {$tbl_site_content} AUTO_INCREMENT = 1");
+    }
 
-	$parent = (int)$_POST['parent'];
+    $parent = (int)$_POST['parent'];
 
-	if(is_dir(MODX_BASE_PATH . 'temp/import')) {
-		$filedir = MODX_BASE_PATH . 'temp/import/';
-	} elseif(is_dir(MODX_BASE_PATH . 'assets/import')) {
-		$filedir = MODX_BASE_PATH . 'assets/import/';
-	} else {
+    if(is_dir(MODX_BASE_PATH . 'temp/import')) {
+        $filedir = MODX_BASE_PATH . 'temp/import/';
+    } elseif(is_dir(MODX_BASE_PATH . 'assets/import')) {
+        $filedir = MODX_BASE_PATH . 'assets/import/';
+    } else {
         $filedir = '';
     }
 
-	$filesfound = 0;
+    $filesfound = 0;
 
-	$files = getFiles($filedir);
-	$files = pop_index($files);
+    $files = getFiles($filedir);
+    $files = pop_index($files);
 
-	// no. of files to import
-	$output .= sprintf('<p>' . $_lang['import_files_found'] . '</p>', $filesfound);
+    // no. of files to import
+    $output .= sprintf('<p>' . $_lang['import_files_found'] . '</p>', $filesfound);
 
-	// import files
-	if(0 < count($files)) {
-		$modx->db->update(array('isfolder' => 1), $tbl_site_content, "id='{$parent}'");
-		importFiles($parent, $filedir, $files, 'root');
-	}
+    // import files
+    if(0 < count($files)) {
+        $modx->db->update(array('isfolder' => 1), $tbl_site_content, "id='{$parent}'");
+        importFiles($parent, $filedir, $files, 'root');
+    }
 
-	$mtime = microtime();
-	$mtime = explode(' ', $mtime);
-	$mtime = $mtime[1] + $mtime[0];
-	$importend = $mtime;
-	$totaltime = ($importend - $importstart);
-	$output .= sprintf('<p>' . $_lang['import_site_time'] . '</p>', round($totaltime, 3));
+    $mtime = microtime();
+    $mtime = explode(' ', $mtime);
+    $mtime = $mtime[1] + $mtime[0];
+    $importend = $mtime;
+    $totaltime = ($importend - $importstart);
+    $output .= sprintf('<p>' . $_lang['import_site_time'] . '</p>', round($totaltime, 3));
 
-	if($_POST['convert_link'] == 'on') {
-		convertLink();
-	}
+    if($_POST['convert_link'] == 'on') {
+        convertLink();
+    }
 
-	return $output;
+    return $output;
 }
 
 /**
@@ -172,144 +172,144 @@ 
  * @param string $mode
  */
 function importFiles($parent, $filedir, $files, $mode) {
-	global $modx;
-	global $_lang, $allowedfiles;
-	global $search_default, $cache_default, $publish_default;
-
-	$tbl_site_content = $modx->getFullTableName('site_content');
-	$tbl_system_settings = $modx->getFullTableName('system_settings');
-
-	$createdby = $modx->getLoginUserID();
-	if(!is_array($files)) {
-		return;
-	}
-	if($_POST['object'] === 'all') {
-		$modx->config['default_template'] = '0';
-		$richtext = '0';
-	} else {
-		$richtext = '1';
-	}
-
-	foreach($files as $id => $value) {
-		if(is_array($value)) {
-			// create folder
-			$alias = $id;
-			printf('<span>' . $_lang['import_site_importing_document'] . '</span>', $alias);
-			$field = array();
-			$field['type'] = 'document';
-			$field['contentType'] = 'text/html';
-			$field['published'] = $publish_default;
-			$field['parent'] = $parent;
-			$field['alias'] = $modx->stripAlias($alias);
-			$field['richtext'] = $richtext;
-			$field['template'] = $modx->config['default_template'];
-			$field['searchable'] = $search_default;
-			$field['cacheable'] = $cache_default;
-			$field['createdby'] = $createdby;
-			$field['isfolder'] = 1;
-			$field['menuindex'] = 1;
-			$find = false;
-			foreach(array(
-						'index.html',
-						'index.htm'
-					) as $filename) {
-				$filepath = $filedir . $alias . '/' . $filename;
-				if($find === false && file_exists($filepath)) {
-					$file = getFileContent($filepath);
-					list($pagetitle, $content, $description) = treatContent($file, $filename, $alias);
-
-					$date = filemtime($filepath);
-					$field['pagetitle'] = $pagetitle;
-					$field['longtitle'] = $pagetitle;
-					$field['description'] = $description;
-					$field['content'] = $modx->db->escape($content);
-					$field['createdon'] = $date;
-					$field['editedon'] = $date;
-					$newid = $modx->db->insert($field, $tbl_site_content);
-					if($newid) {
-						$find = true;
-						echo ' - <span class="success">' . $_lang['import_site_success'] . '</span><br />' . "\n";
-						importFiles($newid, $filedir . $alias . '/', $value, 'sub');
-					} else {
-						echo '<span class="fail">' . $_lang["import_site_failed"] . "</span> " . $_lang["import_site_failed_db_error"] . $modx->db->getLastError();
-						exit;
-					}
-				}
-			}
-			if($find === false) {
-				$date = time();
-				$field['pagetitle'] = '---';
-				$field['content'] = '';
-				$field['createdon'] = $date;
-				$field['editedon'] = $date;
-				$field['hidemenu'] = '1';
-				$newid = $modx->db->insert($field, $tbl_site_content);
-				if($newid) {
-					$find = true;
-					echo ' - <span class="success">' . $_lang['import_site_success'] . '</span><br />' . "\n";
-					importFiles($newid, $filedir . $alias . '/', $value, 'sub');
-				} else {
-					echo '<span class="fail">' . $_lang["import_site_failed"] . "</span> " . $_lang["import_site_failed_db_error"] . $modx->db->getLastError();
-					exit;
-				}
-			}
-		} else {
-			// create document
-			if($mode == 'sub' && $value == 'index.html') {
-				continue;
-			}
-			$filename = $value;
-			$fparts = explode('.', $value);
-			$alias = $fparts[0];
-			$ext = (count($fparts) > 1) ? $fparts[count($fparts) - 1] : "";
-			printf("<span>" . $_lang['import_site_importing_document'] . "</span>", $filename);
-
-			if(!in_array($ext, $allowedfiles)) {
-				echo ' - <span class="fail">' . $_lang["import_site_skip"] . '</span><br />' . "\n";
-			} else {
-				$filepath = $filedir . $filename;
-				$file = getFileContent($filepath);
-				list($pagetitle, $content, $description) = treatContent($file, $filename, $alias);
-
-				$date = filemtime($filepath);
-				$field = array();
-				$field['type'] = 'document';
-				$field['contentType'] = 'text/html';
-				$field['pagetitle'] = $pagetitle;
-				$field['longtitle'] = $pagetitle;
-				$field['description'] = $description;
-				$field['alias'] = $modx->stripAlias($alias);
-				$field['published'] = $publish_default;
-				$field['parent'] = $parent;
-				$field['content'] = $modx->db->escape($content);
-				$field['richtext'] = $richtext;
-				$field['template'] = $modx->config['default_template'];
-				$field['searchable'] = $search_default;
-				$field['cacheable'] = $cache_default;
-				$field['createdby'] = $createdby;
-				$field['createdon'] = $date;
-				$field['editedon'] = $date;
-				$field['isfolder'] = 0;
-				$field['menuindex'] = ($alias == 'index') ? 0 : 2;
-				$newid = $modx->db->insert($field, $tbl_site_content);
-				if($newid) {
-					echo ' - <span class="success">' . $_lang['import_site_success'] . '</span><br />' . "\n";
-				} else {
-					echo '<span class="fail">' . $_lang["import_site_failed"] . "</span> " . $_lang["import_site_failed_db_error"] . $modx->db->getLastError();
-					exit;
-				}
-
-				$is_site_start = false;
-				if($filename == 'index.html') {
-					$is_site_start = true;
-				}
-				if($is_site_start == true && $_POST['reset'] == 'on') {
-					$modx->db->update(array('setting_value' => $newid), $tbl_system_settings, "setting_name='site_start'");
-					$modx->db->update(array('menuindex' => 0), $tbl_site_content, "id='{$newid}'");
-				}
-			}
-		}
-	}
+    global $modx;
+    global $_lang, $allowedfiles;
+    global $search_default, $cache_default, $publish_default;
+
+    $tbl_site_content = $modx->getFullTableName('site_content');
+    $tbl_system_settings = $modx->getFullTableName('system_settings');
+
+    $createdby = $modx->getLoginUserID();
+    if(!is_array($files)) {
+        return;
+    }
+    if($_POST['object'] === 'all') {
+        $modx->config['default_template'] = '0';
+        $richtext = '0';
+    } else {
+        $richtext = '1';
+    }
+
+    foreach($files as $id => $value) {
+        if(is_array($value)) {
+            // create folder
+            $alias = $id;
+            printf('<span>' . $_lang['import_site_importing_document'] . '</span>', $alias);
+            $field = array();
+            $field['type'] = 'document';
+            $field['contentType'] = 'text/html';
+            $field['published'] = $publish_default;
+            $field['parent'] = $parent;
+            $field['alias'] = $modx->stripAlias($alias);
+            $field['richtext'] = $richtext;
+            $field['template'] = $modx->config['default_template'];
+            $field['searchable'] = $search_default;
+            $field['cacheable'] = $cache_default;
+            $field['createdby'] = $createdby;
+            $field['isfolder'] = 1;
+            $field['menuindex'] = 1;
+            $find = false;
+            foreach(array(
+                        'index.html',
+                        'index.htm'
+                    ) as $filename) {
+                $filepath = $filedir . $alias . '/' . $filename;
+                if($find === false && file_exists($filepath)) {
+                    $file = getFileContent($filepath);
+                    list($pagetitle, $content, $description) = treatContent($file, $filename, $alias);
+
+                    $date = filemtime($filepath);
+                    $field['pagetitle'] = $pagetitle;
+                    $field['longtitle'] = $pagetitle;
+                    $field['description'] = $description;
+                    $field['content'] = $modx->db->escape($content);
+                    $field['createdon'] = $date;
+                    $field['editedon'] = $date;
+                    $newid = $modx->db->insert($field, $tbl_site_content);
+                    if($newid) {
+                        $find = true;
+                        echo ' - <span class="success">' . $_lang['import_site_success'] . '</span><br />' . "\n";
+                        importFiles($newid, $filedir . $alias . '/', $value, 'sub');
+                    } else {
+                        echo '<span class="fail">' . $_lang["import_site_failed"] . "</span> " . $_lang["import_site_failed_db_error"] . $modx->db->getLastError();
+                        exit;
+                    }
+                }
+            }
+            if($find === false) {
+                $date = time();
+                $field['pagetitle'] = '---';
+                $field['content'] = '';
+                $field['createdon'] = $date;
+                $field['editedon'] = $date;
+                $field['hidemenu'] = '1';
+                $newid = $modx->db->insert($field, $tbl_site_content);
+                if($newid) {
+                    $find = true;
+                    echo ' - <span class="success">' . $_lang['import_site_success'] . '</span><br />' . "\n";
+                    importFiles($newid, $filedir . $alias . '/', $value, 'sub');
+                } else {
+                    echo '<span class="fail">' . $_lang["import_site_failed"] . "</span> " . $_lang["import_site_failed_db_error"] . $modx->db->getLastError();
+                    exit;
+                }
+            }
+        } else {
+            // create document
+            if($mode == 'sub' && $value == 'index.html') {
+                continue;
+            }
+            $filename = $value;
+            $fparts = explode('.', $value);
+            $alias = $fparts[0];
+            $ext = (count($fparts) > 1) ? $fparts[count($fparts) - 1] : "";
+            printf("<span>" . $_lang['import_site_importing_document'] . "</span>", $filename);
+
+            if(!in_array($ext, $allowedfiles)) {
+                echo ' - <span class="fail">' . $_lang["import_site_skip"] . '</span><br />' . "\n";
+            } else {
+                $filepath = $filedir . $filename;
+                $file = getFileContent($filepath);
+                list($pagetitle, $content, $description) = treatContent($file, $filename, $alias);
+
+                $date = filemtime($filepath);
+                $field = array();
+                $field['type'] = 'document';
+                $field['contentType'] = 'text/html';
+                $field['pagetitle'] = $pagetitle;
+                $field['longtitle'] = $pagetitle;
+                $field['description'] = $description;
+                $field['alias'] = $modx->stripAlias($alias);
+                $field['published'] = $publish_default;
+                $field['parent'] = $parent;
+                $field['content'] = $modx->db->escape($content);
+                $field['richtext'] = $richtext;
+                $field['template'] = $modx->config['default_template'];
+                $field['searchable'] = $search_default;
+                $field['cacheable'] = $cache_default;
+                $field['createdby'] = $createdby;
+                $field['createdon'] = $date;
+                $field['editedon'] = $date;
+                $field['isfolder'] = 0;
+                $field['menuindex'] = ($alias == 'index') ? 0 : 2;
+                $newid = $modx->db->insert($field, $tbl_site_content);
+                if($newid) {
+                    echo ' - <span class="success">' . $_lang['import_site_success'] . '</span><br />' . "\n";
+                } else {
+                    echo '<span class="fail">' . $_lang["import_site_failed"] . "</span> " . $_lang["import_site_failed_db_error"] . $modx->db->getLastError();
+                    exit;
+                }
+
+                $is_site_start = false;
+                if($filename == 'index.html') {
+                    $is_site_start = true;
+                }
+                if($is_site_start == true && $_POST['reset'] == 'on') {
+                    $modx->db->update(array('setting_value' => $newid), $tbl_system_settings, "setting_name='site_start'");
+                    $modx->db->update(array('menuindex' => 0), $tbl_site_content, "id='{$newid}'");
+                }
+            }
+        }
+    }
 }
 
 /**
@@ -319,27 +319,27 @@ 
  * @return array
  */
 function getFiles($directory, $listing = array(), $count = 0) {
-	global $_lang;
-	global $filesfound;
-	$dummy = $count;
-	if( ! empty($directory) && $files = scandir($directory)) {
-		foreach($files as $file) {
-			if($file == '.' || $file == '..') {
-				continue;
-			} elseif($h = @opendir($directory . $file . "/")) {
-				closedir($h);
-				$count = -1;
-				$listing[$file] = getFiles($directory . $file . "/", array(), $count + 1);
-			} elseif(strpos($file, '.htm') !== false) {
-				$listing[$dummy] = $file;
-				$dummy = $dummy + 1;
-				$filesfound++;
-			}
-		}
-	} else {
-		echo '<p><span class="fail">' . $_lang["import_site_failed"] . "</span> " . $_lang["import_site_failed_no_open_dir"] . $directory . ".</p>";
-	}
-	return ($listing);
+    global $_lang;
+    global $filesfound;
+    $dummy = $count;
+    if( ! empty($directory) && $files = scandir($directory)) {
+        foreach($files as $file) {
+            if($file == '.' || $file == '..') {
+                continue;
+            } elseif($h = @opendir($directory . $file . "/")) {
+                closedir($h);
+                $count = -1;
+                $listing[$file] = getFiles($directory . $file . "/", array(), $count + 1);
+            } elseif(strpos($file, '.htm') !== false) {
+                $listing[$dummy] = $file;
+                $dummy = $dummy + 1;
+                $filesfound++;
+            }
+        }
+    } else {
+        echo '<p><span class="fail">' . $_lang["import_site_failed"] . "</span> " . $_lang["import_site_failed_no_open_dir"] . $directory . ".</p>";
+    }
+    return ($listing);
 }
 
 /**
@@ -347,13 +347,13 @@ 
  * @return bool|string
  */
 function getFileContent($filepath) {
-	global $_lang;
-	// get the file
-	if(!$buffer = file_get_contents($filepath)) {
-		echo '<p><span class="fail">' . $_lang['import_site_failed'] . "</span> " . $_lang["import_site_failed_no_retrieve_file"] . $filepath . ".</p>";
-	} else {
-		return $buffer;
-	}
+    global $_lang;
+    // get the file
+    if(!$buffer = file_get_contents($filepath)) {
+        echo '<p><span class="fail">' . $_lang['import_site_failed'] . "</span> " . $_lang["import_site_failed_no_retrieve_file"] . $filepath . ".</p>";
+    } else {
+        return $buffer;
+    }
 }
 
 /**
@@ -361,20 +361,20 @@ 
  * @return array
  */
 function pop_index($array) {
-	$new_array = array();
-	foreach($array as $k => $v) {
-		if($v !== 'index.html' && $v !== 'index.htm') {
-			$new_array[$k] = $v;
-		} else {
-			array_unshift($new_array, $v);
-		}
-	}
-	foreach($array as $k => $v) {
-		if(is_array($v)) {
-			$new_array[$k] = $v;
-		}
-	}
-	return $new_array;
+    $new_array = array();
+    foreach($array as $k => $v) {
+        if($v !== 'index.html' && $v !== 'index.htm') {
+            $new_array[$k] = $v;
+        } else {
+            array_unshift($new_array, $v);
+        }
+    }
+    foreach($array as $k => $v) {
+        if(is_array($v)) {
+            $new_array[$k] = $v;
+        }
+    }
+    return $new_array;
 }
 
 /**
@@ -384,108 +384,108 @@ 
  * @return array
  */
 function treatContent($src, $filename, $alias) {
-	global $modx;
-
-	$src = mb_convert_encoding($src, $modx->config['modx_charset'], 'UTF-8,SJIS-win,eucJP-win,SJIS,EUC-JP,ASCII');
-
-	if(preg_match("@<title>(.*)</title>@i", $src, $matches)) {
-		$pagetitle = ($matches[1] !== '') ? $matches[1] : $filename;
-		$pagetitle = str_replace('[*pagetitle*]', '', $pagetitle);
-	} else {
-		$pagetitle = $alias;
-	}
-	if(!$pagetitle) {
-		$pagetitle = $alias;
-	}
-
-	if(preg_match('@<meta[^>]+"description"[^>]+content=[\'"](.*)[\'"].+>@i', $src, $matches)) {
-		$description = ($matches[1] !== '') ? $matches[1] : $filename;
-		$description = str_replace('[*description*]', '', $description);
-	} else {
-		$description = '';
-	}
-
-	if((preg_match("@<body[^>]*>(.*)[^<]+</body>@is", $src, $matches)) && $_POST['object'] == 'body') {
-		$content = $matches[1];
-	} else {
-		$content = $src;
-		$s = '/(<meta[^>]+charset\s*=)[^>"\'=]+(.+>)/i';
-		$r = '$1' . $modx->config['modx_charset'] . '$2';
-		$content = preg_replace($s, $r, $content);
-		$content = preg_replace('@<title>.*</title>@i', "<title>[*pagetitle*]</title>", $content);
-	}
-	$content = str_replace('[*content*]', '[ *content* ]', $content);
-	$content = trim($content);
-	$pagetitle = $modx->db->escape($pagetitle);
-	return array(
-		$pagetitle,
-		$content,
-		$description
-	);
+    global $modx;
+
+    $src = mb_convert_encoding($src, $modx->config['modx_charset'], 'UTF-8,SJIS-win,eucJP-win,SJIS,EUC-JP,ASCII');
+
+    if(preg_match("@<title>(.*)</title>@i", $src, $matches)) {
+        $pagetitle = ($matches[1] !== '') ? $matches[1] : $filename;
+        $pagetitle = str_replace('[*pagetitle*]', '', $pagetitle);
+    } else {
+        $pagetitle = $alias;
+    }
+    if(!$pagetitle) {
+        $pagetitle = $alias;
+    }
+
+    if(preg_match('@<meta[^>]+"description"[^>]+content=[\'"](.*)[\'"].+>@i', $src, $matches)) {
+        $description = ($matches[1] !== '') ? $matches[1] : $filename;
+        $description = str_replace('[*description*]', '', $description);
+    } else {
+        $description = '';
+    }
+
+    if((preg_match("@<body[^>]*>(.*)[^<]+</body>@is", $src, $matches)) && $_POST['object'] == 'body') {
+        $content = $matches[1];
+    } else {
+        $content = $src;
+        $s = '/(<meta[^>]+charset\s*=)[^>"\'=]+(.+>)/i';
+        $r = '$1' . $modx->config['modx_charset'] . '$2';
+        $content = preg_replace($s, $r, $content);
+        $content = preg_replace('@<title>.*</title>@i', "<title>[*pagetitle*]</title>", $content);
+    }
+    $content = str_replace('[*content*]', '[ *content* ]', $content);
+    $content = trim($content);
+    $pagetitle = $modx->db->escape($pagetitle);
+    return array(
+        $pagetitle,
+        $content,
+        $description
+    );
 }
 
 /**
  * @return void
  */
 function convertLink() {
-	global $modx;
-	$tbl_site_content = $modx->getFullTableName('site_content');
+    global $modx;
+    $tbl_site_content = $modx->getFullTableName('site_content');
 
-	$rs = $modx->db->select('id,content', $tbl_site_content);
-	$p = array();
+    $rs = $modx->db->select('id,content', $tbl_site_content);
+    $p = array();
     $target = array();
-	$dir = '';
-	while($row = $modx->db->getRow($rs)) {
-		$id = $row['id'];
-		$array = explode('<a href=', $row['content']);
-		$c = 0;
-		foreach($array as $v) {
-			if($v[0] === '"') {
-				$v = substr($v, 1);
-				list($href, $v) = explode('"', $v, 2);
-				$_ = $href;
-				if(strpos($_, $modx->config['site_url']) !== false) {
-					$_ = $modx->config['base_url'] . str_replace($modx->config['site_url'], '', $_);
-				}
-				if($_[0] === '/') {
-					$_ = substr($_, 1);
-				}
-				$_ = str_replace('/index.html', '.html', $_);
-				$level = substr_count($_, '../');
-				if(1 < $level) {
-					if(!isset($p[$id])) {
-						$p[$id] = $modx->getParentIds($id);
-					}
-					$k = array_keys($p[$id]);
-					while(0 < $level) {
-						$dir = array_shift($k);
-						$level--;
-					}
-					if($dir != '') {
-						$dir .= '/';
-					}
-				} else {
-					$dir = '';
-				}
-
-				$_ = trim($_, './');
-				if(strpos($_, '/') !== false) {
-					$_ = substr($_, strrpos($_, '/'));
-				}
-				$_ = $dir . str_replace('.html', '', $_);
-				if(!isset($target[$_])) {
-					$target[$_] = $modx->getIdFromAlias($_);
-				}
-				$target[$_] = trim($target[$_]);
-				if(!empty($target[$_])) {
-					$href = '[~' . $target[$_] . '~]';
-				}
-				$array[$c] = '<a href="' . $href . '"' . $v;
-			}
-			$c++;
-		}
-		$content = implode('', $array);
-		$f['content'] = $modx->db->escape($content);
-		$modx->db->update($f, $tbl_site_content, "id='{$id}'");
-	}
+    $dir = '';
+    while($row = $modx->db->getRow($rs)) {
+        $id = $row['id'];
+        $array = explode('<a href=', $row['content']);
+        $c = 0;
+        foreach($array as $v) {
+            if($v[0] === '"') {
+                $v = substr($v, 1);
+                list($href, $v) = explode('"', $v, 2);
+                $_ = $href;
+                if(strpos($_, $modx->config['site_url']) !== false) {
+                    $_ = $modx->config['base_url'] . str_replace($modx->config['site_url'], '', $_);
+                }
+                if($_[0] === '/') {
+                    $_ = substr($_, 1);
+                }
+                $_ = str_replace('/index.html', '.html', $_);
+                $level = substr_count($_, '../');
+                if(1 < $level) {
+                    if(!isset($p[$id])) {
+                        $p[$id] = $modx->getParentIds($id);
+                    }
+                    $k = array_keys($p[$id]);
+                    while(0 < $level) {
+                        $dir = array_shift($k);
+                        $level--;
+                    }
+                    if($dir != '') {
+                        $dir .= '/';
+                    }
+                } else {
+                    $dir = '';
+                }
+
+                $_ = trim($_, './');
+                if(strpos($_, '/') !== false) {
+                    $_ = substr($_, strrpos($_, '/'));
+                }
+                $_ = $dir . str_replace('.html', '', $_);
+                if(!isset($target[$_])) {
+                    $target[$_] = $modx->getIdFromAlias($_);
+                }
+                $target[$_] = trim($target[$_]);
+                if(!empty($target[$_])) {
+                    $href = '[~' . $target[$_] . '~]';
+                }
+                $array[$c] = '<a href="' . $href . '"' . $v;
+            }
+            $c++;
+        }
+        $content = implode('', $array);
+        $f['content'] = $modx->db->escape($content);
+        $modx->db->update($f, $tbl_site_content, "id='{$id}'");
+    }
 }

manager/includes/document.parser.class.inc.php

Doc Comments +24 added lines, -24 removed lines

@@ -256,7 +256,7 @@ 
      * MODX_MANAGER_PATH."includes/extenders/ex_{$extname}.inc.php"
      * $extname - extension name in lowercase
      *
-     * @param $extname
+     * @param string $extname
      * @param bool $reload
      * @return bool
      */
@@ -299,7 +299,7 @@ 
      * @param int $count_attempts
      * @param string $type $type
      * @param string $responseCode
-     * @return bool|null
+     * @return false|null
      * @global string $base_url
      * @global string $site_url
      */
@@ -1000,7 +1000,7 @@ 
     }
 
     /**
-     * @param $contents
+     * @param string $contents
      * @return mixed
      */
     public function RecoveryEscapedTags($contents)
@@ -1024,7 +1024,7 @@ 
     }
 
     /**
-     * @param $tstart
+     * @param double $tstart
      * @return array
      */
     public function getTimerStats($tstart)
@@ -1776,7 +1776,7 @@ 
 
     /**
      * Remove Comment-Tags from output like <!--@- Comment -@-->
-     * @param $content
+     * @param string $content
      * @param string $left
      * @param string $right
      * @return mixed
@@ -1949,7 +1949,7 @@ 
     /**
      * Run snippets as per the tags in $documentSource and replace the tags with the returned values.
      *
-     * @param $content
+     * @param string $content
      * @return string
      * @internal param string $documentSource
      */
@@ -2981,7 +2981,7 @@ 
 
     /**
      * @param $templateID
-     * @return mixed
+     * @return string
      */
     public function _getTemplateCodeFromDB($templateID)
     {
@@ -3022,9 +3022,9 @@ 
     }
 
     /**
-     * @param $id
+     * @param integer $id
      * @param int $top
-     * @return mixed
+     * @return string
      */
     public function getUltimateParentId($id, $top = 0)
     {
@@ -3355,7 +3355,7 @@ 
      *
      * @param int $type Types: 1=template, 2=tv, 3=chunk, 4=snippet, 5=plugin, 6=module, 7=resource, 8=role
      * @param int $id Element- / Resource-id
-     * @return bool
+     * @return false|null
      */
     public function lockElement($type, $id)
     {
@@ -3377,7 +3377,7 @@ 
      * @param int $type Types: 1=template, 2=tv, 3=chunk, 4=snippet, 5=plugin, 6=module, 7=resource, 8=role
      * @param int $id Element- / Resource-id
      * @param bool $includeAllUsers true = Deletes not only own user-locks
-     * @return bool
+     * @return false|null
      */
     public function unlockElement($type, $id, $includeAllUsers = false)
     {
@@ -3485,7 +3485,7 @@ 
      * @param array $params
      * @param string $msg
      * @param array $files
-     * @return mixed
+     * @return boolean
      */
     public function sendmail($params = array(), $msg = '', $files = array())
     {
@@ -3981,7 +3981,7 @@ 
      *
      * @param string $type
      * @param bool $report
-     * @return bool
+     * @return boolean|null
      */
     public function clearCache($type = '', $report = false)
     {
@@ -4348,7 +4348,7 @@ 
      * - Placeholders prefix. Default: '{'.
      * @param string $suffix {string}
      * - Placeholders suffix. Default: '}'.
-     * @return bool|mixed|string {string; false} - Parsed chunk or false if $chunkArr is not array.
+     * @return false|string {string; false} - Parsed chunk or false if $chunkArr is not array.
      * - Parsed chunk or false if $chunkArr is not array.
      */
     public function parseChunk($chunkName, $chunkArr, $prefix = '{', $suffix = '}')
@@ -5324,7 +5324,7 @@ 
      * Remove event listener - only for use within the current execution cycle
      *
      * @param string $evtName
-     * @return boolean
+     * @return false|null
      */
     public function removeEventListener($evtName)
     {
@@ -5348,7 +5348,7 @@ 
      *
      * @param string $evtName
      * @param array $extParams Parameters available to plugins. Each array key will be the PHP variable name, and the array value will be the variable value.
-     * @return boolean|array
+     * @return false|null
      */
     public function invokeEvent($evtName, $extParams = array())
     {
@@ -5947,7 +5947,7 @@ 
 
     /**
      * @param string $str
-     * @return bool|mixed|string
+     * @return string
      */
     public function atBindFileContent($str = '')
     {
@@ -5998,8 +5998,8 @@ 
     }
 
     /**
-     * @param $str
-     * @return bool|string
+     * @param string $str
+     * @return false|string
      */
     public function getExtFromFilename($str)
     {
@@ -6027,7 +6027,7 @@ 
      * @param string $text Error message
      * @param string $file File where the error was detected
      * @param string $line Line number within $file
-     * @return boolean
+     * @return boolean|null
      */
     public function phpError($nr, $text, $file, $line)
     {
@@ -6079,7 +6079,7 @@ 
      * @param string $text
      * @param string $line
      * @param string $output
-     * @return bool
+     * @return null|boolean
      */
     public function messageQuit($msg = 'unspecified error', $query = '', $is_error = true, $nr = '', $file = '', $source = '', $text = '', $line = '', $output = '')
     {
@@ -6501,7 +6501,7 @@ 
 
     /**
      * @param string $str
-     * @return bool|mixed|string
+     * @return string
      */
     public function atBindInclude($str = '')
     {
@@ -6552,7 +6552,7 @@ 
      * @param $str
      * @param int $flags
      * @param string $encode
-     * @return mixed
+     * @return string
      */
     public function htmlspecialchars($str, $flags = ENT_COMPAT, $encode = '')
     {
@@ -6561,7 +6561,7 @@ 
     }
 
     /**
-     * @param $string
+     * @param string $string
      * @param bool $returnData
      * @return bool|mixed
      */

manager/includes/extenders/dbapi.mysqli.class.inc.php

Doc Comments +8 added lines, -8 removed lines

@@ -240,9 +240,9 @@ 
     }
 
     /**
-     * @param string|array $fields
-     * @param string|array $from
-     * @param string|array $where
+     * @param string $fields
+     * @param string $from
+     * @param string $where
      * @param string $orderBy
      * @param string $limit
      * @return bool|mysqli_result
@@ -326,7 +326,7 @@ 
      * @param string $fromtable
      * @param string $where
      * @param string $limit
-     * @return mixed
+     * @return null|integer
      */
     public function insert($fields, $intotable, $fromfields = "*", $fromtable = "", $where = "", $limit = "")
     {
@@ -435,7 +435,7 @@ 
 
     /**
      * @param null|mysqli $conn
-     * @return mixed
+     * @return integer
      */
     public function getInsertId($conn = null)
     {
@@ -513,7 +513,7 @@ 
     }
 
     /**
-     * @param $name
+     * @param string $name
      * @param mysqli_result|string $dsq
      * @return array
      */
@@ -572,7 +572,7 @@ 
 
     /**
      * @param string $table
-     * @return array
+     * @return boolean
      */
     public function getTableMetaData($table)
     {
@@ -619,7 +619,7 @@ 
     }
 
     /**
-     * @param string|mysqli_result $rs
+     * @param string $rs
      * @param bool $index
      * @return array
      */

manager/includes/extenders/maketable.class.php

Doc Comments +4 added lines, -7 removed lines

@@ -278,8 +278,7 @@ 
     /**
      * Sets the width attribute of each column in the array.
      *
-     * @param array $value An Array of column widths in the order of the keys in the
-     *            source table array.
+     * @param string[] $widthArray
      */
     public function setColumnWidths($widthArray)
     {
@@ -289,7 +288,6 @@ 
     /**
      * An optional array of values that can be preselected when using
      *
-     * @param array $value Indicates the INPUT form element type attribute.
      */
     public function setSelectedValues($valueArray)
     {
@@ -326,7 +324,7 @@ 
     /**
      * Determines what class the current row should have applied.
      *
-     * @param int $value The position of the current row being rendered.
+     * @param integer $position
      * @return string
      */
     public function determineRowClass($position)
@@ -353,7 +351,6 @@ 
      * Generates an onclick action applied to the current cell, to execute
      * any specified cell actions.
      *
-     * @param string $value Indicates the INPUT form element type attribute.
      * @return string
      */
     public function getCellAction($currentActionFieldValue)
@@ -395,7 +392,7 @@ 
     /**
      * Function to prepare a link generated in the table cell/link actions.
      *
-     * @param string $value Indicates the INPUT form element type attribute.
+     * @param string $link
      * @return string
      */
     public function prepareLink($link)
@@ -414,7 +411,7 @@ 
      *
      * @param array $fieldsArray The associative array representing the table rows
      * and columns.
-     * @param array $fieldHeadersArray An optional array of values for providing
+     * @param string[] $fieldHeadersArray An optional array of values for providing
      * alternative field headers; this is an associative arrays of keys from
      * the $fieldsArray where the values represent the alt heading content
      * for each column.

manager/includes/extenders/modifiers.class.inc.php

Doc Comments +25 added lines, -1 removed lines

@@ -95,7 +95,7 @@ 
     /**
      * @param string $mode
      * @param string $modifiers
-     * @return bool|string
+     * @return false|string
      */
     public function _getDelim($mode,$modifiers) {
         $c = substr($modifiers,0,1);
@@ -132,6 +132,14 @@ 
             return $opt;
         }
     }
+
+    /**
+     * @param string $mode
+     * @param false|string $delim
+     * @param string $modifiers
+     *
+     * @return string
+     */
     public function _getRemainModifiers($mode,$delim,$modifiers) {
         if($delim) {
             if($mode=='(')
@@ -159,6 +167,9 @@ 
         return substr($string,strpos($string, $delim)+$len);
     }
 
+    /**
+     * @param string $modifiers
+     */
     public function splitEachModifiers($modifiers) {
         global $modx;
 
@@ -228,6 +239,9 @@ 
         return $result;
     }
 
+    /**
+     * @param string $key
+     */
     public function parsePhx($key,$value,$modifiers)
     {
         global $modx;
@@ -294,6 +308,9 @@ 
         else                  return true;
     }
 
+    /**
+     * @param string $cmd
+     */
     public function getValueFromPreset($key, $value, $cmd, $opt)
     {
         global $modx;
@@ -979,6 +996,9 @@ 
         return $value;
     }
 
+    /**
+     * @param string $cmd
+     */
     public function includeMdfFile($cmd) {
         global $modx;
         $key = $this->key;
@@ -1134,6 +1154,10 @@ 
     }
 
     // Sets a placeholder variable which can only be access by Modifiers
+
+    /**
+     * @param string $value
+     */
     public function setModifiersVariable($key, $value) {
         if ($key != 'phx' && $key != 'dummy') $this->placeholders[$key] = $value;
     }

manager/includes/paginate.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -149,7 +149,7 @@
     /**
      * This function returns the current page number.
      *
-     * @return int
+     * @return string
      */
     public function getCurrentPage()
     {

manager/includes/protect.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -16,7 +16,7 @@
 // sanitize array
 if (!function_exists('modx_sanitize_gpc')) {
     /**
-     * @param array|string $values
+     * @param string $values
      * @param int $depth
      * @return array|string
      */