PHP Class Mpociot\ApiDoc\Parsers\RuleDescriptionParser

Show file Open project: mpociot/laravel-apidoc-generator Class Usage Examples

Public Methods

Method	Description
__construct ( null $rule = null )
getDescription ( ) : array \| string
parse ( null $rule = null ) : static
with ( string \| array $parameters )

Protected Methods

Method	Description
makeDescription ( ) : string
replaceAttributes ( $description ) : string
ruleDescriptionExist ( ) : boolean

Method Details

__construct() public method

public __construct ( null $rule = null )
$rule	null

getDescription() public method

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

makeDescription() protected method

protected makeDescription ( ) : string
return	string

parse() public static method

public static parse ( null $rule = null ) : static
$rule	null
return	static

replaceAttributes() protected method

protected replaceAttributes ( $description ) : string
return	string

ruleDescriptionExist() protected method

protected ruleDescriptionExist ( ) : boolean
return	boolean

with() public method

public with ( string \| array $parameters )
$parameters	string \| array