AbstractModel::cleanString() - Code Metrics - Inspection of "Merge branch 'release/1.7.0' into 1.x" - WsdlToPhp/PackageGenerator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 1.x ( 257780...f31d1d )

by Mikaël

created 2016-06-20 20:32 UTC

AbstractModel::cleanString() A

↳ Parent: AbstractModel

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	2
crap	1

<?php

namespace WsdlToPhp\PackageGenerator\Model;

use WsdlToPhp\PackageGenerator\ConfigurationReader\GeneratorOptions;
use WsdlToPhp\PackageGenerator\ConfigurationReader\PhpReservedKeyword;
use WsdlToPhp\PackageGenerator\ConfigurationReader\AbstractReservedWord;
use WsdlToPhp\PackageGenerator\Generator\Generator;
use WsdlToPhp\PackageGenerator\Generator\Utils as GeneratorUtils;
use WsdlToPhp\PackageGenerator\Generator\AbstractGeneratorAware;

/**
 * Class AbstractModel defines the basic properties and methods to operations and structs extracted from the WSDL
 */
abstract class AbstractModel extends AbstractGeneratorAware
{
    /**
     * Constant used to define the key to store documentation value in meta
     * @var string
     */
    const META_DOCUMENTATION = 'documentation';
    /**
     * Original name od the element
     * @var string
     */
    private $name = '';
    /**
     * Values associated to the operation
     * @var string[]
     */
    private $meta = array();
    /**
     * Define the inheritance of a struct by the name of the parent struct or type
     * @var string
     */
    private $inheritance = '';
    /**
     * Store the object which owns the current model
     * @var AbstractModel
     */
    private $owner = null;
    /**
     * Indicates that the current elemen is an abstract element.
     * It allows to generated an abstract class.
     * This will happen for element/complexType that are defined with abstract="true"
     * @var bool
     */
    private $isAbstract = false;
    /**
     * Replaced keywords time in order to generate unique new keyword
     * @var array
     */
    private static $replacedPhpReservedKeywords = array();
    /**
     * Replaced methods time in order to generate unique new method
     * @var array
     */
    private $replacedReservedMethods = array();
    /**
     * Unique name generated in order to ensure unique naming (for struct constructor and setters/getters even for different case attribute name whith same value)
     * @var array
     */
    private static $uniqueNames = array();
    /**
     * Main constructor
     * @uses AbstractModel::setName()
     * @param Generator $generator
     * @param string $name the original name
     */
    public function __construct(Generator $generator, $name)
    {
        parent::__construct($generator);
        $this->setName($name);
    }
    /**
     * @uses AbstractModel::getInheritedMoel()
     * @uses AbstractModel::getPackagedName()
     * @uses AbstractModel::getExtends()
     * @uses Struct::getIsStruct()
     * @return string
     */
    public function getExtendsClassName()
    {
        $extends = '';
        if (($model = $this->getInheritedMoel()) instanceof Struct && $model->getIsStruct()) {
            $extends = $model->getPackagedName();
        }
        if (empty($extends)) {
            $extends = $this->getExtends(true);
        }
        return $extends;
    }
    /**
     * Returns the name of the class the current class inherits from
     * @return string
     */
    public function getInheritance()
    {
        return $this->inheritance;
    }
    /**
     * Sets the name of the class the current class inherits from
     * @param AbstractModel
     */
    public function setInheritance($inheritance = '')
    {
        $this->inheritance = $inheritance;
        return $this;
    }
    /**
     * @uses AbstractGeneratorAware::getGenerator()
     * @uses Generator::getStruct()
     * @uses AbstractModel::getInheritance()
     * @return Struct
     */
    public function getInheritedMoel()
    {
        return $this->getGenerator()->getStruct($this->getInheritance());
    }
    /**
     * Returns the meta
     * @return string[]
     */
    public function getMeta()
    {
        return $this->meta;
    }
    /**
     * Sets the meta
     * @param string[] $meta
     * @return AbstractModel
     */
    public function setMeta(array $meta = array())
    {
        $this->meta = $meta;
        return $this;
    }
    /**
     * Add meta information to the operation
     * @uses AbstractModel::getMeta()
     * @throws \InvalidArgumentException
     * @param string $metaName
     * @param mixed $metaValue
     * @return AbstractModel
     */
    public function addMeta($metaName, $metaValue)
    {
        if (!is_scalar($metaName) || (!is_scalar($metaValue) && !is_array($metaValue))) {
            throw new \InvalidArgumentException(sprintf('Invalid meta name "%s" or value "%s". Please provide scalar meta name and scalar or array meta value.', gettype($metaName), gettype($metaValue)), __LINE__);
        }
        $metaValue = is_scalar($metaValue) ? trim($metaValue) : $metaValue;
        if ((is_scalar($metaValue) && $metaValue !== '') || is_array($metaValue)) {
            if (!array_key_exists($metaName, $this->meta)) {
                $this->meta[$metaName] = $metaValue;
            } elseif (is_array($this->meta[$metaName]) && is_array($metaValue)) {
                $this->meta[$metaName] = array_merge($this->meta[$metaName], $metaValue);
            } elseif (is_array($this->meta[$metaName])) {
                array_push($this->meta[$metaName], $metaValue);
            } else {
                $this->meta[$metaName] = $metaValue;
            }
            ksort($this->meta);
        }
        return $this;
    }
    /**
     * Sets the documentation meta value.
     * Documentation is set as an array so if multiple documentation nodes are set for an unique element, it will gather them.
     * @uses AbstractModel::META_DOCUMENTATION
     * @uses AbstractModel::addMeta()
     * @param string $documentation the documentation from the WSDL
     * @return AbstractModel
     */
    public function setDocumentation($documentation)
    {
        return $this->addMeta(self::META_DOCUMENTATION, is_array($documentation) ? $documentation : array($documentation));
    }
    /**
     * Returns a meta value according to its name
     * @uses AbstractModel::getMeta()
     * @param string $metaName the meta information name
     * @param mixed $fallback the fallback value if unset
     * @return mixed the meta information value
     */
    public function getMetaValue($metaName, $fallback = null)
    {
        $meta = $this->getMeta();
        return array_key_exists($metaName, $meta) ? $meta[$metaName] : $fallback;
    }
    /**
     * Returns the value of the first meta value assigned to the name
     * @param array $names the meta names to check
     * @param mixed $fallback the fallback value if anyone is set
     * @return mixed the meta information value
     */
    public function getMetaValueFirstSet(array $names, $fallback = null)
    {
        $meta = $this->getMeta();
        foreach ($names as $name) {
            if (array_key_exists($name, $meta)) {
                return $meta[$name];
            }
        }
        return $fallback;
    }
    /**
     * Returns the original name extracted from the WSDL
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }
    /**
     * Sets the original name extracted from the WSDL
     * @param string $name
     * @return AbstractModel
     */
    public function setName($name)
    {
        $this->name = $name;
        return $this;
    }
    /**
     * Returns a valid clean name for PHP
     * @uses AbstractModel::getName()
     * @uses AbstractModel::cleanString()
     * @param bool $keepMultipleUnderscores optional, allows to keep the multiple consecutive underscores
     * @return string
     */
    public function getCleanName($keepMultipleUnderscores = true)
    {
        return self::cleanString($this->getName(), $keepMultipleUnderscores);
    }
    /**
     * Returns the owner model object
     * @return AbstractModel
     */
    public function getOwner()
    {
        return $this->owner;
    }
    /**
     * Sets the owner model object
     * @param AbstractModel $owner object the owner of the current model
     * @return AbstractModel
     */
    public function setOwner(AbstractModel $owner)
    {
        $this->owner = $owner;
        return $this;
    }
    /**
     * @return bool
     */
    public function getIsAbstract()
    {
        return $this->isAbstract;
    }
    /**
     * @param bool $isAbstract
     * @return AbstractModel
     */
    public function setIsAbstract($isAbstract)
    {
        $this->isAbstract = $isAbstract;
        return $this;
    }
    /**
     * Returns true if the original name is safe to use as a PHP property, variable name or class name
     * @uses AbstractModel::getName()
     * @uses AbstractModel::getCleanName()
     * @return bool
     */
    public function nameIsClean()
    {
        return ($this->getName() !== '' && $this->getName() === $this->getCleanName());
    }
    /**
     * Returns the packaged name
     * @uses AbstractModel::getNamespace()
     * @uses AbstractModel::getCleanName()
     * @uses AbstractModel::getContextualPart()
     * @uses AbstractModel::uniqueName()
     * @uses AbstractModel::replacePhpReservedKeyword()
     * @uses AbstractGeneratorAware::getGenerator()
     * @uses Generator::getOptionPrefix()
     * @uses Generator::getOptionSuffix()
     * @uses AbstractModel::uniqueName() to ensure unique naming of struct case sensitively
     * @return string
     */
    public function getPackagedName($namespaced = false)
    {
        $nameParts = array();
        if ($namespaced && $this->getNamespace() !== '') {
            $nameParts[] = sprintf('\%s\\', $this->getNamespace());
        }
        $cleanName = $this->getCleanName();
        if ($this->getGenerator()->getOptionPrefix() !== '') {
            $nameParts[] = $this->getGenerator()->getOptionPrefix();
        } else {
            $cleanName = self::replacePhpReservedKeyword($cleanName);
        }
        $nameParts[] = ucfirst(self::uniqueName($cleanName, $this->getContextualPart()));
        if ($this->getGenerator()->getOptionSuffix() !== '') {
            $nameParts[] = $this->getGenerator()->getOptionSuffix();
        }
        return implode('', $nameParts);
    }
    /**
     * Allows to define the contextual part of the class name for the package
     * @return string
     */
    public function getContextualPart()
    {
        return '';
    }
    /**
     * Allows to define from which class the curent model extends
     * @param bool $short
     * @return string|null
     */
    public function getExtends($short = false)
    {
        return '';
    }
    /**
     * @uses AbstractGeneratorAware::getGenerator()
     * @uses Generator::getOptionNamespacePrefix()
     * @uses Generator::getOptionPrefix()
     * @uses Generator::getOptionSuffix()
     * @uses AbstractModel::getSubDirectory()
     * @return string
     */
    public function getNamespace()
    {
        $namespaces = array();
        $namespace = $this->getGenerator()->getOptionNamespacePrefix();
        if (empty($namespace)) {
            if ($this->getGenerator()->getOptionPrefix() !== '') {
                $namespaces[] = $this->getGenerator()->getOptionPrefix();
            } elseif ($this->getGenerator()->getOptionSuffix() !== '') {
                $namespaces[] = $this->getGenerator()->getOptionSuffix();
            }
        } else {
            $namespaces[] = $namespace;
        }
        if ($this->getSubDirectory() !== '') {
            $namespaces[] = $this->getSubDirectory();
        }
        return implode('\\', $namespaces);
    }
    /**
     * Returns directory where to store class and create it if needed
     * @uses AbstractGeneratorAware::getGenerator()
     * @uses AbstractModel::getOptionCategory()
     * @uses AbstractGeneratorAware::getContextualPart()
     * @uses GeneratorOptions::VALUE_CAT
     * @return string
     */
    public function getSubDirectory()
    {
        $subDirectory = '';
        if ($this->getGenerator()->getOptionCategory() === GeneratorOptions::VALUE_CAT) {
            $subDirectory = $this->getContextualPart();
        }
        return $subDirectory;
    }
    /**
     * Returns the sub package name which the model belongs to
     * Must be overridden by sub classes
     * @return array
     */
    public function getDocSubPackages()
    {
        return array();
    }
    /**
     * Clean a string to make it valid as PHP variable
     * @uses GeneratorUtils::cleanString()
     * @param string $string the string to clean
     * @param bool $keepMultipleUnderscores optional, allows to keep the multiple consecutive underscores
     * @return string
     */
    public static function cleanString($string, $keepMultipleUnderscores = true)
    {
        return GeneratorUtils::cleanString($string, $keepMultipleUnderscores);
    }
    /**
     * Returns a usable keyword for a original keyword
     * @uses PhpReservedKeyword::instance()
     * @uses PhpReservedKeyword::is()
     * @param string $keyword the keyword
     * @param string $context the context
     * @return string
     */
    public static function replacePhpReservedKeyword($keyword, $context = null)
    {
        if (PhpReservedKeyword::instance()->is($keyword)) {
            if ($context !== null) {
                $keywordKey = $keyword . '_' . $context;
                if (!array_key_exists($keywordKey, self::$replacedPhpReservedKeywords)) {
                    self::$replacedPhpReservedKeywords[$keywordKey] = 0;
                } else {
                    self::$replacedPhpReservedKeywords[$keywordKey]++;
                }
                return '_' . $keyword . (self::$replacedPhpReservedKeywords[$keywordKey] ? '_' . self::$replacedPhpReservedKeywords[$keywordKey] : '');
            } else {
                return '_' . $keyword;
            }
        } else {
            return $keyword;
        }
    }
    /**
     * @throws \InvalidArgumentException
     * @param $filename
     * @return AbstractReservedWord
     */
    public function getReservedMethodsInstance($filename = null)
    {
        throw new \InvalidArgumentException(sprintf('The method %s should be defined in the class %s', __FUNCTION__, get_called_class(), __LINE__));
    }
    /**
     * Returns a usable method for a original method
     * @uses PhpReservedKeywords::instance()
     * @uses PhpReservedKeywords::is()
     * @param string $keyword the keyword
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param string $context the context
     * @return string
     */
    public function replaceReservedMethod($methodName, $context = null)
    {
        if ($this->getReservedMethodsInstance()->is($methodName)) {
            if ($context !== null) {
                $methodKey = $methodName . '_' . $context;
                if (!array_key_exists($methodKey, $this->replacedReservedMethods)) {
                    $this->replacedReservedMethods[$methodKey] = 0;
                } else {
                    $this->replacedReservedMethods[$methodKey]++;
                }
                return '_' . $methodName . ($this->replacedReservedMethods[$methodKey] ? '_' . $this->replacedReservedMethods[$methodKey] : '');
            } else {
                return '_' . $methodName;
            }
        } else {
            return $methodName;
        }
    }
    /**
     * Static method wich returns a unique name case sensitively
     * Useful to name methods case sensitively distinct, see http://the-echoplex.net/log/php-case-sensitivity
     * @param string $name the original name
     * @param string $context the context where the name is needed unique
     * @return string
     */
    protected static function uniqueName($name, $context)
    {
        $insensitiveKey = strtolower($name . '_' . $context);
        $sensitiveKey = $name . '_' . $context;
        if (array_key_exists($sensitiveKey, self::$uniqueNames)) {
            return self::$uniqueNames[$sensitiveKey];
        } elseif (!array_key_exists($insensitiveKey, self::$uniqueNames)) {
            self::$uniqueNames[$insensitiveKey] = 0;
        } else {
            self::$uniqueNames[$insensitiveKey]++;
        }
        $uniqueName = $name . (self::$uniqueNames[$insensitiveKey] ? '_' . self::$uniqueNames[$insensitiveKey] : '');
        self::$uniqueNames[$sensitiveKey] = $uniqueName;
        return $uniqueName;
    }
    /**
     * Gives the availability for test purpose and multiple package generation to purge unique names
     * @todo see if it can be removed by reviewing how unique names are generated
     */
    public static function purgeUniqueNames()
    {
        self::$uniqueNames = array();
    }
    /**
     * Gives the availability for test purpose and multiple package generation to purge reserved keywords usage
     * @todo see if it can be removed by reviewing how reserved keywords are generated
     */
    public static function purgePhpReservedKeywords()
    {
        self::$replacedPhpReservedKeywords = array();
    }
    /**
     * Gives the availability for test purpose and multiple package generation to purge reserved methods usage
     * @todo see if it can be removed by reviewing how reserved methods are generated
     */
    public static function purgeReservedMethods()
    {
        self::$replacedReservedMethods = array();
    }
}


1		<?php
2
3		namespace WsdlToPhp\PackageGenerator\Model;
4
5		use WsdlToPhp\PackageGenerator\ConfigurationReader\GeneratorOptions;
6		use WsdlToPhp\PackageGenerator\ConfigurationReader\PhpReservedKeyword;
7		use WsdlToPhp\PackageGenerator\ConfigurationReader\AbstractReservedWord;
8		use WsdlToPhp\PackageGenerator\Generator\Generator;
9		use WsdlToPhp\PackageGenerator\Generator\Utils as GeneratorUtils;
10		use WsdlToPhp\PackageGenerator\Generator\AbstractGeneratorAware;
11
12		/**
13		* Class AbstractModel defines the basic properties and methods to operations and structs extracted from the WSDL
14		*/
15		abstract class AbstractModel extends AbstractGeneratorAware
16		{
17		/**
18		* Constant used to define the key to store documentation value in meta
19		* @var string
20		*/
21		const META_DOCUMENTATION = 'documentation';
22		/**
23		* Original name od the element
24		* @var string
25		*/
26		private $name = '';
27		/**
28		* Values associated to the operation
29		* @var string[]
30		*/
31		private $meta = array();
32		/**
33		* Define the inheritance of a struct by the name of the parent struct or type
34		* @var string
35		*/
36		private $inheritance = '';
37		/**
38		* Store the object which owns the current model
39		* @var AbstractModel
40		*/
41		private $owner = null;
42		/**
43		* Indicates that the current elemen is an abstract element.
44		* It allows to generated an abstract class.
45		* This will happen for element/complexType that are defined with abstract="true"
46		* @var bool
47		*/
48		private $isAbstract = false;
49		/**
50		* Replaced keywords time in order to generate unique new keyword
51		* @var array
52		*/
53		private static $replacedPhpReservedKeywords = array();
54		/**
55		* Replaced methods time in order to generate unique new method
56		* @var array
57		*/
58		private $replacedReservedMethods = array();
59		/**
60		* Unique name generated in order to ensure unique naming (for struct constructor and setters/getters even for different case attribute name whith same value)
61		* @var array
62		*/
63		private static $uniqueNames = array();
64		/**
65		* Main constructor
66		* @uses AbstractModel::setName()
67		* @param Generator $generator
68		* @param string $name the original name
69		*/
70	748	public function __construct(Generator $generator, $name)
71		{
72	748	parent::__construct($generator);
73	748	$this->setName($name);
74	748	}
75		/**
76		* @uses AbstractModel::getInheritedMoel()
77		* @uses AbstractModel::getPackagedName()
78		* @uses AbstractModel::getExtends()
79		* @uses Struct::getIsStruct()
80		* @return string
81		*/
82	216	public function getExtendsClassName()
83		{
84	216	$extends = '';
85	216	if (($model = $this->getInheritedMoel()) instanceof Struct && $model->getIsStruct()) {
86	20	$extends = $model->getPackagedName();
87	20	}
88	216	if (empty($extends)) {
89	204	$extends = $this->getExtends(true);
90	204	}
91	216	return $extends;
92		}
93		/**
94		* Returns the name of the class the current class inherits from
95		* @return string
96		*/
97	276	public function getInheritance()
98		{
99	276	return $this->inheritance;
100		}
101		/**
102		* Sets the name of the class the current class inherits from
103		* @param AbstractModel
104		*/
105	180	public function setInheritance($inheritance = '')
106		{
107	180	$this->inheritance = $inheritance;
108	180	return $this;
109		}
110		/**
111		* @uses AbstractGeneratorAware::getGenerator()
112		* @uses Generator::getStruct()
113		* @uses AbstractModel::getInheritance()
114		* @return Struct
115		*/
116	216	public function getInheritedMoel()
117		{
118	216	return $this->getGenerator()->getStruct($this->getInheritance());
119		}
120		/**
121		* Returns the meta
122		* @return string[]
123		*/
124	296	public function getMeta()
125		{
126	296	return $this->meta;
127		}
128		/**
129		* Sets the meta
130		* @param string[] $meta
131		* @return AbstractModel
132		*/
133	4	public function setMeta(array $meta = array())
134		{
135	4	$this->meta = $meta;
136	4	return $this;
137		}
138		/**
139		* Add meta information to the operation
140		* @uses AbstractModel::getMeta()
141		* @throws \InvalidArgumentException
142		* @param string $metaName
143		* @param mixed $metaValue
144		* @return AbstractModel
145		*/
146	372	public function addMeta($metaName, $metaValue)
147		{
148	372	if (!is_scalar($metaName) \|\| (!is_scalar($metaValue) && !is_array($metaValue))) {
149	8	throw new \InvalidArgumentException(sprintf('Invalid meta name "%s" or value "%s". Please provide scalar meta name and scalar or array meta value.', gettype($metaName), gettype($metaValue)), __LINE__);
150		}
151	364	$metaValue = is_scalar($metaValue) ? trim($metaValue) : $metaValue;
152	364	if ((is_scalar($metaValue) && $metaValue !== '') \|\| is_array($metaValue)) {
153	364	if (!array_key_exists($metaName, $this->meta)) {
154	360	$this->meta[$metaName] = $metaValue;
155	364	} elseif (is_array($this->meta[$metaName]) && is_array($metaValue)) {
156	64	$this->meta[$metaName] = array_merge($this->meta[$metaName], $metaValue);
157	84	} elseif (is_array($this->meta[$metaName])) {
158	4	array_push($this->meta[$metaName], $metaValue);
159	4	} else {
160	16	$this->meta[$metaName] = $metaValue;
161		}
162	364	ksort($this->meta);
163	364	}
164	364	return $this;
165		}
166		/**
167		* Sets the documentation meta value.
168		* Documentation is set as an array so if multiple documentation nodes are set for an unique element, it will gather them.
169		* @uses AbstractModel::META_DOCUMENTATION
170		* @uses AbstractModel::addMeta()
171		* @param string $documentation the documentation from the WSDL
172		* @return AbstractModel
173		*/
174	112	public function setDocumentation($documentation)
175		{
176	112	return $this->addMeta(self::META_DOCUMENTATION, is_array($documentation) ? $documentation : array($documentation));
177		}
178		/**
179		* Returns a meta value according to its name
180		* @uses AbstractModel::getMeta()
181		* @param string $metaName the meta information name
182		* @param mixed $fallback the fallback value if unset
183		* @return mixed the meta information value
184		*/
185	240	public function getMetaValue($metaName, $fallback = null)
186		{
187	240	$meta = $this->getMeta();
188	240	return array_key_exists($metaName, $meta) ? $meta[$metaName] : $fallback;
189		}
190		/**
191		* Returns the value of the first meta value assigned to the name
192		* @param array $names the meta names to check
193		* @param mixed $fallback the fallback value if anyone is set
194		* @return mixed the meta information value
195		*/
196	104	public function getMetaValueFirstSet(array $names, $fallback = null)
197		{
198	104	$meta = $this->getMeta();
199	104	foreach ($names as $name) {
200	104	if (array_key_exists($name, $meta)) {
201	80	return $meta[$name];
202		}
203	76	}
204	76	return $fallback;
205		}
206		/**
207		* Returns the original name extracted from the WSDL
208		* @return string
209		*/
210	648	public function getName()
211		{
212	648	return $this->name;
213		}
214		/**
215		* Sets the original name extracted from the WSDL
216		* @param string $name
217		* @return AbstractModel
218		*/
219	748	public function setName($name)
220		{
221	748	$this->name = $name;
222	748	return $this;
223		}
224		/**
225		* Returns a valid clean name for PHP
226		* @uses AbstractModel::getName()
227		* @uses AbstractModel::cleanString()
228		* @param bool $keepMultipleUnderscores optional, allows to keep the multiple consecutive underscores
229		* @return string
230		*/
231	524	public function getCleanName($keepMultipleUnderscores = true)
232		{
233	524	return self::cleanString($this->getName(), $keepMultipleUnderscores);
234		}
235		/**
236		* Returns the owner model object
237		* @return AbstractModel
238		*/
239	524	public function getOwner()
240		{
241	524	return $this->owner;
242		}
243		/**
244		* Sets the owner model object
245		* @param AbstractModel $owner object the owner of the current model
246		* @return AbstractModel
247		*/
248	572	public function setOwner(AbstractModel $owner)
249		{
250	572	$this->owner = $owner;
251	572	return $this;
252		}
253		/**
254		* @return bool
255		*/
256	220	public function getIsAbstract()
257		{
258	220	return $this->isAbstract;
259		}
260		/**
261		* @param bool $isAbstract
262		* @return AbstractModel
263		*/
264	20	public function setIsAbstract($isAbstract)
265		{
266	20	$this->isAbstract = $isAbstract;
267	20	return $this;
268		}
269		/**
270		* Returns true if the original name is safe to use as a PHP property, variable name or class name
271		* @uses AbstractModel::getName()
272		* @uses AbstractModel::getCleanName()
273		* @return bool
274		*/
275	180	public function nameIsClean()
276		{
277	180	return ($this->getName() !== '' && $this->getName() === $this->getCleanName());
278		}
279		/**
280		* Returns the packaged name
281		* @uses AbstractModel::getNamespace()
282		* @uses AbstractModel::getCleanName()
283		* @uses AbstractModel::getContextualPart()
284		* @uses AbstractModel::uniqueName()
285		* @uses AbstractModel::replacePhpReservedKeyword()
286		* @uses AbstractGeneratorAware::getGenerator()
287		* @uses Generator::getOptionPrefix()
288		* @uses Generator::getOptionSuffix()
289		* @uses AbstractModel::uniqueName() to ensure unique naming of struct case sensitively
290		* @return string
291		*/
292	512	public function getPackagedName($namespaced = false)
293		{
294	512	$nameParts = array();
295	512	if ($namespaced && $this->getNamespace() !== '') {
296	200	$nameParts[] = sprintf('\%s\\', $this->getNamespace());
297	200	}
298	512	$cleanName = $this->getCleanName();
299	512	if ($this->getGenerator()->getOptionPrefix() !== '') {
300	276	$nameParts[] = $this->getGenerator()->getOptionPrefix();
301	276	} else {
302	272	$cleanName = self::replacePhpReservedKeyword($cleanName);
303		}
304	512	$nameParts[] = ucfirst(self::uniqueName($cleanName, $this->getContextualPart()));
305	512	if ($this->getGenerator()->getOptionSuffix() !== '') {
306	24	$nameParts[] = $this->getGenerator()->getOptionSuffix();
307	24	}
308	512	return implode('', $nameParts);
309		}
310		/**
311		* Allows to define the contextual part of the class name for the package
312		* @return string
313		*/
314	72	public function getContextualPart()
315		{
316	72	return '';
317		}
318		/**
319		* Allows to define from which class the curent model extends
320		* @param bool $short
321		* @return string\|null
322		*/
323	40	public function getExtends($short = false)
324		{
325	40	return '';
326		}
327		/**
328		* @uses AbstractGeneratorAware::getGenerator()
329		* @uses Generator::getOptionNamespacePrefix()
330		* @uses Generator::getOptionPrefix()
331		* @uses Generator::getOptionSuffix()
332		* @uses AbstractModel::getSubDirectory()
333		* @return string
334		*/
335	244	public function getNamespace()
336		{
337	244	$namespaces = array();
338	244	$namespace = $this->getGenerator()->getOptionNamespacePrefix();
339	244	if (empty($namespace)) {
340	236	if ($this->getGenerator()->getOptionPrefix() !== '') {
341	184	$namespaces[] = $this->getGenerator()->getOptionPrefix();
342	236	} elseif ($this->getGenerator()->getOptionSuffix() !== '') {
343	8	$namespaces[] = $this->getGenerator()->getOptionSuffix();
344	8	}
345	236	} else {
346	8	$namespaces[] = $namespace;
347		}
348	244	if ($this->getSubDirectory() !== '') {
349	236	$namespaces[] = $this->getSubDirectory();
350	236	}
351	244	return implode('\\', $namespaces);
352		}
353		/**
354		* Returns directory where to store class and create it if needed
355		* @uses AbstractGeneratorAware::getGenerator()
356		* @uses AbstractModel::getOptionCategory()
357		* @uses AbstractGeneratorAware::getContextualPart()
358		* @uses GeneratorOptions::VALUE_CAT
359		* @return string
360		*/
361	268	public function getSubDirectory()
362		{
363	268	$subDirectory = '';
364	268	if ($this->getGenerator()->getOptionCategory() === GeneratorOptions::VALUE_CAT) {
365	264	$subDirectory = $this->getContextualPart();
366	264	}
367	268	return $subDirectory;
368		}
369		/**
370		* Returns the sub package name which the model belongs to
371		* Must be overridden by sub classes
372		* @return array
373		*/
374	4	public function getDocSubPackages()
375		{
376	4	return array();
377		}
378		/**
379		* Clean a string to make it valid as PHP variable
380		* @uses GeneratorUtils::cleanString()
381		* @param string $string the string to clean
382		* @param bool $keepMultipleUnderscores optional, allows to keep the multiple consecutive underscores
383		* @return string
384		*/
385	528	public static function cleanString($string, $keepMultipleUnderscores = true)
386		{
387	528	return GeneratorUtils::cleanString($string, $keepMultipleUnderscores);
388		}
389		/**
390		* Returns a usable keyword for a original keyword
391		* @uses PhpReservedKeyword::instance()
392		* @uses PhpReservedKeyword::is()
393		* @param string $keyword the keyword
394		* @param string $context the context
395		* @return string
396		*/
397	508	public static function replacePhpReservedKeyword($keyword, $context = null)
398		{
399	508	if (PhpReservedKeyword::instance()->is($keyword)) {
400	120	if ($context !== null) {
401	68	$keywordKey = $keyword . '_' . $context;
402	68	if (!array_key_exists($keywordKey, self::$replacedPhpReservedKeywords)) {
403	40	self::$replacedPhpReservedKeywords[$keywordKey] = 0;
404	40	} else {
405	28	self::$replacedPhpReservedKeywords[$keywordKey]++;
406		}
407	68	return '_' . $keyword . (self::$replacedPhpReservedKeywords[$keywordKey] ? '_' . self::$replacedPhpReservedKeywords[$keywordKey] : '');
408		} else {
409	96	return '_' . $keyword;
410		}
411		} else {
412	508	return $keyword;
413		}
414		}
415		/**
416		* @throws \InvalidArgumentException
417		* @param $filename
418		* @return AbstractReservedWord
419		*/
420	4	public function getReservedMethodsInstance($filename = null)
421		{
422	4	throw new \InvalidArgumentException(sprintf('The method %s should be defined in the class %s', __FUNCTION__, get_called_class(), __LINE__));
423		}
424		/**
425		* Returns a usable method for a original method
426		* @uses PhpReservedKeywords::instance()
427		* @uses PhpReservedKeywords::is()
428		* @param string $keyword the keyword
		0 ignored issues – show Bug introduced 2016-04-11 20:55 UTC by Report Bug Copy Issue Report There is no parameter named `$keyword`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
429		* @param string $context the context
430		* @return string
431		*/
432	512	public function replaceReservedMethod($methodName, $context = null)
433		{
434	512	if ($this->getReservedMethodsInstance()->is($methodName)) {
435		if ($context !== null) {
436		$methodKey = $methodName . '_' . $context;
437		if (!array_key_exists($methodKey, $this->replacedReservedMethods)) {
438		$this->replacedReservedMethods[$methodKey] = 0;
439		} else {
440		$this->replacedReservedMethods[$methodKey]++;
441		}
442		return '_' . $methodName . ($this->replacedReservedMethods[$methodKey] ? '_' . $this->replacedReservedMethods[$methodKey] : '');
443		} else {
444		return '_' . $methodName;
445		}
446		} else {
447	512	return $methodName;
448		}
449		}
450		/**
451		* Static method wich returns a unique name case sensitively
452		* Useful to name methods case sensitively distinct, see http://the-echoplex.net/log/php-case-sensitivity
453		* @param string $name the original name
454		* @param string $context the context where the name is needed unique
455		* @return string
456		*/
457	516	protected static function uniqueName($name, $context)
458		{
459	516	$insensitiveKey = strtolower($name . '_' . $context);
460	516	$sensitiveKey = $name . '_' . $context;
461	516	if (array_key_exists($sensitiveKey, self::$uniqueNames)) {
462	512	return self::$uniqueNames[$sensitiveKey];
463	444	} elseif (!array_key_exists($insensitiveKey, self::$uniqueNames)) {
464	440	self::$uniqueNames[$insensitiveKey] = 0;
465	440	} else {
466	32	self::$uniqueNames[$insensitiveKey]++;
467		}
468	444	$uniqueName = $name . (self::$uniqueNames[$insensitiveKey] ? '_' . self::$uniqueNames[$insensitiveKey] : '');
469	444	self::$uniqueNames[$sensitiveKey] = $uniqueName;
470	444	return $uniqueName;
471		}
472		/**
473		* Gives the availability for test purpose and multiple package generation to purge unique names
474		* @todo see if it can be removed by reviewing how unique names are generated
475		*/
476	292	public static function purgeUniqueNames()
477		{
478	292	self::$uniqueNames = array();
479	292	}
480		/**
481		* Gives the availability for test purpose and multiple package generation to purge reserved keywords usage
482		* @todo see if it can be removed by reviewing how reserved keywords are generated
483		*/
484	268	public static function purgePhpReservedKeywords()
485		{
486	268	self::$replacedPhpReservedKeywords = array();
487	268	}
488		/**
489		* Gives the availability for test purpose and multiple package generation to purge reserved methods usage
490		* @todo see if it can be removed by reviewing how reserved methods are generated
491		*/
492		public static function purgeReservedMethods()
493		{
494		self::$replacedReservedMethods = array();
495		}
496		}
497

WsdlToPhp / PackageGenerator

Push — 1.x ( 257780...f31d1d )

AbstractModel::cleanString() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like