Permalink
Browse files

Update README.md

  • Loading branch information...
1 parent 1015ce2 commit bcb54d6fc6d0ae824137ccf6970ad71a025efc5b @mikaelcom committed Oct 12, 2012
Showing with 14 additions and 14 deletions.
  1. +14 −14 README.md
View
@@ -3,7 +3,7 @@ WsdlToPhp
Generate PHP classes based on a WSDL
-This package allows to programmatically send request to a SOAP service using PHP classes. In order to that, this class generates each class for each request and each request parameters and each request response. Each class is stored in a hierarchical folder/sub-folder. The SOAP client is then abstracted and you only deal with objects representing the WSDL.
+This package allows to programmatically send request to a SOAP service using PHP classes. In order to do that, this class generates each class for each request and each request parameters and each request response. Each class is stored in a hierarchical folder/sub-folder system. The SOAP client is then abstracted and you only deal with objects representing the WSDL types.
It uses eZ Components, ezcPhpGenerator, in order to generate php files.
Tutorial
@@ -14,30 +14,30 @@ This file shows you how to basically instanciate the WsdlToPhp class. This class
The options can be set by two way :
- on the instanciation :
- - by passing an array associating WSdlToPhp constants with the appropriate value
- - by calling the associated WsdlToPhp method to the WSdlToPhp constant
+ - by passing an associative array with WSdlToPhp constants and the appropriate value
+ - by calling the WsdlToPhp methods associated to the WSdlToPhp constants
List of options :
- - WSdlToPhp::OPT_CAT_KEY / WsdlToPhp::setOptionCategory() : used to define the main categorization (hierarchical folders based on a part of the operations' name, splitted using the upper caracters) of generated classes. Possible values :
+ - WSdlToPhp::OPT_CAT_KEY / WsdlToPhp::setOptionCategory() : used to define the main categorization (hierarchical folders based on a part of the operation's name, splitted using the upper caracters) of generated classes. Possible values :
- WSdlToPhp::OPT_CAT_END_NAME : based on the end of the operation name
- WSdlToPhp::OPT_CAT_START_NAME : based on the beginning of the operation name
- WSdlToPhp::OPT_CAT_NONE_NAME : no main categorization
- - WSdlToPhp::OPT_GEN_AUTOLOAD_KEY / WsdlToPhp::setOptionGenerateAutoloadFile() : enable or disable the generation of the autoload file. The autoload file is useless if you have an clever autoloader. Possible values : true or false
+ - WSdlToPhp::OPT_GEN_AUTOLOAD_KEY / WsdlToPhp::setOptionGenerateAutoloadFile() : enable or disable the generation of the autoload file. The autoload file is useless if you have a clever autoloader. Possible values : true or false
- WSdlToPhp::OPT_GEN_TUTORIAL_KEY / WsdlToPhp::setOptionGenerateTutorialFile() : enable or disable the generation of the tutorial/sample file in order to have the starting code to use the generated classes. Possible values : true or false
- WSdlToPhp::OPT_SUB_CAT_KEY / WsdlToPhp::setOptionSubCategory() : same usage than the main categorization except that it's for the sub categorization, usefull if you use the main categorization. Possible values :
- WSdlToPhp::OPT_SUB_CAT_END_NAME : based on the end of the operation name (after the main category)
- WSdlToPhp::OPT_SUB_CAT_START_NAME : based on the beginning of the operation name (before the main category)
- WSdlToPhp::OPT_SUB_CAT_NONE_NAME : no sub categorization
- - WSdlToPhp::OPT_GEN_WSDL_CLASS_KEY / WsdlToPhp::setOptionGenerateWsdlClassFile() : enable or disable the generation og the WsdlClass which will be the main class from which each generated class will inherit. You should always enable this option cause this class has several usefull methods and is the core model to initialize the SoapClient and even more. Possible values : true or false
- - WSdlToPhp::OPT_GATH_METH_KEY / WsdlToPhp::setOptionGatherMethods() : classes are generated to gather operations based on the oprations' name. In order to gather operations based on their name, you decide how the operations must be gathered accordingly to the oprations' name. Its basically the same behaviour than for categorizing the classes by folders. Possible values :
+ - WSdlToPhp::OPT_GEN_WSDL_CLASS_KEY / WsdlToPhp::setOptionGenerateWsdlClassFile() : enable or disable the generation of the WsdlClass which will be the main class from which each generated class will inherit. You should always enable this option cause this class has several usefull methods and is the core model to initialize the SoapClient and even more. Possible values : true or false
+ - WSdlToPhp::OPT_GATH_METH_KEY / WsdlToPhp::setOptionGatherMethods() : classes are generated to gather operations based on the opration's name. In order to gather operations based on their name, you decide how the operations must be gathered accordingly to the operation's name. Its basically the same behaviour than for categorizing the classes by folders. Possible values :
- WSdlToPhp::OPT_GATH_METH_END_NAME : based on the end of the operation name
- WSdlToPhp::OPT_GATH_METH_START_NAME : based on the beginning of the operation name
- - WSdlToPhp::OPT_SEND_PARAM_AS_ARRAY_KEY / WsdlToPhp::setOptionSendArrayAsParameter() : enable or disable the usage of one array containing all the parameters when calling the operation instead of passing as many parameters as the operations ask. Possible values : true or false
- - WSdlToPhp::OPT_RESPONSE_AS_WSDL_OBJECT_KEY / WsdlToPhp::setOptionResponseAsWsdlObject() : enable or disable the instanciation of an object when getting the result in order to have a WsdlClass generated class object. Possible value : true or false
- - WSdlToPhp::OPT_GENERIC_CONSTANTS_NAMES_KEY / WsdlToPhp::setOptionGenericConstantsNames() : enable or disable the usage of generaic name for constants. The constants are generated when you have enumerations in the WSDL. If enabled, instead of having constant caring the value, cleaned, in its name, it is names with an auto-incremental number suffixing a fixed string. Possible values : true or false
- - WSdlToPhp::OPT_INHERITS_FROM_IDENTIFIER_KEY / WsdlToPhp::setOptionInheritsClassIdentifier() : allow to define the name of the possible main structs from which others struct can ihnerit. By default, the inheritance is detected from the WSDL. Possible value : empty string or valid string
- - WSdlToPhp::OPT_SEND_PARAMETERS_AS_ARRAY_KEY / WsdlToPhp::setOptionSendParametersAsArray() : is linked with the WSdlToPhp::OPT_SEND_PARAM_AS_ARRAY_KEY option. These options are usefull when calling Windows Wseb Services as SharePoint. Possible values : true or false
+ - WSdlToPhp::OPT_SEND_PARAM_AS_ARRAY_KEY / WsdlToPhp::setOptionSendArrayAsParameter() : enable or disable the usage of an associative array containing all the parameters identified by their name when calling the operation instead of passing as many parameters as the operations declares. Possible values : true or false
+ - WSdlToPhp::OPT_RESPONSE_AS_WSDL_OBJECT_KEY / WsdlToPhp::setOptionResponseAsWsdlObject() : enable or disable the instanciation of an object when getting the response in order to have a WsdlClass generated class object. Not needed in every case. It depends on the called WebService. Possible value : true or false
+ - WSdlToPhp::OPT_GENERIC_CONSTANTS_NAMES_KEY / WsdlToPhp::setOptionGenericConstantsNames() : enable or disable the usage of generic name for constants. The constants are generated when you have enumerations in the WSDL. If enabled, instead of having constant's name cleaned caring the value in its name, it is named with an auto-incremental intger stringed suffixing a fixed string. Possible values : true or false
+ - WSdlToPhp::OPT_INHERITS_FROM_IDENTIFIER_KEY / WsdlToPhp::setOptionInheritsClassIdentifier() : allow to define the name of the possible main structs from which others struct can ihnerit. By default, the inheritance is automatically detected from the WSDL. Possible value : empty string or valid string
+ - WSdlToPhp::OPT_SEND_PARAMETERS_AS_ARRAY_KEY / WsdlToPhp::setOptionSendParametersAsArray() : is linked with the WSdlToPhp::OPT_SEND_PARAM_AS_ARRAY_KEY option. It ensures that parameters are sent within an array. These options are usefull when calling Windows WebServices such as SharePoint. Possible values : true or false
-I advise you to use the option WSdlToPhp::OPT_GEN_TUTORIAL_KEY. It is very usefull if you want to have the sarting code to use the generated classes.
+I advise you to use the option WSdlToPhp::OPT_GEN_TUTORIAL_KEY. It is very usefull if you want to have the starting code to use the generated classes.
-Feel free to make request for improvements.
+Feel free to make request for improvements.

0 comments on commit bcb54d6

Please sign in to comment.