Cleanup phpdoc comments

[civicrm-core.git] / install / civicrm.php

diff --git a/install/civicrm.php b/install/civicrm.php
index adedfb9b7d9880ca76bb5c199c1554ceebb9673a..02b50b994cdf6ec95d01889ec221c778311e3a65 100644 (file)
--- a/install/civicrm.php
+++ b/install/civicrm.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.4                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -28,7 +28,7 @@
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
  *
  */
@@ -36,6 +36,12 @@ function civicrm_setup($filesDirectory) {
   global $crmPath, $sqlPath, $pkgPath, $tplPath;
   global $compileDir;
 
+  $pkgPath = $crmPath . DIRECTORY_SEPARATOR . 'packages';
+  set_include_path($crmPath . PATH_SEPARATOR .
+    $pkgPath . PATH_SEPARATOR .
+    get_include_path()
+  );
+
   $sqlPath = $crmPath . DIRECTORY_SEPARATOR . 'sql';
   $tplPath = $crmPath . DIRECTORY_SEPARATOR . 'templates' . DIRECTORY_SEPARATOR . 'CRM' . DIRECTORY_SEPARATOR . 'common' . DIRECTORY_SEPARATOR;
 
@@ -56,6 +62,10 @@ function civicrm_setup($filesDirectory) {
   $compileDir = addslashes($compileDir);
 }
 
+/**
+ * @param string $name
+ * @param $buffer
+ */
 function civicrm_write_file($name, &$buffer) {
   $fd = fopen($name, "w");
   if (!$fd) {
@@ -65,6 +75,9 @@ function civicrm_write_file($name, &$buffer) {
   fclose($fd);
 }
 
+/**
+ * @param $config
+ */
 function civicrm_main(&$config) {
   global $sqlPath, $crmPath, $cmsPath, $installType;
 
@@ -115,8 +128,14 @@ function civicrm_main(&$config) {
 
 }
 
+/**
+ * @param $dsn
+ * @param string $fileName
+ * @param bool $lineMode
+ */
 function civicrm_source($dsn, $fileName, $lineMode = FALSE) {
   global $crmPath;
+
   require_once "$crmPath/packages/DB.php";
 
   $db = DB::connect($dsn);
@@ -167,6 +186,11 @@ function civicrm_source($dsn, $fileName, $lineMode = FALSE) {
   }
 }
 
+/**
+ * @param $config
+ *
+ * @return string
+ */
 function civicrm_config(&$config) {
   global $crmPath, $comPath;
   global $compileDir;
@@ -219,6 +243,9 @@ function civicrm_config(&$config) {
   return trim($str);
 }
 
+/**
+ * @return string
+ */
 function civicrm_cms_base() {
   global $installType;
 
@@ -269,6 +296,9 @@ function civicrm_cms_base() {
   return $url . $baseURL;
 }
 
+/**
+ * @return string
+ */
 function civicrm_home_url() {
   $drupalURL = civicrm_cms_base();
   return $drupalURL . 'index.php?q=civicrm';