Class: Quinoa_Attribute

Source Location: /Quinoa/Attribute.php

Class Overview

Quinoa_Attribute class.

Author(s):

Marcello Duarte <marcello.duarte@gmail.com>

Version:

0.0.21 2007-09-23

Copyright:

2007

Child classes:

Quinoa_Set: Quinoa Set class.

Class Details

[line 45]
Quinoa_Attribute class.

Quinoa_Attribute class. Represents one table attribute. The elementary unit of the data layer. PHP version 5.x Copyright (c) 2007, Freeconcept, Lda. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the Freeconcept, Lda. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Tags:

since:	File available since Release 0.0.1
link:	http://www.quinoaframework.org
version:	0.0.21 2007-09-23
copyright:	2007
author:	Marcello Duarte <marcello.duarte@gmail.com>

[ Top ]

Class Variables

$_dataClass =

[line 160]

The data class that owns the attribute

Tags:

access:

protected

Type:

string

[ Top ]

$_dateDBFormat =

[line 167]

The format the date is saved with

Tags:

access:

protected

Type:

string

[ Top ]

$_dateShowFormat =

[line 174]

The format the date is displayed with

Tags:

access:

protected

Type:

string

[ Top ]

$_decimals =

[line 97]

Decimals maximum position, for validation

Tags:

access:

protected

Type:

string

[ Top ]

$_defaultValue =

[line 118]

The default value the attribute takes

Tags:

access:

protected

Type:

mixed

[ Top ]

$_foreignId =

[line 75]

Deprecated, kept here for compatibility

Tags:

access:	protected
deprecated:	0.0.20

Type:

string

[ Top ]

$_formFieldType =

[line 139]

The HTML type of form field the attribute uses

Tags:

access:

protected

Type:

string

[ Top ]

$_isAutoNumber =

[line 111]

Whether the attribute is autonumbered

Tags:

access:

protected

Type:

boolean

[ Top ]

$_isMandatory =

[line 104]

Whether attribute is mandatory

Tags:

access:

protected

Type:

boolean

[ Top ]

$_isReadOnly =

[line 146]

Whether the attribute is readonly

Tags:

access:

protected

Type:

boolean

[ Top ]

$_label =

[line 82]

Name the attribute assumes for display in lists and forms

Tags:

access:

protected

Type:

string

[ Top ]

$_length =

[line 90]

Length of the value the attribute can take, for validation and form

Length of the value the attribute can take, for validation and form field construction

Tags:

access:

protected

Type:

mixed

[ Top ]

$_name =

[line 53]

Name of the attribute as it comes in the database

Tags:

access:

protected

Type:

string

[ Top ]

$_rows =

[line 153]

The number of rows a Textarea will use

Tags:

access:

protected

Type:

integer

[ Top ]

$_simulateLeftJoin =

[line 182]

Deprecated, kept here for compatibility

Tags:

access:	protected
deprecated:	0.0.20

Type:

boolean

[ Top ]

$_sourceAttribute =

[line 132]

The name of the attribute in the external table in a 1 to N relationship

Tags:

access:

protected

Type:

string

[ Top ]

$_sourceEntity =

[line 125]

The external entity in a 1 to N relationship

Tags:

access:

protected

Type:

string

[ Top ]

$_type =

[line 60]

Type defined in the database or data class if 1 to n relationship

Tags:

access:

protected

Type:

string

[ Top ]

$_value =

[line 67]

Value the attributes assumes when the Quinoa_Record is fetched

Tags:

access:

protected

Type:

mixed

[ Top ]

Class Methods

constructor __construct [line 189]

Quinoa_Attribute __construct(
array
$attribute)

Constructs a Quinoa_Attribute object

Parameters:

array

$attribute

[ Top ]

method getDataClass [line 496]

string getDataClass(
)

dataClass get accessor

Tags:

access:

public

[ Top ]

method getDateDBFormat [line 241]

string getDateDBFormat(
)

dataDBFormat get accessor

Tags:

access:

public

[ Top ]

method getDateShowFormat [line 261]

string getDateShowFormat(
)

dataShowFormat get accessor

Tags:

access:

public

[ Top ]

method getDecimals [line 386]

string getDecimals(
)

decimals get accessor

Tags:

access:

public

[ Top ]

method getDefaultValue [line 436]

mixed getDefaultValue(
)

defaultValue get accessor

Tags:

access:

public

[ Top ]

method getForeignId [line 356]

string getForeignId(
)

foreignId get accessor

foreignId get accessor Deprecated, kept here for compatibility

Tags:

access:	public
deprecated:	0.0.20

[ Top ]

method getFormFieldType [line 466]

string getFormFieldType(
)

formFieldType get accessor

Tags:

access:

public

[ Top ]

method getIsAutoNumber [line 406]

boolean getIsAutoNumber(
)

isAutoNumber get accessor

Tags:

access:

public

[ Top ]

method getIsMandatory [line 396]

boolean getIsMandatory(
)

isMandatory get accessor

Tags:

access:

public

[ Top ]

method getIsReadOnly [line 476]

boolean getIsReadOnly(
)

isReadOnly get accessor

Tags:

access:

public

[ Top ]

method getLabel [line 366]

string getLabel(
)

label get accessor

Tags:

access:

public

[ Top ]

method getLength [line 376]

string getLength(
)

label get accessor

Tags:

access:

public

[ Top ]

method getName [line 324]

string getName(
)

name get accessor

Tags:

access:

public

[ Top ]

method getRows [line 486]

string getRows(
)

rows get accessor

Tags:

access:

public

[ Top ]

method getSourceAttribute [line 456]

string getSourceAttribute(
)

sourceAttribute get accessor

Tags:

access:

public

[ Top ]

method getSourceEntity [line 446]

string getSourceEntity(
)

sourceEntity get accessor

Tags:

access:

public

[ Top ]

method getType [line 334]

string getType(
)

type get accessor

Tags:

access:

public

[ Top ]

method getValue [line 344]

string getValue(
)

value get accessor

Tags:

access:

public

[ Top ]

method isAutoNumber [line 426]

boolean isAutoNumber(
)

isAutoNumber tester

Tags:

access:

public

[ Top ]

method isMandatory [line 416]

boolean isMandatory(
)

isMandatory tester

Tags:

access:

public

[ Top ]

method isReadOnly [line 506]

boolean isReadOnly(
)

isReadOnly tester

Tags:

access:

public

[ Top ]

method setDateDBFormat [line 251]

void setDateDBFormat(
string
$dateDBFormat)

dataDBFormat set accessor

Tags:

access:

public

Parameters:

string

$dateDBFormat

[ Top ]

method setDateShowFormat [line 271]

void setDateShowFormat(
string
$dateShowFormat)

dateShowFormat set accessor

Tags:

access:

public

Parameters:

string

$dateShowFormat

[ Top ]

method setDecimals [line 590]

void setDecimals(
string
$decimals)

decimals set accessor

Tags:

access:

public

Parameters:

string

$decimals

[ Top ]

method setDefaultValue [line 620]

void setDefaultValue(
mixed
$defaultValue)

defaultValue set accessor

Tags:

access:

public

Parameters:

mixed

$defaultValue

[ Top ]

method setForeignId [line 560]

void setForeignId(
mixed
$foreignId, string
$name)

foreignId set accessor

foreignId set accessor Deprecated, kept here for compatibility

Tags:

access:	public
deprecated:	0.0.20

Parameters:

string

$name

[ Top ]

method setFormFieldType [line 650]

void setFormFieldType(
string
$formFieldType)

formFieldType set accessor

Tags:

access:

public

Parameters:

string

$formFieldType

[ Top ]

method setIsAutoNumber [line 610]

void setIsAutoNumber(
boolean
$isAutoNumber)

isAutoNumber set accessor

Tags:

access:

public

Parameters:

boolean

$isAutoNumber

[ Top ]

method setIsMandatory [line 600]

void setIsMandatory(
boolean
$isMandatory)

isMandatory set accessor

Tags:

access:

public

Parameters:

boolean

$isMandatory

[ Top ]

method setIsReadOnly [line 660]

void setIsReadOnly(
boolean
$isReadOnly)

isReadOnly set accessor

Tags:

access:

public

Parameters:

boolean

$isReadOnly

[ Top ]

method setLabel [line 570]

void setLabel(
string
$label)

label set accessor

Tags:

access:

public

Parameters:

string

$label

[ Top ]

method setLength [line 580]

void setLength(
mixed
$length)

length set accessor

Tags:

access:

public

Parameters:

mixed

$length

[ Top ]

method setName [line 528]

void setName(
string
$name)

name set accessor

Tags:

access:

public

Parameters:

string

$name

[ Top ]

method setRows [line 670]

void setRows(
string
$rows)

rows set accessor

Tags:

access:

public

Parameters:

string

$rows

[ Top ]

method setSourceAttribute [line 640]

void setSourceAttribute(
string
$sourceAttribute)

sourceAttribute set accessor

Tags:

access:

public

Parameters:

string

$sourceAttribute

[ Top ]

method setSourceEntity [line 630]

void setSourceEntity(
string
$sourceEntity)

sourceEntity set accessor

Tags:

access:

public

Parameters:

string

$sourceEntity

[ Top ]

method setType [line 538]

void setType(
string
$type)

type set accessor

Tags:

access:

public

Parameters:

string

$type

[ Top ]

method setValue [line 548]

void setValue(
string
$value)

value set accessor

Tags:

access:

public

Parameters:

string

$value

[ Top ]

method simulateLeftJoin [line 518]

boolean simulateLeftJoin(
)

simulateLeftJoin tester

simulateLeftJoin tester Deprecated, kept here for compatibility

Tags:

access:	public
deprecated:	0.0.20

[ Top ]

method _getDefaultFormField [line 281]

string _getDefaultFormField(
mixed
$type, mixed
$foreign)

defaultFormField get accessor

Tags:

access:

protected

[ Top ]

Documentation generated on Wed, 03 Oct 2007 14:25:21 +0100 by phpDocumentor 1.3.0RC3