/sources/comcode_check.php

Description
Functions
check_comcode (line 30)

Check the Comcode is valid.

void check_comcode (LONG_TEXT $comcode, [?MEMBER $source_member = NULL], [boolean $as_admin = false], [?object $connection = NULL], [boolean $attachment_possibility = false])
  • LONG_TEXT $comcode: The comcode to convert
  • ?MEMBER $source_member: The member the evaluation is running as. This is a security issue, and you should only run as an administrator if you have considered where the comcode came from carefully (NULL: current member)
  • boolean $as_admin: Whether to explicitly execute this with admin rights. There are a few rare situations where this should be done, for data you know didn't come from a member, but is being evaluated by one.
  • ?object $connection: The database connection to use (NULL: standard site connection)
  • boolean $attachment_possibility: Whether there might be new attachments. If there are, we will check as lax- as attachments are always preserved by forcing lax parsing.

Documentation generated on Sun, 02 Jan 2011 23:11:44 +0000 by phpDocumentor 1.4.3