Docs For Class RSDEngineFileOption

Description

This class represents a file table option that is used to define settings for individual files.

access: public
copyright: Lukas Feiler 2003
version: 0.1.9
author: Lukas Feiler <mailto:lukas.feiler@chello.at>

Located in /code/framework/RSDEngine/RSDEngineDBTable.php (line 6040)

Variable Summary

boolean $allowUserOrderBy

boolean $footer

boolean $header

String $orderBy

boolean $paging

boolean $public

String $recordsPerPage

String $selectMethodName

String $separateRecordTemplate

boolean $showKeyColumns

String $type

String $write

Method Summary

RSDEngineFileOption RSDEngineFileOption (Array $options)

void overwrite (Array $properties)

String toString ()

void _propertyToString (mixed $value)

Variables

boolean $allowUserOrderBy = null (line 6088)

Whether to allow the user to specify by which column the records should be ordered.

access: public

boolean $footer = null (line 6070)

Whether to include a footer file.

access: public

boolean $header = null (line 6064)

Whether to include a header file.

access: public

String $orderBy = null (line 6082)

The SQL expression by which the records should be ordered.

access: public

boolean $paging = null (line 6094)

Whether to implement a paging feature

access: public

boolean $public = null (line 6058)

Whether this file (controller) is public (or private).

access: public

String $recordsPerPage = null (line 6100)

The number of records to display per page. This property is only relavant if $this->paging is set to true.

access: public

String $selectMethodName = null (line 6106)

The name of the selectIncluding* method used to get the records.

access: public

String $separateRecordTemplate = null (line 6112)

Whether to use a seperate template to display the records in the get/search template.

access: public

boolean $showKeyColumns = null (line 6076)

Whether to display the columns defined as primary or foreing key in the templates.

access: public

String $type = null (line 6046)

The type of the file. Possible values are 'controller', 'view', 'childClass', 'baseClass', 'all'

access: public

String $write = null (line 6052)

Whether to write (create) this file if non-existing, do not even try to create it or to overwrite it if existing. Valid values are 'true', 'false', 'overwrite'.

access: public

Methods

Constructor RSDEngineFileOption (line 6117)

The constructor method.

RSDEngineFileOption RSDEngineFileOption (Array $options)

Array $options: An associative array. All values that have a key that is named like a property of this class are assigned to that property.

overwrite (line 6164)

Updates all properties in with the values of the associative array passed as argument if the values are not null.

void overwrite (Array $properties)

Array $properties

toString (line 6130)

Return a literal representation of this instance.

String toString ()

_propertyToString (line 6147)

void _propertyToString (mixed $value)