Difference between revisions of "JInstallerModule/install"
From Joomla! Documentation
< API15:JInstallerModule
(New page: ===Description===
Custom install method
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>Edit Descripton<nowiki>]</nowiki>
...) |
m (removing red link to edit, no existant pages) |
||
| Line 3: | Line 3: | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
| − | <nowiki>[< | + | <nowiki>[<! removed edit link to red link >]</nowiki> |
</span> | </span> | ||
| − | + | <! removed transcluded page call, red link never existed > | |
===Syntax=== | ===Syntax=== | ||
| Line 204: | Line 204: | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
| − | <nowiki>[< | + | <nowiki>[<! removed edit link to red link >]</nowiki> |
</span> | </span> | ||
| − | + | <! removed transcluded page call, red link never existed > | |
===Examples=== | ===Examples=== | ||
| Line 219: | Line 219: | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
| + | [[Category:Archived pages API15]] | ||
Revision as of 13:32, 12 May 2013
The "API15" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.
Description[edit]
Custom install method
[<! removed edit link to red link >]
<! removed transcluded page call, red link never existed >
Syntax[edit]
install()
Returns[edit]
boolean True on success
Defined in[edit]
libraries/joomla/installer/adapters/module.php
Importing[edit]
jimport( 'joomla.installer.adapters.module' );Source Body[edit]
function install()
{
// Get a database connector object
$db =& $this->parent->getDBO();
// Get the extension manifest object
$manifest =& $this->parent->getManifest();
$this->manifest =& $manifest->document;
// Set the extensions name
$name =& $this->manifest->getElementByPath('name');
$name = JFilterInput::clean($name->data(), 'string');
$this->set('name', $name);
// Get the component description
$description = & $this->manifest->getElementByPath('description');
if (is_a($description, 'JSimpleXMLElement')) {
$this->parent->set('message', $description->data());
} else {
$this->parent->set('message', '' );
}
// Get the target application
if ($cname = $this->manifest->attributes('client')) {
// Attempt to map the client to a base path
jimport('joomla.application.helper');
$client =& JApplicationHelper::getClientInfo($cname, true);
if ($client === false) {
$this->parent->abort(JText::_('Module').' '.JText::_('Install').': '.JText::_('Unknown client type').' ['.$client->name.']');
return false;
}
$basePath = $client->path;
$clientId = $client->id;
} else {
// No client attribute was found so we assume the site as the client
$cname = 'site';
$basePath = JPATH_SITE;
$clientId = 0;
}
// Set the installation path
$element =& $this->manifest->getElementByPath('files');
if (is_a($element, 'JSimpleXMLElement') && count($element->children())) {
$files = $element->children();
foreach ($files as $file) {
if ($file->attributes('module')) {
$mname = $file->attributes('module');
break;
}
}
}
if (!empty ($mname)) {
$this->parent->setPath('extension_root', $basePath.DS.'modules'.DS.$mname);
} else {
$this->parent->abort(JText::_('Module').' '.JText::_('Install').': '.JText::_('No module file specified'));
return false;
}
/*
* If the module directory already exists, then we will assume that the
* module is already installed or another module is using that
* directory.
*/
if (file_exists($this->parent->getPath('extension_root'))&&!$this->parent->getOverwrite()) {
$this->parent->abort(JText::_('Module').' '.JText::_('Install').': '.JText::_('Another module is already using directory').': "'.$this->parent->getPath('extension_root').'"');
return false;
}
// If the module directory does not exist, lets create it
$created = false;
if (!file_exists($this->parent->getPath('extension_root'))) {
if (!$created = JFolder::create($this->parent->getPath('extension_root'))) {
$this->parent->abort(JText::_('Module').' '.JText::_('Install').': '.JText::_('Failed to create directory').': "'.$this->parent->getPath('extension_root').'"');
return false;
}
}
/*
* Since we created the module directory and will want to remove it if
* we have to roll back the installation, lets add it to the
* installation step stack
*/
if ($created) {
$this->parent->pushStep(array ('type' => 'folder', 'path' => $this->parent->getPath('extension_root')));
}
// Copy all necessary files
if ($this->parent->parseFiles($element, -1) === false) {
// Install failed, roll back changes
$this->parent->abort();
return false;
}
// Parse optional tags
$this->parent->parseMedia($this->manifest->getElementByPath('media'), $clientId);
$this->parent->parseLanguages($this->manifest->getElementByPath('languages'), $clientId);
// Parse deprecated tags
$this->parent->parseFiles($this->manifest->getElementByPath('images'), -1);
// Check to see if a module by the same name is already installed
$query = 'SELECT `id`' .
' FROM `#__modules` ' .
' WHERE module = '.$db->Quote($mname) .
' AND client_id = '.(int)$clientId;
$db->setQuery($query);
if (!$db->Query()) {
// Install failed, roll back changes
$this->parent->abort(JText::_('Module').' '.JText::_('Install').': '.$db->stderr(true));
return false;
}
$id = $db->loadResult();
// Was there a module already installed with the same name?
// If there was then we wouldn't be here because it would have
// been stopped by the above. Otherwise the files weren't there
// (e.g. migration) or its an upgrade (files overwritten)
// So all we need to do is create an entry when we can't find one
if (!$id) {
$row = & JTable::getInstance('module');
$row->title = JText::_($this->get('name'));
$row->ordering = $row->getNextOrder( "position='left'" );
$row->position = 'left';
$row->showtitle = 1;
$row->iscore = 0;
$row->access = $clientId == 1 ? 2 : 0;
$row->client_id = $clientId;
$row->module = $mname;
$row->params = $this->parent->getParams();
if (!$row->store()) {
// Install failed, roll back changes
$this->parent->abort(JText::_('Module').' '.JText::_('Install').': '.$db->stderr(true));
return false;
}
// Since we have created a module item, we add it to the installation step stack
// so that if we have to rollback the changes we can undo it.
$this->parent->pushStep(array ('type' => 'module', 'id' => $row->id));
// Clean up possible garbage first
$query = 'DELETE FROM #__modules_menu WHERE moduleid = '.(int) $row->id;
$db->setQuery( $query );
if (!$db->query()) {
// Install failed, roll back changes
$this->parent->abort(JText::_('Module').' '.JText::_('Install').': '.$db->stderr(true));
return false;
}
// Time to create a menu entry for the module
$query = 'INSERT INTO `#__modules_menu` ' .
' VALUES ('.(int) $row->id.', 0 )';
$db->setQuery($query);
if (!$db->query()) {
// Install failed, roll back changes
$this->parent->abort(JText::_('Module').' '.JText::_('Install').': '.$db->stderr(true));
return false;
}
/*
* Since we have created a menu item, we add it to the installation step stack
* so that if we have to rollback the changes we can undo it.
*/
$this->parent->pushStep(array ('type' => 'menu', 'id' => $db->insertid()));
}
// Lastly, we will copy the manifest file to its appropriate place.
if (!$this->parent->copyManifest(-1)) {
// Install failed, rollback changes
$this->parent->abort(JText::_('Module').' '.JText::_('Install').': '.JText::_('Could not copy setup file'));
return false;
}
// Load module language file
$lang =& JFactory::getLanguage();
$lang->load($row->module, JPATH_BASE.DS.'..');
return true;
}[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >
Examples[edit]
<CodeExamplesForm />