class.phpwsdlmethod.php

Ir para a documentação deste ficheiro.

<?php
 
/*
PhpWsdl - Generate WSDL from PHP
Copyright (C) 2011  Andreas Zimmermann, wan24.de 
 
This program is free software; you can redistribute it and/or modify it under 
the terms of the GNU General Public License as published by the Free Software 
Foundation; either version 3 of the License, or (at your option) any later 
version. 
 
This program is distributed in the hope that it will be useful, but WITHOUT 
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. 
 
You should have received a copy of the GNU General Public License along with 
this program; if not, see <http://www.gnu.org/licenses/>.
*/
 
if(basename($_SERVER['SCRIPT_FILENAME'])==basename(__FILE__))
    exit;
 
PhpWsdl::RegisterHook('InterpretKeywordpw_omitfncHook','internal','PhpWsdlMethod::InterpretOmit');
PhpWsdl::RegisterHook('InterpretKeywordignoreHook','internal','PhpWsdlMethod::InterpretOmit');
PhpWsdl::RegisterHook('InterpretKeywordpw_setHook','internal','PhpWsdlMethod::InterpretSetting');
PhpWsdl::RegisterHook('CreateObjectHook','internalmethod','PhpWsdlMethod::CreateMethodObject');
 
class PhpWsdlMethod extends PhpWsdlObject{
    public $Param=Array();
    public $Return=null;
    public $IsGlobal=false;
    public static $IsGlobalDefault=false;
 
    public function PhpWsdlMethod($name,$param=null,$return=null,$settings=null){
        self::__construct($name, $param, $return, $settings);
    }
 
    public function __construct($name,$param=null,$return=null,$settings=null){
        PhpWsdl::Debug('New method '.$name);
        parent::__construct($name,$settings);
        if(!is_null($param))
            $this->Param=$param;
        $this->Return=$return;
        $this->IsGlobal=self::$IsGlobalDefault;
        if(!is_null($settings))
            if(isset($settings['global']))
                $this->IsGlobal=$settings['global']=='true'||$settings['global']=='1';
    }
 
    public function CreatePortType($pw){
        PhpWsdl::Debug('Create WSDL port type for method '.$this->Name);
        $res=Array();
        $res[]='<wsdl:operation name="'.$this->Name.'"';
        $o=sizeof($res)-1;
        $pLen=sizeof($this->Param);
        if($pLen>1){
            $temp=Array();
            $i=-1;
            while(++$i<$pLen)
                $temp[]=$this->Param[$i]->Name;
            $res[$o].=' parameterOrder="'.implode(' ',$temp).'"';
        }
        $res[$o].='>';
        if($pw->IncludeDocs&&!$pw->Optimize&&!is_null($this->Docs))
            $res[]='<wsdl:documentation><![CDATA['.$this->Docs.']]></wsdl:documentation>';
        $res[]='<wsdl:input message="tns:'.$this->Name.'SoapIn" />';
        $res[]='<wsdl:output message="tns:'.$this->Name.'SoapOut" />';
        $res[]='</wsdl:operation>';
        return implode('',$res);
    }
 
    public function CreateBinding($pw){
        PhpWsdl::Debug('Create WSDL binding for method '.$this->Name);
        $res=Array();
        $res[]='<wsdl:operation name="'.$this->Name.'">';
        $res[]='<soap:operation soapAction="'.$pw->NameSpace.$this->Name.'" />';
        $res[]='<wsdl:input>';
        $res[]='<soap:body use="encoded" encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" namespace="'.$pw->NameSpace.'"';
        $pLen=sizeof($this->Param);
        if($pLen>0){
            $temp=Array();
            $i=-1;
            while(++$i<$pLen)
                $temp[]=$this->Param[$i]->Name;
            $res[sizeof($res)-1].=' parts="'.implode(' ',$temp).'"';
        }
        $res[sizeof($res)-1].=' />';
        $res[]='</wsdl:input>';
        $res[]='<wsdl:output>';
        $res[]='<soap:body use="encoded" encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" namespace="'.$pw->NameSpace.'"';
        if(!is_null($this->Return))
            $res[sizeof($res)-1].=' parts="'.$this->Return->Name.'"';
        $res[sizeof($res)-1].=' />';
        $res[]='</wsdl:output>';
        $res[]='</wsdl:operation>';
        return implode('',$res);
    }
    
    public function CreateMessages($pw){
        PhpWsdl::Debug('Create WSDL message for method '.$this->Name);
        $pLen=sizeof($this->Param);
        $res=Array();
        // Request
        if($pLen<1){
            $res[]='<wsdl:message name="'.$this->Name.'SoapIn" />';
        }else{
            $res[]='<wsdl:message name="'.$this->Name.'SoapIn">';
            $i=-1;
            while(++$i<$pLen)
                $res[]=$this->Param[$i]->CreatePart($pw);
            $res[]='</wsdl:message>';
        }
        // Response
        if(is_null($this->Return)){
            $res[]='<wsdl:message name="'.$this->Name.'SoapOut" />';
        }else{
            $res[]='<wsdl:message name="'.$this->Name.'SoapOut">';
            $res[]=$this->Return->CreatePart($pw);
            $res[]='</wsdl:message>';
        }
        return implode('',$res);
    }
    
    public function GetParam($name){
        PhpWsdl::Debug('Find parameter '.$name);
        $i=-1;
        $len=sizeof($this->Param);
        while(++$i<$len)
            if($this->Param[$i]->Name==$name){
                PhpWsdl::Debug('Found parameter at index '.$i);
                return $this->Param[$i];
            }
        return null;
    }
    
    public function CreateMethodHtml($data){
        PhpWsdl::Debug('CreateMethodHtml for '.$data['method']->Name);
        $res=&$data['res'];
        $m=&$data['method'];
        $res[]='<h3>'.$m->Name.'</h3>';
        $res[]='<a name="'.$m->Name.'"></a>';
        $res[]='<p class="pre">';
        $o=sizeof($res)-1;
        if(!is_null($m->Return)){
            $type=$m->Return->Type;
            if(in_array($type,PhpWsdl::$BasicTypes)){
                $res[$o].='<span class="blue">'.$type.'</span>';
            }else{
                $res[$o].='<a href="#'.$type.'"><span class="lightBlue">'.$type.'</span></a>';
            }
        }else{
            $res[$o].='void';
        }
        $res[$o].=' <span class="bold">'.$m->Name.'</span> (';
        $pLen=sizeof($m->Param);
        $spacer='';
        if($pLen>1){
            $res[$o].='<br>';
            $spacer='&nbsp;&nbsp;&nbsp;&nbsp;';
        }
        $hasDocs=false;
        if($pLen>0){
            $j=-1;
            while(++$j<$pLen){
                $p=$m->Param[$j];
                if(in_array($p->Type,PhpWsdl::$BasicTypes)){
                    $res[]=$spacer.'<span class="blue">'.$p->Type.'</span> <span class="bold">'.$p->Name.'</span>';
                }else{
                    $res[]=$spacer.'<a href="#'.$p->Type.'"><span class="lightBlue">'.$p->Type.'</span></a> <span class="bold">'.$p->Name.'</span>';
                }
                $o=sizeof($res)-1;
                if($j<$pLen-1)
                    $res[$o].=', ';
                if($pLen>1)
                    $res[$o].='<br>';
                if(!$hasDocs)
                    if(!is_null($p->Docs))
                        $hasDocs=true;
            }
        }
        $res[].=')</p>';
        // Method documentation
        if(!is_null($m->Docs))
            $res[]='<p>'.nl2br(htmlentities($m->Docs)).'</p>';
        // Parameters documentation
        if($hasDocs){
            $res[]='<ul>';
            $j=-1;
            while(++$j<$pLen)
                $m->Param[$j]->CreateParamHtml(array_merge(
                        $data,
                        Array(
                            'param'         =>  $m->Param[$j]
                        )
                    )
                );
            $res[]='</ul>';
        }
        // Return value documentation
        if(!is_null($m->Return)&&!is_null($m->Return->Docs))
            $m->Return->CreateReturnHtml($data);
        PhpWsdl::CallHook(
            'CreateMethodHtmlHook',
            $data
        );
    }
    
    public function CreateMethodPhp($data){
        $server=$data['server'];
        $res=&$data['res'];
        $res[]="\t/**";
        if(!is_null($this->Docs)){
            $res[]="\t * ".implode("\n\t * ",explode("\n",$this->Docs));
            $res[]="\t *";
        }
        $param=Array();
        $i=-1;
        $pLen=sizeof($this->Param);
        while(++$i<$pLen){
            $p=$this->Param[$i];
            $param[]='$'.$p->Name;
            $res[]="\t * @param ".$p->Type." \$".$p->Name.((!is_null($p->Docs))?" ".implode("\n\t * ",explode("\n",$p->Docs)):"");
        }
        if(!is_null($this->Return)){
            $res[]="\t * @return ".$this->Return->Type.((!is_null($this->Return->Docs))?" ".implode("\n\t * ",explode("\n",$this->Return->Docs)):"");
        }
        $res[]="\t */";
        $res[]="\tpublic function ".$this->Name."(".implode(',',$param)."){";
        if(PhpWsdl::CallHook(
                'CreateMethodPhpHook',
                array_merge(
                    $data,
                    Array(
                        'method'        =>  $this
                    )
                )
            )
        ){
            $res[]="\t\treturn self::_Call('".$this->Name."',Array(";
            if($pLen>0)
                $res[]="\t\t\t".implode(",\n\t\t\t",$param);
            $res[]="\t\t));";
        }
        $res[]="\t}";
    }
    
    public static function InterpretSetting($data){
        $info=explode(' ',$data['keyword'][1],2);
        if(sizeof($info)<1)
            return true;
        PhpWsdl::Debug('Interpret setting '.$info[0]);
        $info=explode('=',$info[0],2);
        if(sizeof($info)>1){
            $data['settings'][$info[0]]=$info[1];
        }else if(isset($data['settings'][$info[0]])){
            unset($data['settings'][$info[0]]);
        }
        return false;
    }
    
    public static function InterpretOmit($data){
        PhpWsdl::Debug('Interpret omitfnc/ignore');
        $data['omit']=true;
        return true;
    }
    
    public static function CreateMethodObject($data){
        if(!is_null($data['obj']))
            return true;
        if($data['method']=='')
            return true;
        if(!is_null($data['type']))
            return true;
        PhpWsdl::Debug('Add method '.$data['method']);
        $server=$data['server'];
        if(!is_null($server->GetMethod($data['method']))){
            PhpWsdl::Debug('WARNING: Double method detected!');
            return true;
        }
        if($server->ParseDocs)
            if(!is_null($data['docs']))
                $data['settings']['docs']=$data['docs'];
        $data['obj']=new PhpWsdlMethod($data['method'],$data['param'],$data['return'],$data['settings']);
        $data['settings']=Array();
        $server->Methods[]=$data['obj'];
        return true;
    }
}