PHP Класс Overtrue\LaravelShoppingCart\Cart

Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$event Illuminate\Contracts\Events\Dispatcher Event dispatcher.
$model string Associated model name.
$name string Current cart name.
$session Illuminate\Session\SessionManager Session manager.

Открытые методы

Метод Описание
__construct ( Illuminate\Session\SessionManager $session, Illuminate\Contracts\Events\Dispatcher $event ) Constructor.
add ( integer | string $id, string $name = null, integer $qty = null, float $price = null, array $attributes = [] ) : string Add a row to the cart.
all ( ) : Collection Get all items.
associate ( string $model ) : Cart Associated model.
clean ( ) : boolean Alias of destory().
count ( boolean $totalItems = true ) : integer Get the number of items in the cart.
countRows ( ) : integer Get rows count.
destroy ( ) : boolean Clean the cart.
get ( string $rawId ) : Item Get a row of the cart by its ID.
getModel ( ) : string Get current associated model.
getName ( ) : string Get current cart name.
isEmpty ( ) : boolean Return whether the shopping cart is empty.
name ( string $name ) : Cart Set the current cart name.
remove ( string $rawId ) : boolean Remove a row from the cart.
search ( array $search ) : array Search if the cart has a item.
total ( ) : float Get the price total.
totalPrice ( ) Return total price of cart.
update ( string $rawId, integer | array $attribute ) : Item | boolean Update the quantity of one row of the cart.

Защищенные методы

Метод Описание
addRow ( string $id, string $name, integer $qty, float $price, array $attributes = [] ) : string Add row to the cart.
generateRawId ( string $id, array $attributes ) : string Generate a unique id for the new row.
getCart ( ) : Collection Get the carts content.
insertRow ( string $rawId, string $id, string $name, integer $qty, float $price, array $attributes = [] ) : Item Create a new row Object.
makeRow ( string $rawId, mixed $id, string $name, integer $qty, float $price, array $attributes = [] ) : Item Make a row item.
save ( Collection | null $cart ) : Collection Sync the cart to session.
updateAttribute ( string $rawId, array $attributes ) : Item Update an attribute of the row.
updateQty ( string $rawId, integer $qty ) : Item | boolean Update the quantity of a row.
updateRow ( string $rawId, array $attributes ) : Item Update a row if the rawId already exists.

Описание методов

__construct() публичный Метод

Constructor.
public __construct ( Illuminate\Session\SessionManager $session, Illuminate\Contracts\Events\Dispatcher $event )
$session Illuminate\Session\SessionManager Session class name
$event Illuminate\Contracts\Events\Dispatcher Event class name

add() публичный Метод

Add a row to the cart.
public add ( integer | string $id, string $name = null, integer $qty = null, float $price = null, array $attributes = [] ) : string
$id integer | string Unique ID of the item
$name string Name of the item
$qty integer Item qty to add to the cart
$price float Price of one item
$attributes array Array of additional attributes, such as 'size' or 'color'...
Результат string

addRow() защищенный Метод

Add row to the cart.
protected addRow ( string $id, string $name, integer $qty, float $price, array $attributes = [] ) : string
$id string Unique ID of the item
$name string Name of the item
$qty integer Item qty to add to the cart
$price float Price of one item
$attributes array Array of additional options, such as 'size' or 'color'
Результат string

all() публичный Метод

Get all items.
public all ( ) : Collection
Результат Illuminate\Support\Collection

associate() публичный Метод

Associated model.
public associate ( string $model ) : Cart
$model string The name of the model
Результат Cart

clean() публичный Метод

Alias of destory().
public clean ( ) : boolean
Результат boolean

count() публичный Метод

Get the number of items in the cart.
public count ( boolean $totalItems = true ) : integer
$totalItems boolean Get all the items (when false, will return the number of rows)
Результат integer

countRows() публичный Метод

Get rows count.
public countRows ( ) : integer
Результат integer

destroy() публичный Метод

Clean the cart.
public destroy ( ) : boolean
Результат boolean

generateRawId() защищенный Метод

Generate a unique id for the new row.
protected generateRawId ( string $id, array $attributes ) : string
$id string Unique ID of the item
$attributes array Array of additional options, such as 'size' or 'color'
Результат string

get() публичный Метод

Get a row of the cart by its ID.
public get ( string $rawId ) : Item
$rawId string The ID of the row to fetch
Результат Item

getCart() защищенный Метод

Get the carts content.
protected getCart ( ) : Collection
Результат Illuminate\Support\Collection

getModel() публичный Метод

Get current associated model.
public getModel ( ) : string
Результат string

getName() публичный Метод

Get current cart name.
public getName ( ) : string
Результат string

insertRow() защищенный Метод

Create a new row Object.
protected insertRow ( string $rawId, string $id, string $name, integer $qty, float $price, array $attributes = [] ) : Item
$rawId string The ID of the new row
$id string Unique ID of the item
$name string Name of the item
$qty integer Item qty to add to the cart
$price float Price of one item
$attributes array Array of additional options, such as 'size' or 'color'
Результат Item

isEmpty() публичный Метод

Return whether the shopping cart is empty.
public isEmpty ( ) : boolean
Результат boolean

makeRow() защищенный Метод

Make a row item.
protected makeRow ( string $rawId, mixed $id, string $name, integer $qty, float $price, array $attributes = [] ) : Item
$rawId string Raw id.
$id mixed Item id.
$name string Item name.
$qty integer Quantity.
$price float Price.
$attributes array Other attributes.
Результат Item

name() публичный Метод

Set the current cart name.
public name ( string $name ) : Cart
$name string Cart name name
Результат Cart

remove() публичный Метод

Remove a row from the cart.
public remove ( string $rawId ) : boolean
$rawId string The __raw_id of the item
Результат boolean

save() защищенный Метод

Sync the cart to session.
protected save ( Collection | null $cart ) : Collection
$cart Illuminate\Support\Collection | null The new cart content
Результат Illuminate\Support\Collection

total() публичный Метод

Get the price total.
public total ( ) : float
Результат float

totalPrice() публичный Метод

Return total price of cart.
public totalPrice ( )

update() публичный Метод

Update the quantity of one row of the cart.
public update ( string $rawId, integer | array $attribute ) : Item | boolean
$rawId string The __raw_id of the item you want to update
$attribute integer | array New quantity of the item|Array of attributes to update
Результат Item | boolean

updateAttribute() защищенный Метод

Update an attribute of the row.
protected updateAttribute ( string $rawId, array $attributes ) : Item
$rawId string The ID of the row
$attributes array An array of attributes to update
Результат Item

updateQty() защищенный Метод

Update the quantity of a row.
protected updateQty ( string $rawId, integer $qty ) : Item | boolean
$rawId string The ID of the row
$qty integer The qty to add
Результат Item | boolean

updateRow() защищенный Метод

Update a row if the rawId already exists.
protected updateRow ( string $rawId, array $attributes ) : Item
$rawId string The ID of the row to update
$attributes array The quantity to add to the row
Результат Item

Описание свойств

$event защищенное свойство

Event dispatcher.
protected Dispatcher,Illuminate\Contracts\Events $event
Результат Illuminate\Contracts\Events\Dispatcher

$model защищенное свойство

Associated model name.
protected string $model
Результат string

$name защищенное свойство

Current cart name.
protected string $name
Результат string

$session защищенное свойство

Session manager.
protected SessionManager,Illuminate\Session $session
Результат Illuminate\Session\SessionManager