PHP Class DataSift_HistoricPreview

This software is the intellectual property of MediaSift Ltd., and is covered by retained intellectual property rights, including copyright. Distribution of this software is strictly forbidden under the terms of this license. The DataSift_HistoricPreview class represents a private source

See link: http://www.mediasift.com

Author: Courtney Robinson ([email protected])

Show file Open project: datasift/datasift-php Class Usage Examples

Public Methods

Method	Description
__construct ( DataSift_User $user, array $data = [] )	Constructs a new DataSift_HistoricPreview
create ( ) : DataSift_HistoricPreview	Create the preview represented by the parameters in this object
fromResponse ( array $data ) : DataSift_HistoricPreview	Hydrates this preview from an array of API responses
get ( DataSift_User $user, string $id ) : DataSift_HistoricPreview	Gets a single DataSift_HistoricPreview object by ID
getCreatedAt ( ) : integer	Gets the created-at timestamp
getData ( )
getEnd ( ) : string	Gets the timestamp this report ends at
getFeeds ( )
getHash ( ) : string
getId ( ) : string	Gets this DataSift_HistoricPreview's unique identifier
getParameters ( ) : array	Gets the parameters for this DataSift_HistoricPreview
getProgress ( )
getSample ( )
getStart ( ) : string	Gets the timestamp this report starts at
getStatus ( )
getUser ( ) : DataSift_User	Gets the user this DataSift_HistoricPreview belongs to
setCreatedAt ( integer $createdAt )	Sets the created-at timestamp
setEnd ( string $end )	Sets the timestamp this report ends
setHash ( string $hash )
setId ( string $id )	Sets this DataSift_HistoricPreview's unique identifier
setParameters ( array $parameters )	Sets the parameters for this DataSift_HistoricPreview
setStart ( string $start )	Sets the timestamp this report starts
setUser ( DataSift_User $user )	Sets the user this DataSift_HistoricPreview belongs to
toArray ( ) : array	Converts this Source to an array suitable for transmission to the API

Protected Methods

Method	Description
setData ( $data )
setFeeds ( $feeds )
setProgress ( $progress )
setSample ( $sample )
setStatus ( $status )

Method Details

__construct() public method

Constructs a new DataSift_HistoricPreview

public __construct ( DataSift_User $user, array $data = [] )
$user	DataSift_User
$data	array

create() public method

Create the preview represented by the parameters in this object

public create ( ) : DataSift_HistoricPreview
return	DataSift_HistoricPreview

fromResponse() public method

Hydrates this preview from an array of API responses

public fromResponse ( array $data ) : DataSift_HistoricPreview
$data	array
return	DataSift_HistoricPreview

get() public static method

Gets a single DataSift_HistoricPreview object by ID

public static get ( DataSift_User $user, string $id ) : DataSift_HistoricPreview
$user	DataSift_User	The user making the request.
$id	string	The id of the Source to fetch
return	DataSift_HistoricPreview

getCreatedAt() public method

Gets the created-at timestamp

public getCreatedAt ( ) : integer
return	integer	A UNIX timestamp

getData() public method

public getData ( )

getEnd() public method

Gets the timestamp this report ends at

public getEnd ( ) : string
return	string

getFeeds() public method

public getFeeds ( )

getHash() public method

public getHash ( ) : string
return	string

getId() public method

Gets this DataSift_HistoricPreview's unique identifier

public getId ( ) : string
return	string

getParameters() public method

Gets the parameters for this DataSift_HistoricPreview

public getParameters ( ) : array
return	array

getProgress() public method

public getProgress ( )

getSample() public method

public getSample ( )

getStart() public method

Gets the timestamp this report starts at

public getStart ( ) : string
return	string

getStatus() public method

public getStatus ( )

getUser() public method

Gets the user this DataSift_HistoricPreview belongs to

public getUser ( ) : DataSift_User
return	DataSift_User

setCreatedAt() public method

Sets the created-at timestamp

public setCreatedAt ( integer $createdAt )
$createdAt	integer

setData() protected method

protected setData ( $data )

setEnd() public method

Sets the timestamp this report ends

public setEnd ( string $end )
$end	string

setFeeds() protected method

protected setFeeds ( $feeds )

setHash() public method

public setHash ( string $hash )
$hash	string

setId() public method

Sets this DataSift_HistoricPreview's unique identifier

public setId ( string $id )
$id	string

setParameters() public method

Sets the parameters for this DataSift_HistoricPreview

public setParameters ( array $parameters )
$parameters	array

setProgress() protected method

protected setProgress ( $progress )

setSample() protected method

protected setSample ( $sample )

setStart() public method

Sets the timestamp this report starts

public setStart ( string $start )
$start	string

setStatus() protected method

protected setStatus ( $status )

setUser() public method

Sets the user this DataSift_HistoricPreview belongs to

public setUser ( DataSift_User $user )
$user	DataSift_User

toArray() public method

Converts this Source to an array suitable for transmission to the API

public toArray ( ) : array
return	array