PHP Class Ptondereau\PackMe\Package

Show file Open project: ptondereau/laravel-packme Class Usage Examples

Protected Properties

Property Type Description
$author string Full author string. (e.g: John Smith ).
$authorName string Author's full name.
$description string Package's description.
$destination string Path destination for all generated files.
$email string Author's email.
$name string Full name of package. (e.g: vendor/package).
$package string Package name (e.g: YourPackage).
$validator Ptondereau\PackMe\Validators\Validator Validator for the package.
$vendor string Vendor name (e.g: YourVendor).

Public Methods

Method Description
__construct ( null | string $name = null, null | string $author = null, null | string $destination = null, Validator $validator = null ) Package constructor.
getAuthor ( ) : string
getAuthorName ( ) : string
getDescription ( ) : string
getDestination ( ) : string
getEmail ( ) : string
getName ( ) : string
getPackage ( ) : string
getVendor ( ) : string
setAuthor ( string $author )
setAuthorName ( string $authorName )
setDescription ( string $description )
setDestination ( string $destination )
setEmail ( string $email )
setName ( string $name )
setPackage ( string $package )
setVendor ( string $vendor )
toArray ( ) : array Return keywords list.

Protected Methods

Method Description
parseAuthor ( $string )

Method Details

__construct() public method

Package constructor.
public __construct ( null | string $name = null, null | string $author = null, null | string $destination = null, Validator $validator = null )
$name null | string
$author null | string
$destination null | string
$validator Ptondereau\PackMe\Validators\Validator

getAuthor() public method

public getAuthor ( ) : string
return string

getAuthorName() public method

public getAuthorName ( ) : string
return string

getDescription() public method

public getDescription ( ) : string
return string

getDestination() public method

public getDestination ( ) : string
return string

getEmail() public method

public getEmail ( ) : string
return string

getName() public method

public getName ( ) : string
return string

getPackage() public method

public getPackage ( ) : string
return string

getVendor() public method

public getVendor ( ) : string
return string

parseAuthor() protected method

protected parseAuthor ( $string )
$string

setAuthor() public method

public setAuthor ( string $author )
$author string

setAuthorName() public method

public setAuthorName ( string $authorName )
$authorName string

setDescription() public method

public setDescription ( string $description )
$description string

setDestination() public method

public setDestination ( string $destination )
$destination string

setEmail() public method

public setEmail ( string $email )
$email string

setName() public method

public setName ( string $name )
$name string

setPackage() public method

public setPackage ( string $package )
$package string

setVendor() public method

public setVendor ( string $vendor )
$vendor string

toArray() public method

Return keywords list.
public toArray ( ) : array
return array

Property Details

$author protected property

Full author string. (e.g: John Smith ).
protected string $author
return string

$authorName protected property

Author's full name.
protected string $authorName
return string

$description protected property

Package's description.
protected string $description
return string

$destination protected property

Path destination for all generated files.
protected string $destination
return string

$email protected property

Author's email.
protected string $email
return string

$name protected property

Full name of package. (e.g: vendor/package).
protected string $name
return string

$package protected property

Package name (e.g: YourPackage).
protected string $package
return string

$validator protected property

Validator for the package.
protected Validator,Ptondereau\PackMe\Validators $validator
return Ptondereau\PackMe\Validators\Validator

$vendor protected property

Vendor name (e.g: YourVendor).
protected string $vendor
return string