$caption = NULL
[line 49]
the title for this group.
usually a string, can be a hash because it's language dependant.
Tags:
$defaultOff = FALSE
[line 137]
tells if the container content is hidden when the form loads.
default and not set = false.
Tags:
$formElements =
[line 40]
holding references to instances of Bs_FormElement.
like the clearing house in Bs_Form.
Tags:
$level =
[line 119]
a container can be assigned to another level. this is used for the multi-level form feature.
all elements (including form fields and sub-containers) of this container automatically inherit the level information of this container. they cannot be in a different level.
note I: if not set then it will be used in all levels. note II: the first level is level 1, not 0. note III: if you want to be able to assign a container to more than one level, code that feature, please. :)
Tags:
$mayToggle = FALSE
[line 128]
tells if the container content may be toggled (display/hide).
default and not set = false.
Tags:
$pseudoContainer = FALSE
[line 68]
should it be displayed as real container with caption and borders? if not then the user won't see that these fields are grouped together.
this is useful to give the container a "level" (multilevel forms) etc.
Tags:
$pseudoIfNada = TRUE
[line 99]
make this container a "pseudocontainer" (hide border and caption) if there is nothing visible to show? default is TRUE.
if there are no fields (because this user does not have the right to see them) or because there are just no fields then the container won't show up with borders.
if there are fields but used invisible in this case then the borders will still show up because we dunno that the elements are invisible RIGHT NOW. this does not apply for real Bs_FormFieldHidden fields. they are detected. in the future i may change this, add some code, and detect this case aswell.
if the container has sub-containers then this will be ignored, because that would go too far. maybe will be implemented later. (it could be that the subcontainers themself have nothing to show...)
if the container uses a template then this setting will be ignored aswell. because there could be text, whatever in the layout for this container. we can't tell.
note: the elementStringFormat will be ignored if this feature kicks in because of nada. this may not be desired in every situation, but it certainly makes sense.
Tags:
$templatePath = NULL
[line 180]
the absolute path to the template(s). if not given then getAbsolutePath() . '../templates/' will be used which kinda sucks. so you better set that...
Tags:
$templateString = NULL
[line 170]
a hardcoded template. if set (and $useTemplate is TRUE) then this one will be used.
has priority over $templatePath.
it may not be empty like "". if you want to set an empty template to have no content in the container, set a space or no-braking-space or disable the container.
Tags:
$useCheckboxAsCaption = FALSE
[line 59]
if set and *this container* has such a checkbox field, the var $caption is ignored, the checkbox plus it's caption is used instead, and the $text of the checkbox is printes as text in the first paragraph of this container. nice feature. should be documented in a howto.
Tags:
$useTemplate = FALSE
[line 155]
if we should use a template when an appropriate one is available. FALSE unless set to TRUE.
since bs4.5 you can use $templateString to hardcode a layout instead of using a file (and $templatePath).
to see how templates are named see the phpdoc of Bs_FormTemplateParser->loadTemplate().
note: you can code endless loops if your template uses the container element itself. it crashed my apache 1.3x on windows 2k workstation.
Tags: