ProcessManager Class Reference

Provides a central management class for event handlers and common functionality for the process component. More...

Public Member Functions
	ProcessManager ($id="")
	run ($action, $params=array())
	Spawns the specified action as a background process under the current user's credentials. More...
	put ($key, $value)
	get ($key)
	setProgress ($status, $message, $percentage)

Static Public Member Functions
static	setDefaults ()
static	upgradeComponent ($version)

Public Attributes
	$id
	$cache

Detailed Description

Provides a central management class for event handlers and common functionality for the process component.

Definition at line 45 of file process_manager.inc.

Member Function Documentation

get()

ProcessManager::get

(

$key

)

Definition at line 114 of file process_manager.inc.

     {
          return $this->cache->get("{$this->id}_{$key}");
     }

ProcessManager()

ProcessManager::ProcessManager

(

$id = ""

)

Definition at line 50 of file process_manager.inc.

     {
          global $config;
          
          $this->id = $id;
          
          if (!$config["file_backed_cache_directory"])
          {
               $cacheDir = $config["uploadbase"] . DIRECTORY_SEPARATOR . "cache";
               if (!is_dir($cacheDir))
               {
                    mkdir($cacheDir);
               }
 
               $config["file_backed_cache_directory"] = $cacheDir;
               
               $this->cache = new FileBackedCache();
          }
     }

put()

ProcessManager::put	(		$key,
			$value
	)

Definition at line 109 of file process_manager.inc.

     {
          $this->cache->put("{$this->id}_{$key}", $value);
     }

run()

ProcessManager::run	(		$action,
			$params = array()
	)

Spawns the specified action as a background process under the current user's credentials.

Parameters

string	$action	the action handler to use to handle the request
array	$params	(optional) array of parameters to pass to the spawned process

Returns

string unique ID for the spawned process

Definition at line 76 of file process_manager.inc.

     {
          global $config;
          global $user;
          
          $isWindows = Fakoli::detectWindowsOS();
          $this->id = sha1(now() . $action);
          foreach($params as $key => $value)
          {
               $this->put($key, $value);
          }
          
          $launch  = $isWindows ? "start " : "";
          $bg = $isWindows ? "" : " &";
          $run = Settings::getValue("process", "PHP_executable")." -d include_path='".
               get_include_path()."' ".
               sanitizePath(Fakoli::getComponent("process")->component_path) . DIRECTORY_SEPARATOR . "run.php";
          $home = $config['homedir'];
          
          $userPK = $user ? $user->get($user->primary_key) : "";
          
          $cmd = "$launch$run ".escapeshellarg($home)." ".escapeshellarg($this->id)." ".escapeshellarg($action)." ".$userPK." ".$bg;
          
          $this->put("status", "Starting");
          $this->put("error", "");
          
          trace($cmd, 3);
          
          pclose(popen($cmd, "r")); 
          
          return $this->id;
     }

setDefaults()

static ProcessManager::setDefaults ( )

static

Definition at line 128 of file process_manager.inc.

     {
          Settings::setDefaultValue("process", "PHP_executable", "/usr/bin/php", String, "This is the path to the PHP command line executable");
          Settings::setDefaultValue("process", "background_process_log_file", "", String, "Optionally specify a separate log file for background processes");
     }

setProgress()

ProcessManager::setProgress	(		$status,
			$message,
			$percentage
	)

Definition at line 119 of file process_manager.inc.

     {
          $this->put("status", $status);
          $this->put("message", $message);
          $this->put("percentage", number_format($percentage, 0));
          
          trace("{$this->id} $status: $message ($percentage%)", 3);
     }

upgradeComponent()

static ProcessManager::upgradeComponent (   $version )

static

Definition at line 134 of file process_manager.inc.

     {
          $mgr = new ProcessUpgradeManager();
          $mgr->upgrade($version);
     }

Member Data Documentation

$cache

ProcessManager::$cache

Definition at line 48 of file process_manager.inc.

$id

ProcessManager::$id

Definition at line 47 of file process_manager.inc.

---

The documentation for this class was generated from the following file:

• C:/code/cms.sonjara.com/cms/components/process/process_manager.inc