/**
* setRegistry()
*
* @param Zend_Tool_Framework_Registry_Interface $registry
* @return Zend_Tool_Framework_Client_Console_ArgumentParser
*/
public function setRegistry(Zend_Tool_Framework_Registry_Interface $registry)
{
// get the client registry
$this->_registry = $registry;
// set manifest repository, request, response for easy access
$this->_manifestRepository = $this->_registry->getManifestRepository();
$this->_request = $this->_registry->getRequest();
$this->_response = $this->_registry->getResponse();
return $this;
}
/**
* undocumented function
*
* @return void
* @author Alistair Stead
**/
protected function _bootstrap()
{
//load Magento
$mageFilename = 'app/Mage.php';
$this->_isInstalled($mageFilename);
require_once $mageFilename;
Mage::setIsDeveloperMode(true);
Mage::app();
// get request/response object
$this->_request = $this->_registry->getRequest();
$this->_response = $this->_registry->getResponse();
}
public function loadProviders(Zend_Tool_Framework_Registry_Interface $registry)
{
if (file_exists($this->getPath())) {
$providerRepository = $registry->getProviderRepository();
foreach (new DirectoryIterator($this->getPath()) as $item) {
if ($item->isFile() && ($suffixStart = strpos($item->getFilename(), 'Provider.php')) !== false) {
$className = substr($item->getFilename(), 0, $suffixStart + 8);
// $loadableFiles[$className] = $item->getPathname();
include_once $item->getPathname();
$providerRepository->addProvider(new $className());
}
}
}
}
/**
* getMetadata() is required by the Manifest Interface.
*
* These are the following metadatas that will be setup:
*
* normalizedActionName
* - metadata for actions
* - value will be a dashed name for the action named in 'actionName'
* normalizedProviderName
* - metadata for providers
* - value will be a dashed-name for the provider named in 'providerName'
* normalizedProviderSpecialtyNames
* - metadata for providers
* normalizedActionableMethodLongParameters
* - metadata for providers
* normalizedActionableMethodShortParameters
* - metadata for providers
*
* @return array Array of Metadatas
*/
public function getMetadata()
{
$metadatas = array();
// setup the camelCase to dashed filter to use since cli expects dashed named
$lowerFilter = new Zend_Filter();
$lowerFilter->addFilter(new Zend_Filter_StringToLower());
// get the registry to get the action and provider repository
$actionRepository = $this->_registry->getActionRepository();
$providerRepository = $this->_registry->getProviderRepository();
// loop through all actions and create a metadata for each
foreach ($actionRepository->getActions() as $action) {
// each action metadata will be called
$metadatas[] = new Zend_Tool_Framework_Metadata_Tool(array('name' => 'normalizedActionName', 'value' => $lowerFilter->filter($action->getName()), 'reference' => $action, 'actionName' => $action->getName(), 'clientName' => 'all'));
}
foreach ($providerRepository->getProviderSignatures() as $providerSignature) {
// create the metadata for the provider's cliProviderName
$metadatas[] = new Zend_Tool_Framework_Metadata_Tool(array('name' => 'normalizedProviderName', 'value' => $lowerFilter->filter($providerSignature->getName()), 'reference' => $providerSignature, 'clientName' => 'all', 'providerName' => $providerSignature->getName()));
// create the metadatas for the per provider specialites in providerSpecaltyNames
foreach ($providerSignature->getSpecialties() as $specialty) {
if ($specialty == '_Global') {
continue;
}
$metadatas[] = new Zend_Tool_Framework_Metadata_Tool(array('name' => 'normalizedSpecialtyName', 'value' => $lowerFilter->filter($specialty), 'reference' => $providerSignature, 'clientName' => 'all', 'providerName' => $providerSignature->getName(), 'specialtyName' => $specialty));
}
// $actionableMethod is keyed by the methodName (but not used)
foreach ($providerSignature->getActionableMethods() as $actionableMethodData) {
$methodLongParams = array();
$methodShortParams = array();
// $actionableMethodData get both the long and short names
foreach ($actionableMethodData['parameterInfo'] as $parameterInfoData) {
// filter to dashed
$methodLongParams[$parameterInfoData['name']] = $lowerFilter->filter($parameterInfoData['name']);
// simply lower the character, (its only 1 char after all)
$methodShortParams[$parameterInfoData['name']] = strtolower($parameterInfoData['name'][0]);
}
// create metadata for the long name cliActionableMethodLongParameters
$metadatas[] = new Zend_Tool_Framework_Metadata_Tool(array('name' => 'normalizedActionableMethodLongParams', 'value' => $methodLongParams, 'clientName' => 'console', 'providerName' => $providerSignature->getName(), 'specialtyName' => $actionableMethodData['specialty'], 'actionName' => $actionableMethodData['actionName'], 'reference' => &$actionableMethodData));
// create metadata for the short name cliActionableMethodShortParameters
$metadatas[] = new Zend_Tool_Framework_Metadata_Tool(array('name' => 'normalizedActionableMethodShortParams', 'value' => $methodShortParams, 'clientName' => 'console', 'providerName' => $providerSignature->getName(), 'specialtyName' => $actionableMethodData['specialty'], 'actionName' => $actionableMethodData['actionName'], 'reference' => &$actionableMethodData));
}
}
return $metadatas;
}
/**
* _respondWithSystemInformation()
*
* @param string $providerNameFilter
* @param string $actionNameFilter
* @param bool $includeAllSpecialties
* @return Zend_Tool_Framework_Client_Console_HelpSystem
*/
protected function _respondWithSystemInformation($providerNameFilter = null, $actionNameFilter = null, $includeAllSpecialties = false)
{
$manifest = $this->_registry->getManifestRepository();
$providerMetadatasSearch = array('type' => 'Tool', 'name' => 'providerName', 'clientName' => 'console');
if (is_string($providerNameFilter)) {
$providerMetadatasSearch = array_merge($providerMetadatasSearch, array('providerName' => $providerNameFilter));
}
$actionMetadatasSearch = array('type' => 'Tool', 'name' => 'actionName', 'clientName' => 'console');
if (is_string($actionNameFilter)) {
$actionMetadatasSearch = array_merge($actionMetadatasSearch, array('actionName' => $actionNameFilter));
}
// get the metadata's for the things to display
$displayProviderMetadatas = $manifest->getMetadatas($providerMetadatasSearch);
$displayActionMetadatas = $manifest->getMetadatas($actionMetadatasSearch);
// create index of actionNames
for ($i = 0; $i < count($displayActionMetadatas); $i++) {
$displayActionNames[] = $displayActionMetadatas[$i]->getActionName();
}
foreach ($displayProviderMetadatas as $providerMetadata) {
$providerNameDisplayed = false;
$providerName = $providerMetadata->getProviderName();
$providerSignature = $providerMetadata->getReference();
foreach ($providerSignature->getActions() as $actionInfo) {
$actionName = $actionInfo->getName();
// check to see if this action name is valid
if (($foundActionIndex = array_search($actionName, $displayActionNames)) === false) {
continue;
} else {
$actionMetadata = $displayActionMetadatas[$foundActionIndex];
}
$specialtyMetadata = $manifest->getMetadata(array('type' => 'Tool', 'name' => 'specialtyName', 'providerName' => $providerName, 'specialtyName' => '_Global', 'clientName' => 'console'));
// lets do the main _Global action first
$actionableGlobalLongParamMetadata = $manifest->getMetadata(array('type' => 'Tool', 'name' => 'actionableMethodLongParams', 'providerName' => $providerName, 'specialtyName' => '_Global', 'actionName' => $actionName, 'clientName' => 'console'));
$actionableGlobalMetadatas = $manifest->getMetadatas(array('type' => 'Tool', 'name' => 'actionableMethodLongParams', 'providerName' => $providerName, 'actionName' => $actionName, 'clientName' => 'console'));
if ($actionableGlobalLongParamMetadata) {
if (!$providerNameDisplayed) {
$this->_respondWithProviderName($providerMetadata);
$providerNameDisplayed = true;
}
$this->_respondWithCommand($providerMetadata, $actionMetadata, $specialtyMetadata, $actionableGlobalLongParamMetadata);
$actionIsGlobal = true;
} else {
$actionIsGlobal = false;
}
// check for providers without a _Global action
$isSingleSpecialProviderAction = false;
if (!$actionIsGlobal && count($actionableGlobalMetadatas) == 1) {
$isSingleSpecialProviderAction = true;
$this->_respondWithProviderName($providerMetadata);
$providerNameDisplayed = true;
}
if ($includeAllSpecialties || $isSingleSpecialProviderAction) {
foreach ($providerSignature->getSpecialties() as $specialtyName) {
if ($specialtyName == '_Global') {
continue;
}
$specialtyMetadata = $manifest->getMetadata(array('type' => 'Tool', 'name' => 'specialtyName', 'providerName' => $providerMetadata->getProviderName(), 'specialtyName' => $specialtyName, 'clientName' => 'console'));
$actionableSpecialtyLongMetadata = $manifest->getMetadata(array('type' => 'Tool', 'name' => 'actionableMethodLongParams', 'providerName' => $providerMetadata->getProviderName(), 'specialtyName' => $specialtyName, 'actionName' => $actionName, 'clientName' => 'console'));
if ($actionableSpecialtyLongMetadata) {
$this->_respondWithCommand($providerMetadata, $actionMetadata, $specialtyMetadata, $actionableSpecialtyLongMetadata);
}
}
}
// reset the special flag for single provider action with specialty
$isSingleSpecialProviderAction = false;
if (!$includeAllSpecialties && count($actionableGlobalMetadatas) > 1) {
$this->_response->appendContent(' Note: There are specialties, use ', array('color' => 'yellow', 'separator' => false));
$this->_response->appendContent('zf ' . $actionMetadata->getValue() . ' ' . $providerMetadata->getValue() . '.?', array('color' => 'cyan', 'separator' => false));
$this->_response->appendContent(' to get specific help on them.', array('color' => 'yellow'));
}
}
if ($providerNameDisplayed) {
$this->_response->appendContent(null, array('separator' => true));
}
}
return $this;
}
public function setRegistry(Zend_Tool_Framework_Registry_Interface $registry)
{
$response = $registry->getResponse();
ZFscaffold_ZfTool_Helpers_Messages::setResponse($response);
return parent::setRegistry($registry);
}
/**
* getMetadata() is required by the Manifest Interface.
*
* These are the following metadatas that will be setup:
*
* actionName
* - metadata for actions
* - value will be a dashed name for the action named in 'actionName'
* providerName
* - metadata for providers
* - value will be a dashed-name for the provider named in 'providerName'
* providerSpecialtyNames
* - metadata for providers
* actionableMethodLongParameters
* - metadata for providers
* actionableMethodShortParameters
* - metadata for providers
*
* @return array Array of Metadatas
*/
public function getMetadata()
{
$metadatas = array();
// setup the camelCase to dashed filter to use since cli expects dashed named
$ccToDashedFilter = new Zend_Filter();
$ccToDashedFilter->addFilter(new Zend_Filter_Word_CamelCaseToDash())->addFilter(new Zend_Filter_StringToLower());
// get the registry to get the action and provider repository
$actionRepository = $this->_registry->getActionRepository();
$providerRepository = $this->_registry->getProviderRepository();
// loop through all actions and create a metadata for each
foreach ($actionRepository->getActions() as $action) {
// each action metadata will be called
$metadatas[] = new Zend_Tool_Framework_Metadata_Tool(array('name' => 'actionName', 'value' => $ccToDashedFilter->filter($action->getName()), 'reference' => $action, 'actionName' => $action->getName(), 'clientName' => 'console', 'clientReference' => $this->_registry->getClient()));
}
foreach ($providerRepository->getProviderSignatures() as $providerSignature) {
// create the metadata for the provider's cliProviderName
$metadatas[] = new Zend_Tool_Framework_Metadata_Tool(array('name' => 'providerName', 'value' => $ccToDashedFilter->filter($providerSignature->getName()), 'reference' => $providerSignature, 'clientName' => 'console', 'providerName' => $providerSignature->getName(), 'clientReference' => $this->_registry->getClient()));
// create the metadatas for the per provider specialites in providerSpecaltyNames
foreach ($providerSignature->getSpecialties() as $specialty) {
$metadatas[] = new Zend_Tool_Framework_Metadata_Tool(array('name' => 'specialtyName', 'value' => $ccToDashedFilter->filter($specialty), 'reference' => $providerSignature, 'clientName' => 'console', 'providerName' => $providerSignature->getName(), 'specialtyName' => $specialty, 'clientReference' => $this->_registry->getClient()));
}
// $actionableMethod is keyed by the methodName (but not used)
foreach ($providerSignature->getActionableMethods() as $actionableMethodData) {
$methodLongParams = array();
//also keeps track of used short params, avoid "Options is being defined more than once"
//exception when two long flags start with the same letter
$methodShortParams = array();
// $actionableMethodData get both the long and short names
foreach ($actionableMethodData['parameterInfo'] as $parameterInfoData) {
// filter to dashed
$methodLongParams[$parameterInfoData['name']] = $ccToDashedFilter->filter($parameterInfoData['name']);
$shortParam = false;
//use the first character in the method name that isn't already
//in use. Try lowercase first, then upper case. If none found...
for ($i = 0; $i < strlen($parameterInfoData['name']); $i++) {
$currentShortParam = strtolower($parameterInfoData['name'][$i]);
if (in_array($currentShortParam, $methodShortParams)) {
$currentShortParam = strtoupper($currentShortParam);
}
if (!in_array($currentShortParam, $methodShortParams)) {
$shortParam = $currentShortParam;
break;
}
}
//...if none found, find first acceptable letter, again try lower case first,
//then upper case.
if (!$shortParam) {
for ($i = 97; $i <= 123; $i++) {
$currentShortParam = chr($i);
if (in_array($currentShortParam, $methodShortParams)) {
$currentShortParam = strtoupper($currentShortParam);
}
if (!in_array($currentShortParam, $methodShortParams)) {
$shortParam = $currentShortParam;
break;
}
}
if (!$shortParam) {
throw new Zend_Tool_Framework_Client_Exception(__METHOD__ . ' was unable
to find a unique short flag name for long flag name "' . $parameterInfoData['name'] . '"');
}
}
$methodShortParams[$parameterInfoData['name']] = $shortParam;
}
// create metadata for the long name cliActionableMethodLongParameters
$metadatas[] = new Zend_Tool_Framework_Metadata_Tool(array('name' => 'actionableMethodLongParams', 'value' => $methodLongParams, 'clientName' => 'console', 'providerName' => $providerSignature->getName(), 'specialtyName' => $actionableMethodData['specialty'], 'actionName' => $actionableMethodData['actionName'], 'reference' => &$actionableMethodData, 'clientReference' => $this->_registry->getClient()));
// create metadata for the short name cliActionableMethodShortParameters
$metadatas[] = new Zend_Tool_Framework_Metadata_Tool(array('name' => 'actionableMethodShortParams', 'value' => $methodShortParams, 'clientName' => 'console', 'providerName' => $providerSignature->getName(), 'specialtyName' => $actionableMethodData['specialty'], 'actionName' => $actionableMethodData['actionName'], 'reference' => &$actionableMethodData, 'clientReference' => $this->_registry->getClient()));
}
}
return $metadatas;
}
