KDevelop API Documentation

PHPSupportPart Class Reference

This is PHP language support plugin. More...

#include <phpsupportpart.h>

Inheritance diagram for PHPSupportPart:

KDevLanguageSupport KDevPlugin QObject KXMLGUIClient List of all members.

Public Member Functions

 PHPSupportPart (QObject *parent, const char *name, const QStringList &)
 ~PHPSupportPart ()

Protected Member Functions

virtual Features features ()
 Returns the feature set of the language.

virtual KMimeType::List mimeTypes ()
 Returns a typical mimetype list for the support language should be configurable in the languagesupport dialog.


Private Slots

void projectOpened ()
void projectClosed ()
void savedFile (const QString &fileName)
void addedFilesToProject (const QStringList &fileList)
void removedFilesFromProject (const QStringList &fileList)
void slotRun ()
void slotNewClass ()
void projectConfigWidget (KDialogBase *dlg)
void slotReceivedPHPExeStderr (KProcess *proc, char *buffer, int buflen)
void slotReceivedPHPExeStdout (KProcess *proc, char *buffer, int buflen)
void slotPHPExeExited (KProcess *proc)
void slotErrorMessageSelected (const QString &filename, int line)
void slotWebData (KIO::Job *job, const QByteArray &data)
void slotWebResult (KIO::Job *job)
void slotWebJobStarted (KIO::Job *job)
void initialParse ()
void slotActivePartChanged (KParts::Part *part)
void slotTextChanged ()
void slotConfigStored ()

Private Member Functions

void maybeParse (const QString fileName)
void executeOnWebserver ()
void executeInTerminal ()
bool validateConfig ()

Private Attributes

PHPHTMLViewm_htmlView
PHPErrorViewm_phpErrorView
KShellProcessphpExeProc
QString m_phpExeOutput
PHPConfigDataconfigData
PHPCodeCompletionm_codeCompletion
PHPParserm_parser
KTextEditor::EditInterfacem_editInterface

Detailed Description

This is PHP language support plugin.

Put a more detailed description of your part in these lines. It can span over several lines. You can even use some html commands in these lines like: This is code, html links link text, and images.

Author(s):
Sandy Meier

Maintainer(s):
Sandy Meier

2nd maintainer full name ...

nth maintainer full name

Feature(s):
PHP language support

Consult Programming Languages Support Status for a up to date features/status of this programming language support part.

Bug:
bugs in php support component at Bugzilla database

Describe a the 1st bug that you know of, but probably hasn't been reported yet. ..

Describe a the nth bug that you know of, but probably hasn't been reported yet.

Requirement(s):
Describe a the 1st requirement of your part.

Describe a the 2nd requirement of your part. ...

Describe a the nth requirement of your part.

Todo:
integrated preview (webserver support and execution with php.exe),including error message parser

syntax check with php.exe

extended classtools (new class,new function...) based on filetemplates

debugger and profiler support dbg (http://dd.cron.ru/dbg)

codecompletion (key words, functions (mysql_*), and current project)

html form support (dialogs for generating html code, tables...)

support for phpdoc

documentation viewer for php (maybe plugins for the current docviewer) (tf)

integrated filemanager with ftp client (maybe a konqueror part)

code template factory (contains useful php code snippet like array_display,trace,validator)

new 'character' based parser, the current is 'line' based

F.A.Q.:
First frequenly asked question about your part ? Answer.

Second frequenly asked question about your part ? Answer. ...

Last frequenly asked question about your part ? Answer.

Note:
First note text.

Second note text. ...

Last note text.

Warning:
First warning text.

Second warning text. ...

Last warning text.

Definition at line 31 of file phpsupportpart.h.


Constructor & Destructor Documentation

PHPSupportPart::PHPSupportPart QObject parent,
const char *  name,
const QStringList
 

PHPSupportPart::~PHPSupportPart  ) 
 

Definition at line 122 of file phpsupportpart.cpp.

References configData, m_codeCompletion, m_htmlView, m_parser, m_phpErrorView, KDevPlugin::mainWindow(), phpExeProc, KDevMainWindow::removeView(), and KHTMLPart::view().


Member Function Documentation

void PHPSupportPart::addedFilesToProject const QStringList fileList  )  [private, slot]
 

Definition at line 425 of file phpsupportpart.cpp.

References addedFilesToProject(), endl(), kdDebug(), maybeParse(), and KDevPlugin::project().

Referenced by addedFilesToProject(), and projectOpened().

void PHPSupportPart::executeInTerminal  )  [private]
 

Definition at line 304 of file phpsupportpart.cpp.

References KParts::PartManager::activePart(), KHTMLPart::begin(), KProcess::clearArguments(), configData, KDevMainWindow::embedPartView(), endl(), file, PHPConfigData::getPHPExecPath(), kdDebug(), m_htmlView, m_phpExeOutput, KDevPlugin::mainWindow(), KDevPlugin::partController(), KURL::path(), phpExeProc, KDevPartController::saveAllFiles(), KHTMLPart::show(), KShellProcess::start(), KParts::ReadOnlyPart::url(), and KHTMLPart::view().

Referenced by slotRun().

void PHPSupportPart::executeOnWebserver  )  [private]
 

Definition at line 249 of file phpsupportpart.cpp.

References KParts::PartManager::activePart(), KHTMLPart::browserExtension(), configData, file, PHPConfigData::getWebDefaultFile(), PHPConfigData::getWebFileMode(), PHPConfigData::getWebURL(), m_htmlView, m_phpExeOutput, KHTMLPart::openURL(), KDevPlugin::partController(), KParts::URLArgs::reload, KDevPartController::saveAllFiles(), KParts::BrowserExtension::setURLArgs(), KHTMLPart::show(), KURL::url(), KParts::ReadOnlyPart::url(), and KParts::BrowserExtension::urlArgs().

Referenced by slotRun().

KDevLanguageSupport::Features PHPSupportPart::features  )  [protected, virtual]
 

Returns the feature set of the language.

This is e.g. used by the class view to decide which organizer items to display and which not.

Reimplemented from KDevLanguageSupport.

Definition at line 473 of file phpsupportpart.cpp.

void PHPSupportPart::initialParse  )  [private, slot]
 

Definition at line 393 of file phpsupportpart.cpp.

References KDevProject::allFiles(), endl(), kdDebug(), KDevPlugin::mainWindow(), maybeParse(), KDevPlugin::project(), KDevMainWindow::statusBar(), and KDevLanguageSupport::updatedSourceInfo().

Referenced by projectOpened().

void PHPSupportPart::maybeParse const QString  fileName  )  [private]
 

Definition at line 375 of file phpsupportpart.cpp.

References KDevPlugin::codeModel(), endl(), CodeModel::hasFile(), kdDebug(), m_parser, maybeParse(), PHPParser::parseFile(), and CodeModel::removeFile().

Referenced by addedFilesToProject(), initialParse(), maybeParse(), and savedFile().

KMimeType::List PHPSupportPart::mimeTypes  )  [protected, virtual]
 

Returns a typical mimetype list for the support language should be configurable in the languagesupport dialog.

Reimplemented from KDevLanguageSupport.

Definition at line 478 of file phpsupportpart.cpp.

References KMimeType::List, and KMimeType::Ptr.

void PHPSupportPart::projectClosed  )  [private, slot]
 

Definition at line 370 of file phpsupportpart.cpp.

void PHPSupportPart::projectConfigWidget KDialogBase dlg  )  [private, slot]
 

Definition at line 200 of file phpsupportpart.cpp.

References KDialogBase::addVBoxPage(), configData, and projectConfigWidget().

Referenced by projectConfigWidget().

void PHPSupportPart::projectOpened  )  [private, slot]
 

Definition at line 355 of file phpsupportpart.cpp.

References addedFilesToProject(), endl(), initialParse(), kdDebug(), KDevPlugin::project(), and removedFilesFromProject().

void PHPSupportPart::removedFilesFromProject const QStringList fileList  )  [private, slot]
 

Definition at line 442 of file phpsupportpart.cpp.

References KDevPlugin::codeModel(), endl(), CodeModel::hasFile(), kdDebug(), KDevPlugin::project(), removedFilesFromProject(), and CodeModel::removeFile().

Referenced by projectOpened(), and removedFilesFromProject().

void PHPSupportPart::savedFile const QString fileName  )  [private, slot]
 

Definition at line 462 of file phpsupportpart.cpp.

References KDevProject::allFiles(), endl(), kdDebug(), length(), maybeParse(), KDevPlugin::project(), and savedFile().

Referenced by savedFile().

void PHPSupportPart::slotActivePartChanged KParts::Part part  )  [private, slot]
 

Definition at line 143 of file phpsupportpart.cpp.

References configData, endl(), PHPConfigData::getRealtimeParsing(), kdDebug(), m_codeCompletion, m_editInterface, PHPCodeCompletion::setActiveEditorPart(), slotActivePartChanged(), slotTextChanged(), and KParts::Part::widget().

Referenced by slotActivePartChanged(), and slotConfigStored().

void PHPSupportPart::slotConfigStored  )  [private, slot]
 

Definition at line 190 of file phpsupportpart.cpp.

References KDevPlugin::partController(), and slotActivePartChanged().

void PHPSupportPart::slotErrorMessageSelected const QString filename,
int  line
[private, slot]
 

Definition at line 196 of file phpsupportpart.cpp.

References KDevPartController::editDocument(), endl(), kdDebug(), KDevPlugin::partController(), and slotErrorMessageSelected().

Referenced by slotErrorMessageSelected().

void PHPSupportPart::slotNewClass  )  [private, slot]
 

Definition at line 210 of file phpsupportpart.cpp.

References KDevPlugin::codeModel(), KDevPlugin::project(), and sortedNameList().

void PHPSupportPart::slotPHPExeExited KProcess proc  )  [private, slot]
 

Definition at line 349 of file phpsupportpart.cpp.

References KHTMLPart::end(), endl(), kdDebug(), m_htmlView, m_phpErrorView, m_phpExeOutput, PHPErrorView::parse(), and slotPHPExeExited().

Referenced by slotPHPExeExited().

void PHPSupportPart::slotReceivedPHPExeStderr KProcess proc,
char *  buffer,
int  buflen
[private, slot]
 

Definition at line 343 of file phpsupportpart.cpp.

References endl(), kdDebug(), m_htmlView, m_phpExeOutput, slotReceivedPHPExeStderr(), and KHTMLPart::write().

Referenced by slotReceivedPHPExeStderr().

void PHPSupportPart::slotReceivedPHPExeStdout KProcess proc,
char *  buffer,
int  buflen
[private, slot]
 

Definition at line 337 of file phpsupportpart.cpp.

References endl(), kdDebug(), m_htmlView, m_phpExeOutput, slotReceivedPHPExeStdout(), and KHTMLPart::write().

Referenced by slotReceivedPHPExeStdout().

void PHPSupportPart::slotRun  )  [private, slot]
 

Definition at line 216 of file phpsupportpart.cpp.

References configData, executeInTerminal(), executeOnWebserver(), PHPConfigData::getInvocationMode(), m_htmlView, m_phpErrorView, KDevPlugin::mainWindow(), KDevPlugin::projectDom(), KDevMainWindow::raiseView(), validateConfig(), and KHTMLPart::view().

void PHPSupportPart::slotTextChanged  )  [private, slot]
 

Definition at line 158 of file phpsupportpart.cpp.

References KParts::PartManager::activePart(), KDevProject::allFiles(), KDevPlugin::codeModel(), KURL::directory(), endl(), KURL::fileName(), CodeModel::hasFile(), kdDebug(), length(), m_editInterface, m_parser, KTextEditor::EditInterface::numLines(), PHPParser::parseLines(), KDevPlugin::partController(), KDevPlugin::project(), CodeModel::removeFile(), KTextEditor::EditInterface::textLine(), and KParts::ReadOnlyPart::url().

Referenced by slotActivePartChanged().

void PHPSupportPart::slotWebData KIO::Job job,
const QByteArray data
[private, slot]
 

Definition at line 293 of file phpsupportpart.cpp.

References data, endl(), kdDebug(), m_phpExeOutput, and slotWebData().

Referenced by slotWebData(), and slotWebJobStarted().

void PHPSupportPart::slotWebJobStarted KIO::Job job  )  [private, slot]
 

Definition at line 282 of file phpsupportpart.cpp.

References data, endl(), kdDebug(), KIO::Job::progressId(), slotWebData(), slotWebJobStarted(), and slotWebResult().

Referenced by slotWebJobStarted().

void PHPSupportPart::slotWebResult KIO::Job job  )  [private, slot]
 

Definition at line 299 of file phpsupportpart.cpp.

References endl(), kdDebug(), m_phpErrorView, m_phpExeOutput, PHPErrorView::parse(), and slotWebResult().

Referenced by slotWebJobStarted(), and slotWebResult().

bool PHPSupportPart::validateConfig  )  [private]
 

Definition at line 231 of file phpsupportpart.cpp.

References KDialogBase::addVBoxPage(), configData, and PHPConfigData::validateConfig().

Referenced by slotRun().


Member Data Documentation

PHPConfigData* PHPSupportPart::configData [private]
 

Definition at line 78 of file phpsupportpart.h.

Referenced by executeInTerminal(), executeOnWebserver(), projectConfigWidget(), slotActivePartChanged(), slotRun(), validateConfig(), and ~PHPSupportPart().

PHPCodeCompletion* PHPSupportPart::m_codeCompletion [private]
 

Definition at line 79 of file phpsupportpart.h.

Referenced by slotActivePartChanged(), and ~PHPSupportPart().

KTextEditor::EditInterface* PHPSupportPart::m_editInterface [private]
 

Definition at line 81 of file phpsupportpart.h.

Referenced by slotActivePartChanged(), and slotTextChanged().

PHPHTMLView* PHPSupportPart::m_htmlView [private]
 

Definition at line 74 of file phpsupportpart.h.

Referenced by executeInTerminal(), executeOnWebserver(), slotPHPExeExited(), slotReceivedPHPExeStderr(), slotReceivedPHPExeStdout(), slotRun(), and ~PHPSupportPart().

PHPParser* PHPSupportPart::m_parser [private]
 

Definition at line 80 of file phpsupportpart.h.

Referenced by maybeParse(), slotTextChanged(), and ~PHPSupportPart().

PHPErrorView* PHPSupportPart::m_phpErrorView [private]
 

Definition at line 75 of file phpsupportpart.h.

Referenced by slotPHPExeExited(), slotRun(), slotWebResult(), and ~PHPSupportPart().

QString PHPSupportPart::m_phpExeOutput [private]
 

Definition at line 77 of file phpsupportpart.h.

Referenced by executeInTerminal(), executeOnWebserver(), slotPHPExeExited(), slotReceivedPHPExeStderr(), slotReceivedPHPExeStdout(), slotWebData(), and slotWebResult().

KShellProcess* PHPSupportPart::phpExeProc [private]
 

Definition at line 76 of file phpsupportpart.h.

Referenced by executeInTerminal(), and ~PHPSupportPart().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for KDevelop Version 3.0.4.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Tue Oct 19 08:02:05 2004 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003