n2n Page Rocket 1 API

­Ei­Type

Property summary

Methods summary

Properties in detail

• subEiTypes

  protected ­ ­ ­ subEiTypes

Methods in detail

• __construct

  public __construct ( string id , Module moduleNamespace )

  param

  string id

  Module

  EntityModel
  Overrides: Type::__construct()

• setEntityModel

  public setEntityModel ( EntityModel entityModel )

• getEntityModel

  EntityModel public getEntityModel ( )

  return

  EntityModel

• setSuperEiType

  public setSuperEiType ( EiType superEiType )

  param

  EiType

• getSuperEiType

  EiType public getSuperEiType ( )

  return

  EiType

• hasSuperEiType

  boolean public hasSuperEiType ( )

  return

  boolean

• getSupremeEiType

  EiType public getSupremeEiType ( )

  return

  EiType

• getAllSuperEiTypes

  public getAllSuperEiTypes ( unknown includeSelf = false )

• hasSubEiTypes

  boolean public hasSubEiTypes ( )

  return

  boolean

• getSubEiTypes

  EiType public getSubEiTypes ( )

  return

  EiType

• containsSubEiTypeId

  public containsSubEiTypeId ( string eiTypeId , bool deepCheck = false )

• getAllSubEiTypes

  EiType public getAllSubEiTypes ( )

  return

  EiType

• findEiTypeByEntityModel

  public findEiTypeByEntityModel ( EntityModel entityModel )

• determineEiType

  EiType public determineEiType ( EntityModel entityModel )

  param

  EntityModel

  throws

  InvalidArgumentException

  return

  EiType

• determineAdequateEiType

  public determineAdequateEiType ( ReflectionClass class )

• hasSecurityOptions

  public hasSecurityOptions ( )

• getPrivilegeOptions

  public getPrivilegeOptions ( N2nContext n2nContext )

• isObjectValid

  public isObjectValid ( unknown object )

• getEiMask

  EiMask public getEiMask ( )

  return

  EiMask

• setDataSourceName

  public setDataSourceName ( string dataSourceName )

  param

  string dataSourceName

• getDataSourceName

  string public getDataSourceName ( )

  return

  string

• getNestedSetStrategy

  NestedSetStrategy public getNestedSetStrategy ( )

  return

  NestedSetStrategy

• setNestedSetStrategy

  public setNestedSetStrategy ( NestedSetStrategy|null nestedSetStrategy )

  param

  NestedSetStrategy|null nestedSetStrategy

• lookupEntityManager

  EntityManager public lookupEntityManager ( PdoPool dbhPool , unknown transactional = false )

  param

  PdoPool

  return

  EntityManager

• lookupEntityManagerFactory

  EntityManagerFactory public lookupEntityManagerFactory ( PdoPool dbhPool )

  param

  PdoPool

  return

  EntityManagerFactory

• extractId

  mixed public extractId ( object entityObj )

  param

  object entityObj

  return

  mixed

• idToPid

  string public idToPid ( mixed id )

  Converts the id of an entity object of this EiType into a pid. In rocket pid stands for Practical Identifier

  . Ids of entities can have diffrent types which isn't practical.

  Pids are always strings which can't contain slashes or backslashes. This allowes a pid to be used in a url path (most servers can't handle urlencoded slashes in paths).

  Note: This method currently uses urlencode() to mask slashes and backslahes which could change in further versions. If you want to embed a pid in a url you stil have to encode it even if this means that a pid gets urlencoded a second time.

  param

  mixed id

  return

  string

  throws

  InvalidArgumentException if null is passed as id.

• pidToId

  mixed public pidToId ( string pid )

  Converts a pid back to an id. EiType::idToPid() for further informations.

  param

  string pid

  return

  mixed

  throws

  InvalidArgumentException

• getEiTypeExtensionCollection

  EiTypeExtensionCollection public getEiTypeExtensionCollection ( )

  return

  EiTypeExtensionCollection

• __toString

  public __toString ( )

• isAbstract

  public isAbstract ( )

• registerVetoableActionListener

  public registerVetoableActionListener ( EiLifecycleListener eiLifecycleListener )

• unregisterVetoableActionListener

  public unregisterVetoableActionListener ( EiLifecycleListener eiLifecycleListener )

• validateLifecycleAction

  public validateLifecycleAction ( VetoableLifecycleAction vetoableLifecycleAction , N2nContext n2nContext )