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])
Afficher le fichier Open project: datasift/datasift-php Class Usage Examples

Méthodes publiques

Méthode 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

Méthodes protégées

Méthode Description
setData ( $data )
setFeeds ( $feeds )
setProgress ( $progress )
setSample ( $sample )
setStatus ( $status )

Method Details

__construct() public méthode

Constructs a new DataSift_HistoricPreview
public __construct ( DataSift_User $user, array $data = [] )
$user DataSift_User
$data array

create() public méthode

Create the preview represented by the parameters in this object
public create ( ) : DataSift_HistoricPreview
Résultat DataSift_HistoricPreview

fromResponse() public méthode

Hydrates this preview from an array of API responses
public fromResponse ( array $data ) : DataSift_HistoricPreview
$data array
Résultat DataSift_HistoricPreview

get() public static méthode

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
Résultat DataSift_HistoricPreview

getCreatedAt() public méthode

Gets the created-at timestamp
public getCreatedAt ( ) : integer
Résultat integer A UNIX timestamp

getData() public méthode

public getData ( )

getEnd() public méthode

Gets the timestamp this report ends at
public getEnd ( ) : string
Résultat string

getFeeds() public méthode

public getFeeds ( )

getHash() public méthode

public getHash ( ) : string
Résultat string

getId() public méthode

Gets this DataSift_HistoricPreview's unique identifier
public getId ( ) : string
Résultat string

getParameters() public méthode

Gets the parameters for this DataSift_HistoricPreview
public getParameters ( ) : array
Résultat array

getProgress() public méthode

public getProgress ( )

getSample() public méthode

public getSample ( )

getStart() public méthode

Gets the timestamp this report starts at
public getStart ( ) : string
Résultat string

getStatus() public méthode

public getStatus ( )

getUser() public méthode

Gets the user this DataSift_HistoricPreview belongs to
public getUser ( ) : DataSift_User
Résultat DataSift_User

setCreatedAt() public méthode

Sets the created-at timestamp
public setCreatedAt ( integer $createdAt )
$createdAt integer

setData() protected méthode

protected setData ( $data )

setEnd() public méthode

Sets the timestamp this report ends
public setEnd ( string $end )
$end string

setFeeds() protected méthode

protected setFeeds ( $feeds )

setHash() public méthode

public setHash ( string $hash )
$hash string

setId() public méthode

Sets this DataSift_HistoricPreview's unique identifier
public setId ( string $id )
$id string

setParameters() public méthode

Sets the parameters for this DataSift_HistoricPreview
public setParameters ( array $parameters )
$parameters array

setProgress() protected méthode

protected setProgress ( $progress )

setSample() protected méthode

protected setSample ( $sample )

setStart() public méthode

Sets the timestamp this report starts
public setStart ( string $start )
$start string

setStatus() protected méthode

protected setStatus ( $status )

setUser() public méthode

Sets the user this DataSift_HistoricPreview belongs to
public setUser ( DataSift_User $user )
$user DataSift_User

toArray() public méthode

Converts this Source to an array suitable for transmission to the API
public toArray ( ) : array
Résultat array