PHP_DocBlockGenerator
[ class tree: PHP_DocBlockGenerator ] [ index: PHP_DocBlockGenerator ] [ all elements ]

Class: PHP_DocBlockGenerator_License

Source Location: /PHP_DocBlockGenerator-1.1.2/PHP/DocBlockGenerator/License.php

Class Overview


License repository: license full name, text template and URL.


Author(s):

Version:

  • Release: @package_version@

Copyright:

  • 2007 Michel Corne

Methods


Inherited Variables

Inherited Methods


Class Details

[line 51]
License repository: license full name, text template and URL.


[ Top ]


Method Detail

__construct (Constructor)   [line 93]

void __construct( )

The class constructor
  • Access: public

[ Top ]

getFullName   [line 118]

string getFullName( string $name)

Gets the license full name
  • Return: the license full name or null if invalid
  • Access: public

Parameters:

string   $name   —  the license name: apache20 | bsd | lgpl21 | mit | php301

[ Top ]

getText   [line 130]

string getText( string $name)

Gets the license text
  • Return: the license text or null if invalid
  • Access: public

Parameters:

string   $name   —  the license name: apache20 | bsd | lgpl21 | mit | php301

[ Top ]

getURL   [line 142]

string getURL( string $name)

Gets the license URL
  • Return: the license URL or null if invalid
  • Access: public

Parameters:

string   $name   —  the license name: apache20 | bsd | lgpl21 | mit | php301

[ Top ]

isValid   [line 154]

boolean isValid( string $name)

Verifies the license template is valid
  • Return: true if the license is valid, false otherwise
  • Access: public

Parameters:

string   $name   —  the license name: apache20 | bsd | lgpl21 | mit | php301

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:46:45 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.