Item
class Item extends NonSequentialIdModel (View source)
Traits
Properties
| bool | $timestamps | Indicates if the model should be timestamped. | from Model |
| bool | $incrementing | Indicates if the IDs are auto-incrementing. | from NonSequentialIdModel |
Methods
Mustard uses camel case for class properties, and snake case for database columns.
Get a relationship. We override this method from the parent to add a camel_case() conversion for the key.
Mustard uses camel case for class properties, and snake case for database columns.
Return UNIX timestamp for item's end.
Return the time difference between now and the end of the item.
Return the time difference between now and the start of the item.
Return the time difference between 0 and the end of the duration.
Return the highest bid amount placed.
Return the primary photo.
Return the item's bid history.
Return true if item can be collected by the buyer.
Return true if user has bid on the item.
Return true if user has won the item.
Return true if user has ever purchased the item.
Return true if the item is still active.
Return true if the item has started.
Return true if the item has ended.
Return true if the item is has not reached a reserve price.
Return true if the item has a fixed price.
Return true if the item has a quantity.
Return true if the item has a reserve price.
Return true if the item has bids.
Shortcut method for placing a bid.
End an item, marking a winning bid.
Withdraw an item without marking a winning bid.
Search the name and description of items for specific keywords.
Scope of active items.
Scope of ended items.
Scope of scheduled items.
Scope of auction items.
Scope of fixed-price items.
Scope of fixed-price items.
Relationship to bids.
Relationship to categories.
Relationship to an item condition.
Relationship to delivery options.
Relationship to photos.
Relationship to purchases.
Relationship to the user selling the item.
Relationship to the users watching the item.
Relationship to the winning bid.
Return the total number of items.
Return the total number of watched items.
Details
in
Model at line 45
mixed
__get(
string $property)
Mustard uses camel case for class properties, and snake case for database columns.
in
Model at line 54
getRelationValue($key)
Get a relationship. We override this method from the parent to add a camel_case() conversion for the key.
in
Model at line 79
__set(
string $property,
mixed $value)
Mustard uses camel case for class properties, and snake case for database columns.
in
Model at line 84
getUrlAttribute()
in
Model at line 89
getSlugAttribute()
at line 47
int
getEndDate()
Return UNIX timestamp for item's end.
at line 57
DateInterval
getTimeLeft()
Return the time difference between now and the end of the item.
at line 67
DateInterval
getStartingIn()
Return the time difference between now and the start of the item.
at line 77
DateInterval
getDuration()
Return the time difference between 0 and the end of the duration.
at line 87
float
getHighestBidAmount()
Return the highest bid amount placed.
at line 99
Photo
getListingPhoto()
Return the primary photo.
at line 111
Collection
getBidHistory()
Return the item's bid history.
at line 124
bool
isCollectable()
Return true if item can be collected by the buyer.
at line 136
bool
isBidder(
User $user)
Return true if user has bid on the item.
at line 150
bool
isWinner(
User $user)
Return true if user has won the item.
at line 166
bool
isBuyer(
User $user)
Return true if user has ever purchased the item.
at line 178
bool
isActive()
Return true if the item is still active.
at line 188
bool
isStarted()
Return true if the item has started.
at line 198
bool
isEnded()
Return true if the item has ended.
at line 208
bool
isReserved()
Return true if the item is has not reached a reserve price.
at line 218
bool
hasFixed()
Return true if the item has a fixed price.
at line 228
bool
hasQuantity()
Return true if the item has a quantity.
at line 238
bool
hasReserve()
Return true if the item has a reserve price.
at line 248
bool
hasBids()
Return true if the item has bids.
at line 261
void
placeBid(
float $amount,
User $user)
Shortcut method for placing a bid.
at line 278
void
end()
End an item, marking a winning bid.
at line 304
void
withdraw()
Withdraw an item without marking a winning bid.
at line 325
Builder
scopeKeywords(
Builder $query,
string $keyword)
Search the name and description of items for specific keywords.
at line 340
Builder
scopeActive(
Builder $query)
Scope of active items.
at line 353
Builder
scopeEnded(
Builder $query)
Scope of ended items.
at line 365
Builder
scopeScheduled(
Builder $query)
Scope of scheduled items.
at line 377
Builder
scopeTypeAuction(
Builder $query)
Scope of auction items.
at line 389
Builder
scopeTypeFixed(
Builder $query)
Scope of fixed-price items.
at line 400
Builder
scopeWinning(
Builder $query)
Scope of fixed-price items.
at line 410
HasMany
bids()
Relationship to bids.
at line 420
BelongsToMany
categories()
Relationship to categories.
at line 430
BelongsTo
condition()
Relationship to an item condition.
at line 440
HasMany
deliveryOptions()
Relationship to delivery options.
at line 450
HasMany
photos()
Relationship to photos.
at line 460
HasMany
purchases()
Relationship to purchases.
at line 470
BelongsTo
seller()
Relationship to the user selling the item.
at line 480
BelongsToMany
watchers()
Relationship to the users watching the item.
at line 490
BelongsTo
winningBid()
Relationship to the winning bid.
at line 503
static
int
totalListed(
int $since,
int $until = null)
Return the total number of items.
at line 520
static
int
totalWatched(
int $since,
int $until = null)
Return the total number of watched items.