File: docs/ArgumentDto.md

Recommend this page to a friend!
  Classes of Kjell-Inge Gustafsson  >  PcGen  >  docs/ArgumentDto.md  >  Download  
File: docs/ArgumentDto.md
Role: Auxiliary data
Content type: text/markdown
Description: Auxiliary data
Class: PcGen
Generate PHP code from parameters
Author: By
Last change:
Date: 2 months ago
Size: 2,377 bytes
 

Contents

Class file image Download

[comment]: # (This file is part of PcGen, PHP Code Generation support package. Copyright 2020 Kjell-Inge Gustafsson, kigkonsult, All rights reserved, licence GPL 3.0)

ArgumentDto

The `ArgumentDto` class, extends [VarDto] class, manages function/method arguments base data and has only getter and setter methods, no logic. Used in [ClassMgr], [FcnFrameMgr] and [FcnInvokeMgr], defining arguments.

ArgumentDto Methods

Inherited [VarDto] methods

* ```varDto``` _VarDto_
* Return _static_
* Static
* Throws InvalidArgumentException
---

  • Return _bool_, true, if argument is passed as reference
  • Throws InvalidArgumentException
* If not set, default, false.
* ```by-reference``` _bool_, if true argument is going to be passed as reference
* Return _static_
---

  • Return _int_ * `ArgumentDto::BEFORE` : argument (value) will update the class property first in method body * `ArgumentDto::AFTER` : argument (value) will update the class property last in method body (but before opt. set return(value)) * `ArgumentDto::NONE` : no update
  • Throws InvalidArgumentException
* If not set, default, no update.
* ```updClassProp``` _int_, default ```ArgumentDto::BEFORE```
  * ```ArgumentDto::BEFORE``` : argument (value) will update the class property before opt set method body
  * ```ArgumentDto::AFTER``` : argument (value) will update the class property after opt set method body (but before opt. set return(value))
  * ```ArgumentDto::NONE``` : no update
* Return _static_
---

  • Return _bool_, true, if argument (value) will append the class property array
  • Throws InvalidArgumentException
* only if argument type/value array (and ! ```ArgumentDto::NONE```, above) 
* If not set, default, false.
* ```nextVarPropIndex``` _bool_
  * if true, the argument (value) will append the class property array
* Return _static_
---

<small>Return to [README] - [Summary]</small>

[ClassMgr]:ClassMgr.md
[FcnFrameMgr]:FcnFrameMgr.md
[FcnInvokeMgr]:FcnInvokeMgr.md
[README]:../README.md
[Summary]:Summary.md
[VarDto]:VarDto.md

For more information send a message to info at phpclasses dot org.