php.php

<?php /*

 ocPortal
 Copyright (c) ocProducts, 2004-2012

 See text/EN/licence.txt for full licencing information.


 NOTE TO PROGRAMMERS:
   Do not edit this file. If you need to make changes, save your changed file to the appropriate *_custom folder
   **** If you ignore this advice, then your website upgrades (e.g. for bug fixes) will likely kill your changes ****

*/

/**
 * @license		http://opensource.org/licenses/cpal_1.0 Common Public Attribution License
 * @copyright	ocProducts Ltd
 * @package		devguide
 */

/*
Here is the code used to extract phpdoc style function comments  from PHP code.
*/

/**
 * Standard code module initialisation function.
 */
function init__php()
{
	global $LANG_TD_MAP;
	$LANG_TD_MAP=NULL;
}

/**
 * Get a complex API information structure from a PHP file. It assumes the file has reasonably properly layed out class and function whitespace
 * The return structure is...
 *  list of classes
 *	each entry is a map containing 'functions' (list of functions) and 'name'
 *	 each functions entry is a map containing 'parameters' and 'name' and 'return'
 *	  each parameters entry is a map containing...
 *		name
 *		description
 *		type
 *		default
 *		set
 *		range
 *
 * @param  ID_TEXT		The PHP code module to get API information for
 * @param  boolean		Whether to include function source code
 * @return array			The complex structure of API information
 */
function get_php_file_api($filename,$include_code=true)
{
	require_code('type_validation');

	$classes=array();

	// Open up PHP file
	if ($filename=='phpstub.php')
	{
		$full_path=$filename;
	} else
	{
		$full_path=((get_file_base()!='')?(get_file_base().'/'):'').filter_naughty($filename);
	}
	$lines=file($full_path);
	foreach ($lines as $i=>$line)
	{
		$lines[$i]=str_replace("\t",' ',$line);
	}

	// Go through all lines, keeping record of what current class we are looking at
	$current_class='__global';
	$current_class_level=0;
	$functions=array();
	global $LINE;
	for ($i=0;array_key_exists($i,$lines);$i++)
	{
		$line=$lines[$i];
		$LINE=$i+1;

		if (strpos($line,'/'.'*NO_API_CHECK*/')!==false) return array();

		// Sense class boundaries (hackerish: assumes whitespace laid out correctly)
		$ltrim=ltrim($line);
		if (substr($ltrim,0,6)=='class ')
		{
			if (count($functions)!=0)
				$classes[$current_class]=array('functions'=>$functions,'name'=>$current_class);

			$space_pos=strpos($ltrim,' ');
			$space_pos_2=strpos($ltrim,' ',$space_pos+1);
			if ($space_pos_2===false) $space_pos_2=strpos($ltrim,chr(13),$space_pos+1);
			if ($space_pos_2===false) $space_pos_2=strpos($ltrim,chr(10),$space_pos+1);
			$current_class=substr($ltrim,$space_pos+1,$space_pos_2-$space_pos-1);
			$current_class_level=strlen($line)-strlen($ltrim);

			$functions=array();
		}
		elseif (($current_class!='__global') && (substr($line,0,$current_class_level+1)==str_repeat(' ',$current_class_level).'}'))
		{
			if (count($functions)!=0)
				$classes[$current_class]=array('functions'=>$functions,'name'=>$current_class);

			$current_class='__global';
			$functions=array_key_exists('__global',$classes)?$classes['__global']['functions']:array();
		}

		// Detect an API function
		if (substr($ltrim,0,3)=='/**')
		{
			$depth=strlen($line)-strlen($ltrim);

			// Find function line
			for ($j=$i+1;array_key_exists($j,$lines);$j++)
			{
				$line2=$lines[$j];
				if (substr($line2,0,$depth+9)==str_repeat(' ',$depth).'function ')
				{
					// Parse function line
					$_line=substr($line2,$depth+9);
					list($function_name,$parameters)=_read_php_function_line($_line);
					break;
				}
				if ((substr(trim($line2),0,3)=='/**') || ((strpos($line2,'*/')!==false) && (array_key_exists($j+1,$lines)) && (strpos($lines[$j+1],'function ')===false))) // Probably just skipped past a top header
				{
					$i=$j-1;
					continue 2;
				}
			}
			if (!array_key_exists($j,$lines)) continue; // No function: probably we commented it out

			// Parse comment block bits
			$description='';
			$flags=array();
			$arg_counter=-1;
			$in_return=false;
			$return=NULL;
			for ($i++;$i<$j-1;$i++)
			{
				$ltrim=ltrim($lines[$i]);
				$ltrim=ltrim(substr($ltrim,1)); // Remove '*'
				$ltrim=rtrim($ltrim); // Remove additional whitespace
				if ($ltrim=='') continue;

				if ($ltrim[0]=='@') // Some kind of code
				{
					if (substr($ltrim,0,6)=='@param')
					{
						$arg_counter++;
						if (!array_key_exists($arg_counter,$parameters))
						{
							fatal_exit(do_lang_tempcode('PARAMETER_MISMATCH',escape_html($function_name)));
							continue 2;
						}
						$parts=_cleanup_array(preg_split('/\s/',substr($ltrim,6)));
						if (($parts[0][0]!='?') && (array_key_exists('default',$parameters[$arg_counter])) && (is_null($parameters[$arg_counter]['default'])))
						{
							fatal_exit(do_lang_tempcode('UNALLOWED_NULL',escape_html($parameters[$arg_counter]['name']),escape_html($function_name),array(escape_html('NULL'))));
							continue 2;
						}
						if ((!in_array($parts[0],array('~mixed','mixed','boolean'))) && ($parts[0][0]!='~') && (array_key_exists('default',$parameters[$arg_counter])) && ($parameters[$arg_counter]['default']===false))
						{
							fatal_exit(do_lang_tempcode('UNALLOWED_NULL',escape_html($parameters[$arg_counter]['name']),escape_html($function_name),array(escape_html('false'))));
							continue 2;
						}
						$parameters[$arg_counter]['type']=$parts[0];
						unset($parts[0]);
						$parameters[$arg_counter]['description']=implode(' ',$parts);
					}
					elseif (substr($ltrim,0,7)=='@return')
					{
						$return=array();

						$parts=_cleanup_array(preg_split('/\s/',substr($ltrim,7)));
						$return['type']=$parts[0];
						unset($parts[0]);
						$return['description']=implode(' ',$parts);

						$in_return=true;
					}
					elseif (substr($ltrim,0,4)=='@set')
					{
						$set=ltrim(substr($ltrim,5));
						if ($in_return)
							$return['set']=$set;
						else
							$parameters[$arg_counter]['set']=$set;
					}
					elseif (substr($ltrim,0,6)=='@range')
					{
						$range=ltrim(substr($ltrim,6));
						if ($in_return)
							$return['range']=$range;
						else
							$parameters[$arg_counter]['range']=$range;
					}
				} else // Part of the description
				{
					$description.=unixify_line_format($ltrim);
				}
			}
			$f_a=strpos($description,'{{');
			if ($f_a!==false)
			{
				$f_b=strpos($description,'}}',$f_a);
				if ($f_b!==false)
				{
					$_flags=substr($description,$f_a+2,$f_b-$f_a-2);
					$flags=explode(' ',$_flags);
					$description=substr($description,$f_a).substr($description,$f_b);
				}
			}

			if (array_key_exists($arg_counter+1,$parameters))
			{
				fatal_exit(do_lang_tempcode('PARAMETER_MISMATCH',escape_html($function_name)));
				continue;
			}

			// Do some checks
			foreach ($parameters as $parameter)
			{
				// Type check
				if (array_key_exists('default',$parameter))
				{
					$default=$parameter['default'];
					if ($default==='boolean-true') $default=true;
					if ($default==='boolean-false') $default=false;
				} else $default=NULL;
				check_function_type($parameter['type'],$function_name,$parameter['name'],$default,array_key_exists('range',$parameter)?$parameter['range']:NULL,array_key_exists('set',$parameter)?$parameter['set']:NULL);

				// Check that null is fully specified
				if ($parameter['type'][0]=='?')
				{
					if (strpos($parameter['description'],'(NULL: ')===false)
					{
						fatal_exit(do_lang_tempcode('NULL_MEANING_NOT_SPECIFIED',escape_html($parameter['name']),escape_html($function_name),array(escape_html('NULL'))));
					}
				}
				if ($parameter['type'][0]=='~')
				{
					if (strpos($parameter['description'],'(false: ')===false)
					{
						fatal_exit(do_lang_tempcode('NULL_MEANING_NOT_SPECIFIED',escape_html($parameter['name']),escape_html($function_name),array(escape_html('false'))));
					}
				}
			}
			if (!is_null($return))
			{
				$fret=$return;
				check_function_type($return['type'],$function_name,'(return)',NULL,array_key_exists('range',$return)?$return['range']:NULL,array_key_exists('set',$return)?$return['set']:NULL);

				// Check that null is fully specified
				if ($return['type'][0]=='?')
				{
					if (strpos($return['description'],'(NULL: ')===false)
					{
						fatal_exit(do_lang_tempcode('NULL_MEANING_NOT_SPECIFIED',escape_html('(return)'),escape_html($function_name),array(escape_html('NULL'))));
					}
				}
				if ($return['type'][0]=='~')
				{
					if (strpos($return['description'],'(false: ')===false)
					{
						fatal_exit(do_lang_tempcode('NULL_MEANING_NOT_SPECIFIED',escape_html('(return)'),escape_html($function_name),array(escape_html('false'))));
					}
				}
			} else $fret=NULL;

			// Now get source code
			$code='';
			for ($k=$j;array_key_exists($k,$lines);$k++)
			{
				$line2=$lines[$k];
				$code.=$line2;
				if (substr($line2,0,$depth+1)==str_repeat(' ',$depth).'}')
				{
					break;
				}
			}

			$function=array('filename'=>$filename,'parameters'=>$parameters,'name'=>$function_name,'description'=>$description,'flags'=>$flags);
			if ($include_code) $function['code']=$code;
			if (!is_null($fret)) $function['return']=$fret;
			$functions[$function_name]=$function;

			$i++;
		}
	}

	if (count($functions)!=0)
	{
		$classes[$current_class]=array('functions'=>$functions,'name'=>$current_class);
	}

	// See if there are any functions with blank lines above them
	for ($i=0;array_key_exists($i,$lines);$i++)
	{
		$line=ltrim($lines[$i]);
		if ((substr($line,0,9)=='function ') && ((trim($lines[$i-1])=='') || (trim($lines[$i-1])=='{')))
		{
			fatal_exit(do_lang_tempcode('MISSING_FUNCTION_COMMENT',rtrim($line)));
		}
	}

	return $classes;
}

/**
 * Read a PHP function line and return parsed details.
 *
 * @param  string			The line
 * @return array			A pair: (function name, parameters), where parameters is a list of maps detailing each parameter
 */
function _read_php_function_line($_line)
{
	$parse='function_name';
	$function_name='';
	$parameters=array();
	$arg_default='';
	$arg_name='';
	$ref=false;

	for ($k=0;$k<strlen($_line);$k++)
	{
		$char=$_line[$k];

		switch($parse)
		{
			case 'in_comment':
				if (($char=='*') && ($_line[$k+1]=='/'))
				{
					$parse='in_args';
					$ref=false;
					$k++;
				}
				break;
			case 'in_comment_default':
				if (($char=='*') && ($_line[$k+1]=='/'))
				{
					$parse='in_default';
					$k++;
				}
				break;
			case 'in_default':
				if (($char=='/') && ($_line[$k+1]=='*'))
				{
					$parse='in_comment_default';
				}
				elseif (($char==',') && (($_line[$k-1]!='\'') || ($_line[$k-2]!='=')))
				{
					if ($arg_default==='true') $default='boolean-true'; // hack, to stop booleans coming out of arrays as integers
					elseif ($arg_default==='false') $default='boolean-false';
					else $default=defined('HIPHOP_PHP')?'':@eval('return '.$arg_default.';'); // Could be unprocessable by php.php in standalone mode
					$parameters[]=array('name'=>$arg_name,'default'=>$default,'ref'=>$ref);
					$arg_name='';
					$arg_default='';
					$parse='in_args';
					$ref=false;
				}
				elseif ($char==')')
				{
					if ($arg_default==='true') $default='boolean-true'; // hack, to stop booleans coming out of arrays as integers
					elseif ($arg_default==='false') $default='boolean-false';
					else $default=defined('HIPHOP_PHP')?'':@eval('return '.$arg_default.';'); // Could be unprocessable by php.php in standalone mode
					$parameters[]=array('name'=>$arg_name,'default'=>$default,'ref'=>$ref);
					$parse='done';
				} else
				{
					$arg_default.=$char;
				}
				break;
			case 'in_args':
				if (($char=='/') && ($_line[$k+1]=='*'))
				{
					$parse='in_comment';
				}
				elseif (is_alphanumeric($char))
				{
					$arg_name.=$char;
				}
				elseif ($char=='&')
				{
					$ref=true;
				}
				elseif ($char==',')
				{
					$parameters[]=array('name'=>$arg_name,'ref'=>$ref);
					$ref=false;
					$arg_name='';
				}
				elseif ($char=='=')
				{
					$parse='in_default';
					$arg_default='';
				}
				elseif ($char==')')
				{
					if ($arg_name!='') $parameters[]=array('name'=>$arg_name,'ref'=>$ref);
					$parse='done';
				}
				break;
			case 'function_name':
				if (is_alphanumeric($char))
				{
					$function_name.=$char;
				}
				elseif ($char=='(')
				{
					$parse='in_args';
					$ref=false;
					$arg_name='';
				} else
				{
					$parse='between_name_and_args';
				}
				break;
			case 'between_name_and_args':
				if ($char=='(')
				{
					$parse='in_args';
					$ref=false;
					$arg_name='';
				}
		}
	}

	return array($function_name,$parameters);
}

/**
 * Remove and blank strings from the given array.
 *
 * @param  array			List of strings
 * @return array			List of strings, with blank strings removed
 */
function _cleanup_array($in)
{
	$out=array();
	foreach ($in as $bit)
	{
		if ($bit!='') $out[]=$bit;
	}
	return $out;
}

/**
 * Type-check the specified parameter (giving an error if the type checking fails) [all checks]
 *
 * @param  ID_TEXT		The parameter type
 * @param  string			The functions name (used in error message)
 * @param  string			The parameter name (used in error message)
 * @param  ?mixed			The parameters value (NULL: value actually is null)
 * @param  ?string		The string of value range of the parameter (NULL: no range constraint)
 * @param  ?string		The string of value set limitation for the parameter (NULL: no set constraint)
 * @param  boolean		Whether we just echo errors instead of exiting
 */
function check_function_type($type,$function_name,$name,$value,$range,$set,$echo=false)
{
	$valid_types=array(
		'AUTO_LINK',
		'SHORT_INTEGER',
		'UINTEGER',
		'REAL',
		'BINARY',
		'MEMBER',
		'GROUP',
		'TIME',
		'LONG_TEXT',
		'SHORT_TEXT',
		'ID_TEXT',
		'MINIID_TEXT',
		'IP',
		'LANGUAGE_NAME',
		'URLPATH',
		'PATH',
		'MD5',
		'EMAIL',
		'string',
		'integer',
		'array',
		'list',
		'map',
		'boolean',
		'float',
		'tempcode',
		'object',
		'resource',
		'mixed'
	);

	$_type=(($type[0]=='?') || ($type[0]=='~'))?substr($type,1):$type;

	if (!in_array($_type,$valid_types)) fatal_exit(do_lang_tempcode('INVALID_PARAMETER_TYPE',escape_html($type),escape_html($function_name)));

	if (!is_null($value))
	{
		test_fail_php_type_check($type,$function_name,$name,$value,$echo);
	}

	// Check range
	if ((!is_null($range)) && (!is_null($value)))
	{
		$allowed=array(
			'UINTEGER',
			'SHORT_INTEGER',
			'REAL',
			'integer',
			'float'
		);
		$allowed_string=array(
			'LONG_TEXT',
			'SHORT_TEXT',
			'ID_TEXT',
			'MINIID_TEXT',
			'string',
		);
		if ((!in_array($_type,$allowed)) && (!in_array($_type,$allowed_string)) && ($type!='array') && ($type!='list') && ($type!='map'))
			fatal_exit(do_lang_tempcode('BAD_RANGE_SPECIFICATION',escape_html($_type),escape_html($function_name)));

		list($min,$max)=explode(' ',$range);

		if (in_array($_type,$allowed))
		{
			if (($value!='') || (!defined('HIPHOP_PHP')))
				if ((($min!='min') && ($value<intval($min))) || (($max!='max') && ($value>intval($max))))
					fatal_exit(do_lang_tempcode('OUT_OF_RANGE_VALUE',escape_html($name),escape_html($function_name),array(escape_html($value))));
		}
		elseif (in_array($_type,$allowed_string))
		{
			if (($value!='') || (!defined('HIPHOP_PHP')))
				if ((($min!='min') && (strlen($value)<intval($min))) || (($max!='max') && (strlen($value)>intval($max))))
					fatal_exit(do_lang_tempcode('OUT_OF_RANGE_VALUE',escape_html($name),escape_html($function_name),array(escape_html($value))));
		}
		else
		{
			if (($value!='') || (!defined('HIPHOP_PHP')))
				if ((($min!='min') && (count($value)<intval($min))) || (($max!='max') && (count($value)>intval($max))))
					fatal_exit(do_lang_tempcode('OUT_OF_RANGE_VALUE',escape_html($name),escape_html($function_name),array(escape_html($value))));
		}
	}

	// Check set
	if ((!is_null($set)) && (!is_null($value)))
	{
		$_set=explode(' ',$set);
		foreach ($_set as $i=>$s)
		{
			if ($s=='""') $_set[$i]='';
		}
		if (!in_array(is_string($value)?$value:strval($value),$_set))
		{
			if (($value!='') || (!defined('HIPHOP_PHP')))
				fatal_exit(do_lang_tempcode('OUT_OF_RANGE_VALUE',escape_html($name),escape_html($function_name),array(escape_html($value))));
		}
	}
}

/**
 * Type-check the specified parameter (giving an error if the type checking fails) [just value against type]
 *
 * @param  ID_TEXT		The parameter type
 * @param  string			The functions name (used in error message)
 * @param  string			The parameter name (used in error message)
 * @param  mixed			The parameters value (cannot be null)
 * @param  boolean		Whether we just echo errors instead of exiting
 */
function test_fail_php_type_check($type,$function_name,$name,$value,$echo=false)
{
	$null_allowed=($type[0]=='?');
	$false_allowed=($type[0]=='~');
	$_type=($null_allowed || $false_allowed)?substr($type,1):$type;

	if (($value===false) && (!$false_allowed) && (!in_array($_type,array('mixed','boolean'))))
		fatal_exit(do_lang_tempcode('UNALLOWED_NULL',escape_html($name),escape_html($function_name),array('false')));

	if ((is_null($value)) && (!$null_allowed))
		fatal_exit(do_lang_tempcode('UNALLOWED_NULL',escape_html($name),escape_html($function_name),array('NULL')));

	if ($_type=='mixed') return;
	switch ($_type)
	{
		case 'integer':
			if ((!is_integer($value)) && ((!is_float($value)) || (strval(intval(round($value)))!=strval($value)))) _fail_php_type_check($type,$function_name,$name,$value,$echo);
			break;
		case 'UINTEGER':
			if ((!is_integer($value)) && ((!is_float($value)) || (strval(intval(round($value)))!=strval($value))) || ($value<0)) _fail_php_type_check($type,$function_name,$name,$value,$echo);
			break;
		case 'resource':
			if (!is_resource($value)) _fail_php_type_check($type,$function_name,$name,$value,$echo);
			break;
		case 'object':
			if (!is_object($value)) _fail_php_type_check($type,$function_name,$name,$value,$echo);
			break;
		case 'tempcode':
			if ((!is_object($value)) || (!is_a($value,'ocp_tempcode'))) _fail_php_type_check($type,$function_name,$name,$value,$echo);
			break;
		case 'REAL':
		case 'float':
			if (!is_float($value)) _fail_php_type_check($type,$function_name,$name,$value,$echo);
			break;
		case 'boolean':
			if (!is_bool($value)) _fail_php_type_check($type,$function_name,$name,$value,$echo);
			break;
		case 'list':
			if (!is_array($value)) _fail_php_type_check($type,$function_name,$name,$value,$echo);
			break;
		case 'map':
			if (!is_array($value)) _fail_php_type_check($type,$function_name,$name,$value,$echo);
			break;
		case 'array':
			if (!is_array($value)) _fail_php_type_check($type,$function_name,$name,$value,$echo);
			break;
		case 'string':
			if (!is_string($value)) _fail_php_type_check($type,$function_name,$name,$value,$echo);
			break;
		case 'PATH':
			if (!is_string($value)) _fail_php_type_check($type,$function_name,$name,$value,$echo);
			break;
		case 'MD5':
			if ((!is_string($value)) || (strlen($value)>33)) _fail_php_type_check($type,$function_name,$name,$value,$echo);
			break;
		case 'EMAIL':
			if ((!is_string($value)) || (is_valid_email_address($value))) _fail_php_type_check($type,$function_name,$name,$value,$echo);
			break;
		case 'URLPATH':
			if ((!is_string($value)) || (strlen($value)>127)) _fail_php_type_check($type,$function_name,$name,$value,$echo);
			break;
		case 'LONG_TEXT':
			if (!is_string($value)) _fail_php_type_check($type,$function_name,$name,$value,$echo);
			break;
		case 'MINIID_TEXT':
			if ((!is_string($value)) || (strlen($value)>40)) _fail_php_type_check($type,$function_name,$name,$value,$echo);
			break;
		case 'ID_TEXT':
			if ((!is_string($value)) || (strlen($value)>80)) _fail_php_type_check($type,$function_name,$name,$value,$echo);
			break;
		case 'LANGUAGE_NAME':
			global $LANG_TD_MAP;
			if (is_null($LANG_TD_MAP)) $LANG_TD_MAP=better_parse_ini_file(get_file_base().'/lang/langs.ini');
			if ((!is_string($value)) || (!array_key_exists($value,$LANG_TD_MAP))) _fail_php_type_check($type,$function_name,$name,$value,$echo);
			break;
		case 'IP':
			if ((!is_string($value)) || (strlen($value)>40) || ((strlen($value)<7) && ($value!='')) || ((count(explode('.',$value))!=4) && ($value!='') && (count(explode(':',$value))<3))) _fail_php_type_check($type,$function_name,$name,$value,$echo);
			break;
		case 'SHORT_TEXT':
			if ((!is_string($value)) || (strlen($value)>255)) _fail_php_type_check($type,$function_name,$name,$value,$echo);
			break;
		case 'SHORT_INTEGER':
			if ((!is_integer($value)) || ($value>255) || ($value<0)) _fail_php_type_check($type,$function_name,$name,$value,$echo);
			break;
		case 'AUTO_LINK':
			if ((!is_integer($value)) || ($value<-1)) _fail_php_type_check($type,$function_name,$name,$value,$echo); // -1 means something different to NULL
			break;
		case 'BINARY':
			if ((!is_integer($value)) || (($value!=0) && ($value!=1))) _fail_php_type_check($type,$function_name,$name,$value,$echo);
			break;
		case 'MEMBER':
			if ((!is_integer($value)) || ($value<$GLOBALS['FORUM_DRIVER']->get_guest_id())) _fail_php_type_check($type,$function_name,$name,$value,$echo);
			break;
		case 'TIME':
			if ((!is_integer($value)) || ($value>time()+500000000) || ($value<1000)) _fail_php_type_check($type,$function_name,$name,$value,$echo);
			break;
	}
}

/**
 * Throw out a type checker error message.
 *
 * @param  string			The type involved
 * @param  string			The function involved
 * @param  string			The parameter name involved
 * @param  string			The value involved
 * @param  boolean		Whether we just echo errors instead of exiting
 */
function _fail_php_type_check($type,$function_name,$name,$value,$echo=false)
{
	if (($value=='') && (defined('HIPHOP_PHP'))) return;

	if ($echo) echo 'TYPE_MISMATCH in \''.$function_name.'\' ('.$name.' is '.(is_string($value)?$value:strval($value)).' which is not a '.$type.')<br />';
	else fatal_exit(do_lang_tempcode('TYPE_MISMATCH',escape_html($function_name),escape_html($name),is_string($value)?$value:strval($value)/*,$type*/));
}

/**
 * Render a PHP function to display in a template.
 *
 * @param  array			The map of function information
 * @param  array			The map of class information
 * @param  boolean		Show filenames in the function description
 * @return array			A pair: The rendered function, The rendered summary (for a TOC)
 */
function render_php_function($function,$class,$show_filename=false)
{
	$parameters=new ocp_tempcode();
	$full_parameters=new ocp_tempcode();
	foreach ($function['parameters'] as $parameter)
	{
//				if (!array_key_exists('type',$parameter)) exit($function['name']);

		if (!$parameters->is_empty()) $parameters->attach(', ');
		$parameters->attach(do_template('PHP_PARAMETER_LIST',array('_GUID'=>'03e76c19ec2cf9cb7f283db72728fc13','TYPE'=>$parameter['type'],'NAME'=>$parameter['name'])));

		$bits=render_php_function_do_bits($parameter);

		$full_parameters->attach(do_template('PHP_PARAMETER',array('_GUID'=>'fa1f59637723d35da5e210e4efa0e27c','BITS'=>$bits)));
	}

	if (array_key_exists('return',$function))
	{
		$return=render_php_function_do_bits($function['return']);
		$return_type=$function['return']['type'];
	} else
	{
		$return=new ocp_tempcode();
		$return_type='void';
	}

	$description=comcode_to_tempcode($function['description']);

	if ((function_exists('highlight_string')) && (array_key_exists('code',$function)) && ($function['filename']!='sources/phpstub.php'))
	{
		$_code="<"."?php\n".$function['code']."\n?".">";

		if (defined('HIPHOP_PHP'))
		{
			$code=nl2br(escape_html($_code));
		} else
		{
			ob_start();
			highlight_string($_code);
			$code=ob_get_contents();
			ob_end_clean();
		}
		$code=str_replace('&lt;?php<br />','',$code);
		$code=str_replace('?&gt;','',$code);
		require_code('xhtml');
		$code=xhtmlise_html($code);
	} else $code='';

	$filename=$show_filename?$function['filename']:'';
	if (!isset($class['name'])) $class['name']='';

	$a=do_template('PHP_FUNCTION',array('_GUID'=>'f01224ffadc5cde023a1777b9267da61','FILENAME'=>$filename,'CODE'=>$code,'RETURN_TYPE'=>$return_type,'FUNCTION'=>$function['name'],'CLASS'=>$class['name'],'PARAMETERS'=>$parameters,'DESCRIPTION'=>$description,'FULL_PARAMETERS'=>$full_parameters,'RETURN'=>$return));
	$b=do_template('PHP_FUNCTION_SUMMARY',array('_GUID'=>'ac91501d0fcef2f17c7f068f0d506d42','FILENAME'=>$filename,'RETURN_TYPE'=>$return_type,'CLASS'=>$class['name'],'FUNCTION'=>$function['name'],'PARAMETERS'=>$parameters));

	return array($a,$b);
}

/**
 * Get a PHP function parameter line.
 *
 * @param  array			A map containing: name, description, default, type, set, range
 * @return tempcode		The line
 */
function render_php_function_do_bits($parameter)
{
	$bits=new ocp_tempcode();

	if (array_key_exists('name',$parameter)) // Name
	{
		$bits->attach(do_template('PHP_PARAMETER_BIT',array('_GUID'=>'81bd29ddf7c9b4d2ae03ca870575cb18','NAME'=>do_lang_tempcode('NAME'),'VALUE'=>$parameter['name'])));
	}
	if (array_key_exists('description',$parameter)) // Description
	{
		$description=comcode_to_tempcode($parameter['description']);
		$bits->attach(do_template('PHP_PARAMETER_BIT',array('_GUID'=>'c1e8627fa77c26b15d4346948c623fd3','NAME'=>do_lang_tempcode('DESCRIPTION'),'VALUE'=>$description)));
	}
	if (array_key_exists('default',$parameter)) // Default
	{
		$value='';
		if (!is_string($parameter['default']))
		{
			if (!is_null($parameter['default'])) $value=strval($parameter['default']);
		} else $value=$parameter['default'];
		$bits->attach(do_template('PHP_PARAMETER_BIT',array('_GUID'=>'b5fc6eb98568ca4e36e25cb15d3e26b5','NAME'=>do_lang_tempcode('DEFAULT_VALUE'),'VALUE'=>$value)));
	}
	if (array_key_exists('type',$parameter)) // Type
	{
		$bits->attach(do_template('PHP_PARAMETER_BIT',array('_GUID'=>'dd638a63173699326a8f856e931354d5','NAME'=>do_lang_tempcode('TYPE'),'VALUE'=>$parameter['type'])));
	}
	if (array_key_exists('set',$parameter)) // Set
	{
		$bits->attach(do_template('PHP_PARAMETER_BIT',array('_GUID'=>'d647ace9bdd0150dac1b02e3b1cf12c9','NAME'=>do_lang_tempcode('POSSIBLE_VALUES'),'VALUE'=>$parameter['set'])));
	}
	if (array_key_exists('range',$parameter)) // Range
	{
		$bits->attach(do_template('PHP_PARAMETER_BIT',array('_GUID'=>'845d1a0286323342bc4e011b178d4ac1','NAME'=>do_lang_tempcode('VALUE_RANGE'),'VALUE'=>$parameter['range'])));
	}

	return $bits;
}