Layer: DAO · Source: lib/dao/DataRequestDao.php:22 (lines 22–178)

class DataRequestDao extends Dao

DataRequestDao Class

Data Access Object for GDPR data requests (access, rectification, erasure)

^ Tag ^ Value ^
| ''@category'' | Dao Class |
| ''@author'' | Scriptlog |
| ''@license'' | MIT |
| ''@version'' | 1.0 |
| ''@since'' | Since Release 1.0 |

^ Relation ^ Type ^ Meaning ^
| extends | [[scriptlog:lib:core:dao|''Dao'']] | parent class/interface |

None.

None declared.

^ Visibility ^ Method ^ Summary ^ Line ^
| public | ''__construct()'' | Constructor | 27 |
| public | ''createRequest()'' | Create a new data request | 41 |
| public | ''updateRequestStatus()'' | Update request status | 62 |
| public | ''getRequestById()'' | Get request by ID | 85 |
| public | ''getRequestByEmail()'' | Get request by email | 98 |
| public | ''getAllRequests()'' | Get all requests | 117 |
| public | ''getRequestsByStatus()'' | Get requests by status | 133 |
| public | ''deleteRequest()'' | Delete request | 149 |
| public | ''totalRequestRecords()'' | Total request records | 160 |
| public | ''getPendingCount()'' | Get pending requests count | 172 |

public function __construct()

lines 27–30 (4)

Constructor

Takes no parameters.

public function createRequest($requestType, $email, $ipAddress, $note = null)

lines 41–52 (12)

Create a new data request

^ Parameter ^ Type ^ Default ^ Description ^
| ''$requestType'' | ''(untyped)'' | //required// | //none// |
| ''$email'' | ''(untyped)'' | //required// | //none// |
| ''$ipAddress'' | ''(untyped)'' | //required// | //none// |
| ''$note'' | ''(untyped)'' | ''null'' | //none// |

Returns: (none declared) — int

public function updateRequestStatus($id, $status, $note = null)

lines 62–77 (16)

Update request status

^ Parameter ^ Type ^ Default ^ Description ^
| ''$id'' | ''(untyped)'' | //required// | //none// |
| ''$status'' | ''(untyped)'' | //required// | //none// |
| ''$note'' | ''(untyped)'' | ''null'' | //none// |

Returns: (none declared) — bool

public function getRequestById($id)

lines 85–90 (6)

Get request by ID

^ Parameter ^ Type ^ Default ^ Description ^
| ''$id'' | ''(untyped)'' | //required// | //none// |

Returns: (none declared) — array|bool

public function getRequestByEmail($email)

lines 98–106 (9)

Get request by email

^ Parameter ^ Type ^ Default ^ Description ^
| ''$email'' | ''(untyped)'' | //required// | //none// |

Returns: (none declared) — array|bool

public function getAllRequests($orderBy = 'ID')

lines 117–125 (9)

Get all requests

Sort column is validated against an explicit allow-list so raw input is never interpolated into the query.

^ Parameter ^ Type ^ Default ^ Description ^
| ''$orderBy'' | ''(untyped)'' | '''ID''' | //none// |

Returns: (none declared) — array|bool

public function getRequestsByStatus($status)

lines 133–141 (9)

Get requests by status

^ Parameter ^ Type ^ Default ^ Description ^
| ''$status'' | ''(untyped)'' | //required// | //none// |

Returns: (none declared) — array|bool

public function deleteRequest($id)

lines 149–153 (5)

Delete request

^ Parameter ^ Type ^ Default ^ Description ^
| ''$id'' | ''(untyped)'' | //required// | //none// |

Returns: (none declared) — bool

public function totalRequestRecords()

lines 160–165 (6)

Total request records

Takes no parameters.

Returns: (none declared) — int

public function getPendingCount()

lines 172–177 (6)

Get pending requests count

Takes no parameters.

Returns: (none declared) — int

^ Alias ^ Fully-qualified name ^
| ''Dao'' | [[scriptlog:lib:core:dao|''Scriptlog\Core\Dao'']] |

This page is generated from source by 'tools/gendoc'. Edits will be overwritten.