PHP Interface Tdt\Core\Repositories\Interfaces\DefinitionRepositoryInterface

Public Methods

Method	Description
count ( ) : integer	Retrieve the amount of definitions
countPublished ( ) : integer	Retrieve the amount of published definitions
delete ( string $identifier ) : boolean \| null	Delete a Definition object
exists ( string $identifier ) : boolean	Check if a definition exists with a given identifier
getAll ( integer $limit, integer $offset ) : array	Retrieve all definitions
getAllDefinitionInfo ( integer $limit, integer $offset, array $keywords = [] ) : array	Retrieve all the public information of all published Defintion's
getAllFullDescriptions ( integer $limit, integer $offset ) : array	Retrieve all the information of all Defintion's
getAllPublished ( integer $limit, integer $offset ) : array	Retrieve all published definitions
getByCollection ( $collection ) : array	Retrieve a collection of definitions based on the collection prefix of the identifier
getByIdentifier ( string $identifier ) : array	Retrieve a definition by its identifier
getCreateParameters ( ) : array	Retrieve the create parameters for a Definition e.g. array( 'create_parameter' => array( 'required' => true, 'description' => '.
getDefinitionSource ( integer $definition_id, string $name ) : array	Get the source of the definition (e.g. CsvDefinition, ShpDefinition,.
getFullDescription ( string $identifier ) : array	Retrieve the full description of a definition
getOldest ( ) : array	Retrieve the oldest definition
store ( array $input ) : array	Store a Definition object
update ( string $identifier, array $input ) : array	Update a Definition object

Method Details

count() public method

Retrieve the amount of definitions

public count ( ) : integer
return	integer

countPublished() public method

Retrieve the amount of published definitions

public countPublished ( ) : integer
return	integer

delete() public method

Delete a Definition object

public delete ( string $identifier ) : boolean \| null
$identifier	string
return	boolean \| null

exists() public method

Check if a definition exists with a given identifier

public exists ( string $identifier ) : boolean
$identifier	string
return	boolean

getAll() public method

Retrieve all definitions

public getAll ( integer $limit, integer $offset ) : array
$limit	integer
$offset	integer
return	array	of Definition's

getAllDefinitionInfo() public method

Retrieve all the public information of all published Defintion's

public getAllDefinitionInfo ( integer $limit, integer $offset, array $keywords = [] ) : array
$limit	integer
$offset	integer
$keywords	array
return	array	of Definition's

getAllFullDescriptions() public method

Retrieve all the information of all Defintion's

public getAllFullDescriptions ( integer $limit, integer $offset ) : array
$limit	integer
$offset	integer
return	array	of Definition's

getAllPublished() public method

Retrieve all published definitions

public getAllPublished ( integer $limit, integer $offset ) : array
$limit	integer
$offset	integer
return	array	of Definition's

getByCollection() public method

Retrieve a collection of definitions based on the collection prefix of the identifier

public getByCollection ( $collection ) : array
return	array	of Definition's

getByIdentifier() public method

Retrieve a definition by its identifier

public getByIdentifier ( string $identifier ) : array
$identifier	string
return	array	Definition

getCreateParameters() public method

..', 'type' => 'string', 'name' => 'pretty name' ), ...)

public getCreateParameters ( ) : array
return	array

getDefinitionSource() public method

..)

public getDefinitionSource ( integer $definition_id, string $name ) : array
$definition_id	integer	(id of the definition)
$name	string	(e.g. CsvDefinition, ShpDefinition,...)
return	array	Source

getFullDescription() public method

Retrieve the full description of a definition

public getFullDescription ( string $identifier ) : array
$identifier	string
return	array	Definition

getOldest() public method

Retrieve the oldest definition

public getOldest ( ) : array
return	array	Definition

store() public method

Store a Definition object

public store ( array $input ) : array
$input	array
return	array	Definition

update() public method

Update a Definition object

public update ( string $identifier, array $input ) : array
$identifier	string
$input	array
return	array	Definition