Documentation

ChannelRest10Reader extends BaseChannelReader
in package

Read PEAR packages using REST 1.0 interface

At version 1.0 package descriptions read from: {baseUrl}/p/packages.xml {baseUrl}/p/{package}/info.xml {baseUrl}/p/{package}/allreleases.xml {baseUrl}/p/{package}/deps.{version}.txt

Tags
author

Alexey Prilipko palex@farpost.com

Table of Contents

ALL_CATEGORIES_NS  = 'http://pear.php.net/dtd/rest.allcategories'
ALL_PACKAGES_NS  = 'http://pear.php.net/dtd/rest.allpackages'
ALL_RELEASES_NS  = 'http://pear.php.net/dtd/rest.allreleases'
CATEGORY_PACKAGES_INFO_NS  = 'http://pear.php.net/dtd/rest.categorypackageinfo'
CHANNEL_NS  = 'http://pear.php.net/channel-1.0'
PEAR REST Interface namespaces
PACKAGE_INFO_NS  = 'http://pear.php.net/dtd/rest.package'
$dependencyReader  : mixed
$rfs  : RemoteFilesystem
__construct()  : mixed
read()  : array<string|int, PackageInfo>
Reads package descriptions using PEAR Rest 1.0 interface
requestContent()  : SimpleXMLElement
Read content from remote filesystem.
requestXml()  : SimpleXMLElement
Read xml content from remote filesystem
readPackage()  : PackageInfo
Read package info from {baseUrl}/p/{package}/info.xml
readPackageReleaseDependencies()  : array<string|int, DependencyInfo>
Read package dependencies from {baseUrl}/p/{package}/deps.{version}.txt
readPackageReleases()  : array<string|int, ReleaseInfo>
Read package releases from {baseUrl}/p/{package}/allreleases.xml
readPackages()  : array<string|int, PackageInfo>
Read list of packages from {baseUrl}/p/packages.xml

Constants

ALL_CATEGORIES_NS

public mixed ALL_CATEGORIES_NS = 'http://pear.php.net/dtd/rest.allcategories'

ALL_PACKAGES_NS

public mixed ALL_PACKAGES_NS = 'http://pear.php.net/dtd/rest.allpackages'

ALL_RELEASES_NS

public mixed ALL_RELEASES_NS = 'http://pear.php.net/dtd/rest.allreleases'

CATEGORY_PACKAGES_INFO_NS

public mixed CATEGORY_PACKAGES_INFO_NS = 'http://pear.php.net/dtd/rest.categorypackageinfo'

CHANNEL_NS

PEAR REST Interface namespaces

public mixed CHANNEL_NS = 'http://pear.php.net/channel-1.0'

PACKAGE_INFO_NS

public mixed PACKAGE_INFO_NS = 'http://pear.php.net/dtd/rest.package'

Properties

Methods

__construct()

public __construct(mixed $rfs) : mixed
Parameters
$rfs : mixed
Return values
mixed

read()

Reads package descriptions using PEAR Rest 1.0 interface

public read(string $baseUrl) : array<string|int, PackageInfo>
Parameters
$baseUrl : string

base Url interface

Return values
array<string|int, PackageInfo>

requestContent()

Read content from remote filesystem.

protected requestContent(string $origin, string $path) : SimpleXMLElement
Parameters
$origin : string

server

$path : string

relative path to content

Tags
throws
UnexpectedValueException
Return values
SimpleXMLElement

requestXml()

Read xml content from remote filesystem

protected requestXml(string $origin, string $path) : SimpleXMLElement
Parameters
$origin : string

server

$path : string

relative path to content

Tags
throws
UnexpectedValueException
Return values
SimpleXMLElement

readPackage()

Read package info from {baseUrl}/p/{package}/info.xml

private readPackage(string $baseUrl, string $packageName) : PackageInfo
Parameters
$baseUrl : string
$packageName : string
Return values
PackageInfo

readPackageReleaseDependencies()

Read package dependencies from {baseUrl}/p/{package}/deps.{version}.txt

private readPackageReleaseDependencies(string $baseUrl, string $packageName, string $version) : array<string|int, DependencyInfo>
Parameters
$baseUrl : string
$packageName : string
$version : string
Return values
array<string|int, DependencyInfo>

readPackageReleases()

Read package releases from {baseUrl}/p/{package}/allreleases.xml

private readPackageReleases(string $baseUrl, string $packageName) : array<string|int, ReleaseInfo>
Parameters
$baseUrl : string
$packageName : string
Tags
throws
TransportException|Exception
Return values
array<string|int, ReleaseInfo>

hash array with keys as version numbers

readPackages()

Read list of packages from {baseUrl}/p/packages.xml

private readPackages(string $baseUrl) : array<string|int, PackageInfo>
Parameters
$baseUrl : string
Return values
array<string|int, PackageInfo>

Search results