PHP Класс Sonata\CustomerBundle\Controller\Api\AddressController

Автор: Vincent Composieux ([email protected])
Показать файл Открыть проект

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

Свойство Тип Описание
$addressManager Sonata\Component\Customer\AddressManagerInterface
$formFactory Symfony\Component\Form\FormFactoryInterface

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

Метод Описание
__construct ( Sonata\Component\Customer\AddressManagerInterface $addressManager, Symfony\Component\Form\FormFactoryInterface $formFactory ) Constructor.
deleteAddressAction ( integer $id ) : FOS\RestBundle\View\View Deletes an address.
getAddressAction ( $id ) : Sonata\Component\Customer\AddressInterface Retrieves a specific address.
getAddressesAction ( FOS\RestBundle\Request\ParamFetcherInterface $paramFetcher ) : Sonata\DatagridBundle\Pager\PagerInterface Returns a paginated list of addresses.
postAddressAction ( Request $request ) : Sonata\Component\Customer\AddressInterface Adds an address.
putAddressAction ( integer $id, Request $request ) : Address Updates an address.

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

Метод Описание
getAddress ( integer $id ) : Sonata\Component\Customer\AddressInterface Retrieves address with id $id or throws an exception if it doesn't exist.
handleWriteAddress ( Request $request, integer | null $id = null ) : FOS\RestBundle\View\View | FormInterface Write an address, this method is used by both POST and PUT action methods.

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

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

Constructor.
public __construct ( Sonata\Component\Customer\AddressManagerInterface $addressManager, Symfony\Component\Form\FormFactoryInterface $formFactory )
$addressManager Sonata\Component\Customer\AddressManagerInterface
$formFactory Symfony\Component\Form\FormFactoryInterface

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

Deletes an address.
public deleteAddressAction ( integer $id ) : FOS\RestBundle\View\View
$id integer An Address identifier
Результат FOS\RestBundle\View\View

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

Retrieves address with id $id or throws an exception if it doesn't exist.
protected getAddress ( integer $id ) : Sonata\Component\Customer\AddressInterface
$id integer
Результат Sonata\Component\Customer\AddressInterface

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

Retrieves a specific address.
public getAddressAction ( $id ) : Sonata\Component\Customer\AddressInterface
$id
Результат Sonata\Component\Customer\AddressInterface

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

Returns a paginated list of addresses.
public getAddressesAction ( FOS\RestBundle\Request\ParamFetcherInterface $paramFetcher ) : Sonata\DatagridBundle\Pager\PagerInterface
$paramFetcher FOS\RestBundle\Request\ParamFetcherInterface
Результат Sonata\DatagridBundle\Pager\PagerInterface

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

Write an address, this method is used by both POST and PUT action methods.
protected handleWriteAddress ( Request $request, integer | null $id = null ) : FOS\RestBundle\View\View | FormInterface
$request Symfony\Component\HttpFoundation\Request Symfony request
$id integer | null An Address identifier
Результат FOS\RestBundle\View\View | FormInterface

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

Adds an address.
public postAddressAction ( Request $request ) : Sonata\Component\Customer\AddressInterface
$request Symfony\Component\HttpFoundation\Request A Symfony request
Результат Sonata\Component\Customer\AddressInterface

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

Updates an address.
public putAddressAction ( integer $id, Request $request ) : Address
$id integer An Address identifier
$request Symfony\Component\HttpFoundation\Request A Symfony request
Результат Address

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

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

protected AddressManagerInterface,Sonata\Component\Customer $addressManager
Результат Sonata\Component\Customer\AddressManagerInterface

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

protected FormFactoryInterface,Symfony\Component\Form $formFactory
Результат Symfony\Component\Form\FormFactoryInterface