Spec Help
About
The pearfarm spce file is the interface for making a simple package.xml
See the Php Doc for the spec class for more advanced information
Default Options (required)
->setName('PackageName')
->setChannel('joe.pearfarm.org)
->setSummary('Your short summary')
->setDescription('More detailed information about your package')
->setNotes('Release notes')
Release Options (required)
->setReleaseVersion('1.0.0')
->setReleaseStability('alpha')
Api Options (required)
->setApiVersion('0.1.0')
->setApiStability('alpha')
License Options (required)
MIT is currently the only licenese defined as a constant
if you wish to add another type of license the format is as follows:
array('name' => 'MIT', 'uri' => 'http://www.opensource.org/licenses/mit-license.html')
Other wise just pass the constant
->setLicense(Pearfarm_PackageSpec::LICENSE_MIT)
Maintainer options (required)
Maintainers have 4 types
- lead
- developer
- contributor
- helper
Syntax:
->addMaintainer(<type>, <name>, <username>, <email>)
Repository options
Add all files from a git project
->addGitFiles()
Add all files from an svn project
->addSvnFiles()
Add a bunch of files from file system
Roles are:
- php
- data
- script
- test
Simple:
->addFilesSimple($files, $role= self::ROLE_PHP, $options = array())
Regex:
->addFilesRegex($regexs, $role = self::ROLE_PHP, $options = array())