PHP Class OpenSkill\Datatable\Versions\VersionEngine

Show file Open project: openskill/datatable Class Usage Examples

Public Methods

Method Description
__construct ( array $versions ) DTVersionEngine constructor. The first version will be set as default version.
getVersion ( ) : OpenSkill\Datatable\Versions\Version
hasVersion ( ) : boolean
setVersion ( OpenSkill\Datatable\Versions\Version $version )

Private Methods

Method Description
setDefaultVersion ( array $versions ) Set the default version that will be used by the VersionEngine.
setVersionFromRequest ( array $versions ) Pick the verison of an engine that can parse a request.

Method Details

__construct() public method

DTVersionEngine constructor. The first version will be set as default version.
public __construct ( array $versions )
$versions array an array of possible version this data table supports

getVersion() public method

public getVersion ( ) : OpenSkill\Datatable\Versions\Version
return OpenSkill\Datatable\Versions\Version Will return the version that is currently selected to handle the request.

hasVersion() public method

public hasVersion ( ) : boolean
return boolean true if one of the versions can handle the request, false otherwise

setVersion() public method

public setVersion ( OpenSkill\Datatable\Versions\Version $version )
$version OpenSkill\Datatable\Versions\Version The version that should be used in this request.