Overview

Namespaces

  • LeanMapper
    • Exception
    • Reflection
    • Relationship

Classes

  • Aliases
  • AliasesBuilder
  • AliasesParser
  • AnnotationsParser
  • EntityReflection
  • Property
  • PropertyFactory
  • PropertyFilters
  • PropertyMethods
  • PropertyPasses
  • PropertyType
  • PropertyValuesEnum
  • Overview
  • Namespace
  • Class

Class Property

Reflection of entity's property

Namespace: LeanMapper\Reflection
Author: Vojtěch Kohout
Located at Reflection/Property.php
Methods summary
public
# __construct( string $name, LeanMapper\Reflection\EntityReflection $entityReflection, string|null $column, LeanMapper\Reflection\PropertyType $type, boolean $isWritable, boolean $isNullable, boolean $containsCollection, boolean $hasDefaultValue, mixed|null $defaultValue = null, LeanMapper\Relationship\HasOne|LeanMapper\Relationship\HasMany|LeanMapper\Relationship\BelongsToOne|LeanMapper\Relationship\BelongsToMany|null $relationship = null, LeanMapper\Reflection\PropertyMethods $propertyMethods = null, LeanMapper\Reflection\PropertyFilters $propertyFilters = null, LeanMapper\Reflection\PropertyPasses $propertyPasses = null, LeanMapper\Reflection\PropertyValuesEnum $propertyValuesEnum = null, array $customFlags = array() )

Parameters

$name
$entityReflection
$column
$type
$isWritable
$isNullable
$containsCollection
$hasDefaultValue
$defaultValue
$relationship
$propertyMethods
$propertyFilters
$propertyPasses
$propertyValuesEnum
$customFlags

Throws

LeanMapper\Exception\InvalidArgumentException
public string
# getName( )

Gets property name

Gets property name

Returns

string
public string|null
# getColumn( )

Gets name of column holding low-level value

Gets name of column holding low-level value

Returns

string|null
public boolean
# containsCollection( )

Tells whether property is assumed to contain collection

Tells whether property is assumed to contain collection

Returns

boolean
public boolean
# hasDefaultValue( )

Tells whether property has default value (defined in annotation)

Tells whether property has default value (defined in annotation)

Returns

boolean
public mixed|null
# getDefaultValue( )

Gets default value of property (as defined in annotation)

Gets default value of property (as defined in annotation)

Returns

mixed|null
public string
# getType( )

Gets property type

Gets property type

Returns

string
public boolean
# isBasicType( )

Tells whether property type is basic type (boolean|integer|float|string|array)

Tells whether property type is basic type (boolean|integer|float|string|array)

Returns

boolean
public boolean
# isWritable( )

Tells whether property is writable

Tells whether property is writable

Returns

boolean
public boolean
# isNullable( )

Tells whether property can be null

Tells whether property can be null

Returns

boolean
public boolean
# hasRelationship( )

Tells whether property represents relationship

Tells whether property represents relationship

Returns

boolean
public LeanMapper\Relationship\BelongsToMany|LeanMapper\Relationship\BelongsToOne|LeanMapper\Relationship\HasMany|LeanMapper\Relationship\HasOne|null
# getRelationship( )

Returns relationship that property represents

Returns relationship that property represents

Returns

LeanMapper\Relationship\BelongsToMany|LeanMapper\Relationship\BelongsToOne|LeanMapper\Relationship\HasMany|LeanMapper\Relationship\HasOne|null
public string|null
# getGetter( )

Gets getter method

Gets getter method

Returns

string|null
public string|null
# getSetter( )

Gets setter method

Gets setter method

Returns

string|null
public array|null
# getFilters( integer $index = 0 )

Gets property filters

Gets property filters

Parameters

$index

Returns

array|null
public array|null
# getFiltersTargetedArgs( integer $index = 0 )

Gets filters arguments hard-coded in annotation

Gets filters arguments hard-coded in annotation

Parameters

$index

Returns

array|null
public string|null
# getGetterPass( )

Gets getter pass

Gets getter pass

Returns

string|null
public string|null
# getSetterPass( )

Gets setter pass

Gets setter pass

Returns

string|null
public boolean
# containsEnumeration( )

Tells whether property contains enumeration

Tells whether property contains enumeration

Returns

boolean
public boolean
# isValueFromEnum( mixed $value )

Tells wheter given value is from enumeration

Tells wheter given value is from enumeration

Parameters

$value

Returns

boolean

Throws

LeanMapper\Exception\InvalidMethodCallException
public array
# getEnumValues( )

Gets possible enumeration values

Gets possible enumeration values

Returns

array
public boolean
# hasCustomFlag( string $name )

Tells whether property has custom flag

Tells whether property has custom flag

Parameters

$name

Returns

boolean
public string
# getCustomFlagValue( string $name )

Gets value of requested custom flag

Gets value of requested custom flag

Parameters

$name

Returns

string

Throws

LeanMapper\Exception\InvalidArgumentException
tharos/leanmapper v2.3.0 API documentation API documentation generated by ApiGen