EntryGenerator
extends Generator
in package
Table of Contents
Properties
- $compiler : Compiler
- $copyArchiveEngine : CopyEntryArchive
- $destination : Destination
- $entryIds : array<string|int, mixed>
- $httpClient : Browser
- $logger : Logger
- $maxPublishCount : int
- $withArchive : bool
Methods
- __construct() : mixed
- Generator constructor.
- run() : PromiseInterface<string|int, void>
- setEntryIds() : mixed
- setWithArchive() : void
- getName() : string
- handle() : PromiseInterface<string|int, void>
- handleError() : void
- onBeforeRequest() : void
- // Do something before sending HTTP request
- request() : PromiseInterface<string|int, void>
- shouldGenerateNextPage() : bool
- 次のページを生成するかどうか
- writeContents() : void
Properties
$compiler
protected
Compiler
$compiler
$copyArchiveEngine
protected
CopyEntryArchive
$copyArchiveEngine
$destination
protected
Destination
$destination
$entryIds
protected
array<string|int, mixed>
$entryIds
= []
$httpClient
protected
Browser
$httpClient
$logger
protected
Logger
$logger
$maxPublishCount
protected
int
$maxPublishCount
$withArchive
protected
bool
$withArchive
= false
Methods
__construct()
Generator constructor.
public
__construct(Compiler $compiler, Destination $destination, Logger $logger[, int $maxPublishCount = 5 ][, string $nameServer = '8.8.8.8' ]) : mixed
Parameters
- $compiler : Compiler
- $destination : Destination
- $logger : Logger
- $maxPublishCount : int = 5
- $nameServer : string = '8.8.8.8'
run()
public
run() : PromiseInterface<string|int, void>
Tags
Return values
PromiseInterface<string|int, void>setEntryIds()
public
setEntryIds(array<string|int, int> $entryIds) : mixed
Parameters
- $entryIds : array<string|int, int>
setWithArchive()
public
setWithArchive(bool $withArchive) : void
Parameters
- $withArchive : bool
getName()
protected
getName() : string
Return values
stringhandle()
protected
final handle(array<string|int, Page> $pages) : PromiseInterface<string|int, void>
Parameters
- $pages : array<string|int, Page>
Return values
PromiseInterface<string|int, void>handleError()
protected
handleError(Throwable $th, string $url) : void
Parameters
- $th : Throwable
- $url : string
onBeforeRequest()
// Do something before sending HTTP request
protected
onBeforeRequest(Page $page) : void
Parameters
- $page : Page
Tags
request()
protected
final request(string $url[, callable $onSuccess = null ][, callable $onFailure = null ]) : PromiseInterface<string|int, void>
Parameters
- $url : string
- $onSuccess : callable = null
- $onFailure : callable = null
Return values
PromiseInterface<string|int, void>shouldGenerateNextPage()
次のページを生成するかどうか
protected
shouldGenerateNextPage() : bool
Return values
boolwriteContents()
protected
writeContents(string $path, string $data) : void
Parameters
- $path : string
- $data : string