Basic CRUD Operations
There are four main save methods on Spot’s mapper:
update. There are some basic differences between them, so this page
will address each one.
Build an entity object with the provided array data.
Build will create the Entity object for you, but it will not save it. If you also wish to save the entity object, you must pass it to one of the save methods:
Create will both build and insert the entity. The result will be a fully-loaded entity object that has already been saved.
Expect an Entity… or Else!Unlike
createmethod will throw an exception if a record cannot be inserted. This is because since it only accepts a data array, a boolean false on failure would not allow the user to see any validation errors if present. So instead, the
createmethod will always return either a successfully inserted Entity object, or will throw an exception. This makes the
createmethod a great choice for database seed files and other setup scripts.
insert method will create a new row in the database with the provided
data (either an array of data, or a
Spot\Entity object), and will return
either the inserted record’s primary key, or boolean false.
Using a data array is perhaps the easiest way to use
You can also pass a
Spot\Entity object to
save method is a convenience method that handles both inserting and
updating an entity object. Save will call either
depending on whether the Entity has already been saved (it will check
update method will update an existing entity.
Currently, Spot does not automatically save any related entities on save. For
instance, if you have a
Book entity that hasOne
Author, and you make edits
to the author object, you must save the author object itself directly with the
author’s mapper. Saving the book object will not automatically detect and save
changes on any related objects, even if the related objects are already loaded.