This class provides the Fakoli CMS core. More...

Public Member Functions
	getAdminPageRole ($identifier)
	Get the applicable access roles for a given admin page, based on information supplied by components in their manifests. More...

	scrollTo ($element, $offset=0)
	Automatically scroll the page to the specified element (by DOM ID) when the page loads. More...

	scrollToOnNextPage ($element, $offset=0)
	Schedules a scrollTo event when the next page is loaded. More...

	scriptOnNextPage ($s)
	Schedules the provided script fragment to be output when the next page is loaded. More...

Static Public Member Functions
static	put ($key, $obj)
	Stores a value or object at the given key. More...

static	get ($key)
	Retrieves the value or object at the given key. More...

static	using ()
	Import the datamodels, views and manifest for the specified component(s). More...

static	getComponents ()
	Retrieve an array of all the currently enabled components, indexed by component name. More...

static	getComponent ($name)
	Return the component record by name. More...

static	componentExists ($name)
	Test whether the specified component has been registered. More...

static	initialComponentScan ()
	Performs a complete component scan if the component table is found to be empty. More...

static	bootstrap ()
	Bootstraps the creation of the database schema if the component table does not exist. More...

static	assertRole ($role, $redirect="", $message="")
	Assert that the user has one of the specified roles. More...

static	checkRole ($role, $msg=null)
	Check that the user has one of the specified roles. More...

static	isUserActive ($user)
	Checks if the given user is active. More...

static	getLocalIP ()
	Returns the local IP address for the server. More...

static	usingFile ()
	Uses the specified framework file(s) from the framework directory. More...

static	usingFeature ()
	Uses the specified framework feature(s). More...

static	getAdminMenu ()
	Builds the administration menu, combining menu items supplied by the registered components in their manifests. More...

static	getAdminIcons ()
	Builds the admin icon map. More...

static	getScripts ()
	Returns the HTML scripts tags for Javascript files specified by the registered components in their manifest files. More...

static	loadScripts ()
	Load the list of JS scripts from the manifests of all registered, active components. More...

static	getStyles ()
	Returns the HTML link tags for CSS files specified by the registered components in their manifest files. More...

static	loadStyles ()
	Load the list of CSS files from the manifests of all registered, active components. More...

static	evaluateFile ($filePath)
	Evaluates a PHP include file and returns the generated content. More...

static	includeScript ($src)
	Utility function to pull in a specific Javascript file for the current page. More...

static	includeStylesheet ($src, $media="all")
	Utility function to pull in a specific CSS Stylesheet for the current page. More...

static	compareByWeight ($item1, $item2)
	Sorting callback function that sorts two admin menu items by their specified weights. More...

static	getComponentClassRoot ($name)
	Retrieves the capitalized camlCase name for the specified component. More...

static	sendResource ($uri, $component="")
	Sends the resource at the specified URI to the client. More...

static	sendFile ($resource)
	Sends the contents of the specified file to the client. More...

static	detectXSendFileSupport ()
	Determines whether the mod_xsendfile extension is present, when running under Apache. More...

static	resolveResource ($resource, $component="")
	Resolves the path to a web resource based on the PHP include path. More...

static	loadResource ($resource, $component="")
	Load the specified resource into memory. More...

static	applyTemplate ($target, $templateFile, $component="")
	Format the target DataItem or JoinResult using the specified template file. More...

static	checkSSL ()
	Checks if SSL is enabled on the current request. More...

static	sendPage ($sectionIdentifier, $identifier, $page_id=null)
	Serves the page with the specified section and identifier. More...

static	getAdminAccessRoles ()
	Returns the user roles that have access to the admin section. More...

static	countActiveSessions ()
	Returns the number of active user sessions. More...

static	sendAdminPage ($identifier)
	Send the admin page for the given identifier. More...

static	getComponentForClass ($class)
	Find the component containing the specified class. More...

static	end ($message="")
	Use this method to terminate execution of a script instead of using the php keywords exit() or die(). More...

static	JSONreturn ($object, $sendType=true, $wrap=true)
	Return a DataItem to the client in JSON format. More...

static	JSONerror ($error, $sendType=true)
	Return an error code to the client in JSON format, as an object with the single property 'error'. More...

static	notify ($message, $blocking=false, $button="OK", $onClick="null")
	Utility method to display a notification message to the user when the page has finished loading. More...

static	notifyOnNextPage ($message, $blocking=false, $button="OK", $onClick="null")
	Schedules a notification message to be displayed to the user at the next full page load. More...

static	showPendingNotification ()
	Display any previously scheduled notification message. More...

static	showPendingScrollTo ()
	Display any previously scheduled scrollto event. More...

static	writePendingScripts ()
	Outputs any pending scripts submitted by Fakoli::scriptOnNextPage() More...

static	setTraceLevel ($level)
	Set the trace log level. More...

static	applicationTraceLevel ()
	Change to the configured trace level for application code. More...

static	coreTraceLevel ()
	Change to the configured trace level for Fakoli core code. More...

static	scheduledTaskTraceLevel ()
	Changed to the configured trace level for scheduled task worker code. More...

static	errorHandler ($errLevel, $errMsg, $errFile, $errLine)
	Custom Error Handler. More...

static	exceptionHandler ($exception)
	Custom Exception Handler. More...

static	scriptName ()
	Returns the name of the currently executing script. More...

static	detectWindowsOS ()
	Returns true if running on Windows, false otherwise. More...

static	getServerLoad ()
	Retrieves information about the Server CPU load. More...

static	getFileSystemInfo ()
	Returns formatted summary information regarding usage of the server's filesystem. More...

static	shutdownHandler ()
	Custom shutdown handler. More...

Static Public Attributes
static	$componentsUsed = array()
	Array of the components that have been referenced in this page request. More...

static	$scanning = false
	Semaphore indicating that a component scan is in progress. More...

static	$outputBufferLevel = 0
	Records the level at which gzip output buffering began. More...

static	$rollbackBuffers = true
	Specifies whether to rollback output buffers when there is an unhandled exception. More...

static	$storage = array()
	General storage (volatile). See Fakoli::put and Fakoli::get. More...

static	$timestamp
	Microsecond Timestamp for start of request. More...

static	$requestStartTime
	Start of request in DateTime format. More...

static	$requestURI
	The initial request URI. More...

static	$bodyClass = ""
	Override for the body class of the page currently being served. More...

Detailed Description

This class provides the Fakoli CMS core.

It contains basic utility functions used by components and modules to access the component map, and provides facilities for serving resources and pages to the client.

Author: andy

Definition at line 79 of file core.inc.

Member Function Documentation

◆ applicationTraceLevel()

static Fakoli::applicationTraceLevel ( )

static

Change to the configured trace level for application code.

Definition at line 1338 of file core.inc.

      {
           Fakoli::setTraceLevel(Settings::getValue("debug", "application_trace_level"));
      }

◆ applyTemplate()

static Fakoli::applyTemplate	(	$target,
		$templateFile,
		$component = `""`
	)

static

Format the target DataItem or JoinResult using the specified template file.

The template file can use any of the standard Fakoli DataItem formatting tags.

Parameters

mixed	$target	the DataItem or JoinResult to be formatted
string	$templateFile	path to the template file
	string	optional component to search for the template file

Returns: string formatted output of the target with the template applied

Definition at line 949 of file core.inc.

      {
           $template = Fakoli::loadResource($templateFile, $component);
           return $target->format($template);
      }

◆ assertRole()

static Fakoli::assertRole	(	$role,
		$redirect = `""`,
		$message = `""`
	)

static

Assert that the user has one of the specified roles.

Parameters

string	$role	comma-separated list of acceptable roles
string	$redirect	the page to which the user is to be redirected on failure
string	$message	a message to display if redirect is empty

Definition at line 297 of file core.inc.

      {
           global $user;
           global $isAction;
           
           if (!$redirect && !$message) $redirect = "/index";
           
           if (!checkRole($role))
           {
                if ($redirect)
                {
                     if (!$user)
                     {
                          $mgr = new LoginManager();
                          $mgr->storeRedirectPage();
                     }
      
                     redirect($redirect);
                }
                else
                {
                     if ($isAction)
                     {
                          Fakoli::end($message);
                     }
                     else
                     {
                          throw new FakoliException($message);
                     }
                }
           }
      }

◆ bootstrap()

static Fakoli::bootstrap ( )

static

Bootstraps the creation of the database schema if the component table does not exist.

Definition at line 276 of file core.inc.

      {
           require_once realpath(dirname(__FILE__)."/components/component/datamodel/component.inc");
           require_once realpath(dirname(__FILE__)."/components/component/datamodel/component_page.inc");
           require_once realpath(dirname(__FILE__)."/components/component/datamodel/admin_page.inc");
           require_once realpath(dirname(__FILE__)."/components/component/datamodel/component_update_log.inc");
           require_once realpath(dirname(__FILE__)."/components/component/serialization_manager.inc");
           require_once realpath(dirname(__FILE__)."/components/component/component_manager.inc");
           require_once realpath(dirname(__FILE__)."/components/component/upgrade_manager.inc");
           require_once realpath(dirname(__FILE__)."/components/component/component_upgrade_manager.inc");
           
           $mgr = new ComponentUpgradeManager();
           $mgr->bootstrap();
      }    

◆ checkRole()

static Fakoli::checkRole	(	$role,
		$msg = `null`
	)

static

Check that the user has one of the specified roles.

If the $msg parameter is set and the user does not have the right role, that message is thrown in an exception.

Parameters

string	$role	comma-separated list of acceptable roles
string	$msg	optional error message to be displayed on failure. If not specified, then false is returned on failure

Exceptions

FakoliException

Returns: true if the user has one of the specified roles, false otherwise

Definition at line 338 of file core.inc.

      {
           $access = checkRole($role);
           if (!$access && $msg) throw new FakoliException($msg);
           return $access;
      }

◆ checkSSL()

static Fakoli::checkSSL ( )

static

Checks if SSL is enabled on the current request.

Definition at line 958 of file core.inc.

      {
           $https = false;
           $https = $_SERVER['HTTPS'];
           if ($https == "off") $https = false;
           if (isset($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] === 'https') 
           {
                $https = true;
           }
           
           return $https;
      }

◆ compareByWeight()

static Fakoli::compareByWeight	(	$item1,
		$item2
	)

static

Sorting callback function that sorts two admin menu items by their specified weights.

Used during the construction of the admin menu.

Parameters

array	$item1
array	$item2

Definition at line 742 of file core.inc.

      {
           return $item1["weight"] - $item2["weight"];
      }

◆ componentExists()

static Fakoli::componentExists ( $name )

static

Test whether the specified component has been registered.

Parameters

string $name the name of the component to test

Returns: boolean true if registered, false otherwise

Definition at line 246 of file core.inc.

      {
           return array_key_exists($name, Fakoli::getComponents());
      }

◆ coreTraceLevel()

static Fakoli::coreTraceLevel ( )

static

Change to the configured trace level for Fakoli core code.

Definition at line 1346 of file core.inc.

      {
           Fakoli::setTraceLevel(Settings::getValue("debug", "trace_level"));
      }

◆ countActiveSessions()

static Fakoli::countActiveSessions ( )

static

Returns the number of active user sessions.

Definition at line 1085 of file core.inc.

      {
           $sessions = scandir(ini_get("session.save_path"));
           trace("SESSIONS: ".print_r($session, true), 1);
           $number_of_users = count($sessions) - 2;
           return $number_of_users;
      }

◆ detectWindowsOS()

static Fakoli::detectWindowsOS ( )

static

Returns true if running on Windows, false otherwise.

Definition at line 1455 of file core.inc.

     {
           return (strtolower(substr(PHP_OS, 0, 3)) == "win");
     }

◆ detectXSendFileSupport()

static Fakoli::detectXSendFileSupport ( )

static

Determines whether the mod_xsendfile extension is present, when running under Apache.

This extension can significantly improve performance when serving static files from PHP scripts, such as for static file resources packaged within components, or when serving uploaded images or documents.

Returns: boolean true if mod_xsendfile is present, false otherwise.

Definition at line 834 of file core.inc.

      {
           if (function_exists("apache_get_modules"))
           {
                $support = in_array('mod_xsendfile', apache_get_modules());
           }
           
           return $support;
      }

◆ end()

static Fakoli::end ( $message = "" )

static

Use this method to terminate execution of a script instead of using the php keywords exit() or die().

Parameters

string $message a message or return code to emit before exiting

Definition at line 1149 of file core.inc.

      {
           throw new FakoliEarlyExit($message);
      }

◆ errorHandler()

static Fakoli::errorHandler	(	$errLevel,
		$errMsg,
		$errFile,
		$errLine
	)

static

Custom Error Handler.

Parameters

int	$errLevel	the error number or level
string	$errMsg	the reported error message
string	$errFile	path to the file where the error occurred
int	$errLine	the line where the error occurred

Exceptions

DOMException
ErrorException

Definition at line 1368 of file core.inc.

      {
           // Transform XML DOM warning messages into exceptions for easier handling
          if ($errLevel==E_WARNING && (substr_count($errMsg,"DOMDocument::loadXML()")>0))
          {
              throw new DOMException($errMsg);
          }
          
           if ($errLevel & (E_NOTICE | E_WARNING | E_USER_WARNING | E_STRICT | E_DEPRECATED)) return;
           
           throw new ErrorException($errMsg, $errLevel, $errLevel, $errFile, $errLine);
      }

◆ evaluateFile()

static Fakoli::evaluateFile ( $filePath )

static

Evaluates a PHP include file and returns the generated content.

Files can either be specified relative the application home directory, or relative to a component using the form "<component>,<relative path>"

Parameters

string $filePath path to the file

Returns: string the output generated by the file

Exceptions

FakoliException

Definition at line 650 of file core.inc.

      {
           global $config;
           global $method;
           global $user;
           global $script;
           global $styles;
           global $breadcrumbs;
           global $dialogs;
           global $page;
           global $site;
           global $menu_identifier;
           global $identifier;
           global $section;
           
           ob_start();
                
           $codePath = explode(",", $filePath);
           if (count($codePath) == 2)
           {
                $name = $codePath[0];
                $php_code_file = $codePath[1];
                $components = Fakoli::getComponents();
                if (array_key_exists($name, $components))
                {
                     
                     $path = $components[$name]->component_path."/{$php_code_file}";
                     trace("Evaluating $path", 3);
                     include $path;
                }
                else
                {
                     throw new FakoliException("Unknown component");
                }
           }
           else
           {
                $matches = array();
                if (preg_match('/^\/components\/(.*?)\//', $filePath, $matches))
                {
                     $c = $matches[1];
                     $path = str_replace("/components/{$c}", "", $filePath);
                     $component = Fakoli::getComponent($c);
                     if ($component)
                     {
                          $path = $component->component_path . $path;
                          include $path;
                     }
                }
                else
                {
                     include $config['homedir']."/{$filePath}";
                }
           }
           $output = ob_get_contents();
           ob_end_clean();          
           
           return $output;
      }

◆ exceptionHandler()

static Fakoli::exceptionHandler ( $exception )

static

Custom Exception Handler.

Parameters

Exception $exception

Returns: void|boolean

Definition at line 1386 of file core.inc.

      {
           global $isAction;
           global $config;
           
           try 
           {
           //Getting exception information
                $errMsg = $exception->getMessage();
                $errLevel = $exception->getCode();
                $errFile = $exception->getFile();
                $errLine = $exception->getLine();
              
                if ($errLevel & (E_NOTICE | E_WARNING | E_USER_WARNING | E_STRICT | E_DEPRECATED)) return;
           
                trace("ZIP: Winding back output buffers from ".ob_get_level(), 3);
                
                if (Fakoli::$rollbackBuffers)
                {
                     while(ob_get_level() > Fakoli::$outputBufferLevel) // Clear all output buffers.
                     {
                          ob_end_clean();
                     }
                }
                          
                $msg = $exception->getMessage();
                if ($config["bootstrap_error_stack_trace"])
                {
                     $msg .= "<br/><b>Stack trace:</b><br/>".$exception->getTraceAsString();
                }
                
                if ($isAction)
                {
                     echo $msg;
                }
                else
                {
                     $err = Fakoli::resolveResource("/fakoli/error.tpl");
                     $template = file_get_contents($err);
                     $out = str_replace("{message}", $msg, $template);
                     echo $out;
                }
                     
                ComponentManager::fireEvent("RequestComplete");
           }
           catch (Exception $ex)
           {
                echo $ex->getMessage();
                //Do nothing. 
                //Avoiding error from error handling...
           }
          
           /* Don't execute PHP internal error handler */
          return true;
      }

◆ get()

static Fakoli::get ( $key )

static

Retrieves the value or object at the given key.

This storage is volatile and limited to the scope of the current page request. This mechanism can be used to store information that needs to be communicated between modules rendering on the same page, or for other, similar purposes.

Parameters

string $key the key for the data to be retrieved

Returns: multitype:

Definition at line 109 of file core.inc.

109 { return Fakoli::$storage[$key]; }

Fakoli\$storage

static $storage

General storage (volatile). See Fakoli::put and Fakoli::get.

Definition: core.inc:85

◆ getAdminAccessRoles()

static Fakoli::getAdminAccessRoles ( )

static

Returns the user roles that have access to the admin section.

Definition at line 1074 of file core.inc.

      {
           global $config;
           $adminAccess = $config["admin_access_roles"];
           if (!$adminAccess) $adminAccess = "admin";
           return $adminAccess;
      }

◆ getAdminIcons()

static Fakoli::getAdminIcons ( )

static

Builds the admin icon map.

Components can subscribe to the RegisterAdminIcons event to specify icons for their own admin menu items.

Returns: array Array of icon names, indexed by menu item

Definition at line 456 of file core.inc.

      {
           $icons = Cache::get("fakoli_admin_icons");
           if ($icons) return $icons;
           
           $icons = array("Site Content"      => "file-alt",
                             "Site Configuration"  => "cogs",
                             "Collaboration"       => "comments", 
                             "Classification"      => "tags",
                             "Email Management"    => "envelope",
                             "User Management"     => "users",
                             "Users"                    => "user",
                             "Public Site"         => "home"
           );
           
           $icons = ComponentManager::fireEvent("RegisterAdminIcons", $icons);
           
           Cache::put("fakoli_admin_icons", $icons);
           return $icons;
      }

◆ getAdminMenu()

static Fakoli::getAdminMenu ( )

static

Builds the administration menu, combining menu items supplied by the registered components in their manifests.

Definition at line 405 of file core.inc.

      {
           $menu = Cache::get("fakoli_admin_menu");
           if ($menu) return $menu;
           
           $menu = array("Site Content"            => array(),
                            "Site Configuration"        => array(),
                            "Collaboration"             => array(),    
                            "Classification"            => array(),
                            "Email Management"          => array(),
                            "User Management"           => array());        
           
           $components = Fakoli::getComponents();
           foreach($components as $name => $component)
           {
                $manifest = $component->loadManifest();
                if (method_exists($manifest, getAdminMenu))
                {
                     $componentMenuItems = $manifest->getAdminMenu();
                     if ($componentMenuItems)
                     {
                          foreach($componentMenuItems as $category => $items)
                          {
                               if (!$menu[$category])
                               {
                                    $menu[$category] = $items;
                               }
                               else
                               {    
                                    $menu[$category] = array_merge($menu[$category], $items);
                               }
                          }              
                     }
                }
           }
           
           foreach($menu as $category => $items)
           {
                uasort($menu[$category], array(Fakoli, compareByWeight));
           }
           
           Cache::put("fakoli_admin_menu", $menu);
           
           return $menu;
      }

◆ getAdminPageRole()

Fakoli::getAdminPageRole ( $identifier )

Get the applicable access roles for a given admin page, based on information supplied by components in their manifests.

The rules to determine access roles for an admin page are:

By default ALL pages are accessible only to the admin role
Pages mentioned with explicit roles in the admin menu structure give access to those roles
If a component needs to grant access to an additional role for pages that are not mentioned in the admin menu (such as sub-pages within tabbed workflows) must list these by exposing a method named getAdminPageRoles() and returning an associative array of admin page identifiers to their allowed roles.
Only roles defined in the $config['admin_access_roles'] property have any level of access to admin
Parameters

string $identifier the identifier of the admin page to be checked

Definition at line 513 of file core.inc.

      {
           $uri = "/admin/$identifier";
           
           $role = "admin";
           $menu = Fakoli::getAdminMenu();
           foreach($menu as $heading => $items)
           {
                foreach($items as $item)
                {
                     if ($item["page"] == $uri)
                     {
                          if ($item["role"]) 
                          {
                               $role = $item["role"];
                               break;
                          }
                     }
                }
           }
           
           trace("###Role: $role", 3);
           
           $pageRoles = Fakoli::getAdminPageRoles();
           trace(print_r($pageRoles, true), 3);
           
           if ($pageRoles[$uri])
           {
                $role = $pageRoles[$uri];
           }
           
           trace("###ADMIN PAGE ROLE: $identifier $role", 3);
           return $role;       
      }    

◆ getComponent()

static Fakoli::getComponent ( $name )

static

Return the component record by name.

Parameters

string $name the name of the component

Returns: Component the component record for the specified component.

Definition at line 235 of file core.inc.

      {
           $components = Fakoli::getComponents();
           return $components[$name];
      }

◆ getComponentClassRoot()

static Fakoli::getComponentClassRoot ( $name )

static

Retrieves the capitalized camlCase name for the specified component.

This is the root of the name for the component's manifest class.

Parameters

string $name the component's name

Definition at line 752 of file core.inc.

      {
           return str_replace(" ", "", prettify($name));
      }

◆ getComponentForClass()

static Fakoli::getComponentForClass ( $class )

static

Find the component containing the specified class.

Definition at line 1123 of file core.inc.

      {
           $reflector = new ReflectionClass($class);
           $file = $reflector->getFileName();
           trace("File for $class: $file", 3);
           
           if ($file)
           {
                $file = str_replace(DIRECTORY_SEPARATOR, "/", $file);
                
                $matches = array();
                if (preg_match("/components\\/(.*?)\\//", $file, $matches))
                {
                     trace("Component for $class is {$matches[1]}", 3);                    
                     return $matches[1];
                }
           }
           
           throw new FakoliException("Failed to determine component for $class");
      }

◆ getComponents()

static Fakoli::getComponents ( )

static

Retrieve an array of all the currently enabled components, indexed by component name.

Returns: array

Definition at line 206 of file core.inc.

      {
           $components = Cache::get("fakoli_components");
           
           if (!$components)
           {
                $component = new Component();
                if (!$component->tableExists()) Fakoli::bootstrap();
           
                $components = indexedQuery(Component, "WHERE enabled=1", "name");
                if (count($components) == 0)
                {
                     Fakoli::initialComponentScan();
                     $components = Cache::get("fakoli_components");
                }
                else
                {
                     Cache::put("fakoli_components", $components);
                }
           }
           
           return $components;
      }

◆ getFileSystemInfo()

static Fakoli::getFileSystemInfo ( )

static

Returns formatted summary information regarding usage of the server's filesystem.

Returns: string

Definition at line 1506 of file core.inc.

     {
      global $config;
      
      if (isset($config['filesystems']))
      {
           $fs = explode(",", $config['filesystems']);
      }
      else if (Fakoli::detectWindowsOS())
      {
           $fs = array("C:");
      }
      else
      {
           $fs = array("/");
      }
      
      $out = "<table class='list'><thead><tr><th>File System</th><th>Size</th><th>Available</th><th>% Free</th></tr></thead><tbody>";
      foreach($fs as $f)
      {
           $free = disk_free_space($f);
           $total = disk_total_space($f);
           $percent = number_format($free * 100 / $total, 1);
           $style = ($percent < 10) ? " style='background-color: #f00;color: #fff'" : (($percent < 25) ? " style='background-color: #ff0'" : "");
           $out .= "<tr$style><td>$f</td><td style='text-align: right'>" . getScaledSize($total) . 
                     "</td><td style='text-align: right'>" . getScaledSize($free) . 
                     "</td><td style='text-align: right'>" . $percent . "%</td></tr>";
      }
      
      $out .= "</tbody></table>";
      return $out;
     }

◆ getLocalIP()

static Fakoli::getLocalIP ( )

static

Returns the local IP address for the server.

Definition at line 360 of file core.inc.

      {
           $ip = Settings::getValue("settings", "local_IP_address");
           return ($ip) ? $ip : $_SERVER["SERVER_ADDR"];
      }

◆ getScripts()

static Fakoli::getScripts ( )

static

Returns the HTML scripts tags for Javascript files specified by the registered components in their manifest files.

Definition at line 554 of file core.inc.

      {
           $scripts = Cache::get("fakoli_scripts");
           if ($scripts) return $scripts;
           
           $scriptArray = Fakoli::loadScripts();
           foreach($scriptArray as $s)
           {
                Fakoli::$includedScripts[$s] = true;
           }
           
           $scriptArray = ComponentManager::fireEvent("PreProcessScripts", $scriptArray);
           
           $scripts = "";
           foreach($scriptArray as $s)
           {
                $scripts .= "  <script type='text/javascript' src='$s'></script>\n";
           }
           
           Cache::put("fakoli_scripts", $scripts);
           return $scripts;
      }

◆ getServerLoad()

static Fakoli::getServerLoad ( )

static

Retrieves information about the Server CPU load.

For Windows systems this is reported as percentage CPU. For Linux/UNIX systems the load information is returned in uptime format.

Note that in order for the system to return correct load values on Windows, the application pool must be running as a user with permission to read performance counters (such as NetworkService).

Definition at line 1469 of file core.inc.

      {
           $out = "";
           
           if (Fakoli::detectWindowsOS()) 
           {              
                if (class_exists("COM"))
                {
                  $wmi = new COM("Winmgmts:{impersonationlevel=impersonate}!\\Root\\Cimv2");
                     $cpus = $wmi->InstancesOf("Win32_Processor");
        
                     foreach ($cpus as $cpu) 
                     {
                          $out .=  $cpu->LoadPercentage."% ";
                     }
                }
                else
                {
                     $out .= "Not Available";
                }              
         } 
         else 
         {       
             $sys_load = sys_getloadavg();
             $load0 = number_format($sys_load[0], 2);
             $load1 = number_format($sys_load[1], 2);
             $load2 = number_format($sys_load[2], 2);
             $out = "$load0&nbsp;&nbsp;&nbsp;$load1&nbsp;&nbsp;&nbsp;$load2";       
         }
        
         return $out;  
     }

◆ getStyles()

static Fakoli::getStyles ( )

static

Returns the HTML link tags for CSS files specified by the registered components in their manifest files.

Definition at line 603 of file core.inc.

      {
           $styles = Cache::get("fakoli_styles");
           if ($styles) return $styles;
  
           $styleArray = Fakoli::loadStyles();          
           $styleArray = ComponentManager::fireEvent("PreProcessStyles", $styleArray);
           
           $styles = "";
           foreach($styleArray as $s)
           {
                $styles .= "  <link href='$s' rel='stylesheet' type='text/css' media='all'/>\n";
           }
           
           Cache::put("fakoli_styles", $styles);
           return $styles;          
      }

◆ includeScript()

static Fakoli::includeScript ( $src )

static

Utility function to pull in a specific Javascript file for the current page.

Parameters

string $src the URL of the Javascript file

Definition at line 714 of file core.inc.

      {
           global $isResource;
           global $script;
           if (!array_key_exists($src, Fakoli::$includedScripts))
           {
                $script .= "<script type='text/javascript' src='$src'></script>\n";
                Fakoli::$includedScripts[$src] = true;
           }
      }

◆ includeStylesheet()

static Fakoli::includeStylesheet	(	$src,
		$media = `"all"`
	)

static

Utility function to pull in a specific CSS Stylesheet for the current page.

Parameters

string	$src	the URL of the stylesheet
string	$media	the target media for the stylesheet (defaults to 'all')

Definition at line 730 of file core.inc.

      {
           global $styles;
           $styles .= "<link href='$src' rel='stylesheet' type='text/css' media='$media'/>\n";
      }

◆ initialComponentScan()

static Fakoli::initialComponentScan ( )

static

Performs a complete component scan if the component table is found to be empty.

Definition at line 255 of file core.inc.

      {
           global $config;
           
           require_once realpath(dirname(__FILE__)."/components/component/datamodel/component.inc");
           require_once realpath(dirname(__FILE__)."/components/component/datamodel/component_page.inc");
           require_once realpath(dirname(__FILE__)."/components/component/datamodel/admin_page.inc");
           require_once realpath(dirname(__FILE__)."/components/component/datamodel/component_update_log.inc");
           require_once realpath(dirname(__FILE__)."/components/component/serialization_manager.inc");
           require_once realpath(dirname(__FILE__)."/components/component/component_manager.inc");
           require_once realpath(dirname(__FILE__)."/components/component/upgrade_manager.inc");
           require_once realpath(dirname(__FILE__)."/components/component/component_upgrade_manager.inc");
           
           $mgr = new ComponentManager();
           $mgr->scan($config["scan_verbosity"]);
      }

◆ isUserActive()

static Fakoli::isUserActive ( $user )

static

Checks if the given user is active.

Parameters

Object $user

Definition at line 349 of file core.inc.

      {
           $mgr = new UserManager();
           if (method_exists($mgr, "isActive")) return $mgr->isActive($user);
           if ($user->hasField("active")) return $user->active;
           return false;
      }

◆ JSONerror()

static Fakoli::JSONerror	(	$error,
		$sendType = `true`
	)

static

Return an error code to the client in JSON format, as an object with the single property 'error'.

Parameters

String $error the error message to be converted to an object and returned

Definition at line 1180 of file core.inc.

      {
           if ($sendType) header("Content-Type: application/json");
           
           $errorObject = (object)array('error' => $error);
           
           throw new FakoliEarlyExit(json_encode($errorObject));
      }

◆ JSONreturn()

static Fakoli::JSONreturn	(	$object,
		$sendType = `true`,
		$wrap = `true`
	)

static

Return a DataItem to the client in JSON format.

Parameters

mixed	$object	the object to be returned
boolean	$sendType	true to send the content type
boolean	$wrap	true to wrap the returned output into a result field, false to send unwrapped

Definition at line 1160 of file core.inc.

      {
           if ($sendType) header("Content-Type: application/json");
           if (method_exists($object, "toJSON"))
           {
                $out = ($wrap) ? '{"result": '.$object->toJSON().'}' : $object->toJSON();
           }
           else 
           {         
                $out = ($wrap) ? '{"result": '.json_encode($object).'}' : json_encode($object);
           }
           
           throw new FakoliEarlyExit($out);        
      }

◆ loadResource()

static Fakoli::loadResource	(	$resource,
		$component = `""`
	)

static

Load the specified resource into memory.

Parameters

string $resource

Definition at line 932 of file core.inc.

      {
           $path = Fakoli::resolveResource($resource, $component);
           if ($path) return file_get_contents($path);
           return null;
      }

◆ loadScripts()

static Fakoli::loadScripts ( )

static

Load the list of JS scripts from the manifests of all registered, active components.

Returns: array an array containing all the script paths in the correct include order.

Definition at line 581 of file core.inc.

      {
           $scriptArray = array();
           
           $components = Query::create(Component, "WHERE enabled=1 ORDER BY priority")->execute();
           foreach($components as $component)
           {
                $manifest = $component->loadManifest();
                if (method_exists($manifest, getScripts))
                {
                     // Calculate union of scripts
                     $scriptArray = array_merge($scriptArray, array_diff($manifest->getScripts(), $scriptArray));
                }
           }
           
           return $scriptArray;
      }

◆ loadStyles()

static Fakoli::loadStyles ( )

static

Load the list of CSS files from the manifests of all registered, active components.

Returns: array an array containing all the file paths in the correct include order.

Definition at line 625 of file core.inc.

      {
           $styleArray = array();
           
           $components = Query::create(Component, "WHERE enabled=1 ORDER BY priority")->execute();
           foreach($components as $component)
           {
                $manifest = $component->loadManifest();
                if (method_exists($manifest, getStyles))
                {
                     // Calculate union of styles
                     $styleArray = array_merge($styleArray, array_diff($manifest->getStyles(), $styleArray));
                }
           }
           
           return $styleArray;
      }

◆ notify()

static Fakoli::notify	(	$message,
		$blocking = `false`,
		$button = `"OK"`,
		$onClick = `"null"`
	)

static

Utility method to display a notification message to the user when the page has finished loading.

This is useful for displaying information after a form has been saved, etc.

Parameters

string	$message	the notification message to be displayed
boolean	$blocking	(optional) true if the user has to dismiss the message manually, false (default) if it should disappear automatically
string	$button	(optional) button text to show for blocking notifications,
string	$onClick	(optional) Javascript code to execute when the OK button is clicked

Definition at line 1198 of file core.inc.

      {
           $message = jsSafe($message);
           
           if ($blocking)
           {
                $options = ", {blocking: true, buttonText: '$button', onClick: $onClick}";
           }
           global $script;
           $script .= 
 <<<ENDSCRIPT
           <script type='text/javascript'>
           window.addEvent('load', function()
           {
                notification("$message"$options);
           });
           </script>
 ENDSCRIPT;
      }

◆ notifyOnNextPage()

static Fakoli::notifyOnNextPage	(	$message,
		$blocking = `false`,
		$button = `"OK"`,
		$onClick = `"null"`
	)

static

Schedules a notification message to be displayed to the user at the next full page load.

Use this when you need to display a notification after a redirect.

Parameters

string $message

Definition at line 1223 of file core.inc.

      {
           $_SESSION["notification_pending"] = $message;
           $_SESSION["notification_pending_blocking"] = $blocking;
           $_SESSION["notification_pending_button"] = $button;
           $_SESSION["notification_pending_onclick"] = $onClick;
      }

◆ put()

static Fakoli::put	(	$key,
		$obj
	)

static

Stores a value or object at the given key.

This storage is volatile and limited to the scope of the current page request. This mechanism can be used to store information that needs to be communicated between modules rendering on the same page, or for other, similar purposes.

Parameters

string	$key	the key to store the data under
mixed	$obj	the object or value to be stored.

Definition at line 99 of file core.inc.

99 { Fakoli::$storage[$key] = $obj; }

$obj

Definition: data_import_select.inc:29

◆ resolveResource()

static Fakoli::resolveResource	(	$resource,
		$component = `""`
	)

static

Resolves the path to a web resource based on the PHP include path.

Parameters

string	$path	the web resource path (URI)
string	$component	(optional) the component that owns the resource

Returns: string the full server path of the matching file.

Definition at line 850 of file core.inc.

      {
           global $config;
           
           if (strpos("../", $resource) !== FALSE)
           {
                throw new FakoliException("Attempt to resolve illegal resource path");
           }
           
           if (endsWith($resource, ".inc") || endsWith($resource, ".php"))
           {
                header("HTTP/1.0 403 Forbidden");
                throw new FakoliException("Access Forbidden");              
           }
           
           $resource = sanitizePath($resource);
           
           $dir = dirname($resource);
           
           // Exclude the following component sub-directories
           if ($dir == "datamodel" || $dir == "updates" || $dir == "admin") return null;
           
           $components = Fakoli::getComponents();
           
           if ($component)
           {
                if (!$components[$component])
                {
                     throw new FakoliException("Attempt to reference unknown or disabled component '$component'");
                }
                
                $c = $components[$component];
                
                $file = $c->component_path . DIRECTORY_SEPARATOR . $resource;
                
                return (file_exists($file)) ? $file : null;
           }
           
           $file = Cache::get("resource:$resource");
           if ($file) return $file;
           
           $path = $config['homedir'] . PATH_SEPARATOR . ini_get("include_path");
           if (isset($config["extra_includes"])) $path .= PATH_SEPARATOR . $config["extra_includes"];
           
           $roots = explode(PATH_SEPARATOR, $path);
                
           foreach($roots as $root)
           {
                $file = sanitizePath($root . DIRECTORY_SEPARATOR . $resource);
                if (file_exists($file))
                {
                     Cache::put("resource:$resource", $file);
                     return $file;
                }
                
                $file = sanitizePath($root . DIRECTORY_SEPARATOR . "cms" . DIRECTORY_SEPARATOR . $resource);
                if (file_exists($file))
                {
                     Cache::put("resource:$resource", $file);
                     return $file;
                }              
           }
  
           foreach($components as $name => $c)
           {
                $file = sanitizePath($c->component_path . DIRECTORY_SEPARATOR . $resource);
                if (file_exists($file))
                {                   
                     Cache::put("resource:$resource", $file);
                     return $file;
                }
           }
                     
           trace("Cannot resolve $file", 2);
           
           return null;
      }

◆ scheduledTaskTraceLevel()

static Fakoli::scheduledTaskTraceLevel ( )

static

Changed to the configured trace level for scheduled task worker code.

Definition at line 1354 of file core.inc.

      {
           Fakoli::setTraceLevel(Settings::getValue("debug", "scheduled_task_trace_level"));
      }

◆ scriptName()

static Fakoli::scriptName ( )

static

Returns the name of the currently executing script.

Returns: string the script that is currently executing

Definition at line 1446 of file core.inc.

      {
           list ($s, $qs) = explode("?", $_SERVER['REQUEST_URI']);
           return $s;          
      }

◆ scriptOnNextPage()

Fakoli::scriptOnNextPage ( $s )

Schedules the provided script fragment to be output when the next page is loaded.

Parameters

string $s the script to be executed (including the enclosing script tags)

Definition at line 1305 of file core.inc.

      {
           $_SESSION["script_pending"] .= $s;
      }

◆ scrollTo()

Fakoli::scrollTo	(	$element,
		$offset = `0`
	)

Automatically scroll the page to the specified element (by DOM ID) when the page loads.

An optional offset can be specified to account for headers, etc.

Parameters

string	$element	the DOM ID of the element to scroll to
integer	$offset	(optional) offset in pixels

Definition at line 1259 of file core.inc.

      {
           global $script;
           $script .=
 <<<ENDSCRIPT
      <script type='text/javascript'>
      window.addEvent('domready', function()
      {
           window.scrollToElement('{$element}', $offset);
      });
      </script>
 ENDSCRIPT;
      }

◆ scrollToOnNextPage()

Fakoli::scrollToOnNextPage	(	$element,
		$offset = `0`
	)

Schedules a scrollTo event when the next page is loaded.

Parameters

string	$element	the DOM ID of the element to scroll to
integer	$offset	(optional) offset in pixels

Definition at line 1279 of file core.inc.

      {
           $_SESSION["scrollto_pending"] = $element;
           $_SESSION["scrollto_offset"] = $offset;
      }

◆ sendAdminPage()

static Fakoli::sendAdminPage ( $identifier )

static

Send the admin page for the given identifier.

Parameters

string $identifier the admin page to be sent to the client

Definition at line 1097 of file core.inc.

      {
           $adminAccess = Fakoli::getAdminAccessRoles();
           
           $pageRole = Fakoli::getAdminPageRole($identifier);
           
           if ($identifier != "login" && $identifier != "password_help") 
           {
                Fakoli::assertRole($adminAccess, "/admin/login");
                Fakoli::assertRole($pageRole, "/admin/login");
           }
           
           $https = Fakoli::checkSSL();
           
           if ($config['admin_SSL'] && !$https )
           {
                redirect("https://".$config['http_host'].$_SERVER['REQUEST_URI']);
           }
           
           $view = new AdminPageView($identifier);
           $view->drawView();       
      }

◆ sendFile()

static Fakoli::sendFile ( $resource )

static

Sends the contents of the specified file to the client.

Parameters

string $resource the full local file path of the resource

Definition at line 780 of file core.inc.

      {
          $last_modified = filemtime($resource);
           
           $mimeType = DocumentHandler::getMIMEType($resource);
           
          if(array_key_exists("HTTP_IF_MODIFIED_SINCE",$_SERVER))
          {
           
              $if_modified_since=strtotime($_SERVER["HTTP_IF_MODIFIED_SINCE"]);
           //$if_modified_since=strtotime(preg_replace('/;.*$/','',$_SERVER["HTTP_IF_MODIFIED_SINCE"]));
              
              if($if_modified_since >= $last_modified)
              {
                  header("HTTP/1.0 304 Not Modified");
                  $noChange = true;
              }
          }
  
           header("Content-Type: $mimeType"); 
           header("Last-Modified: ".date('r', $last_modified));
           header("Cache-Control: max-age=300, must-revalidate");
           header("Pragma: private");
           header("Expires: " . date(DATE_RFC822,strtotime(" 2 day")));
           
           if (!$noChange)
           {
                if (Fakoli::detectXSendFileSupport())
                {
                     header("X-SendFile: $resource");
                     return;   
                }
                else
                {
                     $f = fopen($resource, "r");
           
                    $size = filesize($resource);
                     header("Content-Length: $size");
                               
                     fpassthru($f);
                     fclose($f);
                }
           }
           
           ComponentManager::fireEvent("RequestComplete");
      }

◆ sendPage()

static Fakoli::sendPage	(	$sectionIdentifier,
		$identifier,
		$page_id = `null`
	)

static

Serves the page with the specified section and identifier.

Parameters

string	$sectionIdentifier	the identifier of the section
string	$identifier	the identifier of the page
int	$page_id	numeric page identifier (deprecated)

Definition at line 978 of file core.inc.

      {
           trace("Send Page: '$sectionIdentifier', '$identifier', '$page_id'", 2);
           
           $site = Site::getSite();
           
           if (!$sectionIdentifier) $sectionIdentifier = "/";
           
           if ($sectionIdentifier == "/" && $identifier == "admin")
           {
                redirect("/admin/index");
           }
           
           if (!$identifier && $page_id)
           {
                throw new FakoliException("Page ID access has been deprecated.");
           }
           
           global $config;
           global $section;
           
           try
           {
                $section = Section::createFromIdentifier($sectionIdentifier);
  
                ComponentManager::fireEvent("OverrideResource", $identifier);
                
                if (!$section)
                {
                     throw new FakoliException("The section you were attempting to access could not be found.");
                }
                
                $contentManager = $section->getContentManager();
                
                if (!$identifier)
                {
                     $url = $section->getSectionURL();
                     redirect($url.$contentManager->getDefaultPage($section));
                }
                else
                {
                     $alias = ComponentManager::fireEvent("PreprocessURI", $identifier);
                     if ($alias) $identifier = $alias;
                }
                
                $content = $section->getContent($identifier);
                if (!$content)
                {
                     ComponentManager::fireEvent("ResourceNotFound", $identifier);
                          
                     throw new FakoliException("The page you were attempting to access could not be found.");
                }
                
                $permissions = $section->getPermissions($content);
                if ($permissions)
                {
                     trace("Checking Permissions: [{$permissions}]", 4);
                     if (!Settings::checkPermissions($permissions))
                     {
                          LoginManager::redirectToLogin();
                     }
                }
                else if (!checkRole($section->getRole($content)))
                {
                     LoginManager::redirectToLogin();
                }
                
                trace("\$_SERVER['HTTPS'] = {$_SERVER['HTTPS']}", 3);
                trace("\$_SERVER['REQUEST_URI'] = {$_SERVER['REQUEST_URI']}", 3);
                
                $https = Fakoli::checkSSL();
                
                $useSSL = $section->use_SSL || $content->use_SSL;
                
                if ($useSSL && !$https )
                {
                     redirect("https://".$config['http_host'].$_SERVER['REQUEST_URI']);
                }
                else if (!$useSSL && $https && $identifier != "login" && !isset($_REQUEST["login"]))
                {
                     redirect("http://".$config['http_host'].$_SERVER['REQUEST_URI']);
                }
                
                ComponentManager::fireEvent("StartPage");
                $contentManager->sendContent($section, $identifier);
                ComponentManager::fireEvent("RequestComplete");        
           }
           catch(FakoliEarlyExit $exit)
           {
                echo $exit->getMessage();
           }         
      }

◆ sendResource()

static Fakoli::sendResource	(	$uri,
		$component = `""`
	)

static

Sends the resource at the specified URI to the client.

This is used by the resource.php dispatcher to send files owned by the library that may not be within the web root.

Parameters

string	$uri	the URI to the resource
string	$component	the component that owns the resource

Definition at line 765 of file core.inc.

      {
           $resource = Fakoli::resolveResource($uri, $component);
           if (!$resource)
           {
                throw new FakoliException("Cannot find resource '$uri'");
           }
           
           Fakoli::sendFile($resource);
      }

◆ setTraceLevel()

static Fakoli::setTraceLevel ( $level )

static

Set the trace log level.

Definition at line 1329 of file core.inc.

      {
           global $config;
           $config["trace_level"] = $level;        
      }

◆ showPendingNotification()

static Fakoli::showPendingNotification ( )

static

Display any previously scheduled notification message.

Definition at line 1234 of file core.inc.

      {
           global $isAction;
           global $isResource;
           
           if (!$isAction &&  !$isResource && isset($_SESSION["notification_pending"]))
           {
                Fakoli::notify($_SESSION["notification_pending"], 
                                  $_SESSION["notification_pending_blocking"], 
                                  $_SESSION["notification_pending_button"],
                                  $_SESSION["notification_pending_onclick"]);
                unset($_SESSION["notification_pending"]);
                unset($_SESSION["notification_pending_blocking"]);
                unset($_SESSION["notification_pending_button"]);
                unset($_SESSION["notification_pending_onclick"]);
           }
      }

◆ showPendingScrollTo()

static Fakoli::showPendingScrollTo ( )

static

Display any previously scheduled scrollto event.

Definition at line 1288 of file core.inc.

      {
           global $isAction;
           global $isResource;
           
           if (!$isAction &&  !$isResource && isset($_SESSION["scrollto_pending"]))
           {
                Fakoli::scrollTo($_SESSION["scrollto_pending"], $_SESSION["scrollto_offset"]);
                unset($_SESSION["scrollto_pending"]);
                unset($_SESSION["scrollto_offset"]);
           }
      }

◆ shutdownHandler()

static Fakoli::shutdownHandler ( )

static

Custom shutdown handler.

Definition at line 1542 of file core.inc.

     {
      global $config;
      $error = error_get_last();
      
      trace("## Shutdown", 4);
      
          if ($error)
          {
           switch($error['type'])
           {
              case E_ERROR:
              case E_CORE_ERROR:
              case E_COMPILE_ERROR:
              case E_USER_ERROR:
                
                trace($error['message']." at ".$error['file'].":".$error['line'], 1);
  
                if ($config["dump_includes"]) 
                  {
                     printIncludes();
                  }
                  break;
              }
          }   
     }

◆ using()

static Fakoli::using ( )

static

Import the datamodels, views and manifest for the specified component(s).

More than one component can be specified in the call.

Parameters

string $component the component to import

Definition at line 116 of file core.inc.

      {
           global $config;
           
           $num = func_num_args();
           for($i = 0; $i < $num; ++$i)
           {
                $component = func_get_arg($i);
                
                if (array_key_exists($component, Fakoli::$componentsUsed)) continue;
           
           Fakoli::$componentsUsed[$component] = true;
                
                $includes = Cache::get("fakoli_includes_$component");
                if ($includes)
                {
                     if ($config['strict_includes'])
                     {
                          foreach ($includes as $include)
                          {
                               require_once $include;
                          }
                     }
                     else
                     {
                          foreach ($includes as $include)
                          {
                               include_once $include;
                          }
                     }                   
                     continue;
                }
      
                $components = Fakoli::getComponents();
                
                if (!$components[$component])
                {
                     trace("Attempt to reference unknown or disabled component '$component'", 2);
                     continue;
                }
                
                $includes = array();
                
                $c = $components[$component];
                
                $dm = $c->component_path . DIRECTORY_SEPARATOR . "datamodel";
                if (is_dir($dm))
                {
                     $handle = opendir($dm);
                     while(false !== ($file = readdir($handle))) 
                {
                     if (endsWith($file, ".inc"))
                     {
                          $f = $dm . DIRECTORY_SEPARATOR . $file;
  
                          $includes[] = $f;
                          require_once $f;
                     }
                }
                
                closedir($handle);
                }
                
                trace($c->component_path, 4);
                
                $handle = opendir($c->component_path);
      
                if (!$handle) continue;
                
                while(false !== ($file = readdir($handle))) 
           {
                if (endsWith($file, ".inc"))
                {
                     $f = $c->component_path . DIRECTORY_SEPARATOR . $file;
  
                     $includes[] = $f;
                     require_once $f;
                }
           }
           
           closedir($handle);
           
           Cache::put("fakoli_includes_$component", $includes);        
           }
      }

◆ usingFeature()

static Fakoli::usingFeature ( )

static

Uses the specified framework feature(s).

Each feature corresponds to a file in the framework directory (without the extension). Use this method to select the framework functionality you require for your page, (such as 'auto_form' or 'data_view').

Definition at line 388 of file core.inc.

      {
           $num = func_num_args();
           
           for($i = 0; $i < $num; ++$i)
           {
                $file = func_get_arg($i);
                
                $f = realpath(dirname(__FILE__)."/../framework/{$file}.inc");
                require_once $f;
           }
      }    

◆ usingFile()

static Fakoli::usingFile ( )

static

Uses the specified framework file(s) from the framework directory.

Definition at line 369 of file core.inc.

      {
           $num = func_num_args();
           
           for($i = 0; $i < $num; ++$i)
           {
                $file = func_get_arg($i);
                
                $f = realpath(dirname(__FILE__)."/../$file");
                require_once $f;
           }
      }

◆ writePendingScripts()

static Fakoli::writePendingScripts ( )

static

Outputs any pending scripts submitted by Fakoli::scriptOnNextPage()

Definition at line 1313 of file core.inc.

      {
           global $isAction;
           global $isResource;
           global $script;
           
           if (!$isAction && !$isResource && isset($_SESSION["script_pending"]))
           {
                $script .= $_SESSION["script_pending"];
                unset($_SESSION["script_pending"]);
           }
      }

Member Data Documentation

◆ $bodyClass

Fakoli::$bodyClass = ""

static

Override for the body class of the page currently being served.

Definition at line 89 of file core.inc.

◆ $componentsUsed

Fakoli::$componentsUsed = array()

static

Array of the components that have been referenced in this page request.

Definition at line 81 of file core.inc.

◆ $outputBufferLevel

Fakoli::$outputBufferLevel = 0

static

Records the level at which gzip output buffering began.

Definition at line 83 of file core.inc.

◆ $requestStartTime

Fakoli::$requestStartTime

static

Start of request in DateTime format.

Definition at line 87 of file core.inc.

◆ $requestURI

Fakoli::$requestURI

static

The initial request URI.

Definition at line 88 of file core.inc.

◆ $rollbackBuffers

Fakoli::$rollbackBuffers = true

static

Specifies whether to rollback output buffers when there is an unhandled exception.

Definition at line 84 of file core.inc.

◆ $scanning

Fakoli::$scanning = false

static

Semaphore indicating that a component scan is in progress.

Definition at line 82 of file core.inc.

◆ $storage

Fakoli::$storage = array()

static

General storage (volatile). See Fakoli::put and Fakoli::get.

Definition at line 85 of file core.inc.

◆ $timestamp

Fakoli::$timestamp

static

Microsecond Timestamp for start of request.

Definition at line 86 of file core.inc.

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

C:/code/cms.sonjara.com/cms/core.inc

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ applicationTraceLevel()

◆ applyTemplate()

◆ assertRole()

◆ bootstrap()

◆ checkRole()

◆ checkSSL()

◆ compareByWeight()

◆ componentExists()

◆ coreTraceLevel()

◆ countActiveSessions()

◆ detectWindowsOS()

◆ detectXSendFileSupport()

◆ end()

◆ errorHandler()

◆ evaluateFile()

◆ exceptionHandler()

◆ get()

◆ getAdminAccessRoles()

◆ getAdminIcons()

◆ getAdminMenu()

◆ getAdminPageRole()

◆ getComponent()

◆ getComponentClassRoot()

◆ getComponentForClass()

◆ getComponents()

◆ getFileSystemInfo()

◆ getLocalIP()

◆ getScripts()

◆ getServerLoad()

◆ getStyles()

◆ includeScript()

◆ includeStylesheet()

◆ initialComponentScan()

◆ isUserActive()

◆ JSONerror()

◆ JSONreturn()

◆ loadResource()

◆ loadScripts()

◆ loadStyles()

◆ notify()

◆ notifyOnNextPage()

◆ put()

◆ resolveResource()

◆ scheduledTaskTraceLevel()

◆ scriptName()

◆ scriptOnNextPage()

◆ scrollTo()

◆ scrollToOnNextPage()

◆ sendAdminPage()

◆ sendFile()

◆ sendPage()

◆ sendResource()

◆ setTraceLevel()

◆ showPendingNotification()

◆ showPendingScrollTo()

◆ shutdownHandler()

◆ using()

◆ usingFeature()

◆ usingFile()

◆ writePendingScripts()

Member Data Documentation

◆ $bodyClass

◆ $componentsUsed

◆ $outputBufferLevel

◆ $requestStartTime

◆ $requestURI

◆ $rollbackBuffers

◆ $scanning

◆ $storage

◆ $timestamp