PHP Class Components_Helper_DocsOrigin, horde

Copyright 2011-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

See link: http://pear.horde.org/index.php?package=Components

Author: Gunnar Wrobel ([email protected])

ファイルを表示 Open project: horde/horde Class Usage Examples

Public Methods

Method	Description
__construct ( string $docs_origin, Horde_Http_Client $client )	Constructor.
_fetchDocument ( string $remote, string $local, Components_Output $output ) : null	Fetch the given remote document into a local target path.
fetchDocuments ( Components_Output $output ) : null	Fetch the remote documents.
getDocuments ( ) : array	Return the list of documents that will be fetched.

Private Methods

Method	Description
_parse ( ) : null	Parse the instructions from the file.

Method Details

__construct() public method

Constructor.

public __construct ( string $docs_origin, Horde_Http_Client $client )
$docs_origin	string	Path to the DOCS_ORIGIN file.
$client	Horde_Http_Client

_fetchDocument() public method

Fetch the given remote document into a local target path.

public _fetchDocument ( string $remote, string $local, Components_Output $output ) : null
$remote	string	The remote URI.
$local	string	The local target path.
$output	Components_Output	The output handler.
return	null

fetchDocuments() public method

Fetch the remote documents.

public fetchDocuments ( Components_Output $output ) : null
$output	Components_Output	The output handler.
return	null

getDocuments() public method

Return the list of documents that will be fetched.

public getDocuments ( ) : array
return	array	The list of remote documents.