Actions

Difference between revisions of "Configuring Eclipse IDE for PHP development/Linux"

From Joomla! Documentation

< Configuring Eclipse IDE for PHP development
(Created page with "{{underconstruction}} {{RightTOC}} Theses instructions should work fine on any Debian based distribution such as Debian, Ubuntu, LinuxMint, Xubuntu, Kbuntu and others. == Down...")
 
(Configuration)
Line 89: Line 89:
  
 
== Configuration ==
 
== Configuration ==
 +
 +
 
=== Installing more extensions ===
 
=== Installing more extensions ===
For your PHP  
+
 
 +
For your Eclipse IDE you will need to install more extension for PHP development and other tools to help you in your project development journey, follow this steps and indications:
 +
 
 +
*On Eclipse go to: "Toolbar --> help --> install new software"
 +
*You are now on the "Install" window, click the drop-down list  "Work with" and set it to "--All Available Sites--"
 +
*In the search box type the following keywords and select all the results in the list below:
 +
**subversive
 +
**Remote Development Support
 +
**php
 +
**xml editors
 +
**xsl editors
 +
**javascript
 +
**Remote System Explorer
 +
**Eclipse Web Developer Tools
 +
**Web Page Editor
 +
*Press "Next>" and follow the installation wizard and restart Eclipse if needed
 +
 
 +
Those are all the extension to install for now, they should be enough to work with local and remote PHP and Joomla development projects, nonetheless you can experiment and tray all the extensions you like.
 +
 
 +
 
 
=== Configuring the perspectives and views ===
 
=== Configuring the perspectives and views ===
 +
 +
In this case we need to configure Eclipse for PHP development, so you should add the following perspectives:
 +
 +
*Go to: "Toolbar --> windows --> open perspective --> others --> debug"
 +
*Go to: "Toolbar --> windows --> open perspective --> others --> php"
 +
*Switch to the "PHP perspective"
 +
*Go to: "Toolbar --> windows --> show view --> others --> remote systems"
 +
*Drag the view from the tab and drop it next to the "PHP explorer" view
 +
 +
Now you can explore local and remote PHP project, how to configure this tools will be explained in [[Setting_up_your_workstation_for_PHP_development | this]] series of articles, but for now leave it for the future.
 +
 
=== Configuring the editors ===
 
=== Configuring the editors ===
  
 +
These are some of the configuration you can do to your editors to improve the user experience:
 +
 +
==== Display white spaces ====
 +
 +
Some people like to see the white spaces represented in the editor to do so:
 +
 +
*Go to "Toolbar --> window --> preferences --> general --> editors --> text editors"
 +
*Set "show whitespace characters" to check
 +
 +
==== Colors ====
 +
 +
To highlight some the parts of the code with stronger colors, follow this steps:
 +
 +
*Go to "Toolbar --> window --> preferences --> general --> editors --> text editors --> annotations "
 +
**On the list find "java scrip occurrences" and set the color value to "#FFFF5A"
 +
**On the list find "matching tags" and set the color value to "#FFFF5A"
 +
**On the list find "php elements read occurrences" and set the color value to "#FFFF5A"
 +
*Go to "Toolbar --> window --> preferences --> general --> editors --> structured text editor"
 +
**Find the list "Appearance color options"
 +
**On the list find "Matching brackets highlight" and set the color value to "#0000FF"
 +
*Go to "Toolbar --> window --> javascript --> editor"
 +
**Find the list "Appearance color options"
 +
**On the list find "Matching brackets highlight" and set the color value to "#0000FF"
 +
 +
==== code folding ====
  
 +
==== code cleaning ====
  
 
== Fine tuning ==
 
== Fine tuning ==

Revision as of 17:42, 3 May 2012

Documentation all together tranparent small.png
Under Construction

This article or section is in the process of an expansion or major restructuring. You are welcome to assist in its construction by editing it as well. If this article or section has not been edited in several days, please remove this template.
This article was last edited by Enav (talk| contribs) 2 years ago. (Purge)

Contents

Theses instructions should work fine on any Debian based distribution such as Debian, Ubuntu, LinuxMint, Xubuntu, Kbuntu and others.


Download and Installation

There is 2 ways to download and install Eclipse IDE in your Linux box, you can do it automatically from the comfort of your software center or the Linux terminal with few commands or manually downloading and installing Eclipse IDE from the Eclipse project website.


Method 1: From a Linux repository

NOTE: This method is the most recommended because you will have the benefits of automate all the installation process and get automatic security and bug fixes updates when the software is installed from the repositories.


Method 1: Terminal

  • Open your terminal and type
 sudo apt-get install eclipse 
  • Wait until installation process finish
  • If everything whent fine Eclipse IDE should be available in the software menu


Method 2: Software center

  • Open the software center that comes with your distribution
  • Type in the search box "Eclipse IDE"
  • Select Eclipse IDEe in the search result list
  • Click on the "install" button
  • Wait until installation processes finish
  • If everything whent fine Eclipse IDE should be available in the software menu


Method 2: From a downloaded copy

  • Go to: Eclipse download page
  • Download "Eclipse Classic" 32 or 64 bits according to your current OS version
  • Unpack the downloaded file on any location comfortable for you, ex: Downloads folder or Desktop
  • Open the eclipse folder an find an executable file called "eclipse"
  • Do a right click on the file then -> properties -> permissions and check "Allow executing file as a program"
  • To execute Eclipse IDE, you can do a double click on the executable file or run it from terminal, ex:
cd ~/Downloads/eclipse/
eclipse

NOTE: For manual download and installation you got to have JAVA runtime previously installed or Eclipse IDE will not run, when you install eclipse from terminal all the packages and dependencies are automatically downloaded and installed.

To install java runtime on your Linux box open a terminal and type:

sudo apt-get install sun-java6

Wait until installation process finish and try to execute Eclipse IDE again.

NOTE: At the Eclipse download page you can see many versions of Eclipse IDE, all of them are basically the same Eclipse with a bunch of extensions pre-installed to do specific task by default Eclipse IDE comes with all the tools needed to develop JAVA projects but you can install more extensions to develop in other languages, click in the link Compare Packages to see a complete char of all the extensions included on each Eclipse Package build, ex: you can download "Eclipse Classic" and manually install some extensions to make it works just like the version called "Eclipse IDE for JavaScript Web Developers" which contains several common extensions needed to develop web applications.


Understanding the Eclipse IDE interface

Eclipse IDE is not just a editor it is a platform and can be used to many thing, that is why it implement a very flexible philosophy to denominate and describe the way it display and organize the information, the most relevant parts of eclipse interface are:

  • The tool bar: Is at the top of the window just like any other common application
  • The tool bar with buttons: Is right under neat the toolbar it contains a bunch of buttons most of them change according the current context, view or perspective, you can drag and drop that some of it buttons to arrange them the way you want
  • The views: They are sections that divide the windows content and display different kind of information, you can arrange the views in almost any possible way, ex: columns, rows, complex combinations of columns and rows and so forth
  • The perspectives: The perspectives are just a setup of views arranged in certain configuration and normally sharing a relationship between them

Is important to understand how this perspective philosophy works, for example The "PHP perspective" is used to edit PHP code so is coherent to display views related to the PHP code edition, views to manage the project files and views to navigate trough the code, the following is a typical "PHP perspective":

  • Docked at the left with several tabs are the "PHP explorer" view and the "Type Hierarchy explorer" view
  • In the middle is a wide view which is the "editor area", there will be as many tabs as many files you are editing
  • Docked at the right with several tabs are the "Search" view and the "outline" view, they will assist you to find chuck of code or navigate trough the parts, variables and object of your current file under edition.
  • Docked at the bottom are with several tabs are the "Problems" view,"Task" view, "Console" view and "Progress" view there you will see things like unsolved problems like syntax errors, uncompleted TODO tasks, and see the progress of build or update operations

In the other hand the "Debug Perspective" share some views with the "PHP perspective" but have a different arrangement of views and got more different views related to the code debugging operations such as:

  • Debug view: Display the call stack of the current breakpoint
  • servers view: Display a list of the configured server to debug with
  • Variables view: This view shows a tree that is basically is a complete dump of all the variables and object of the current session at the current breakpoint
  • Breakpoints view: Display a list of all the breakpoints set all over your project, you can double click on one of the item of that list to jump in that exact line of code
  • Expressions views: There you can create expressions on the fly to evaluate them without the need of do code modifications

You can switch betweend perspectives selecting them at "Tool bar --> window --> Open perspective" or you can click in the perspective buttons located at the far right of the "The tool bar with buttons"

If you don't feel happy with any of this perspective configurations and how their views are arranged, you can create your very own perspectives and add as much views as you want and arrange them the way that makes you feel good, you just got to:

  • Modify the current perspective (any it doesn't matter)
  • Add thew views you want and remove the others you don't
  • Arrange the views the way you like and make you feel comfortable
  • Go to "Tool bar --> window --> Save perspective as" and set a name for your custom perspective, ex: "pimp-My-IDE" and save it, you can also overwrite an existing view name

So far you should be able to know how to play with Eclipse IDE and understand it interface philosophy, if you want to see a video demonstration about Eclipse IDE to get a preview and taste some of it powers check this out Webinar: Using Eclipse for Joomla! Development


Configuration

Installing more extensions

For your Eclipse IDE you will need to install more extension for PHP development and other tools to help you in your project development journey, follow this steps and indications:

  • On Eclipse go to: "Toolbar --> help --> install new software"
  • You are now on the "Install" window, click the drop-down list "Work with" and set it to "--All Available Sites--"
  • In the search box type the following keywords and select all the results in the list below:
    • subversive
    • Remote Development Support
    • php
    • xml editors
    • xsl editors
    • javascript
    • Remote System Explorer
    • Eclipse Web Developer Tools
    • Web Page Editor
  • Press "Next>" and follow the installation wizard and restart Eclipse if needed

Those are all the extension to install for now, they should be enough to work with local and remote PHP and Joomla development projects, nonetheless you can experiment and tray all the extensions you like.


Configuring the perspectives and views

In this case we need to configure Eclipse for PHP development, so you should add the following perspectives:

  • Go to: "Toolbar --> windows --> open perspective --> others --> debug"
  • Go to: "Toolbar --> windows --> open perspective --> others --> php"
  • Switch to the "PHP perspective"
  • Go to: "Toolbar --> windows --> show view --> others --> remote systems"
  • Drag the view from the tab and drop it next to the "PHP explorer" view

Now you can explore local and remote PHP project, how to configure this tools will be explained in this series of articles, but for now leave it for the future.

Configuring the editors

These are some of the configuration you can do to your editors to improve the user experience:

Display white spaces

Some people like to see the white spaces represented in the editor to do so:

  • Go to "Toolbar --> window --> preferences --> general --> editors --> text editors"
  • Set "show whitespace characters" to check

Colors

To highlight some the parts of the code with stronger colors, follow this steps:

  • Go to "Toolbar --> window --> preferences --> general --> editors --> text editors --> annotations "
    • On the list find "java scrip occurrences" and set the color value to "#FFFF5A"
    • On the list find "matching tags" and set the color value to "#FFFF5A"
    • On the list find "php elements read occurrences" and set the color value to "#FFFF5A"
  • Go to "Toolbar --> window --> preferences --> general --> editors --> structured text editor"
    • Find the list "Appearance color options"
    • On the list find "Matching brackets highlight" and set the color value to "#0000FF"
  • Go to "Toolbar --> window --> javascript --> editor"
    • Find the list "Appearance color options"
    • On the list find "Matching brackets highlight" and set the color value to "#0000FF"

code folding

code cleaning

Fine tuning