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

Class: CodeGen_License

Source Location: /CodeGen-1.0.7/CodeGen/License.php

Class Overview


Abstract base class for licenses


Author(s):

Version:

  • Release: @package_version@

Copyright:

  • 2005-2008 Hartmut Holzgraefe

Methods


Child classes:

CodeGen_License_LGPL
The LGPL License
CodeGen_License_PHP
The PHP License
CodeGen_License_BSD
The BSD License
CodeGen_License_GPL3
The GPL License
CodeGen_License_GPL2
The GPL License
CodeGen_License_LGPL21
The LGPL License

Inherited Variables

Inherited Methods


Class Details

[line 38]
Abstract base class for licenses


[ Top ]


Method Detail

factory   [line 59]

object License factory( string $name, [array $options = array()])

Takes a License shortname and returns an instantiated object of that license
  • Return: instance or PEAR error object
  • Access: public

Parameters:

string   $name     License shortname, e.g. PHP, BSD, LGPL
array   $options     License options

[ Top ]

getName   [line 97]

string getName( )

Returns the full license name
  • Return: License name
  • Abstract:
  • Access: public

Overridden in child classes as:

CodeGen_License_LGPL::getName()
Get full name
CodeGen_License_PHP::getName()
Get full name
CodeGen_License_BSD::getName()
Get full name
CodeGen_License_GPL3::getName()
Get full name
CodeGen_License_GPL2::getName()
Get full name
CodeGen_License_LGPL21::getName()
Get full name

[ Top ]

getShortName   [line 105]

string getShortName( )

Returns the sort license name
  • Return: License shortname
  • Abstract:
  • Access: public

Overridden in child classes as:

CodeGen_License_LGPL::getShortName()
Get short name
CodeGen_License_PHP::getShortName()
Get short name
CodeGen_License_BSD::getShortName()
Get short name
CodeGen_License_GPL3::getShortName()
Get short name
CodeGen_License_GPL2::getShortName()
Get short name
CodeGen_License_LGPL21::getShortName()
Get short name

[ Top ]

getText   [line 113]

string getText( )

Returns the complete license text as string
  • Return: License text
  • Abstract:
  • Access: public

Overridden in child classes as:

CodeGen_License_LGPL::getText()
Complete License Text
CodeGen_License_PHP::getText()
Complete License Text
CodeGen_License_BSD::getText()
Complete License Text
CodeGen_License_GPL3::getText()
Complete License Text
CodeGen_License_GPL2::getText()
Complete License Text
CodeGen_License_LGPL21::getText()
Complete License Text

[ Top ]

getUri   [line 121]

string getUri( )

Returns an URI that points to the license text or an online description
  • Return: License URI
  • Access: public

[ Top ]

writeToFile   [line 82]

bool writeToFile( [string $path = "./LICENSE"])

Writes the License text to a file
  • Return: Success state
  • Access: public

Parameters:

string   $path     Filename to write to (default is ./LICENSE)

[ Top ]


Documentation generated on Mon, 27 Sep 2010 12:00:07 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.