Skip to content

docs: fix typos in comments in Model #6813

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 4, 2022
Merged

docs: fix typos in comments in Model #6813

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions system/Model.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,8 +157,8 @@ public function setTable(string $table)

/**
* Fetches the row of database from $this->table with a primary key
* matching $id. This methods works only with dbCalls
* This methods works only with dbCalls
* matching $id.
* This method works only with dbCalls.
*
* @param bool $singleton Single or multiple results
* @param array|int|string|null $id One primary key or an array of primary keys
Expand Down Expand Up @@ -189,8 +189,8 @@ protected function doFind(bool $singleton, $id = null)
}

/**
* Fetches the column of database from $this->table
* This methods works only with dbCalls
* Fetches the column of database from $this->table.
* This method works only with dbCalls.
*
* @param string $columnName Column Name
*
Expand All @@ -204,7 +204,7 @@ protected function doFindColumn(string $columnName)
/**
* Works with the current Query Builder instance to return
* all results, while optionally limiting them.
* This methods works only with dbCalls
* This method works only with dbCalls.
*
* @param int $limit Limit
* @param int $offset Offset
Expand All @@ -227,7 +227,7 @@ protected function doFindAll(int $limit = 0, int $offset = 0)
/**
* Returns the first row of the result set. Will take any previous
* Query Builder calls into account when determining the result set.
* This methods works only with dbCalls
* This method works only with dbCalls.
*
* @return array|object|null
*/
Expand All @@ -252,7 +252,7 @@ protected function doFirst()

/**
* Inserts data into the current table.
* This method works only with dbCalls
* This method works only with dbCalls.
*
* @param array $data Data
*
Expand Down Expand Up @@ -288,7 +288,7 @@ protected function doInsert(array $data)

/**
* Compiles batch insert strings and runs the queries, validating each row prior.
* This methods works only with dbCalls
* This method works only with dbCalls.
*
* @param array|null $set An associative array of insert values
* @param bool|null $escape Whether to escape values
Expand All @@ -314,7 +314,7 @@ protected function doInsertBatch(?array $set = null, ?bool $escape = null, int $

/**
* Updates a single record in $this->table.
* This methods works only with dbCalls
* This method works only with dbCalls.
*
* @param array|int|string|null $id
* @param array|null $data
Expand All @@ -340,7 +340,7 @@ protected function doUpdate($id = null, $data = null): bool

/**
* Compiles an update string and runs the query
* This methods works only with dbCalls
* This method works only with dbCalls.
*
* @param array|null $set An associative array of update values
* @param string|null $index The where key
Expand All @@ -359,7 +359,7 @@ protected function doUpdateBatch(?array $set = null, ?string $index = null, int
/**
* Deletes a single record from $this->table where $id matches
* the table's primaryKey
* This methods works only with dbCalls
* This method works only with dbCalls.
*
* @param array|int|string|null $id The rows primary key(s)
* @param bool $purge Allows overriding the soft deletes setting.
Expand Down Expand Up @@ -404,7 +404,7 @@ protected function doDelete($id = null, bool $purge = false)
/**
* Permanently deletes all rows that have been marked as deleted
* through soft deletes (deleted = 1)
* This methods works only with dbCalls
* This method works only with dbCalls.
*
* @return bool|string Returns a string if in test mode.
*/
Expand All @@ -418,7 +418,7 @@ protected function doPurgeDeleted()
/**
* Works with the find* methods to return only the rows that
* have been deleted.
* This methods works only with dbCalls
* This method works only with dbCalls.
*/
protected function doOnlyDeleted()
{
Expand All @@ -427,7 +427,7 @@ protected function doOnlyDeleted()

/**
* Compiles a replace into string and runs the query
* This methods works only with dbCalls
* This method works only with dbCalls.
*
* @param array|null $data Data
* @param bool $returnSQL Set to true to return Query String
Expand All @@ -443,7 +443,7 @@ protected function doReplace(?array $data = null, bool $returnSQL = false)
* Grabs the last error(s) that occurred from the Database connection.
* The return array should be in the following format:
* ['source' => 'message']
* This methods works only with dbCalls
* This method works only with dbCalls.
*
* @return array<string,string>
*/
Expand Down Expand Up @@ -497,7 +497,7 @@ public function getIdValue($data)
* Loops over records in batches, allowing you to operate on them.
* Works with $this->builder to get the Compiled select to
* determine the rows to operate on.
* This methods works only with dbCalls
* This method works only with dbCalls.
*
* @throws DataException
*/
Expand Down