Inheritance diagram for PEAR_Validate:

Public Member Functions
	_addFailure ($field, $reason)
	_addWarning ($field, $reason)
	_validateFilelist ()
	_validPackageName ($name)
	getFailures ()
	setPackageFile (&$pf)
	validate ($state=null)
	validateChangelog ()
	validateDate ()
	validateDependencies ()
	validateDeps ()
	validateDescription ()
	validateFilelist ()
	validateLicense ()
	validateMainFilelist ()
	validateMaintainers ()
	validateNotes ()
	validatePackageName ()
	validateReleaseFilelist ()
	validateStability ()
	validateState ()
	validateSummary ()
	validateTime ()
	validateVersion ()
	validPackageName ($name, $validatepackagename=false)

Static Public Member Functions
static	getValidStates ()
static	validGroupName ($name)
static	validState ($state)
static	validVersion ($ver)

Data Fields
	$_failures = array('error' => array(), 'warning' => array())
	$_packagexml
	$_state = PEAR_VALIDATE_NORMAL
	$packageregex = _PEAR_COMMON_PACKAGE_NAME_PREG

Detailed Description

Definition at line 38 of file Validate.php.

Member Function Documentation

◆ _addFailure()

_addFailure	(		$field,
			$reason )

@access private

Definition at line 137 of file Validate.php.

    {
        $this->_failures['errors'][] = array('field' => $field, 'reason' => $reason);
    }

Referenced by validateDate(), validatePackageName(), validateStability(), validateState(), validateTime(), validateVersion(), and PEAR_Validator_PECL\validateVersion().

Here is the caller graph for this function:

◆ _addWarning()

_addWarning	(		$field,
			$reason )

@access private

Definition at line 145 of file Validate.php.

    {
        $this->_failures['warnings'][] = array('field' => $field, 'reason' => $reason);
    }

Referenced by validateDate(), validatePackageName(), PEAR_Validator_PECL\validatePackageName(), and validateVersion().

Here is the caller graph for this function:

◆ _validateFilelist()

_validateFilelist ( )

for package.xml 1.0 only @access private

Definition at line 579 of file Validate.php.

    {
        return true; // placeholder for now
    }

◆ _validPackageName()

_validPackageName ( $name )

Override this method to handle validation of normal package names

Parameters

string

Returns: bool @access protected

Definition at line 62 of file Validate.php.

    {
        return (bool) preg_match('/^' . $this->packageregex . '\\z/', $name);
    }

Referenced by validPackageName().

Here is the caller graph for this function:

◆ getFailures()

getFailures ( )

Definition at line 150 of file Validate.php.

    {
        $failures = $this->_failures;
        $this->_failures = array('warnings' => array(), 'errors' => array());
        return $failures;
    }

References $_failures.

◆ getValidStates()

getValidStates ( )

static

Get a list of valid stability levels

Returns: array @final

Definition at line 109 of file Validate.php.

    {
        return array('snapshot', 'devel', 'alpha', 'beta', 'stable');
    }

Referenced by validateStability(), and validateState().

Here is the caller graph for this function:

◆ setPackageFile()

setPackageFile ( & $pf )

Parameters

PEAR_PackageFile_v1|PEAR_PackageFile_v2

Definition at line 129 of file Validate.php.

    {
        $this->_packagexml = &$pf;
    }

◆ validate()

validate ( $state = null )

Parameters

int	one of the PEAR_VALIDATE_* constants

Definition at line 160 of file Validate.php.

    {
        if (!isset($this->_packagexml)) {
            return false;
        }
        if ($state !== null) {
            $this->_state = $state;
        }
        $this->_failures = array('warnings' => array(), 'errors' => array());
        $this->validatePackageName();
        $this->validateVersion();
        $this->validateMaintainers();
        $this->validateDate();
        $this->validateSummary();
        $this->validateDescription();
        $this->validateLicense();
        $this->validateNotes();
        if ($this->_packagexml->getPackagexmlVersion() == '1.0') {
            $this->validateState();
            $this->validateFilelist();
        } elseif ($this->_packagexml->getPackagexmlVersion() == '2.0' ||
                  $this->_packagexml->getPackagexmlVersion() == '2.1') {
            $this->validateTime();
            $this->validateStability();
            $this->validateDeps();
            $this->validateMainFilelist();
            $this->validateReleaseFilelist();
            //$this->validateGlobalTasks();
            $this->validateChangelog();
        }
        return !((bool) count($this->_failures['errors']));
    }

References validateChangelog(), validateDate(), validateDeps(), validateDescription(), validateFilelist(), validateLicense(), validateMainFilelist(), validateMaintainers(), validateNotes(), validatePackageName(), validateReleaseFilelist(), validateStability(), validateState(), validateSummary(), validateTime(), and validateVersion().

Here is the call graph for this function:

◆ validateChangelog()

validateChangelog ( )

@access protected

Definition at line 605 of file Validate.php.

    {
        return true;
    }

Referenced by validate().

Here is the caller graph for this function:

◆ validateDate()

validateDate ( )

@access protected

Definition at line 436 of file Validate.php.

    {
        if ($this->_state == PEAR_VALIDATE_NORMAL ||
              $this->_state == PEAR_VALIDATE_PACKAGING) {
 
            if (!preg_match('/(\d\d\d\d)\-(\d\d)\-(\d\d)/',
                  $this->_packagexml->getDate(), $res) ||
                  count($res) < 4
                  || !checkdate($res[2], $res[3], $res[1])
                ) {
                $this->_addFailure('date', 'invalid release date "' .
                    $this->_packagexml->getDate() . '"');
                return false;
            }
 
            if ($this->_state == PEAR_VALIDATE_PACKAGING &&
                  $this->_packagexml->getDate() != date('Y-m-d')) {
                $this->_addWarning('date', 'Release Date "' .
                    $this->_packagexml->getDate() . '" is not today');
            }
        }
        return true;
    }

References _addFailure(), _addWarning(), PEAR_VALIDATE_NORMAL, and PEAR_VALIDATE_PACKAGING.

Referenced by validate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ validateDependencies()

validateDependencies ( )

for package.xml 2.0 only - channels can't use package.xml 1.0 @access protected

Definition at line 570 of file Validate.php.

    {
        return true;
    }

◆ validateDeps()

validateDeps ( )

@access protected

Definition at line 621 of file Validate.php.

    {
        return true;
    }

Referenced by validate().

Here is the caller graph for this function:

◆ validateDescription()

validateDescription ( )

@access protected

Definition at line 545 of file Validate.php.

    {
        return true;
    }

Referenced by validate().

Here is the caller graph for this function:

◆ validateFilelist()

validateFilelist ( )

@access protected

Definition at line 613 of file Validate.php.

    {
        return true;
    }

Referenced by validate().

Here is the caller graph for this function:

◆ validateLicense()

validateLicense ( )

@access protected

Definition at line 553 of file Validate.php.

    {
        return true;
    }

Referenced by validate().

Here is the caller graph for this function:

◆ validateMainFilelist()

validateMainFilelist ( )

for package.xml 2.0 only @access protected

Definition at line 588 of file Validate.php.

    {
        return true; // placeholder for now
    }

Referenced by validate().

Here is the caller graph for this function:

◆ validateMaintainers()

validateMaintainers ( )

@access protected

Definition at line 426 of file Validate.php.

    {
        // maintainers can only be truly validated server-side for most channels
        // but allow this customization for those who wish it
        return true;
    }

Referenced by validate().

Here is the caller graph for this function:

◆ validateNotes()

validateNotes ( )

@access protected

Definition at line 561 of file Validate.php.

    {
        return true;
    }

Referenced by validate().

Here is the caller graph for this function:

◆ validatePackageName()

validatePackageName ( )

@access protected

Reimplemented in PEAR_Validator_PECL.

Definition at line 196 of file Validate.php.

    {
        if ($this->_state == PEAR_VALIDATE_PACKAGING ||
              $this->_state == PEAR_VALIDATE_NORMAL) {
            if (($this->_packagexml->getPackagexmlVersion() == '2.0' ||
                 $this->_packagexml->getPackagexmlVersion() == '2.1') &&
                  $this->_packagexml->getExtends()) {
                $version = $this->_packagexml->getVersion() . '';
                $name = $this->_packagexml->getPackage();
                $a = explode('.', $version);
                $test = array_shift($a);
                if ($test == '0') {
                    return true;
                }
                $vlen = strlen($test);
                $majver = substr($name, strlen($name) - $vlen);
                while ($majver && !is_numeric($majver[0])) {
                    $majver = substr($majver, 1);
                }
                if ($majver != $test) {
                    $this->_addWarning('package', "package $name extends package " .
                        $this->_packagexml->getExtends() . ' and so the name should ' .
                        'have a postfix equal to the major version like "' .
                        $this->_packagexml->getExtends() . $test . '"');
                    return true;
                } elseif (substr($name, 0, strlen($name) - $vlen) !=
                            $this->_packagexml->getExtends()) {
                    $this->_addWarning('package', "package $name extends package " .
                        $this->_packagexml->getExtends() . ' and so the name must ' .
                        'be an extension like "' . $this->_packagexml->getExtends() .
                        $test . '"');
                    return true;
                }
            }
        }
        if (!$this->validPackageName($this->_packagexml->getPackage())) {
            $this->_addFailure('name', 'package name "' .
                $this->_packagexml->getPackage() . '" is invalid');
            return false;
        }
    }

References _addFailure(), _addWarning(), PEAR_VALIDATE_NORMAL, PEAR_VALIDATE_PACKAGING, and validPackageName().

Referenced by validate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ validateReleaseFilelist()

validateReleaseFilelist ( )

for package.xml 2.0 only @access protected

Definition at line 597 of file Validate.php.

    {
        return true; // placeholder for now
    }

Referenced by validate().

Here is the caller graph for this function:

◆ validateStability()

validateStability ( )

@access protected

Definition at line 512 of file Validate.php.

    {
        $ret = true;
        $packagestability = $this->_packagexml->getState();
        $apistability = $this->_packagexml->getState('api');
        if (!PEAR_Validate::validState($packagestability)) {
            $this->_addFailure('state', 'invalid release stability "' .
                $this->_packagexml->getState() . '", must be one of: ' .
                implode(', ', PEAR_Validate::getValidStates()));
            $ret = false;
        }
        $apistates = PEAR_Validate::getValidStates();
        array_shift($apistates); // snapshot is not allowed
        if (!in_array($apistability, $apistates)) {
            $this->_addFailure('state', 'invalid API stability "' .
                $this->_packagexml->getState('api') . '", must be one of: ' .
                implode(', ', $apistates));
            $ret = false;
        }
        return $ret;
    }

References _addFailure(), getValidStates(), and validState().

Referenced by validate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ validateState()

validateState ( )

@access protected

Definition at line 493 of file Validate.php.

    {
        // this is the closest to "final" php4 can get
        if (!PEAR_Validate::validState($this->_packagexml->getState())) {
            if (strtolower($this->_packagexml->getState() == 'rc')) {
                $this->_addFailure('state', 'RC is not a state, it is a version ' .
                    'postfix, use ' . $this->_packagexml->getVersion() . 'RC1, state beta');
            }
            $this->_addFailure('state', 'invalid release state "' .
                $this->_packagexml->getState() . '", must be one of: ' .
                implode(', ', PEAR_Validate::getValidStates()));
            return false;
        }
        return true;
    }

References _addFailure(), getValidStates(), and validState().

Referenced by validate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ validateSummary()

validateSummary ( )

@access protected

Definition at line 537 of file Validate.php.

    {
        return true;
    }

Referenced by validate().

Here is the caller graph for this function:

◆ validateTime()

validateTime ( )

@access protected

Definition at line 463 of file Validate.php.

    {
        if (!$this->_packagexml->getTime()) {
            // default of no time value set
            return true;
        }
 
        // packager automatically sets time, so only validate if pear validate is called
        if ($this->_state = PEAR_VALIDATE_NORMAL) {
            if (!preg_match('/\d\d:\d\d:\d\d/',
                  $this->_packagexml->getTime())) {
                $this->_addFailure('time', 'invalid release time "' .
                    $this->_packagexml->getTime() . '"');
                return false;
            }
 
            $result = preg_match('|\d{2}\:\d{2}\:\d{2}|', $this->_packagexml->getTime(), $matches);
            if ($result === false || empty($matches)) {
                $this->_addFailure('time', 'invalid release time "' .
                    $this->_packagexml->getTime() . '"');
                return false;
            }
        }
 
        return true;
    }

References $result, _addFailure(), and PEAR_VALIDATE_NORMAL.

Referenced by validate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ validateVersion()

validateVersion ( )

@access protected

Reimplemented in PEAR_Validator_PECL.

Definition at line 241 of file Validate.php.

    {
        if ($this->_state != PEAR_VALIDATE_PACKAGING) {
            if (!$this->validVersion($this->_packagexml->getVersion())) {
                $this->_addFailure('version',
                    'Invalid version number "' . $this->_packagexml->getVersion() . '"');
            }
            return false;
        }
        $version = $this->_packagexml->getVersion();
        $versioncomponents = explode('.', $version);
        if (count($versioncomponents) != 3) {
            $this->_addWarning('version',
                'A version number should have 3 decimals (x.y.z)');
            return true;
        }
        $name = $this->_packagexml->getPackage();
        // version must be based upon state
        switch ($this->_packagexml->getState()) {
            case 'snapshot' :
                return true;
            case 'devel' :
                if ($versioncomponents[0] . 'a' == '0a') {
                    return true;
                }
                if ($versioncomponents[0] == 0) {
                    $versioncomponents[0] = '0';
                    $this->_addWarning('version',
                        'version "' . $version . '" should be "' .
                        implode('.' ,$versioncomponents) . '"');
                } else {
                    $this->_addWarning('version',
                        'packages with devel stability must be < version 1.0.0');
                }
                return true;
            break;
            case 'alpha' :
            case 'beta' :
                // check for a package that extends a package,
                // like Foo and Foo2
                if ($this->_state == PEAR_VALIDATE_PACKAGING) {
                    if (substr($versioncomponents[2], 1, 2) == 'rc') {
                        $this->_addFailure('version', 'Release Candidate versions ' .
                            'must have capital RC, not lower-case rc');
                        return false;
                    }
                }
                if (!$this->_packagexml->getExtends()) {
                    if ($versioncomponents[0] == '1') {
                        if ($versioncomponents[2][0] == '0') {
                            if ($versioncomponents[2] == '0') {
                                // version 1.*.0000
                                $this->_addWarning('version',
                                    'version 1.' . $versioncomponents[1] .
                                        '.0 probably should not be alpha or beta');
                                return true;
                            } elseif (strlen($versioncomponents[2]) > 1) {
                                // version 1.*.0RC1 or 1.*.0beta24 etc.
                                return true;
                            } else {
                                // version 1.*.0
                                $this->_addWarning('version',
                                    'version 1.' . $versioncomponents[1] .
                                        '.0 probably should not be alpha or beta');
                                return true;
                            }
                        } else {
                            $this->_addWarning('version',
                                'bugfix versions (1.3.x where x > 0) probably should ' .
                                'not be alpha or beta');
                            return true;
                        }
                    } elseif ($versioncomponents[0] != '0') {
                        $this->_addWarning('version',
                            'major versions greater than 1 are not allowed for packages ' .
                            'without an <extends> tag or an identical postfix (foo2 v2.0.0)');
                        return true;
                    }
                    if ($versioncomponents[0] . 'a' == '0a') {
                        return true;
                    }
                    if ($versioncomponents[0] == 0) {
                        $versioncomponents[0] = '0';
                        $this->_addWarning('version',
                            'version "' . $version . '" should be "' .
                            implode('.' ,$versioncomponents) . '"');
                    }
                } else {
                    $vlen = strlen($versioncomponents[0] . '');
                    $majver = substr($name, strlen($name) - $vlen);
                    while ($majver && !is_numeric($majver[0])) {
                        $majver = substr($majver, 1);
                    }
                    if (($versioncomponents[0] != 0) && $majver != $versioncomponents[0]) {
                        $this->_addWarning('version', 'first version number "' .
                            $versioncomponents[0] . '" must match the postfix of ' .
                            'package name "' . $name . '" (' .
                            $majver . ')');
                        return true;
                    }
                    if ($versioncomponents[0] == $majver) {
                        if ($versioncomponents[2][0] == '0') {
                            if ($versioncomponents[2] == '0') {
                                // version 2.*.0000
                                $this->_addWarning('version',
                                    "version $majver." . $versioncomponents[1] .
                                        '.0 probably should not be alpha or beta');
                                return false;
                            } elseif (strlen($versioncomponents[2]) > 1) {
                                // version 2.*.0RC1 or 2.*.0beta24 etc.
                                return true;
                            } else {
                                // version 2.*.0
                                $this->_addWarning('version',
                                    "version $majver." . $versioncomponents[1] .
                                        '.0 cannot be alpha or beta');
                                return true;
                            }
                        } else {
                            $this->_addWarning('version',
                                "bugfix versions ($majver.x.y where y > 0) should " .
                                'not be alpha or beta');
                            return true;
                        }
                    } elseif ($versioncomponents[0] != '0') {
                        $this->_addWarning('version',
                            "only versions 0.x.y and $majver.x.y are allowed for alpha/beta releases");
                        return true;
                    }
                    if ($versioncomponents[0] . 'a' == '0a') {
                        return true;
                    }
                    if ($versioncomponents[0] == 0) {
                        $versioncomponents[0] = '0';
                        $this->_addWarning('version',
                            'version "' . $version . '" should be "' .
                            implode('.' ,$versioncomponents) . '"');
                    }
                }
                return true;
            break;
            case 'stable' :
                if ($versioncomponents[0] == '0') {
                    $this->_addWarning('version', 'versions less than 1.0.0 cannot ' .
                    'be stable');
                    return true;
                }
                if (!is_numeric($versioncomponents[2])) {
                    if (preg_match('/\d+(rc|a|alpha|b|beta)\d*/i',
                          $versioncomponents[2])) {
                        $this->_addWarning('version', 'version "' . $version . '" or any ' .
                            'RC/beta/alpha version cannot be stable');
                        return true;
                    }
                }
                // check for a package that extends a package,
                // like Foo and Foo2
                if ($this->_packagexml->getExtends()) {
                    $vlen = strlen($versioncomponents[0] . '');
                    $majver = substr($name, strlen($name) - $vlen);
                    while ($majver && !is_numeric($majver[0])) {
                        $majver = substr($majver, 1);
                    }
                    if (($versioncomponents[0] != 0) && $majver != $versioncomponents[0]) {
                        $this->_addWarning('version', 'first version number "' .
                            $versioncomponents[0] . '" must match the postfix of ' .
                            'package name "' . $name . '" (' .
                            $majver . ')');
                        return true;
                    }
                } elseif ($versioncomponents[0] > 1) {
                    $this->_addWarning('version', 'major version x in x.y.z may not be greater than ' .
                        '1 for any package that does not have an <extends> tag');
                }
                return true;
            break;
            default :
                return false;
            break;
        }
    }

References _addFailure(), _addWarning(), PEAR_VALIDATE_PACKAGING, and validVersion().

Referenced by validate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ validGroupName()

validGroupName ( $name )

static

This validates a bundle name, and bundle names must conform to the PEAR naming convention, so the method is final and static.

Parameters

string @final

Definition at line 88 of file Validate.php.

    {
        return (bool) preg_match('/^' . _PEAR_COMMON_PACKAGE_NAME_PREG . '\\z/', $name);
    }

References _PEAR_COMMON_PACKAGE_NAME_PREG.

Referenced by PEAR_PackageFile_v2_Validator\_validateDependencies(), and PEAR_Registry\parsePackageName().

Here is the caller graph for this function:

◆ validPackageName()

validPackageName	(		$name,
			$validatepackagename = false )

Parameters

string	package name to validate
string	name of channel-specific validation package @final

Definition at line 72 of file Validate.php.

    {
        if ($validatepackagename) {
            if (strtolower($name) == strtolower($validatepackagename)) {
                return (bool) preg_match('/^[a-zA-Z0-9_]+(?:\.[a-zA-Z0-9_]+)*\\z/', $name);
            }
        }
        return $this->_validPackageName($name);
    }

References _validPackageName().

Referenced by validatePackageName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ validState()

validState ( $state )

static

Determine whether $state represents a valid stability level

Parameters

string

Returns: bool @final

Definition at line 99 of file Validate.php.

    {
        return in_array($state, array('snapshot', 'devel', 'alpha', 'beta', 'stable'));
    }

Referenced by validateStability(), and validateState().

Here is the caller graph for this function:

◆ validVersion()

validVersion ( $ver )

static

Determine whether a version is a properly formatted version number that can be used by version_compare

Parameters

string

Returns: bool @final

Definition at line 121 of file Validate.php.

    {
        return (bool) preg_match(PEAR_COMMON_PACKAGE_VERSION_PREG, $ver);
    }

References PEAR_COMMON_PACKAGE_VERSION_PREG.

Referenced by validateVersion().

Here is the caller graph for this function:

Field Documentation

◆ $_failures

$_failures = array('error' => array(), 'warning' => array())

Definition at line 54 of file Validate.php.

Referenced by getFailures().

◆ $_packagexml

$_packagexml

Definition at line 44 of file Validate.php.

◆ $_state

$_state = PEAR_VALIDATE_NORMAL

Definition at line 48 of file Validate.php.

◆ $packageregex

$packageregex = _PEAR_COMMON_PACKAGE_NAME_PREG

Definition at line 40 of file Validate.php.

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

E:/Bearsampp-development/sandbox/core/libs/php/pear/pear/PEAR/Validate.php

Public Member Functions

Static Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

◆ _addFailure()

◆ _addWarning()

◆ _validateFilelist()

◆ _validPackageName()

◆ getFailures()

◆ getValidStates()

◆ setPackageFile()

◆ validate()

◆ validateChangelog()

◆ validateDate()

◆ validateDependencies()

◆ validateDeps()

◆ validateDescription()

◆ validateFilelist()

◆ validateLicense()

◆ validateMainFilelist()

◆ validateMaintainers()

◆ validateNotes()

◆ validatePackageName()

◆ validateReleaseFilelist()

◆ validateStability()

◆ validateState()

◆ validateSummary()

◆ validateTime()

◆ validateVersion()

◆ validGroupName()

◆ validPackageName()

◆ validState()

◆ validVersion()

Field Documentation

◆ $_failures

◆ $_packagexml

◆ $_state

◆ $packageregex