PHP Class Sonata\CustomerBundle\Controller\Api\CustomerController

Author: Hugo Briand ([email protected])
Show file Open project: sonata-project/ecommerce

Protected Properties

Property Type Description
$addressManager Sonata\Component\Customer\AddressManagerInterface
$customerManager Sonata\Component\Customer\CustomerManagerInterface
$formFactory Symfony\Component\Form\FormFactoryInterface
$orderManager Sonata\Component\Order\OrderManagerInterface

Public Methods

Method Description
__construct ( Sonata\Component\Customer\CustomerManagerInterface $customerManager, Sonata\Component\Order\OrderManagerInterface $orderManager, Sonata\Component\Customer\AddressManagerInterface $addressManager, Symfony\Component\Form\FormFactoryInterface $formFactory ) Constructor.
deleteCustomerAction ( integer $id ) : FOS\RestBundle\View\View Deletes a customer.
getCustomerAction ( $id ) : Sonata\Component\Customer\CustomerInterface Retrieves a specific customer.
getCustomerAddressesAction ( $id ) : Sonata\Component\Customer\AddressInterface Retrieves a specific customer's addresses.
getCustomerOrdersAction ( $id ) : Sonata\Component\Order\OrderInterface Retrieves a specific customer's orders.
getCustomersAction ( FOS\RestBundle\Request\ParamFetcherInterface $paramFetcher ) : Sonata\DatagridBundle\Pager\PagerInterface Returns a paginated list of customers.
postCustomerAction ( Request $request ) : Customer Adds a customer.
postCustomerAddressAction ( integer $id, Request $request ) : Address Adds a customer address.
putCustomerAction ( integer $id, Request $request ) : Customer Updates a customer.

Protected Methods

Method Description
getCustomer ( $id ) : Sonata\Component\Customer\CustomerInterface Retrieves customer with id $id or throws an exception if it doesn't exist.
handleWriteCustomer ( Request $request, integer | null $id = null ) : FOS\RestBundle\View\View | FormInterface Write a customer, this method is used by both POST and PUT action methods.

Method Details

__construct() public method

Constructor.
public __construct ( Sonata\Component\Customer\CustomerManagerInterface $customerManager, Sonata\Component\Order\OrderManagerInterface $orderManager, Sonata\Component\Customer\AddressManagerInterface $addressManager, Symfony\Component\Form\FormFactoryInterface $formFactory )
$customerManager Sonata\Component\Customer\CustomerManagerInterface
$orderManager Sonata\Component\Order\OrderManagerInterface
$addressManager Sonata\Component\Customer\AddressManagerInterface
$formFactory Symfony\Component\Form\FormFactoryInterface

deleteCustomerAction() public method

Deletes a customer.
public deleteCustomerAction ( integer $id ) : FOS\RestBundle\View\View
$id integer A Customer identifier
return FOS\RestBundle\View\View

getCustomer() protected method

Retrieves customer with id $id or throws an exception if it doesn't exist.
protected getCustomer ( $id ) : Sonata\Component\Customer\CustomerInterface
$id
return Sonata\Component\Customer\CustomerInterface

getCustomerAction() public method

Retrieves a specific customer.
public getCustomerAction ( $id ) : Sonata\Component\Customer\CustomerInterface
$id
return Sonata\Component\Customer\CustomerInterface

getCustomerAddressesAction() public method

Retrieves a specific customer's addresses.
public getCustomerAddressesAction ( $id ) : Sonata\Component\Customer\AddressInterface
$id
return Sonata\Component\Customer\AddressInterface

getCustomerOrdersAction() public method

Retrieves a specific customer's orders.
public getCustomerOrdersAction ( $id ) : Sonata\Component\Order\OrderInterface
$id
return Sonata\Component\Order\OrderInterface

getCustomersAction() public method

Returns a paginated list of customers.
public getCustomersAction ( FOS\RestBundle\Request\ParamFetcherInterface $paramFetcher ) : Sonata\DatagridBundle\Pager\PagerInterface
$paramFetcher FOS\RestBundle\Request\ParamFetcherInterface
return Sonata\DatagridBundle\Pager\PagerInterface

handleWriteCustomer() protected method

Write a customer, this method is used by both POST and PUT action methods.
protected handleWriteCustomer ( Request $request, integer | null $id = null ) : FOS\RestBundle\View\View | FormInterface
$request Symfony\Component\HttpFoundation\Request Symfony request
$id integer | null A customer identifier
return FOS\RestBundle\View\View | FormInterface

postCustomerAction() public method

Adds a customer.
public postCustomerAction ( Request $request ) : Customer
$request Symfony\Component\HttpFoundation\Request A Symfony request
return Customer

postCustomerAddressAction() public method

Adds a customer address.
public postCustomerAddressAction ( integer $id, Request $request ) : Address
$id integer A Customer identifier
$request Symfony\Component\HttpFoundation\Request A Symfony request
return Address

putCustomerAction() public method

Updates a customer.
public putCustomerAction ( integer $id, Request $request ) : Customer
$id integer A Customer identifier
$request Symfony\Component\HttpFoundation\Request A Symfony request
return Customer

Property Details

$addressManager protected property

protected AddressManagerInterface,Sonata\Component\Customer $addressManager
return Sonata\Component\Customer\AddressManagerInterface

$customerManager protected property

protected CustomerManagerInterface,Sonata\Component\Customer $customerManager
return Sonata\Component\Customer\CustomerManagerInterface

$formFactory protected property

protected FormFactoryInterface,Symfony\Component\Form $formFactory
return Symfony\Component\Form\FormFactoryInterface

$orderManager protected property

protected OrderManagerInterface,Sonata\Component\Order $orderManager
return Sonata\Component\Order\OrderManagerInterface