mako\Mako

Description

Class containing core methods that are used throughout the framework.

Class methods

protected __construct()

Protected constructor since this is a static class.

Return value

NULL

protected function __construct()
{
	// Nothing here
}

Toggle source

public static init()

Initializes the system.

Return value

NULL

public static function init()
{
	// Include bootstrap file
	
	require MAKO_APPLICATION . '/bootstrap.php';

	// Load config

	static::$config = Config::get('mako');

	// Set internal charset

	define('MAKO_CHARSET', static::$config['charset']);

	mb_language('uni');
	mb_regex_encoding(MAKO_CHARSET);
	mb_internal_encoding(MAKO_CHARSET);

	if(PHP_SAPI !== 'cli')
	{
		// Start output buffering

		ob_start();

		// Setup error handling
		
		if(static::$config['error_handler']['enable'] === true)
		{
			set_error_handler('\mako\Mako::errorHandler');
			
			register_shutdown_function('\mako\Mako::fatalErrorHandler');
			
			set_exception_handler('\mako\Mako::exceptionHandler');
		}
		
		// Send default header
		
		header('Content-Type: text/html; charset=' . MAKO_CHARSET);
				
		// Clean input

		if(MAKO_MAGIC_QUOTES === 1)
		{
			$_GET     = static::cleanInput($_GET);
			$_POST    = static::cleanInput($_POST);
			$_COOKIE  = static::cleanInput($_COOKIE);
			$_REQUEST = static::cleanInput($_REQUEST);
		}
	}

	// Set default timezone
	
	date_default_timezone_set(static::$config['timezone']);
	
	// Set locale
	
	static::locale(static::$config['locale']['locales'], static::$config['locale']['lc_numeric']);

	// Set up class aliases

	foreach(static::$config['aliases'] as $alias => $className)
	{
		ClassLoader::alias($alias, $className);
	}

	// Initialize packages

	foreach(static::$config['packages'] as $package)
	{
		Package::init($package);
	}
}

Toggle source

public static run($route = NULL)

Executes request and sends response.

Parameters

Type	Description
string	(optional) URL segments passed to the request handler.

Return value

NULL

public static function run($route = null)
{
	static::init();

	try
	{
		Request::factory($route)->execute()->send();
	}
	catch(RequestException $e)
	{
		Response::factory(new View('_errors/' . $e->getMessage()))->send($e->getMessage());
	}	
}

Toggle source

protected static cleanInput($input)

Removes slashes added by magic quotes.

Parameters

Type	Description
mixed	String or array to clean

Return value

mixed

protected static function cleanInput($input)
{
	if(is_array($input))
	{
		foreach($input as $key => $value)
		{
			$input[$key] = static::cleanInput($value);
		}
	}
	else
	{
		$input = stripslashes($input);
	}
	
	return $input;
}

Toggle source

public static locale($locale = NULL, $numeric = false)

Set locale information.

Parameters

Type	Description
mixed	(optional) Locale or array of locales to try until success
boolean	(optional) Set to false to use the 'C' locale for LC_NUMERIC

Return value

NULL

public static function locale($locale = null, $numeric = false)
{
	if($locale !== null)
	{	
		setlocale(LC_ALL, $locale);
		
		if($numeric === false)
		{
			setlocale(LC_NUMERIC, 'C');
		}
	}
}

Toggle source

public static path($path, $string)

Returns path to a package or application directory.

Parameters

Type	Description
string	Path
string	String

Return value

string

public static function path($path, $string)
{
	if(strpos($string, '::') !== false)
	{
		list($package, $file) = explode('::', $string);

		$path = MAKO_PACKAGES . '/' . $package . '/' . $path . '/' . $file . '.php';
	}
	else
	{
		$path = MAKO_APPLICATION . '/' . $path . '/' . $string . '.php';
	}

	return $path;
}

Toggle source

protected static highlightCode($file, $line, $padding = 6)

Returns an array of lines from a file.

Parameters

Type	Description
string	File in which you want to highlight a line
int	Line number to highlight
int	(optional) Number of padding lines

Return value

array

protected static function highlightCode($file, $line, $padding = 6)
{
	if(!is_readable($file))
	{
		return false;
	}

	$highlight = function($string)
	{
		$search  = array("\r\n", "\n\r", "\r", "\n", '<code>', '</code>', '<span style="color: #0000BB">&lt;?php&nbsp;', '#$@r4!/*');
		$replace = array('', '', '', '', '', '', '<span style="color: #0000BB">', '/*');

		return str_replace($search, $replace, highlight_string('<?php ' . str_replace('/*', '#$@r4!/*', $string), true));	
	};

	$handle      = fopen($file, 'r');
	$lines       = array();
	$currentLine = 0;

	while(!feof($handle))
	{
		$currentLine++;

		$temp = fgets($handle);

		if($currentLine > $line + $padding)
		{
			break; // Exit loop after we have found what we were looking for
		}

		if($currentLine >= ($line - $padding) && $currentLine <= ($line + $padding))
		{
			$lines[] = array
			(
				'number'      => str_pad($currentLine, 4, ' ', STR_PAD_LEFT),
				'highlighted' => ($currentLine === $line),
				'code'        => $highlight($temp),
			);
		}
	}

	fclose($handle);

	return $lines;
}

Toggle source

protected static formatBacktrace($backtrace)

Returns a backtrace array.

Parameters

Type	Description
array	Array returned by the getTrace() method of an exception object

Return value

array

protected static function formatBacktrace($backtrace)
{
	if(is_array($backtrace) === false || count($backtrace) === 0)
	{
		return $backtrace;
	}
	
	// Remove unnecessary info from backtrace
	
	if($backtrace[0]['function'] == '{closure}')
	{
		unset($backtrace[0]);
	}
	
	// Format backtrace

	$trace = array();

	foreach($backtrace as $entry)
	{
		// Function
		
		$function = '';
		
		if(isset($entry['class']))
		{
			$function .= $entry['class'] . $entry['type'];
		}
		
		$function .= $entry['function'] . '()';
		
		// Arguments
		
		$arguments = array();
		
		if(isset($entry['args']) && count($entry['args']) > 0)
		{
			foreach($entry['args'] as $arg)
			{
				ob_start();

				var_dump($arg);

				$arg = htmlspecialchars(ob_get_contents());

				ob_end_clean();

				$arguments[] = $arg;
			}
		}
		
		// Location
		
		$location = array();
		
		if(isset($entry['file']))
		{
			$location['file'] = $entry['file'];
			$location['line'] = $entry['line'];
			$location['code'] = static::highlightCode($entry['file'], $entry['line']);
		}
		
		// Compile into array
		
		$trace[] = array
		(
			'function'  => $function,
			'arguments' => $arguments,
			'location'  => $location,
		);
	}

	return $trace;
}

Toggle source

public static errorHandler($code, $message, $file, $line)

Converts errors to ErrorExceptions.

Parameters

Type	Description
int	The error code
str	The error message
str	The filename where the error occurred
int	The line number where the error occurred

Return value

boolean

public static function errorHandler($code, $message, $file, $line)
{
	if((error_reporting() & $code) !== 0)
	{
		throw new ErrorException($message, $code, 0, $file, $line);
	}

	// Don't execute PHP internal error handler

	return true;
}

Toggle source

public static fatalErrorHandler()

Convert errors not caught by the errorHandler to ErrorExceptions.

Return value

NULL

public static function fatalErrorHandler()
{
	$error = error_get_last();
	
	if($error !== null && (error_reporting() & $error['type']) !== 0)
	{
		try
		{
			static::exceptionHandler(new ErrorException($error['message'], $error['type'], 0, $error['file'], $error['line']));
		}
		catch(Exception $e)
		{
			while(ob_get_level() > 0) ob_end_clean();

			echo $e->getMessage() . ' in ' . $e->getFile() . ' (line ' . $e->getLine() . ').';
		}

		exit(1);
	}
}

Toggle source

public static exceptionHandler($exception)

Handles uncaught exceptions and returns a pretty error screen.

Parameters

Type	Description
Exception	An exception object

Return value

NULL

public static function exceptionHandler($exception)
{
	try
	{
		// Empty output buffers

		while(ob_get_level() > 0) ob_end_clean();

		// Get exception info

		$error['code']    = $exception->getCode();
		$error['message'] = $exception->getMessage();
		$error['file']    = $exception->getFile();
		$error['line']    = $exception->getLine();

		// Determine error type

		if($exception instanceof ErrorException)
		{
			$error['type'] = 'ErrorException: ';

			$codes = array
			(
				E_ERROR             => 'Fatal Error',
				E_PARSE             => 'Parse Error',
				E_COMPILE_ERROR     => 'Compile Error',
				E_COMPILE_WARNING   => 'Compile Warning',
				E_STRICT            => 'Strict Mode Error',
				E_NOTICE            => 'Notice',
				E_WARNING           => 'Warning',
				E_RECOVERABLE_ERROR => 'Recoverable Error',
				E_DEPRECATED        => 'Deprecated',
				E_USER_NOTICE       => 'Notice',
				E_USER_WARNING      => 'Warning',
				E_USER_ERROR        => 'Error',
				E_USER_DEPRECATED   => 'Deprecated'
			);

			$error['type'] .= in_array($error['code'], array_keys($codes)) ? $codes[$error['code']] : 'Unknown Error';
		}
		else
		{
			$error['type'] = get_class($exception);
		}

		// Write to error log (disabled for E_COMPILE_ERROR and E_ERROR as it causes problems with autoloader)

		if(static::$config['error_handler']['log_errors'] === true && !in_array($error['code'], array(E_COMPILE_ERROR, E_ERROR)))
		{
			Log::error("{$error['type']}: {$error['message']} in {$error['file']} at line {$error['line']}");
		}

		// Send headers and output

		@header('Content-Type: text/html; charset=' . MAKO_CHARSET);

		@header(isset($_SERVER['FCGI_SERVER_VERSION']) ? 'Status:' : (isset($_SERVER['SERVER_PROTOCOL']) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.1') . ' 500 Internal Server Error');

		if(static::$config['error_handler']['display_errors'] === true)
		{
			$error['backtrace'] = $exception->getTrace();

			if($exception instanceof ErrorException)
			{
				$error['backtrace'] = array_slice($error['backtrace'], 1); //Remove call to error handler from backtrace
			}

			$error['backtrace']   = static::formatBacktrace($error['backtrace']);
			$error['highlighted'] = static::highlightCode($error['file'], $error['line']);

			include MAKO_APPLICATION . '/views/_errors/exception.php'; // Include file instead of using view class as it can cause problems with fatal errors.
		}
		else
		{
			include MAKO_APPLICATION . '/views/_errors/error.php'; // Include file instead of using view class as it can cause problems with fatal errors.
		}
	}
	catch(Exception $e)
	{
		while(ob_get_level() > 0) ob_end_clean();

		echo $e->getMessage() . ' in ' . $e->getFile() . ' (line ' . $e->getLine() . ').';
	}

	exit(1);
}