Menu

## StudentHistoryProcess

StudentHistoryProcess.php : 15

##### Tags

class

  trait Trait for Common Processes

### Table of Contents

#### Methods

createReadHistory() : void
  Record that a parent has read an entity related to a student.
getReadCount() : int
  Count read history entries for an entity.

### Methods

#### createReadHistory()

StudentHistoryProcess.php : 28

Record that a parent has read an entity related to a student.

`public static createReadHistory(int $school_id, int $student_id, int $parent_id, int $entity_id, string $entity_name, string $type) : void`

##### Parameters

$school_id : int

  School identifier

$student_id : int

  Student identifier

$parent_id : int

  Parent identifier

$entity_id : int

  Related entity identifier

$entity_name : string

  Entity model name

$type : string

  Type of history entry

#### getReadCount()

StudentHistoryProcess.php : 57

Count read history entries for an entity.

`public static getReadCount(int $school_id, int $entity_id, string $entity_name) : int`

##### Parameters

$school_id : int

  School identifier

$entity_id : int

  Related entity identifier

$entity_name : string

  Entity name to filter on

##### Return values

int —

Number of read records

## Search results