file-fetcher
Public Member Functions | Protected Member Functions | List of all members
FileFetcher\FileFetcher Class Reference
Inheritance diagram for FileFetcher\FileFetcher:
Procrastinator\Job\AbstractPersistentJob Procrastinator\Job::Job Contracts\HydratableInterface

Detailed Description

These can be utilized to make a local copy of a remote file aka fetch a file.

Basic Usage:

$fetcher = FileFetcher::get(
"1",
new Memory(),
[
"filePath" => "http://samplecsvs.s3.amazonaws.com/Sacramentorealestatetransactions.csv",
"processors" => [Local::class]
]
);
$result = $fetcher->run();

Public Member Functions

 setTimeLimit (int $seconds)
 
- Public Member Functions inherited from Procrastinator\Job\AbstractPersistentJob
 run ()
 
- Public Member Functions inherited from Procrastinator\Job::Job
 __construct ()
 
 run ()
 
 setTimeLimit (int $seconds)
 
 getTimeLimit ()
 
 getState ()
 
 getStateProperty (string $property, $default=null)
 
 getResult ()
 
 setStateProperty ( $property, $value)
 
 jsonSerialize ()
 
 setStateProperty ($property, $value)
 
 getTimeLimit ()
 
 getState ()
 
 getStateProperty (string $property, $default=null)
 
 getResult ()
 
 jsonSerialize ()
 

Protected Member Functions

 __construct (string $identifier, $storage, array $config=null)
 
 runIt ()
 
- Protected Member Functions inherited from Procrastinator\Job\AbstractPersistentJob
 setStatus ($status)
 
 setError ($message)
 
 setState ($state)
 
 serializeIgnoreProperties ()
 
- Protected Member Functions inherited from Procrastinator\Job::Job
 runIt ()
 

Additional Inherited Members

- Static Public Member Functions inherited from Procrastinator\Job\AbstractPersistentJob
static get (string $identifier, $storage, array $config=null)
 
- Static Public Member Functions inherited from Procrastinator\Job::Job
static hydrate ( $json)
 
- Static Public Member Functions inherited from Contracts\HydratableInterface
static hydrate (string $json, $instance=null)
 
- Protected Attributes inherited from Procrastinator\Job\AbstractPersistentJob
 $identifier
 
 $storage
 

Constructor & Destructor Documentation

◆ __construct()

FileFetcher\FileFetcher::__construct ( string  $identifier,
  $storage,
array  $config = null 
)
protected

Constructor.

Reimplemented from Procrastinator\Job\AbstractPersistentJob.

Member Function Documentation

◆ runIt()

FileFetcher\FileFetcher::runIt ( )
protected

Reimplemented from Procrastinator\Job::Job.

◆ setTimeLimit()

FileFetcher\FileFetcher::setTimeLimit ( int  $seconds)

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