namespace-None

It appears that you are using AdBlocking software. The cost of running this website is covered by advertisements. If you like it please feel free to a small amount of money to secure the future of this website.
Overview

Classes

Interfaces

Exceptions

Functions

No namespace

Classes summary
C_mailer
CAS_Client

The CAS_Client class is a client interface that provides CAS authentication to PHP applications.

CAS_CookieJar

This class provides access to service cookies and handles parsing of response headers to pull out cookie values.

CAS_Languages_Catalan Catalan language class
CAS_Languages_ChineseSimplified Chinese Simplified language class
CAS_Languages_English English language class
CAS_Languages_French French language class
CAS_Languages_German German language class
CAS_Languages_Greek Greek language class
CAS_Languages_Japanese Japanese language class. Now Encoding is UTF-8.
CAS_Languages_Spanish Spanish language class
CAS_PGTStorage_AbstractStorage

Basic class for PGT storage The CAS_PGTStorage_AbstractStorage class is a generic class for PGT storage. This class should not be instanciated itself but inherited by specific PGT storage classes.

CAS_PGTStorage_Db

Basic class for PGT database storage The CAS_PGTStorage_Db class is a class for PGT database storage.

CAS_PGTStorage_File

The CAS_PGTStorage_File class is a class for PGT file storage. An instance of this class is returned by CAS_Client::SetPGTStorageFile().

CAS_ProxiedService_Abstract

This class implements common methods for ProxiedService implementations included with phpCAS.

CAS_ProxiedService_Http_Abstract

This class implements common methods for ProxiedService implementations included with phpCAS.

CAS_ProxiedService_Http_Get This class is used to make proxied service requests via the HTTP GET method.
CAS_ProxiedService_Http_Post This class is used to make proxied service requests via the HTTP POST method.
CAS_ProxiedService_Imap Provides access to a proxy-authenticated IMAP stream
CAS_ProxyChain

A normal proxy-chain definition that lists each level of the chain as either a string or regular expression.

CAS_ProxyChain_AllowedList

ProxyChain is a container for storing chains of valid proxies that can be used to validate proxied requests to a service

CAS_ProxyChain_Any A proxy-chain definition that will match any list of proxies.
CAS_ProxyChain_Trusted

A proxy-chain definition that defines a chain up to a trusted proxy and delegates the resposibility of validating the rest of the chain to that trusted proxy.

CAS_Request_AbstractRequest Provides support for performing web-requests via curl
CAS_Request_CurlMultiRequest

This interface defines a class library for performing multiple web requests in batches. Implementations of this interface may perform requests serially or in parallel.

CAS_Request_CurlRequest Provides support for performing web-requests via curl
Datamatrix
LatexRender
PDF417
phpCAS

The phpCAS class is a simple container for the phpCAS library. It provides CAS authentication for web applications written in PHP.

PHPMailer PHPMailer - PHP email creation and transport class.
PHPMailerOAuth PHPMailerOAuth - PHPMailer subclass adding OAuth support.
PHPMailerOAuthGoogle PHPMailerOAuthGoogle - Wrapper for League OAuth2 Google provider.
POP3

PHPMailer POP-Before-SMTP Authentication Class. Specifically for PHPMailer to use for RFC1939 POP-before-SMTP authentication. Does not support APOP.

QRcode
Radius
SMTP

PHPMailer RFC821 SMTP email transport class. Implements RFC 821 SMTP commands and provides some utility methods for sending mail to an SMTP server.

TCPDF
TCPDF2DBarcode
TCPDF_COLORS
TCPDF_FILTERS
TCPDF_FONT_DATA
TCPDF_FONTS
TCPDF_IMAGES
TCPDF_IMPORT
TCPDF_PARSER
TCPDF_STATIC
TCPDFBarcode
TCPDFEX
TMXResourceBundle
XMLQuestionImporter
XMLUserImporter
Interfaces summary
CAS_Exception A root exception interface for all exceptions in phpCAS.
CAS_Languages_LanguageInterface Language Interface class for all internationalization files
CAS_ProxiedService

This interface defines methods that allow proxy-authenticated service handlers to interact with phpCAS.

CAS_ProxiedService_Http

This interface defines methods that clients should use for configuring, sending, and receiving proxied HTTP requests.

CAS_ProxiedService_Testable

This interface defines methods that allow proxy-authenticated service handlers to be tested in unit tests.

CAS_ProxyChain_Interface

An interface for classes that define a list of allowed proxies in front of the current application.

CAS_Request_MultiRequestInterface

This interface defines a class library for performing multiple web requests in batches. Implementations of this interface may perform requests serially or in parallel.

CAS_Request_RequestInterface This interface defines a class library for performing web requests.
Exceptions summary
CAS_AuthenticationException

This interface defines methods that allow proxy-authenticated service handlers to interact with phpCAS.

CAS_GracefullTerminationException An exception for terminatinating execution or to throw for unit testing
CAS_InvalidArgumentException Exception that denotes invalid arguments were passed.
CAS_OutOfSequenceBeforeAuthenticationCallException

This class defines Exceptions that should be thrown when the sequence of operations is invalid. In this case it should be thrown when an authentication call has not yet happened.

CAS_OutOfSequenceBeforeClientException

This class defines Exceptions that should be thrown when the sequence of operations is invalid. In this case it should be thrown when the client() or proxy() call has not yet happened and no client or proxy object exists.

CAS_OutOfSequenceBeforeProxyException

This class defines Exceptions that should be thrown when the sequence of operations is invalid. In this case it should be thrown when the proxy() call has not yet happened and no proxy object exists.

CAS_OutOfSequenceException

This class defines Exceptions that should be thrown when the sequence of operations is invalid. Examples are: - Requesting the response before executing a request. - Changing the URL of a request after executing the request.

CAS_ProxiedService_Exception An Exception for problems communicating with a proxied service.
CAS_ProxyTicketException An Exception for errors related to fetching or validating proxy tickets.
CAS_Request_Exception An Exception for problems performing requests
CAS_TypeMismatchException Exception that denotes invalid arguments were passed.
phpmailerException PHPMailer exception handler
Functions summary
__autoload
addSlashesArray

Escape strings with backslashes before characters that need to be escaped. These characters are single quote ('), double quote ("), backslash () and NUL (the NULL byte).

authenticate_and_cache
bcdechex Convert an long integer number to a Hexadecimal representation
CAS_autoload Autoload a class
checkPassword Verifies that a password matches a hash
F_addLogAnswers Add specified answers on tce_tests_logs_answer table.
F_addQuestionAnswers Add answers to selected question.
F_altLogin

Try various external Login Systems. (SSL, HTTP-BASIC, CAS, SHIBBOLETH, RADIUS, LDAP)

F_check_fields_format

Check fields format using regular expression comparisons.
Returns a string containing a list of wrong fields (comma separated).

F_check_form_fields

Check Form Fields. see: F_check_required_fields, F_check_fields_format

F_check_required_fields

Check Required Form Fields.
Returns a string containing a list of missing fields (comma separated).

F_check_unique Check if specified fields are unique on table.
F_checkTestStatus Check and returns specific test status for the specified user.
F_close_button Returns XHTML code string to display a window close button
F_compact_string

Remove the following characters:

  • "\t" (ASCII 9 (0x09)), a tab.
  • "\n" (ASCII 10 (0x0A)), a new line (line feed)
  • "\r" (ASCII 13 (0x0D)), a carriage return
  • "\0" (ASCII 0 (0x00)), the NUL-byte
  • "\x0B" (ASCII 11 (0x0B)), a vertical tab
F_count_executed_tests Returns the number of executed tests on the specified time interval.
F_count_rows Count rows of the given table.
F_create_database

Create new database. Existing database will be dropped. Oracle databases must be created manually (create the tcexam user and set the database name equal to user name)

F_createMediaDir Create a new media directory inside the cache
F_createTest Create user's test and returns TRUE on success.
F_db_affected_rows
F_db_close
F_db_connect
F_db_error
F_db_fetch_array
F_db_fetch_assoc
F_db_getUTCoffset Returns the UTC time offset yo be used with CONVERT_TZ function
F_db_insert_id
F_db_num_rows
F_db_query
F_decode_form_fields Returns an array containing form fields.
F_decode_tcecode Returns XHTML code from text marked-up with TCExam Code Tags
F_decodeBase32 Decode a Base32 encoded string.
F_decodeOMRPage

Decode a single OMR Page and return data array. This function requires ImageMagick library and zbarimg (http://zbar.sourceforge.net/).

F_decodeOMRTestData Decode OMR test data string (read from QR-Code) as array.
F_decodeOMRTestDataQRCode

Read QR-Code from OMR page and return Test data. This function uses the external application zbarimg (http://zbar.sourceforge.net/).

F_deleteMediaDir Delete the specified media directory
F_deleteMediaFile Delete the selected media file
F_display_db_error Print the database error message.
F_empty_to_null

Prepare field value for SQL query.
Returns the quoted string if not empty, NULL otherwise.

F_encodeOMRTestData Encode OMR test data array as a string to be printed on QR-Code.
F_error_handler Custom PHP error handler function.
F_escape_sql
F_execute_sql_queries Parses an SQL file and execute queries.
F_executeTest

Returns true if the current user is authorized to execute the selected test.
Generates the test if it's not already generated.

F_formatFileSize Return a formatted file size
F_formatFloat Format a percentage number.
F_formatPdfPercentage format a percentage number
F_formatPercentage Format a percentage number.
F_formatXMLPercentage format a percentage number for XML
F_get_user_groups Returns an array containing groups IDs to which the specified user belongs
F_getAllUsersTestStat Returns users statistic array for the selected test.
F_getAnswerIdFromPosition Returns the answer ID from position
F_getArrayStatistics Return an array containing descriptive statistics for the bidimensional input array.
F_getAuthorizedDirs Returns a regular expression to match authorised directories.
F_getAuthorizedUsers Returns a comma separated string of ID of the users that belong to the same groups.
F_getBoolean

Returns boolean value from string or integer.
This function is needed to get the right boolean value from boolean field returned by PostgreSQL query.

F_getDirFiles Get an associative array of directories and folder inside the specified dir.
F_getDirTable Get an html table containing files and subdirs
F_getDirVisualTable Get an html visual list of files and subdirs
F_getFileInfo Get file information
F_getFirstTestUser Returns the ID of the tce_tests_users table corresponding to a complete test of $test_id type.
F_getMediaDirPathLink Get an html string containing active path of the specified directory with links to subdirectories.
F_getNumOmittedQuestions Returns the number of omitted questions (unanswered + undisplayed).
F_getOTP Get a One Time Password for the specified secret key.
F_getRandomOTPkey Return a random One Time Password Secret Key (Base32 encoded).
F_getRawTestStat Returns raw statistic array for the selected test.
F_getSSLCertificateHash Get the hash code of the specified SSL certificate
F_getSSLClientHash Get the hash code for the client certificate
F_getSVGGraph Replace angular parenthesis with html equivalents (html entities).
F_getSVGGraphCode Replace angular parenthesis with html equivalents (html entities).
F_getTestData Returns the test data.
F_getTestDuration Returns the test duration time in seconds.
F_getTestGroups Get a comma separated list of valid group IDs for the selected test.
F_getTestIDReports Returns a comma separated string of test IDs with test_results_to_users enabled
F_getTestIDResults Returns a comma separated string of test IDs with test_results_to_users enabled
F_getTestIDs Returns a comma separated string of test IDs with test_results_to_users enabled
F_getTestName Returns the test name.
F_getTestPassword Returns the test password.
F_getTestSSLCerts Get a comma separated list of valid SSL certificates IDs for the selected test.
F_getTestStartTime Returns the user's test start time in seconds since UNIX epoch (1970-01-01 00:00:00).
F_getTestStat Returns statistic array for the selected test.
F_getUIDfromRegnum Return the user ID from registration number.
F_getUserData Returns user data.
F_getUserTests Returns an XHTML table of user's tests.
F_getUserTestStat Returns statistic array for the test-user
F_getUserTestTotals Returns test-user totals
F_getUTCoffset Returns the UTC time offset in seconds
F_html_color_picker Display Color Picker
F_html_to_text Convert HTML code to Text string.
F_html_to_TSV Convert HTML code to TSV string.
F_import_tsv_users

Import users from TSV file (tab delimited text). The format of TSV is the same obtained by exporting data from Users Selection Form.

F_importOMRTestData Import user's test data from OMR.
F_install_database Install TCExam database.
F_is_allowed_upload Check if the uploaded file extension is allowed.
F_isAuthorizedDir Returns true if the user is authorized to use the specified directory, false otherwise.
F_isAuthorizedEditorForGroup Return true if the current user is an administrator or belongs to the group, false otherwise
F_isAuthorizedEditorForUser Return true if the current user is authorized to edit the specified user
F_isAuthorizedUser Returns true if the current user is authorized to update and delete the selected database record.
F_isRightTestlogUser

Checks if the current user is the right testlog_id owner.
This function is used for security reasons.

F_isSslCertificateValid Check if the client has a valid SSL certificate.
F_isTestOnGroup Return true if the selected test is active for the selected group
F_isTestOnSSLCerts Return true if the selected test is active for the selected SSL Certificate
F_isTestOverLimits Returns false if the number of executed tests is under the limits, true otherwise.
F_isURL Returns true if the string is an URL.
F_isUsedMediaFile Return true if the file is used on question or answer descriptions
F_isUserOnGroup Return true if the selected user belongs to the selected group
F_isValidIP Check if user's IP is valid over test IP range
F_isValidSSLCert Check if user's IP is valid over test IP range
F_isValidTestUser Check if user is authorized to execute the specified test
F_latex_callback

Callback function for preg_replace_callback (LaTeX replacement). Returns replacement image for LaTeX code.

F_list_online_users Display online users.
F_lockUserTest Lock the user's test.
F_login_form

Display login page. NOTE: This function calls exit() after execution.

F_loginForm

Returns XHTML / CSS formatted string for login form.
The CSS classes used are:

  • div.login_form : container for login box
  • div.login_form div.login_row : container for label + input field or button
  • div.login_form div.login_row span.label : container for input label
  • div.login_form div.login_row span.formw : container for input form
F_logout_form Display logout form.
F_logout_page

Display logout page. NOTE: This function calls exit() after execution.

F_mathml_callback

Callback function for preg_replace_callback (MathML replacement). Returns replacement code for MathML code.

F_menu_isChildActive Returns true if the menu item has an active child, false otherwise.
F_menu_link

Returns a menu element link wit subitems. If the link refers to the current page, only the name will be returned.

F_newTestLog Creates a new tce_tests_logs table entry and returns inserted ID.
F_normalizeTestStatAverages Calculate average values from TestStat array
F_objects_callback

Callback function for preg_replace_callback. Returns replacement code by MIME type.

F_objects_replacement Returns the xhtml code needed to display the object by MIME type.
F_print_error

Handle error/warning/system messages. Print a message

F_printTestInfo Returns an XHTML string containing specified test information.
F_printTestResultStat Returns test stats as HTML table
F_printTestStat Returns test stats as HTML table
F_printUserTestStat Returns user test stats as HTML table
F_question_copy Copy selected question to another topic
F_question_delete Delete selected question (or disable it if used)
F_question_get_data Get question data
F_question_get_position Get question position
F_question_set_enabled Enable/Disable selected question
F_questionForm

Returns a formatted XHTML form code to handle the specified question.
Form fields names are: answer_text, answer_id
CSS classes:

  • div.tcecontentbox
  • div.rowl
  • textarea.answertext
F_questionsMenu Returns a questions menu and navigator buttons.
F_read_file_size returns the file size in bytes
F_remove_tcecode Returns specified string without tcecode mark-up tags
F_renameMediaFile Rename the selected media file
F_repeatTest Mark previous test attempts as repeated.
F_replace_angulars Replace angular parenthesis with html equivalents (html entities).
F_select_executed_tests_sql Returns a SQL string to select executed tests accounting for user authorizations.
F_select_module_subjects_sql Returns a SQL string to select modules and subjects accounting for user authorizations.
F_select_modules_sql Returns a SQL string to select modules accounting for user authorizations.
F_select_subjects_sql Returns a SQL string to select subjects accounting for user authorizations.
F_select_table_header_element Display table header element with order link.
F_select_test Display test selection for using F_show_select_test function.
F_select_tests_sql Returns a SQL string to select tests accounting for user authorizations.
F_select_user Display user selection for using F_show_select_user function.
F_selectAnswers Return an array containing answer_id field of selected answers.
F_send_report_emails Sends email test reports to users.
F_send_user_reg_email Send a registration verification email to user.
F_session_close

Close session.
Call garbage collector function to remove expired sessions.

F_session_destroy Deletes the specific session.
F_session_gc

Garbage collector.
Deletes expired sessions.
NOTE: while time() function returns a 32 bit integer, it works fine until year 2038.

F_session_open Open session.
F_session_read Get session data.
F_session_string_to_array Convert encoded session string data to array.
F_session_write Insert or Update session.
F_show_online_users Display online users form using F_list_online_users function.
F_show_page_navigator Display Pages navigation index.
F_show_select_questions Display a list of selected questions.
F_show_select_test Display test selection XHTML table.
F_show_select_test_popup Display user selection XHTML table (popup mode).
F_show_select_user Display user selection XHTML table.
F_show_select_user_popup Display user selection XHTML table (popup mode).
F_stripslashes_formfields Strip slashes from posted form fields.
F_submit_button Returns XHTML code string to display Form Submit Button.
F_substr_utf8 Performs a multi-byte safe substr() operation based on number of characters.
F_substrHTML

Return a substring of XHTML code while making sure no html tags are chopped. It also prevents chopping while a tag is still open. this function is based on a public-domain script posted on www.php.net by fox@conskript.server and mr@bbp.biz

F_syncUserGroups Sync user groups with the ones specified on the configuration file for alternate authentication.
F_tcecodeToLine Converts tcecode text to a single XHTML string removing some objects.
F_tcecodeToTitle Converts tcecode text to simple string for XHTML title attribute.
F_terminateUserTest Terminate user's test
F_testComment Display a textarea for user's comment.
F_testInfoLink Returns XHTML link to open test info popup.
F_testLoginForm

Returns XHTML / CSS formatted page string to insert the test password.
The CSS classes used are:

  • div.login_form : container for login box
  • div.login_form div.login_row : container for label + input field or button
  • div.login_form div.login_row span.label : container for input label
  • div.login_form div.login_row span.formw : container for input form
F_text_to_tsv Escape some special characters for TSV output.
F_text_to_xml Escape some special characters (< > &).
F_tsv_export_questions Export all questions of the selected subject to TSV.
F_tsv_export_users Export all users to TSV grouped by users' groups.
F_tsv_to_text Unescape some special characters from TSV format.
F_TSVQuestionImporter

Import questions from TSV file (tab delimited text). The format of TSV is the same obtained by exporting data from TCExam interface.

F_twoColRow

Return a formatted XHTML row to display 2 columns data.
See CSS classes:

  • div.row span.label
  • div.row span.formw
F_update_config_files Update some configuration files.
F_updateQuestionLog Updates question log data (register user's answers and calculate scores).
F_updateTestComment Updates user's test comment.
F_updateTestuserStat Track generated tests.
F_upload_file Uploads image file to the server.
F_user_group_select Display select box for user groups
F_user_group_select_sql Return the SQL selection query for user groups
F_utf8_normalizer

Normalize the UTF-8 input string. Modes greater than 0 requires php5-intl module. Please edit this function to implement your custom normalization method.

F_xml_export_question_stats Export all question statistics of the selected test to XML.
F_xml_export_questions Export all questions of the selected subject to XML.
F_xml_export_results Export results in XML format.
F_xml_export_user_results Export user results in XML format.
F_xml_export_users Export all users to XML grouped by users' groups.
F_xml_to_text Unescape some special characters (< > &).
F_zero_to_null

Prepare field value for SQL query.
Returns the num if different from zero, NULL otherwise.

getClientFingerprint Generate a client fingerprint (unique ID for the client browser)
getContrastColor Get a black or white color that maximize contrast.
getDataTSV Get data in TSV format (tab separated text values).
getDataTSVHeader Get data headers (keys) in TSV header (tab separated text values).
getDataXML Get data array in XML format.
getFormDescriptionLine Print form row with label and description
getFormNoscriptSelect Print form row with submit button when noscript is active.
getFormRowCheckBox Print check box row form.
getFormRowFixedValue Print fixed value row form.
getFormRowSelectBox Print select box row form.
getFormRowTextBox Print text box row form.
getFormRowTextInput Print input row form.
getFormRowVertDiv Print form row with title.
getFormRowVertSpace Print empty form row.
getFormSmallDivSpace Print empty form row.
getFormSmallVertSpace Print empty form row.
getFormUploadFile Print input row form to upluad a file.
getImageButton Display one tag button
getIpAsInt Converts a string containing an IP address into its integer value.
getIpAsString Converts a string containing an IP address into its integer value and return string representation.
getNewSessionID Generate and return a new session ID.
getNormalizedIP Convert all IP addresses to IPv6 expanded notation.
getPasswordHash Hash password for Database storing.
gettmpdir The default directory for the debug file under Unix.
PHPMailerAutoload PHPMailer SPL autoloader.
showRequiredField Return a string containing an HTML acronym for required/not required fields.
str_split
tcecodeEditorTagButtons Display TCExam Code EDITOR Tag Buttons
unhtmlentities Reverse function for htmlentities.
utrim Strip whitespace (or other characters) from the beginning and end of an UTF-8 string and replace the "\xA0" with normal space.
 

© 2004-2018 – Nicola Asuni - Tecnick.com - All rights reserved.
about - disclaimer - privacy