Zend Framework: Zend_Soap Component Proposal

Table of Contents

1. Overview

Zend_Soap is intended as a convenience layer over PHP's SoapServer class. It will allow aggregating configuration options for the SoapServer constructor, error handling, and inspection of requests and responses.

2. References

• PHP SOAP classes
• SOAPServer

3. Component Requirements, Constraints, and Acceptance Criteria

• This component will allow setting SoapServer options individually, en masse, or via the constructor
• This component will allow inspecting the request and response handled
• This component will catch errors and exceptions and report them as SOAP faults

4. Dependencies on Other Framework Components

• SoapServer
• Zend

5. Theory of Operation

Zend_Soap_Server will operate, at its most basic level, exactly like the PHP SoapServer. The key differences are the addition of:

• Ability to set configuration options individually
• Request and response introspection
  • Mimics SoapClient: getLastRequest() and getLastResponse() methods
• Error/exception handling to explicitly throw as SOAP faults
  • Turns display_errors off
  • Traps exceptions from SoapServer::handle() and re-throws them as SoapFaults
  • Registers an internal method as an error handler for E_USER_FATALs, and throws trapped PHP errors as exceptions
  • Has a whitelist approach to exceptions; only registered exception classes may be returned as SoapFaults; all others result in a SoapFault with an 'unknown error' message

6. Milestones / Tasks

• Milestone 1: Initial proposal
• Milestone 2: Code samples and use cases in proposal
• Milestone 3: Proposal acceptance
• Milestone 4: Working prototype checked into the incubator supporting use cases (with unit tests)
• Milestone 5: Initial documentation exists.

7. Class Index

• Zend_Soap_Server

8. Use Cases

9. Class Skeletons