Skip to content

Commit d631b72

Browse files
committed
docs: add description
1 parent 54bd8de commit d631b72

2 files changed

Lines changed: 8 additions & 4 deletions

File tree

user_guide_src/source/general/common_functions.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -101,11 +101,13 @@ Service Accessors
101101

102102
.. php:function:: model($name[, $getShared = true[, &$conn = null]])
103103
104-
:param string $name:
105-
:param boolean $getShared:
106-
:param ConnectionInterface|null $conn:
104+
:param string $name: The model classname.
105+
:param boolean $getShared: Whether to return a shared instance.
106+
:param ConnectionInterface|null $conn: The database connection.
107107
:returns: More simple way of getting model instances
108-
:rtype: mixed
108+
:rtype: object
109+
110+
See also the :ref:`Using CodeIgniter's Model <accessing-models>`.
109111

110112
.. php:function:: old($key[, $default = null,[, $escape = 'html']])
111113

user_guide_src/source/models/model.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ It comes out of the box with helper
1616
methods for much of the standard ways you would need to interact with a database table, including finding records,
1717
updating records, deleting records, and more.
1818

19+
.. _accessing-models:
20+
1921
Accessing Models
2022
****************
2123

0 commit comments

Comments
 (0)