[ ] [ ] [ ]

Packages:
CodeGen

Classes:

CodeGen_Command
CodeGen_Element
CodeGen_Extension
CodeGen_ExtensionParser
CodeGen_License
CodeGen_License_BSD
CodeGen_License_LGPL
CodeGen_License_PHP
CodeGen_Maintainer
CodeGen_Release
CodeGen_Tools_Getopt
CodeGen_Tools_Indent
CodeGen_Tools_Outbuf
CodeGen_Tools_Platform
CodeGen_Tools_Tokenizer
CodeGen_XmlParser

Files:

BSD.php
Code.php
Command.php
Element.php
Extension.php
ExtensionParser.php
Getopt.php
Indent.php
LGPL.php
License.php
Maintainer.php
Outbuf.php
PHP.php
Platform.php
Release.php
Tokenizer.php
XmlParser.php

Class: CodeGen_License

Source Location: /CodeGen-0.9.0rc1/CodeGen/License.php

Class Overview

Abstract base class for licenses

Author(s):

Hartmut Holzgraefe <hartmut at php.net>

Version:

Release: @package_version@

Copyright:

2005 Hartmut Holzgraefe

Methods

Child classes:

CodeGen_License_PHP: The PHP License

CodeGen_License_BSD: The BSD License

CodeGen_License_LGPL: The LGPL License

Inherited Variables

Inherited Methods

Class Details

[line 34]
Abstract base class for licenses

Author: Hartmut Holzgraefe <hartmut@php.net>
Version: Release: @package_version@
Copyright: 2005 Hartmut Holzgraefe
Link: http://pear.php.net/package/CodeGen
Abstract:
License: PHP License 3.0

[ Top ]

Method Detail

factory [line 55]

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

Takes a License shortname and returns an instantiated object of that license

Return: instance
Access: public

Parameters:

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

[ Top ]

getComment [line 97]

string getComment(
)

Returns a string suitable for insertion into comment headers

Return: License comment
Abstract:
Access: public

Overridden in child classes as:

CodeGen_License_PHP::getComment(): License comment to include in code files

CodeGen_License_BSD::getComment(): License comment to include in code files

CodeGen_License_LGPL::getComment(): License comment to include in code files

[ Top ]

getText [line 105]

string getText(
)

Returns the complete license text as string

Return: License text
Abstract:
Access: public

Overridden in child classes as:

CodeGen_License_PHP::getText(): Complete License Text

CodeGen_License_BSD::getText(): Complete License Text

CodeGen_License_LGPL::getText(): Complete License Text

[ Top ]

writeToFile [line 78]

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, 11 Mar 2019 14:16:27 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.