ApiCommand
Package | pii.commands |
---|---|
Inheritance | class ApiCommand » CConsoleCommand » CComponent |
Since | 2.0 |
Version | $Id$ |
Public Properties
Property | Type | Description | Defined By |
---|---|---|---|
classes | ApiCommand | ||
commandRunner | CConsoleCommandRunner | the command runner instance | CConsoleCommand |
currentClass | ApiCommand | ||
help | ApiCommand | ||
name | string | the command name. | CConsoleCommand |
packages | ApiCommand | ||
pageTitle | ApiCommand | ||
themePath | ApiCommand |
Public Methods
Method | Description | Defined By |
---|---|---|
__call() | Calls the named method which is not a class method. | CComponent |
__construct() | Constructor. | CConsoleCommand |
__get() | Returns a property value, an event handler list or a behavior based on its name. | CComponent |
__isset() | Checks if a property value is null. | CComponent |
__set() | Sets value of a component property. | CComponent |
__unset() | Sets a component property to be null. | CComponent |
asa() | Returns the named behavior object. | CComponent |
attachBehavior() | Attaches a behavior to this component. | CComponent |
attachBehaviors() | Attaches a list of behaviors to the component. | CComponent |
attachEventHandler() | Attaches an event handler to an event. | CComponent |
buildFileList() | Builds the file list of a directory. | CConsoleCommand |
canGetProperty() | Determines whether a property can be read. | CComponent |
canSetProperty() | Determines whether a property can be set. | CComponent |
copyFiles() | Copies a list of files from one place to another. | CConsoleCommand |
detachBehavior() | Detaches a behavior from the component. | CComponent |
detachBehaviors() | Detaches all behaviors from the component. | CComponent |
detachEventHandler() | Detaches an existing event handler. | CComponent |
disableBehavior() | Disables an attached behavior. | CComponent |
disableBehaviors() | Disables all behaviors attached to this component. | CComponent |
enableBehavior() | Enables an attached behavior. | CComponent |
enableBehaviors() | Enables all behaviors attached to this component. | CComponent |
ensureDirectory() | Creates all parent directories if they do not exist. | CConsoleCommand |
getCommandRunner() | CConsoleCommand | |
getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
getHelp() | ApiCommand | |
getName() | CConsoleCommand | |
hasEvent() | Determines whether an event is defined. | CComponent |
hasEventHandler() | Checks whether the named event has attached handlers. | CComponent |
hasProperty() | Determines whether a property is defined. | CComponent |
pluralize() | Converts a word to its plural form. | CConsoleCommand |
raiseEvent() | Raises an event. | CComponent |
render() | ApiCommand | |
renderFile() | Renders a view file. | CConsoleCommand |
renderImplements() | ApiCommand | |
renderInheritance() | ApiCommand | |
renderPartial() | ApiCommand | |
renderPropertySignature() | ApiCommand | |
renderSubclasses() | ApiCommand | |
renderSubjectUrl() | ApiCommand | |
renderTypeUrl() | ApiCommand | |
run() | Execute the action. | ApiCommand |
usageError() | Displays a usage error. | CConsoleCommand |
Protected Methods
Method | Description | Defined By |
---|---|---|
buildKeywords() | ApiCommand | |
buildModel() | ApiCommand | |
buildOfflinePages() | ApiCommand | |
buildOnlinePages() | ApiCommand | |
fixOfflineLink() | ApiCommand | |
fixOnlineLink() | ApiCommand |
Property Details
classes
property
public $classes;
currentClass
property
public $currentClass;
help
property
read-only
public void getHelp()
packages
property
public $packages;
pageTitle
property
public $pageTitle;
themePath
property
public $themePath;
Method Details
buildKeywords()
method
protected void buildKeywords($docPath)
| ||
$docPath |
buildModel()
method
protected void buildModel($sourcePath, $options)
| ||
$sourcePath | ||
$options |
buildOfflinePages()
method
protected void buildOfflinePages($docPath, $themePath)
| ||
$docPath | ||
$themePath |
buildOnlinePages()
method
protected void buildOnlinePages($docPath, $themePath)
| ||
$docPath | ||
$themePath |
fixOfflineLink()
method
protected void fixOfflineLink($matches)
| ||
$matches |
fixOnlineLink()
method
protected void fixOnlineLink($matches)
| ||
$matches |
getHelp()
method
public void getHelp()
|
render()
method
public void render($view, $data=NULL, $return=false, $layout='main')
| ||
$view | ||
$data | ||
$return | ||
$layout |
renderImplements()
method
public void renderImplements($class)
| ||
$class |
renderInheritance()
method
public void renderInheritance($class)
| ||
$class |
renderPartial()
method
public void renderPartial($view, $data=NULL, $return=false)
| ||
$view | ||
$data | ||
$return |
renderPropertySignature()
method
public void renderPropertySignature($property)
| ||
$property |
renderSubclasses()
method
public void renderSubclasses($class)
| ||
$class |
renderSubjectUrl()
method
public void renderSubjectUrl($type, $subject, $text=NULL)
| ||
$type | ||
$subject | ||
$text |
renderTypeUrl()
method
public void renderTypeUrl($type)
| ||
$type |
run()
method
public void run(array $args)
| ||
$args | array | command line parameters specific for this command |
Execute the action.