Open Journal Systems  3.3.0
PKP\Services\Interfaces\EntityPropertyInterface Interface Reference

Public Member Functions

 getFullProperties ($entity, $args=null)
 
 getProperties ($entity, $props, $args=null)
 
 getSummaryProperties ($entity, $args=null)
 

Detailed Description

Definition at line 18 of file EntityPropertyInterface.inc.php.

Member Function Documentation

◆ getFullProperties()

PKP\Services\Interfaces\EntityPropertyInterface::getFullProperties (   $entity,
  $args = null 
)

Returns full properties for an entity

Parameters
$entityobject The object to convert
$argsarray Additional variable which may be required $args['request'] PKPRequest Required $args['slimRequest'] SlimRequest
Returns
array

◆ getProperties()

PKP\Services\Interfaces\EntityPropertyInterface::getProperties (   $entity,
  $props,
  $args = null 
)

Returns the values for the requested list of properties

Parameters
$entityobject The object to convert
$propsarray The properties to include in the result
$argsarray Additional variable which may be required $args['request'] PKPRequest Required $args['slimRequest'] SlimRequest
Returns
array

◆ getSummaryProperties()

PKP\Services\Interfaces\EntityPropertyInterface::getSummaryProperties (   $entity,
  $args = null 
)

Returns summary properties for an entity

Parameters
$entityobject The object to convert
$argsarray Additional variables which may be required $args['request'] PKPRequest Required $args['slimRequest'] SlimRequest
Returns
array

The documentation for this interface was generated from the following file: