Метод getKey

Метод getKey применяется к экземпляру модели Eloquent и возвращает значение её первичного ключа. Этот метод удобен, когда нужно получить идентификатор модели без обращения к атрибуту напрямую. Метод автоматически определяет имя первичного ключа из свойства primaryKey модели и возвращает его значение для текущей модели.

Синтаксис

<?php
	$model->getKey();
?>

Пример

Получим значение первичного ключа для модели статьи:

<?php
	namespace App\Http\Controllers;

	use App\Models\Article;

	class ArticleController extends Controller
	{
		public function index()
		{
			$article = Article::find(5);
			$key = $article->getKey();

			echo $key;
		}
	}
?>

Результат выполнения кода:

"5"

Пример

Получим первичный ключ для модели пользователя, созданной без сохранения в базу данных:

<?php
	namespace App\Http\Controllers;

	use App\Models\User;

	class UserController extends Controller
	{
		public function index()
		{
			$user = new User();
			$user->name = 'John Doe';
			$user->email = 'john@example.com';

			$key = $user->getKey();

			echo $key;
		}
	}
?>

Результат выполнения кода:

"null"

Пример

Получим первичный ключ модели после сохранения в базе данных:

<?php
	namespace App\Http\Controllers;

	use App\Models\User;

	class UserController extends Controller
	{
		public function index()
		{
			$user = new User();
			$user->name = 'Jane Doe';
			$user->email = 'jane@example.com';
			$user->save();

			$key = $user->getKey();

			echo $key;
		}
	}
?>

Результат выполнения кода:

"10"

Смотрите также

метод getAttribute,
который возвращает значение любого атрибута модели
метод getOriginal,
который возвращает исходное значение атрибута
метод getDirty,
который возвращает изменённые атрибуты модели
метод find,
который находит модель по первичному ключу