1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 <?php
namespace Gedcomx\Rs\Client\Util;
/**
* A basic class for using various data sources with the artifacts and memories API.
*
* Class DataSource
*
* @package Gedcomx\Rs\Client\Util
*/
class DataSource
{
private $filepath;
private $title;
private $parameters;
private $isFile;
/**
* Sets the file that will be uploaded.
*
* @param string $filepath Path to the file to upload
*/
public function setFile($filepath)
{
$this->isFile = true;
$this->filepath = $filepath;
}
/**
* Return the file path of this data source
*
* @return string
*/
public function getFile()
{
return $this->filepath;
}
/**
* Sets the title of the file to be uploaded.
*
* @param string $title A human readable name to associate with the data file
*/
public function setTitle($title)
{
$this->title = $title;
}
/**
* Return the title of this data
*
* @return string
*/
public function getTitle()
{
return $this->title;
}
/**
* Add a key value pair as data
*
* @param $key
* @param $value
*/
public function addParameter($key, $value)
{
$this->parameters[$key] = $value;
}
/**
* Return the array of parameters assigned to this data source
*
* @return array
*/
public function getParameters(){
return $this->parameters;
}
/**
* Return whether or not this data source has a file associated with it
*
* @return boolean
*/
public function isFile()
{
return $this->isFile;
}
}