File: docs/VarDto.md

Recommend this page to a friend!
  Classes of Kjell-Inge Gustafsson  >  PcGen  >  docs/VarDto.md  >  Download  
File: docs/VarDto.md
Role: Auxiliary data
Content type: text/markdown
Description: Auxiliary data
Class: PcGen
Generate PHP code from parameters
Author: By
Last change: 1.1
Date: 1 month ago
Size: 3,326 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)

VarDto

The `VarDto` class manages base variable data and has only getter and setter methods, no logic. Used in [ClassMgr], [FcnFrameMgr] and [FcnInvokeMgr], defining (simpler) arguments.

VarDto Methods

* ```varName``` _string_ 
* ```varType``` _string_, variable type (type hint), default null
  * convenient constants found in PcGenInterface
* ```default```, _mixed_, the argument (init-)value if null
* ```summary``` _string_, the [phpdoc] summary
* ```description``` _string_|_array_, the [phpdoc] description
* Throws InvalidArgumentException

  • `varName` _string_
  • `varType` _string_, variable type (type hint), default null * convenient constants found in PcGenInterface
  • `default`, _mixed_, the argument (init-)value if null
  • `summary` _string_, the [phpdoc] summary
  • `description` _string_|_array_, the [phpdoc] description
  • Return _static_
  • Static
  • Throws InvalidArgumentException ---
* Return _string_
* Throws InvalidArgumentException

  • Return _bool_, true if varName is set
* ```varName``` _string_ 
* Return _static_
* Throws InvalidArgumentException
---

  • Return _string_
* Return _string_, the [phpdoc] param tag value type, if set, otherwise 'mixed' 

  • Return _bool_, true if varType is of array type
* ```phpVersion``` _string_, expected PHP version, if null current (constant) PHP_VERSION is used 
* Return _bool_, true if varType can be used as type hint (dep. on PHP version) 

  • Return _bool_, true if varType is set
* ```varType``` _string_, variable type (type hint), default null
  * convenient constants found in PcGenInterface
* Return _static_
---

  • Return _mixed_
* Return _bool_, true if default value is array 

  • Return _bool_, true if default is set
* Return _bool_, true if default is typed as array 

  • `default` _mixed_
  • Return _static_ ---
* Return _string_

  • Return _bool_, true if summary is set
* ```summary``` _string_, the [phpdoc] summary
* Return _static_
---

  • Return _array_
* Return _bool_, true if description is set 

  • `description` _string_|_array_, the [phpdoc] description
  • Return _static_ ---

<small>Return to PcGen [README], [Summary]</small>

[ClassMgr]:ClassMgr.md [FcnFrameMgr]:FcnFrameMgr.md [FcnInvokeMgr]:FcnInvokeMgr.md [phpdoc]:https://phpdoc.org [README]:../README.md [Summary]:Summary.md


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