SimpleSAML\XML\Errors Class Reference

Collaboration diagram for SimpleSAML\XML\Errors:

Static Public Member Functions
static	begin ()
	Start error logging. More...
static	end ()
	End error logging. More...
static	formatError ($error)
	Format an error as a string. More...
static	formatErrors ($errors)
	Format a list of errors as a string. More...

Static Private Member Functions
static	addErrors ()
	Append current XML errors to the current stack level. More...

Static Private Attributes
static	$errorStack = array()
static	$xmlErrorState

Detailed Description

Definition at line 15 of file Errors.php.

Member Function Documentation

addErrors()

static SimpleSAML\XML\Errors::addErrors ( )

staticprivate

Append current XML errors to the current stack level.

Definition at line 32 of file Errors.php.

    {
        $currentErrors = libxml_get_errors();
        libxml_clear_errors();

        $level = count(self::$errorStack) - 1;
        self::$errorStack[$level] = array_merge(self::$errorStack[$level], $currentErrors);
    }

begin()

static SimpleSAML\XML\Errors::begin ( )

static

Start error logging.

A call to this function will begin a new error logging context. Every call must have a corresponding call to end().

Definition at line 48 of file Errors.php.

References array.

Referenced by SimpleSAML\Utils\XML\isDOMNodeOfType().

    {

        // Check whether the error access functions are present
        if (!function_exists('libxml_use_internal_errors')) {
            return;
        }

        if (count(self::$errorStack) === 0) {
            // No error logging is currently in progress. Initialize it.
            self::$xmlErrorState = libxml_use_internal_errors(true);
            libxml_clear_errors();
        } else {
            /* We have already started error logging. Append the current errors to the
             * list of errors in this level.
             */
            self::addErrors();
        }

        // Add a new level to the error stack
        self::$errorStack[] = array();
    }

Here is the caller graph for this function:

end()

static SimpleSAML\XML\Errors::end ( )

static

End error logging.

Returns

array An array with the LibXMLErrors which has occurred since begin() was called.

Definition at line 77 of file Errors.php.

References $ret, and array.

Referenced by SimpleSAML\Utils\XML\isDOMNodeOfType().

    {

        // Check whether the error access functions are present
        if (!function_exists('libxml_use_internal_errors')) {
            // Pretend that no errors occurred
            return array();
        }

        // Add any errors which may have occurred
        self::addErrors();


        $ret = array_pop(self::$errorStack);

        if (count(self::$errorStack) === 0) {
            // Disable our error logging and restore the previous state
            libxml_use_internal_errors(self::$xmlErrorState);
        }

        return $ret;
    }

Here is the caller graph for this function:

formatError()

static SimpleSAML\XML\Errors::formatError (   $error )

static

Format an error as a string.

This function formats the given LibXMLError object as a string.

Parameters

\LibXMLError

$error

The LibXMLError which should be formatted.

Returns

string A string representing the given LibXMLError.

Definition at line 109 of file Errors.php.

References $error.

    {
        assert('$error instanceof LibXMLError');
        return 'level=' . $error->level . ',code='  . $error->code . ',line=' . $error->line . ',col=' . $error->column .
            ',msg=' . trim($error->message);
    }

formatErrors()

static SimpleSAML\XML\Errors::formatErrors (   $errors )

static

Format a list of errors as a string.

This fucntion takes an array of LibXMLError objects and creates a string with all the errors. Each error will be separated by a newline, and the string will end with a newline-character.

Parameters

array

$errors

An array of errors.

Returns

string A string representing the errors. An empty string will be returned if there were no errors in the array.

Definition at line 127 of file Errors.php.

References $error, $errors, and $ret.

Referenced by SimpleSAML\Utils\XML\isDOMNodeOfType().

    {
        assert('is_array($errors)');

        $ret = '';
        foreach ($errors as $error) {
            $ret .= self::formatError($error) . "\n";
        }

        return $ret;
    }

Here is the caller graph for this function:

Field Documentation

$errorStack

SimpleSAML\XML\Errors::$errorStack = array()

staticprivate

Definition at line 21 of file Errors.php.

$xmlErrorState

SimpleSAML\XML\Errors::$xmlErrorState

staticprivate

Definition at line 26 of file Errors.php.

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/lib/SimpleSAML/XML/Errors.php