adalm pluto

Creating of PHP Portlet isn’t an easy mission as no standard specification created for. However, when it comes to make an integration between PHP and Java you may mainly would like to:

创建PHP Portlet并非易事，因为没有为其创建标准规范。 但是，当要在PHP和Java之间进行集成时，您可能主要希望：

• Execute Java code inside a PHP pages. (Using of Java Bridge, To be Discussed Later On).在PHP页面内执行Java代码。 （ 使用Java Bridge，稍后再讨论 ）。
• Execute a PHP page by a Java-based container (JVM). (Using of Quercus Library).通过基于Java的容器（JVM）执行PHP页面。 （ 使用Quercus库 ）。

Actually, this tutorial is intended to cover the second choice as the first one would be discussed later on. Practically, you may find a links inside Apache Pluto site referring for PHP bridge, but unfortunately, it’s considered as obsolete API, thus is no longer available. You won’t be able to locate any of these mentioned libraries neither as a JAR nor as a Maven libraries.

实际上，本教程旨在涵盖第二种选择，因为稍后将讨论第一种选择。 实际上，您可能会在Apache Pluto站点内找到一个指向PHP桥的链接，但不幸的是，它被视为过时的API，因此不再可用。 您将无法以JAR或Maven库的形式找到任何上述库。

This tutorial will provide you a kind of integration that you may find it very helpful way to leverage a PHP code inside your Portlet application. We’re going to orchestrate the Portlet, Servlet and PHP pages for achieving employee registration process like we did in Developing Portlets with JSPs & Servlets Tutorial.

本教程将为您提供一种集成，您可能会发现它是在Portlet应用程序中利用PHP代码的非常有用的方法。 我们将对Portlet，Servlet和PHP页面进行编排，以实现员工注册过程，就像我们在使用JSP和Servlets开发Portlet教程中所做的那样。

For executing a PHP pages inside a JVM, we’ve used a Quercus library which is considered as a Java-based implementation for PHP language. It’s already contained for a lot of PHP modules and extensions like PDF, MySQL, JSON, etc.

为了在JVM中执行PHP页面，我们使用了Quercus库，该库被视为PHP语言的基于Java的实现。 许多PHP模块和扩展（例如PDF，MySQL，JSON等）已经包含了它。

However, the assumed employee registration example will adhere the MVC concept while it handles the client request by using Standard Portlet and delegate it into the desired view (PHP pages), once the user has activated a registration action, the submitted form should be handled by the business Servlet that’s already created for this purpose and the employee should be registered after then.

但是，假设的员工注册示例将在使用标准Portlet处理客户请求并将其委托到所需视图（PHP页面）的过程中遵循MVC概念，一旦用户激活了注册操作，提交的表单应由以下方式处理：为此已经创建的业务Servlet，然后应注册员工。

A confirmation message should be displayed once the registration operation finished successfully. In case you’ve got an exception, an error message should be displayed contained for the reason of happened error.

注册操作成功完成后，将显示一条确认消息。 万一您遇到异常，出于发生错误的原因，应显示一条错误消息。

Either the operation has been finished successfully or not, the user will be able to navigate again into the registration employee view for another trial.

无论操作是否成功完成，用户都可以再次导航到注册员工视图中以进行另一次试用。

员工表 (Employee Table)

This section will show you the Employee Table that’s used for retaining the registered employees.

本节将向您显示用于保留注册员工的员工表。

employee.sql

employee.sql

CREATE TABLE `employee` (`EMP_ID` int(11) NOT NULL AUTO_INCREMENT,`EMP_NAME` varchar(45) DEFAULT NULL,`EMP_JOB` varchar(45) DEFAULT NULL,`EMP_SALARY` int(11) DEFAULT NULL,PRIMARY KEY (`EMP_ID`)
) ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8;

员工模式 (Employee Model)

Accordingly, an Employee object model should be defined for holding the employee’s information that’s going back and forth in the registration process.

因此，应该定义一个Employee对象模型来保存在注册过程中来回传递的员工信息。

Employee.java

Employee.java

package com.journaldev.data;public class Employee {private int id;private String name;private String job;private int salary;public int getId() {return id;}public void setId(int id) {this.id = id;}public String getName() {return name;}public void setName(String name) {this.name = name;}public String getJob() {return job;}public void setJob(String job) {this.job = job;}public int getSalary() {return salary;}public void setSalary(int salary) {this.salary = salary;}
}

PHP视图 (PHP Views)

Similar for the example was provided for JSP, the view should be handled by using a set of PHP pages. Mainly, we have a three different views, employee registration, success confirmation and failure confirmation are the only views you would deal with for handling the employee registration process.

与为JSP提供的示例类似，应使用一组PHP页面来处理视图。 主要地，我们有三种不同的视图，员工注册，成功确认和失败确认是您处理员工注册过程时要处理的唯一视图。

register.php

register.php

<?php
$actionUrl = "?";
$renderUrl = "?";foreach($_GET as $key=>$val){if($key == "actionUrl"){$actionUrl = $val;}
}
?>
<html><body><form action="<?php echo $actionUrl?>" method="POST"><table><tr><td>Enter ID:</td><td><input name="employeeID"/></td></tr><tr><td>Enter name:</td><td><input name="employeeName"/></td></tr><tr><td>Enter job:</td><td><input name="employeeJob"/></td></tr><tr><td>Enter salary:</td><td><input name="employeeSalary"/></td></tr><tr><td colspan="2"><input type="submit" value="Register"/></td></tr></table></form></body>
</html>

success.php

success.php

<?php $renderUrl = "?";foreach($_GET as $key=>$val){if($key == "renderUrl"){$renderUrl = $val;}
}
?>
<html><body><table><tr><td>Congratulations, employee registration operation has been finished successfully !</td></tr></table><a href="<?php echo $renderUrl?>">Register Another</a></body>
</html>

failure.php

failure.php

<?php $renderUrl = "?";
$exception = "?";foreach($_GET as $key=>$val){if($key == "renderUrl"){$renderUrl = $val;}else if($key == "exception"){$exception = $val;}
}
?>
<html><body><table><tr><td><span style="color: red;">Unfortunately, employee registration operation hasn't been finished successfully !</span></td></tr><tr><td>For cause:<?php echo $exception?></td></tr></table><a href="<?php echo $renderUrl?>">Try Again</a></body>
</html>

Just, want you notice that we have a PHP code snippets in the provided views and these will absolutely be handled by the used JVM (i.e. Apache Pluto).

只是，希望您注意到我们在提供的视图中有一个PHP代码段，这些代码段将完全由使用的JVM（即Apache Pluto）处理。

Portlet部署描述符 (Portlet Deployment Descriptor)

Find below the portlet.xml file that would help your Portlet container recognize your Portlets.

在portlet.xml文件下面找到可帮助您的Portlet容器识别您的Portlet的文件。

portlet.xml

portlet.xml

<?xml version="1.0" encoding="UTF-8"?><portlet-app xmlns="https://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"version="2.0" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="https://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"><portlet><display-name>Register Employee</display-name><portlet-name>RegisterEmployee</portlet-name><portlet-class>com.journaldev.portlet.RegisterEmployeePortlet</portlet-class><description>Employee Registration</description><supports><mime-type>text/html</mime-type><portlet-mode>VIEW</portlet-mode></supports><portlet-info><title>Employee Registration</title><keywords>employee, registration</keywords><short-title>Employee Registration</short-title></portlet-info></portlet>
</portlet-app>

As you’ve mentioned, no additional fragments used as being the developed Portlet is a standard one.

正如您已经提到的那样，用作开发的Portlet的其他片段都不是标准片段。

注册员工门户 (Register Employee Portlet)

RegisterEmployeePortlet.java

RegisterEmployeePortlet.java

package com.journaldev.portlet;import java.io.IOException;import javax.portlet.ActionRequest;
import javax.portlet.ActionResponse;
import javax.portlet.GenericPortlet;
import javax.portlet.PortletException;
import javax.portlet.PortletRequestDispatcher;
import javax.portlet.RenderRequest;
import javax.portlet.RenderResponse;public class RegisterEmployeePortlet extends GenericPortlet{public void doView(RenderRequest request, RenderResponse response) throws PortletException, IOException {if(request.getParameter("status") == null){PortletRequestDispatcher dispatcher = this.getPortletContext().getRequestDispatcher("/register/register.php?actionUrl="+response.createActionURL());dispatcher.include(request, response);}else {if(request.getParameter("status").equals("success")){PortletRequestDispatcher dispatcher = this.getPortletContext().getRequestDispatcher("/register/success.php?renderUrl="+response.createRenderURL());dispatcher.include(request, response);}else {PortletRequestDispatcher dispatcher = this.getPortletContext().getRequestDispatcher("/register/failure.php?renderUrl="+response.createRenderURL()+"&exception="+request.getParameter("exception"));dispatcher.include(request, response);}}}public void processAction(ActionRequest request, ActionResponse response) throws PortletException, IOException{// Create request dispatcherPortletRequestDispatcher dispatcher =  this.getPortletContext().getNamedDispatcher("RegisterEmployeeServlet");try {// Includedispatcher.include(request, response);// Set render parameterresponse.setRenderParameter("status", "success");}catch(Exception ex){// Set render parameterresponse.setRenderParameter("status", "failed");response.setRenderParameter("exception", ex.getMessage());}}
}

注册员工Servlet (Register Employee Servlet)

RegisterEmployeeServlet.java

RegisterEmployeeServlet.java

package com.journaldev.servlet;import java.io.IOException;import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;import org.apache.log4j.Logger;import com.journaldev.dao.EmployeeDAO;
import com.journaldev.data.Employee;public class RegisterEmployeeServlet extends HttpServlet {private static final long serialVersionUID = 1L;Logger logger = Logger.getLogger(RegisterEmployeeServlet.class);public RegisterEmployeeServlet() {super();}protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {// Create employeeEmployee employee = new Employee();// Fill in required data from the request sentemployee.setId(Integer.parseInt(request.getParameter("employeeID")));employee.setName(request.getParameter("employeeName"));employee.setJob(request.getParameter("employeeJob"));employee.setSalary(Integer.parseInt(request.getParameter("employeeSalary")));try {// Asking employeeDAO creating the employee against registered databaseEmployee createdEmployee = EmployeeDAO.getInstance().createEmployee(employee);// Print out the created employee informationlogger.info("Employee Created"+createdEmployee);} catch (Exception e) {// Log the exceptionlogger.error("Employee Creation Failed", e);// Throw another exception for notifying the Portletthrow new ServletException(e);}}}

部署描述符和Maven构建文件 (Deployment Descriptor & Maven Build File)

As we’ve stated earlier, Quercus is used for interpreting the PHP code inside your JVM, thus, below Maven file will be included for the all needed libraries that you need for executing a PHP code inside your JVM.

如前所述， Quercus用于解释JVM内部PHP代码，因此，在Maven文件下面将包含在JVM内部执行PHP代码所需的所有必需库。

pom.xml

pom.xml

<project xmlns="https://maven.apache.org/POM/4.0.0" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="https://maven.apache.org/POM/4.0.0 https://maven.apache.org/maven-v4_0_0.xsd"><modelVersion>4.0.0</modelVersion><groupId>com.journaldev</groupId><artifactId>PHPBridge</artifactId><packaging>war</packaging><version>0.0.1-SNAPSHOT</version><name>PHPBridge</name><url>https://maven.apache.org</url><properties><deployFolder>D:/Apache Pluto/pluto-2.0.3/webapps</deployFolder></properties><repositories><repository><id>caucho</id><name>Caucho</name><url>https://caucho.com/m2</url><layout>default</layout><snapshots><enabled>false</enabled></snapshots></repository></repositories><dependencies><!-- Java Portlet Specification V2.0 --><dependency><groupId>org.apache.portals</groupId><artifactId>portlet-api_2.0_spec</artifactId><version>1.0</version><scope>provided</scope></dependency><dependency><groupId>javax.servlet</groupId><artifactId>servlet-api</artifactId><version>2.4</version><scope>provided</scope></dependency><dependency><groupId>javax.servlet</groupId><artifactId>jsp-api</artifactId><version>2.0</version><scope>provided</scope></dependency><dependency><groupId>commons-fileupload</groupId><artifactId>commons-fileupload</artifactId><version>1.3</version></dependency><dependency><groupId>log4j</groupId><artifactId>log4j</artifactId><version>1.2.17</version></dependency><dependency><groupId>org.apache.pluto</groupId><artifactId>pluto-taglib</artifactId><version>1.1.7</version></dependency><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>5.1.32</version></dependency><dependency><groupId>com.caucho</groupId><artifactId>resin</artifactId><version>4.0.30</version></dependency></dependencies><build><finalName>${project.artifactId}</finalName><plugins><!-- bind 'pluto2:assemble' goal to 'process-resources' lifecycle --><!-- This plugin will read your portlet.xml and web.xml and injects requiredlines --><plugin><groupId>org.apache.portals.pluto</groupId><artifactId>maven-pluto-plugin</artifactId><version>2.1.0-M3</version><executions><execution><phase>generate-resources</phase><goals><goal>assemble</goal></goals></execution></executions></plugin><!-- configure maven-war-plugin to use updated web.xml --><!-- This plugin will make sure your WAR will contain the updated web.xml --><plugin><artifactId>maven-war-plugin</artifactId><version>2.1.1</version><configuration><webXml>${project.build.directory}/pluto-resources/web.xml</webXml></configuration></plugin><plugin><artifactId>maven-antrun-plugin</artifactId><executions><execution><id>copy</id><phase>integration-test</phase><configuration><tasks><copy file="target/${project.artifactId}.war" tofile="${deployFolder}/${project.artifactId}.war" /></tasks></configuration><goals><goal>run</goal></goals></execution><execution><id>delete</id><phase>clean</phase><configuration><tasks><delete file="${deployFolder}/${project.artifactId}.war" /><delete dir="${deployFolder}/${project.artifactId}" /></tasks><detail>true</detail></configuration><goals><goal>run</goal></goals></execution></executions></plugin><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-compiler-plugin</artifactId><version>3.1</version><configuration><source>1.6</source><target>1.6</target></configuration></plugin></plugins></build>
</project>

You should notice that you are provided resin library that would be used for interpreting PHP purpose. Actually, a QuercusServlet will do that and so, you must configure it inside your web deployment descriptor. So we added it inside our deployment descriptor that should look like below:

您应该注意，已提供了用于解释PHP目的的树脂库。 实际上， QuercusServlet可以做到这一点，因此，您必须在Web部署描述符中对其进行配置。 因此，我们将其添加到了部署描述符中，该描述符应如下所示：

web.xml

web.xml

<!DOCTYPE web-app PUBLIC"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN""https://java.sun.com/dtd/web-app_2_3.dtd" ><web-app><display-name>Employee Registration</display-name><servlet><servlet-class>com.journaldev.servlet.RegisterEmployeeServlet</servlet-class><servlet-name>RegisterEmployeeServlet</servlet-name></servlet><servlet-mapping><servlet-name>RegisterEmployeeServlet</servlet-name><url-pattern>/registerEmployeeServlet</url-pattern></servlet-mapping><taglib><taglib-uri>https://java.sun.com/portlet</taglib-uri><taglib-location>/WEB-INF/portlet.tld</taglib-location></taglib><servlet><servlet-name>Quercus Servlet</servlet-name><servlet-class>com.caucho.quercus.servlet.QuercusServlet</servlet-class></servlet><servlet-mapping><servlet-name>Quercus Servlet</servlet-name><url-pattern>*.php</url-pattern></servlet-mapping>
</web-app>

As you’ve noticed, any request for a PHP resources should trigger the Quercus Servlet to handle the initiated request. This Servlet will read the requested resource and make its interpretation operation to return a pure HTML code for your browser.

您已经注意到，对PHP资源的任何请求都应触发Quercus Servlet来处理已发起的请求。 该Servlet将读取请求的资源并进行解释操作，以为您的浏览器返回纯HTML代码。

EmployeeDAO和ConnectionUtility (EmployeeDAO and ConnectionUtility)

For seeking simplicity, we’ve developed EmployeeDAO and ConnectionUtility classes for handling all database operations.

为了寻求简单性，我们开发了EmployeeDAO和ConnectionUtility类来处理所有数据库操作。

ConnectionUtility.java

ConnectionUtility.java

package com.journaldev.dao.utility;import java.io.IOException;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.SQLException;
import java.util.Properties;public class ConnectionUtility {private static ConnectionUtility connectionUtiliy = null;private Connection connection = null;private ConnectionUtility() {}public static ConnectionUtility getInstance() throws IOException, IllegalAccessException, SQLException, ClassNotFoundException{// Synchronized against connectionUtility instancesynchronized(ConnectionUtility.class){// Check whether the connectionUtility is null or notif(connectionUtiliy == null){// Create a properties instanceProperties properties = new Properties();// Load properties from classpathproperties.load(Thread.currentThread().getContextClassLoader().getResourceAsStream("connection.properties"));// Set connection with connectionUtilityconnectionUtiliy = new ConnectionUtility();// Load driver classClass.forName("com.mysql.jdbc.Driver");// Create connectionconnectionUtiliy.setConnection(DriverManager.getConnection("jdbc:mysql://localhost:3306/journaldev", properties));}return connectionUtiliy;}}public Connection getConnection() throws ClassNotFoundException, SQLException, IOException {if(connection.isClosed()){// Create a properties instanceProperties properties = new Properties();// Load properties from classpathproperties.load(Thread.currentThread().getContextClassLoader().getResourceAsStream("connection.properties"));// Load driver classClass.forName("com.mysql.jdbc.Driver");// Create connectionconnectionUtiliy.setConnection(DriverManager.getConnection("jdbc:mysql://10.10.90.3:3306/journaldev", properties));}return connection;}public void setConnection(Connection connection) {this.connection = connection;}}

EmployeeDAO.java

EmployeeDAO.java

package com.journaldev.dao;import java.io.IOException;
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.SQLException;import com.journaldev.dao.utility.ConnectionUtility;
import com.journaldev.data.Employee;public class EmployeeDAO {public static EmployeeDAO employeeDAO = null;private EmployeeDAO(){}public static EmployeeDAO getInstance(){synchronized(EmployeeDAO.class){if(employeeDAO == null){employeeDAO = new EmployeeDAO();}}return employeeDAO;}public Employee createEmployee(Employee employee) throws SQLException, IllegalAccessException, IOException, ClassNotFoundException{// Get connection instanceConnection connection = ConnectionUtility.getInstance().getConnection();// Create Prepared StatementPreparedStatement query = connection.prepareStatement("INSERT INTO EMPLOYEE VALUES (?,?,?,?)");// Set variablesquery.setInt(1, employee.getId());query.setString(2, employee.getName());query.setString(3, employee.getJob());query.setInt(4, employee.getSalary());try {// Executequery.execute();// Return employee instancereturn employee;}catch(Exception e){// Close statementquery.close();// Close connectionconnection.close();// Throw another exception for notifying the Servletthrow new SQLException(e);}}public boolean deleteEmployee(Employee employee){return false;}public boolean updateEmployee(Employee employee, int employeeId){return false;}
}

员工注册演示 (Employee Registration Demo)

Now, it’s time to see what’s the result of code developed above, but before getting into, you should create a Portal page named JournalDev and you must deploy your WAR into your Apache Pluto Portlet container after then. If you’ve not tried that before, it’s important for you to return back into our Apache Pluto Introduction to know how you can achieve these important tasks.

现在，该看一下上面开发的代码的结果了，但是在进入之前，您应该创建一个名为JournalDev的门户页面，并且在此之后必须将WAR部署到您的Apache Pluto Portlet容器中。 如果您以前没有尝试过，那么对您来说，返回到我们的Apache Pluto简介以了解如何完成这些重要任务非常重要。

And when you try to register another employee with the same ID, you should face the following error:

并且，当您尝试注册具有相同ID的另一名员工时，您将面临以下错误：

摘要 (Summary)

Apache Pluto hasn’t provided you the way in which you can integrate your PHP views with its Portlet container. This tutorial is a good trial from JournalDev to make this possible by orchestrate different parties help you achieving that. Contribute us by commenting below and find downloaded source code.

Apache Pluto尚未为您提供将PHP视图与其Portlet容器集成的方式。 本教程是JournalDev的一个很好的尝试，它可以通过协调各方来帮助您实现这一目标。 通过在下面评论来贡献我们，并找到下载的源代码。

翻译自: https://www.journaldev.com/5095/apache-pluto-php-integration-example-tutorial

adalm pluto