From c2127a28fbab18ab6780296e4983054d6cfe7535 Mon Sep 17 00:00:00 2001 From: Alex Tselegidis Date: Tue, 2 Nov 2021 10:03:10 +0100 Subject: [PATCH] Added missing comments --- application/core/EA_Model.php | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/application/core/EA_Model.php b/application/core/EA_Model.php index a2b6b5a0..5138a18d 100644 --- a/application/core/EA_Model.php +++ b/application/core/EA_Model.php @@ -38,6 +38,11 @@ * @property EA_Session $session * @property EA_Upload $upload * @property EA_URI $uri + * + * @method int save(array $record) + * @method array find(int $id) + * @method array get($where, int $limit, int $offset, string $order_by) + * @method mixed value(int $id, string $field) */ class EA_Model extends CI_Model { /** @@ -89,10 +94,10 @@ class EA_Model extends CI_Model { /** * Get all records that match the provided criteria. * - * @param mixed|null $where - * @param int|null $limit - * @param int|null $offset - * @param string|null $order_by + * param array|string $where Where conditions + * @param int|null $limit Record limit. + * @param int|null $offset Record offset. + * @param string|null $order_by Order by. * * @return array Returns an array of records. */ @@ -115,6 +120,14 @@ class EA_Model extends CI_Model { return $this->save($record); } + /** + * Easily cast fields to the correct data type. + * + * The integrated MySQL library will return all values as strings, something that can easily becoming problematic, + * especially when comparing database values. + * + * @param array $record Record data. + */ public function cast(array &$record) { foreach ($this->casts as $attribute => $cast)