PEAR Manual
PrevNext

PEAR_ChannelFile::getValidationObject()

PEAR_ChannelFile::getValidationObject()  -- Retrieve the object that can be used for custom validation

Synopsis

require_once '/ChannelFile.php';

PEAR_Validate|false & PEAR_ChannelFile::getValidationObject (string|false [$package = FALSE])

Description

Retrieve the channel validation object. The package parameter is intended to notify getValidationObject() of the package to be validated. If the package is in fact the channel validation package, then PEAR_Validate will be used for validation. This prevents an endless loop that would otherwise occur.

Parameter

string|FALSE $package

The name of the package to validate. If the package is the channel validation package, PEAR_Validate is returned.

Return value

returns false is returned if the validation package cannot be located

Throws

throws no exceptions thrown

Note

This function can not be called statically.

PrevHomeNext
PEAR_ChannelFile::getSummary()UpPEAR_ChannelFile::getValidationPackage()