Why getter is not used for private property in parent class?

[trailsnail]

Hi there,

following #392 (comment) we used the ExtendAssembler while creating classes which must extend from each other. Thsi still doesn't work automatically by given WSDLs.

Now the problem:

class ShipmentDetailsTypeType extends ShipmentDetailsType
{
}

class ShipmentDetailsType {
  /**
     * @var string
     */
    private $product;
}

ShipmentDetailsTypeType is used in Request, but does not have access on private $product;. It seems, that ShipmentDetailsType::getProduct() is not used. Why?

We tried a workaround with PropertyAssembler:

->addRule(new Rules\TypenameMatchesRule(
        new Rules\AssembleRule(new Assembler\PropertyAssembler(\Laminas\Code\Generator\PropertyGenerator::VISIBILITY_PROTECTED)),
        '/^ShipmentDetailsTypeType$/'
    ))

but the properties are still created private.

🆘 😄 What can we do now to get things running?

Kind regards

Here the Error and the example data:

error	data

[veewee]

Have you tried starting from an empty ruleset before adding the property assembler?

Otherwise the default assembler will create the property as private.
Ext-soap uses properties to encode and decode.
The added getters and setters are for end users in order to read from or write to the model.

[trailsnail]

This is our setup for config

<?php

require_once __DIR__.'/../SoapConfig.php';

use DhlApi\SoapConfig;
use Phpro\SoapClient\CodeGenerator\Assembler;
use Phpro\SoapClient\CodeGenerator\Rules;
use Phpro\SoapClient\CodeGenerator\Config\Config;
use Phpro\SoapClient\Soap\Driver\ExtSoap\ExtSoapEngineFactory;

return Config::create()
    ->setEngine($engine = ExtSoapEngineFactory::fromOptions(
        SoapConfig::generateOptionsForUrl('C:\dvl\DefaultWorkspace\kunzmann\soap\config\geschaeftskundenversand-api-3.2.0.wsdl')
    ))
    ->setTypeDestination('soap\Type')
    ->setTypeNamespace('DhlApi\Type')
    ->setClientDestination('soap')
    ->setClientName('DhlClient')
    ->setClientNamespace('DhlApi')
    ->setClassMapDestination('soap')
    ->setClassMapName('DhlClassmap')
    ->setClassMapNamespace('DhlApi')
    ->addRule(new Rules\AssembleRule(new Assembler\GetterAssembler(new Assembler\GetterAssemblerOptions())))
    ->addRule(new Rules\AssembleRule(new Assembler\ImmutableSetterAssembler(
        new Assembler\ImmutableSetterAssemblerOptions()
    )))
    ->addRule(
        new Rules\IsRequestRule(
            $engine->getMetadata(),
            new Rules\MultiRule([
                new Rules\AssembleRule(new Assembler\RequestAssembler()),
                new Rules\AssembleRule(new Assembler\ConstructorAssembler(new Assembler\ConstructorAssemblerOptions())),
            ])
        )
    )
    ->addRule(new Rules\TypenameMatchesRule(
        new Rules\AssembleRule(new Assembler\ExtendAssembler('DhlApi\Type\ShipmentDetailsType')),
        '/^ShipmentDetailsTypeType$/'
    ))
    ->addRule(
        new Rules\IsResultRule(
            $engine->getMetadata(),
            new Rules\MultiRule([
                new Rules\AssembleRule(new Assembler\ResultAssembler()),
            ])
        )
    )
;

I tried to add the propertyAssembler in between, but this doesn't work

[veewee]

The config starts out with a default set of rules, in which the property assembler is configured.
Instead of addRule, you'll need to use setRuleSet and start of with a fresh ruleset instead.

More context:

soap-client/src/Phpro/SoapClient/CodeGenerator/Config/Config.php

Line 73 in e47ea71

$this->ruleSet = new RuleSet([

[trailsnail]

I assume, that all properties then will be protected because I can't set their visibility per class?

[veewee]

You can assemble it per class by using regexes or a map, by using the rule system

[trailsnail]

Thank you very much.

After a few attempts and a little more understanding, I have now achieved the desired result:

• protected properties for one special class
• the rest private like before

Here the final working setup:

<?php

require_once __DIR__.'/../SoapConfig.php';

use DhlApi\SoapConfig;
use Laminas\Code\Generator\PropertyGenerator;
use Phpro\SoapClient\CodeGenerator\Assembler;
use Phpro\SoapClient\CodeGenerator\Rules;
use Phpro\SoapClient\CodeGenerator\Config\Config;
use Phpro\SoapClient\Soap\Driver\ExtSoap\ExtSoapEngineFactory;

return Config::create()
    ->setRuleSet(new Rules\RuleSet([
        new Rules\AssembleRule(new Assembler\ClassMapAssembler()),
        new Rules\AssembleRule(new Assembler\ClientMethodAssembler())
    ]))
    ->setEngine($engine = ExtSoapEngineFactory::fromOptions(
        SoapConfig::generateOptionsForUrl('C:\dvl\DefaultWorkspace\kunzmann\soap\config\geschaeftskundenversand-api-3.2.0.wsdl')
    ))
    ->setTypeDestination('soap\Type')
    ->setTypeNamespace('DhlApi\Type')
    ->setClientDestination('soap')
    ->setClientName('DhlClient')
    ->setClientNamespace('DhlApi')
    ->setClassMapDestination('soap')
    ->setClassMapName('DhlClassmap')
    ->setClassMapNamespace('DhlApi')
    ->addRule(new Rules\AssembleRule(new Assembler\GetterAssembler(new Assembler\GetterAssemblerOptions())))
    ->addRule(new Rules\AssembleRule(new Assembler\ImmutableSetterAssembler(
        new Assembler\ImmutableSetterAssemblerOptions()
    )))
    ->addRule(
        new Rules\IsRequestRule(
            $engine->getMetadata(),
            new Rules\MultiRule([
                new Rules\AssembleRule(new Assembler\RequestAssembler()),
                new Rules\AssembleRule(new Assembler\ConstructorAssembler(new Assembler\ConstructorAssemblerOptions())),
            ])
        )
    )
   // Rule for the protected properties
    ->addRule(new Rules\TypenameMatchesRule(
        new Rules\AssembleRule(new Assembler\PropertyAssembler(PropertyGenerator::VISIBILITY_PROTECTED)), 
        '/^ShipmentDetailsType$/'
    ))
   // Rule for the private properties of all remeianing classes
    ->addRule(new Rules\TypenameMatchesRule(
        new Rules\AssembleRule(new Assembler\PropertyAssembler(PropertyGenerator::VISIBILITY_PRIVATE)),
        '/^((?!ShipmentDetailsType$).)*$/'
    ))
    ->addRule(new Rules\TypenameMatchesRule(
        new Rules\AssembleRule(new Assembler\ExtendAssembler('DhlApi\Type\ShipmentDetailsType')),
        '/^ShipmentDetailsTypeType$/'
    ))
    ->addRule(
        new Rules\IsResultRule(
            $engine->getMetadata(),
            new Rules\MultiRule([
                new Rules\AssembleRule(new Assembler\ResultAssembler()),
            ])
        )
    )
;