PHP Class Dingo\Blueprint\Action

Inheritance: extends Section

Datei anzeigen Open project: dingo/blueprint

Protected Properties

Property	Type	Description
$annotations	Illuminate\Support\Collection	Annotations belonging to the action.
$reflector	ReflectionMethod	Action reflector instance.
$resource	Resource	Parent resource of the action.

Public Methods

Method	Description
__construct ( ReflectionMethod $reflector, Collection $annotations ) : void	Create a new action instance.
getDefinition ( ) : string	Get the actions definition.
getDescription ( ) : string \| null	Get the actions description.
getIdentifier ( ) : string \| null	Get the actions identifier.
getMethod ( ) : string	Get the actions method.
getRequest ( ) : Dingo\Blueprint\Annotation\Request \| null	Get the actions request annotation.
getResponse ( ) : Dingo\Blueprint\Annotation\Response \| null	Get the actions response annotation.
getTransaction ( ) : Dingo\Blueprint\Annotation\Transaction \| null	Get the actions transaction annotation.
getUri ( ) : string	Get the actions URI.
getVersions ( ) : Dingo\Blueprint\Annotation\Versions \| null	Get the actions version annotation.
setResource ( Resource $resource ) : void	Set the parent resource on the action.

Method Details

__construct() public method

Create a new action instance.

public __construct ( ReflectionMethod $reflector, Collection $annotations ) : void
$reflector	ReflectionMethod
$annotations	Illuminate\Support\Collection
return	void

getDefinition() public method

Get the actions definition.

public getDefinition ( ) : string
return	string

getDescription() public method

Get the actions description.

public getDescription ( ) : string \| null
return	string \| null

getIdentifier() public method

Get the actions identifier.

public getIdentifier ( ) : string \| null
return	string \| null

getMethod() public method

Get the actions method.

public getMethod ( ) : string
return	string

getRequest() public method

Get the actions request annotation.

public getRequest ( ) : Dingo\Blueprint\Annotation\Request \| null
return	Dingo\Blueprint\Annotation\Request \| null

getResponse() public method

Get the actions response annotation.

public getResponse ( ) : Dingo\Blueprint\Annotation\Response \| null
return	Dingo\Blueprint\Annotation\Response \| null

getTransaction() public method

Get the actions transaction annotation.

public getTransaction ( ) : Dingo\Blueprint\Annotation\Transaction \| null
return	Dingo\Blueprint\Annotation\Transaction \| null

getUri() public method

Get the actions URI.

public getUri ( ) : string
return	string

getVersions() public method

Get the actions version annotation.

public getVersions ( ) : Dingo\Blueprint\Annotation\Versions \| null
return	Dingo\Blueprint\Annotation\Versions \| null

setResource() public method

Set the parent resource on the action.

public setResource ( Resource $resource ) : void
$resource	Resource
return	void

Property Details

$annotations protected_oe property

Annotations belonging to the action.

protected Collection,Illuminate\Support $annotations
return	Illuminate\Support\Collection

$reflector protected_oe property

Action reflector instance.

protected ReflectionMethod $reflector
return	ReflectionMethod

$resource protected_oe property

Parent resource of the action.

protected Resource,Dingo\Blueprint $resource
return	Resource