The Bakery Everything CakePHP

Thanks for the article.

I am getting the following error after following this tutorial:


Notice (8): Undefined offset:  1 [CORE\app\vendors\wshelper\lib\soap\IPReflectionCommentParser.class.php, line 136]

I am using:
cake 1.2.0.5875 pre-beta
php 5.2.3
jool.nl webservices helper 1.5.0


It appears to throw an error when it attempts to generate the wsdl file for the first time from the ->setService($refl) call on line 64 of the soap.php component:


60            $wsdlStruct = new WSDLStruct('http://schema.example.com', 
61                                         $serviceURL . '/' . $modelId, 
62                                         SOAP_RPC, 
63                                         SOAP_LITERAL);
64            $wsdlStruct->setService($refl);
65            try {
66                $wsdl = $wsdlStruct->generateDocument();
67                // cache($cachePath, $wsdl, $expireTime);
68            } catch (WSDLException $exception) {

Any ideas?

NSM

Just curious if anyone has implemented this tutorial successfully...

I make SOAP service, but with authorization(SOAP headers) and handler - controller and i have problems with it.
http://groups.google.com/group/cake-php/browse_thread/thread/1856af46a3589303#

Hi,

I have a problem loading the vendor... i'm using CakePHP 1.2 RC3...

can anyone help me...

Hi,

I have a problem loading the vendor... i'm using CakePHP 1.2 RC3...

can anyone help me...
Dude, did you see this?
http://book.cakephp.org/view/538/Loading-Vendor-Files

I've just used this with cake 1.2 and it works fine.

I did have to change a couple of things.

1) Vendor imports

App::import('Vendor', 'IPReflectionClass', array('file' => 'wshelper' . DS . 'lib' . DS . 'soap' . DS . 'IPReflectionClass.class.php'));
App::import('Vendor', 'IPReflectionCommentParser', array('file' => 'wshelper' . DS . 'lib' . DS . 'soap' . DS . 'IPReflectionCommentParser.class.php'));
App::import('Vendor', 'IPXMLSchema', array('file' => 'wshelper' . DS . 'lib' . DS . 'soap' . DS . 'IPXMLSchema.class.php'));
App::import('Vendor', 'IPReflectionMethod', array('file' => 'wshelper' . DS . 'lib' . DS . 'soap' . DS . 'IPReflectionMethod.class.php'));
App::import('Vendor', 'WSDLStruct', array('file' => 'wshelper' . DS . 'lib' . DS . 'soap' . DS . 'WSDLStruct.class.php'));
App::import('Vendor', 'WSDLException', array('file' => 'wshelper' . DS . 'lib' . DS . 'soap' . DS . 'WSDLException.class.php'));
2) If debug is 2 the xml output is not valid so i turned it off in the controller

function afterFilter()
{
    if (Configure::read('debug') > 1){
        Configure::write('debug', 0);
    }
}
I also found a couple of things that you might want to consider mentioning or changing

1) The WSDL file generated makes references to the http://schema.example.com namespace.

An alternative would be

$wsdlStruct = new WSDLStruct(Router::url('/', true),
                    $serviceURL . '/' . $modelId,
                    SOAP_RPC,
                    SOAP_LITERAL);
2) The line that saves the generated WSDL file in cache is commented

//cache($cachePath, $wsdl, $expireTime);
Thanks again for the component, it integrates nicely with cakephp.

Ok, I don't know what I'm missing here. I've followed these directions and it works perfectly with Max's recommended changes. However, if I change the code, presumably to actually use it for something useful, things break.. Even little changes. Take the model:

Model Class:

<?php 

        function divide($a, $b)
        {
                if ($b != 0) {
                        return $a / $b;
                }
                return 0;
        }
?>
if I change it to:

Model Class:

<?php 
        function divide($a, $c)
        {
                if ($c != 0) {
                        return $a / $c;
                }
                return 0;
        }
?>

It doesn't work. It returns 0 everytime. In fact, if I just return $c in that example, it returns null. It's worth mentioning that the wsdl IS rendered properly requesting a 'c' var instead of a 'b' var. The soap request changed to 'c' looks good too:


<SOAP-ENV:Body>
    <m:divide xmlns:m="http://www.example.com/">
      <a xsi:type="xsd:float">5</a>
      <c xsi:type="xsd:float">6</c>
    </m:divide>
</SOAP-ENV:Body>


I'm not sure what I'm missing here..

Now I added a function to the model:

Model Class:

<?php 
        /**
         * Add two numbers
         *
         * @param float $a
         * @param float $b
         * @return float
         */
        function add($a,$b)
        {
                return $a + $b;
        }
}
?>
Which once again, the WSDL is generated perfectly, but when I make a request I get "Procedure 'add' not present. Am I supposed to register my functions somewhere? That would explain all of this, but in the working example, I don't see the functions or the variables registered. So I'm really confused.

Lastly, and this I'm sure will expose my lack of experience in Cake, why are the functions in the model, and not the controller? I'm not sure how to do all the same controller type actions from the model. Am I missing something?

Thanks!
-Brett

Has anyone had luck implementing custom types and then using it as an array.

eg:
class appointment
{
/** @var float */
public $patient;

/** @var string */
public $time;
}

/**
* Add appointments
*
* @param appointment[] $a
* @return int
*/
function add($a)
{
...
}

I'm trying to send an array of appointments from a C# app. But either get a null passed into param $a or an empty StdClass.

Thanks in advanced.
Alix

Are you getting just one StdClass or an array of empty objects with StdClass?

If its the later then try using a classmap when you instantiate your soap server so that it can map the array objects to your class.
$server = new SoapServer("appointments.wsdl", array("classmap" => array("appointment" => "localAppointmentClass")));

I added the classmap map however now I get an empty Appointment object instead of an array of Appointments.

By the way thanks for the component Charles.


Are you getting just one StdClass or an array of empty objects with StdClass?

If its the later then try using a classmap when you instantiate your soap server so that it can map the array objects to your class.
$server = new SoapServer("appointments.wsdl", array("classmap" => array("appointment" => "localAppointmentClass")));

Can someone post an example of a custom complex type?

Here's what I'm trying, proof of concept style:


        /**
         * List of patients
         *
         * @return string[]
         */
        function getlist() {
                $val=array('one',array('joe','mack','rob'),'three');
                return $val;
        }

This produces:


<SOAP-ENV:Body>
-<ns1:getlistResponse xmlns:ns1="http://schema.example.com">
-<getlistReturn>
-<xsd:string>one</xsd:string>
-<xsd:string>Array</xsd:string>
-<xsd:string>three</xsd:string>
</getlistReturn>
</ns1:getlistResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

I know I probably need to make a class and reference it, but I'm not really sure how to even define the class as a complex type. A small example would go a long way. :)

Thanks,
Brett

Earlier in the comments, people were having problems dealing with parameters, as was I. In the article, the author shows an example model method as this:


    /**
     * Divide two numbers
     *
     * @param float $a
     * @param float $b
     * @return float
     */
    function divide($a, $b)
    {
        if ($b != 0) {
            return $a / $b;
        }
        return 0;
    }

But they probably forgot to mention that the comments appearing above the function are extremely important! The vendor wshelper files must read them to determine the structure of the WSDL. Therefore, if I wanted 4 parameters in my function (name, age, height, weight) and for it to return a string, I would need to put them in the comments, like so:

/**
* Divide two numbers
*
* @param string $name
* @param int $age
* @param int $height
* @param int $weight
* @return string
*/
function divide($name, $age, $height, $weight)
{
// your code
return $mystring;
}


So, in case anyone else couldn't figure that out, it's there now, explicitly stated.

Thanks for this article, it's made soap so much easier for me, I really appreciate your time put into this.

hi,

I recently working with CakePHP and I have to implement a SOAP Server with my models. I have follow all the tutorial, and the comments. But My server can not generate the wdsl xml.

In a first time, I have to add

header('Content-type: text/xml; charset=UTF-8');
in the getWSDL method in the component soap.php. If I do not have this line in this method, the wdsl file is not considered as an xml file but as an html file.

And when I add the type of the content, I get this error:

Erreur d'analyse XML : instruction de traitement XML ou texte pas au début d'une entité externe
Emplacement : http://127.0.0.1/siv/service/wsdl/test
Numéro de ligne 1, Colonne 4 :   <?xml version="1.0"?>
---^
Is there any solution to delete the default line ?

@Matt Mendick
Hi thanks. I've found that the generated xml has three space characters at the beginning of the file. How could I delete them ? I don't really know what file I have to edit.

Hi again - I think there's some confusion with @Charles about who was commenting on what here, not that it makes a big difference to the ultimate decyphering of the code, but the person who posted the comment has their name below the comment, not above it, so I was the one who posted about the @params, and @Kwan Joel was posting about the xml header issues.

To complicate things more, I'll now talk about the xml header issues:

I was also having the problem where the generated text was a valid wsdl (determined by copying and pasting the source into a plain .xml static file, then viewing it with firefox: valid wsdl), but the header was still coming through as text/html on the generated document. I haven't had time to dig through and figure out exactly what is going on, but it seems as if the method showWSDL in WSHelper.class.php is not getting called, as the header() call in that method is not being called, therefore the header is not being set and is defaulting to text/html. So, I "fixed" the problem (at least my problem) by removing the header() call in showWSDL, and adding this line:


header('Content-type: text/xml; charset=UTF-8');

as the first line in the method getWSDL, which is in soap.php (component class).

This seems to work quite well, and I get valid xml, which is shown in "nice form" in firefox.

Now I really have working code, thanks a lot. For people talking about having spaces, I definitely would check all php files involved with the service, to make sure there are no spaces or newlines at the beginning or end of the files (before or after the tags) because that will definitely be causing you troubles.

No problem, thanks for all your work on this.

@Matt Mendick

My bad, I sure was confused :D. Sorry about that.

And when I add the type of the content, I get this error:

Erreur d'analyse XML : instruction de traitement XML ou texte pas au début d'une entité externe
Emplacement : http://127.0.0.1/siv/service/wsdl/test
Numéro de ligne 1, Colonne 4 :   <?xml version="1.0"?>
---^
Is there any solution to delete the default line ?


check if there are any trailing spaces after ?> in your component/controller/model files.
I had some and that caused the same problem

I have checked my model, controller, and component files. And there are one space caracter at the end of the files after ?>. I've deleted them and now it works perfectly. Thanks everyone !

Wsdl cache caused me headache when I was testing my web service while changing return types (objects in particular) - saying no method with that name is available. After I deleted /tmp/wsdl* it started working as expected.