Recycling

Recycling referes to the temporary deletion and subsequent restoration of objects in the package. All objects in the package are recyclable. Recycled objects may also be permanently destroyed, but this action does not no remove them from the database but instead only marks them as having been destroyed.

Attributes

• user_id: The id of the user associated with the recycledObject. Defaults to the id of the logged in user.
• recyclable_id: The id of the object that has been recycled.
• recyclable_type: The type the object that has been recycled.
• entity_id: The Id of the entity associated with the recycledObject. Defaults to the id of entity of the logged in user.

Relations

• $recycled->entity: The entity associated with the recycledObject.
• $recycled->recyclable: The the object that has been recycled.
• $recycled->user: The user associated with the recycledObject.

Methods

• $recycled->attributes(): Presents the recycledObject’s attributes as an object. Useful for debugging.

Usage

This class is not intended to be used directly, it is hooked into Eloquents events system specifically the deleting and restoring events. To recycle an object, simply call delete on it as you would any Eloquent model.

$user = User::create(["email"=>"test@example.com","password"=>"testpassword"]);

$user->delete();

This marks the object as deleted, making the object unavailable vie regular querying functions. It may however be retrieved using the Eloquent withTrashed() function. It also creates a RecycledObjectinstance in the database to record the action.

$user = User::withTrashed()->where("id",$user_id)->first();

You can then inspect details of all the recycling actions such as the time they happened and the users responsible by calling the recycled() method on the object, which returns a collection of RecycledObject belonging to the object.

$user->recycled(); // Eloquent Collection

Restoring the item with the restore() function deletes the RecycledObject.

$user->restore();

Calling forceDelete() function on an object marks it as destroyed, which means that whereas the object is still visible by using withTrashed() it cannot be restored.

$user->forceDelete();