Describes the behavior of a LazyJsonMapper property.
NOTE: The class validates all parameters, but provides public properties to
avoid needless function calls. It's therefore your responsibility to never
assign any bad values to the public properties after this object's creation!
BASIC_TYPES
List of valid basic PHP types.
NOTE: We don't include array, object or null. Because we handle
arrays separately (via $arrayDepth), and objects via $isObjectType,
and we never want to explicitly cast anything to NULL. We also avoid
PHP's alternative names for some types, favoring their shortest names.
$propType : string|null
Assigned value-type for the property.
In case of basic PHP types, it is a string value such as int.
It uses NULL to represent mixed or "" (mixed shorthand) to make it
easy & fast to check for untyped properties via a === null comparison.
In case of classes, this is the normalized NameSpace\Class path, but
WITHOUT any initial leading \ ("look from the global namespace")
backslash. That's PHP's preferred notation for class paths in all of its
various "get name" functions. However, that's very unsafe for actual
object creation, since PHP would first try resolving to a relative
object. Therefore, use getStrictClassPath() for actual creation and
for all strict comparisons where any kind of namespace resolution will
be involved, in functions such as is_a() or is_subclass_of(), etc!
__construct(string|null $definitionStr = null, string|null $baseNamespace = '')
Constructor.
| string|null | $definitionStr | A PHPdoc-style string describing the
property, or |
| string|null | $baseNamespace | Namespace to use for resolving relative
class paths. It CANNOT start or end
with a backslash. (Use |
If the provided definition is invalid.
getStrictClassPath() : string|null
Get the strict, global path to the target class.
Always use this function when creating objects or in any other way using the "property type" class path as argument for PHP's class checking functions. The strict path that it provides ensures that PHP will find the global path instead of resolving to a local object.
Strict path if this is an object, otherwise NULL.
equals(\LazyJsonMapper\Property\PropertyDefinition $otherObject) : boolean
Check if all values of this property match another property object.
| \LazyJsonMapper\Property\PropertyDefinition | $otherObject | The object to compare with. |
TRUE if all property values are identical, otherwise FALSE.