Documentation

DocsOrigin
in package

Components_Helper_DocOrigin:: deals with a DOCS_ORIGIN file.

Copyright 2011-2020 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Tags
category

Horde

author

Gunnar Wrobel wrobel@pardus.de

license

http://www.horde.org/licenses/lgpl21 LGPL 2.1

Table of Contents

$_client  : Horde_Http_Client
The HTTP client for remote access.
$_docs_origin  : array<string|int, mixed>
Path to the DOCS_ORIGIN file.
$_documents  : array<string|int, mixed>
The list of remote documents. Keys represent the local target positions, the values indicate the remote location.
__construct()  : mixed
Constructor.
_fetchDocument()  : void
Fetch the given remote document into a local target path.
fetchDocuments()  : void
Fetch the remote documents.
getDocuments()  : array<string|int, mixed>
Return the list of documents that will be fetched.
_parse()  : array<string|int, mixed>
Parse the instructions from the file.

Properties

$_client read-only

The HTTP client for remote access.

private Horde_Http_Client $_client

$_docs_origin

Path to the DOCS_ORIGIN file.

private array<string|int, mixed> $_docs_origin

$_documents

The list of remote documents. Keys represent the local target positions, the values indicate the remote location.

private array<string|int, mixed> $_documents

Methods

__construct()

Constructor.

public __construct(string|array<string|int, string> $docs_origin, Horde_Http_Client $_client) : mixed
Parameters
$docs_origin : string|array<string|int, string>

Path to the DOCS_ORIGIN file.

$_client : Horde_Http_Client
Return values
mixed —

_fetchDocument()

Fetch the given remote document into a local target path.

public _fetchDocument(string $remote, string $local, Output $output) : void
Parameters
$remote : string

The remote URI.

$local : string

The local target path.

$output : Output

The output handler.

Return values
void —

fetchDocuments()

Fetch the remote documents.

public fetchDocuments(Output $output) : void
Parameters
$output : Output

The output handler.

Return values
void —

getDocuments()

Return the list of documents that will be fetched.

public getDocuments() : array<string|int, mixed>
Return values
array<string|int, mixed> —

The list of remote documents.

_parse()

Parse the instructions from the file.

private _parse() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Search results