Docs For Class atkAttributeTestCase

Home

Documentation home

Atk index

Docs For Class atkAttributeTestCase [ package: atk ]

Class: atkAttributeTestCase

Source Location: /test/class.atkattributetestcase.inc

Class atkAttributeTestCase

Class Overview

Baseclass for attribute unittests. This class is an extension to the default UnitTestCase. It provides an apiTest method that performs a basic test if the attribute responds to standard api calls correctly

Located in /test/class.atkattributetestcase.inc [line 29]

Wiki documentation

UnitTestCase
   |
   --atkAttributeTestCase

Author(s):

Ivo Jansch <ivo@achievo.org>

API Tags:

Access:

private

Information Tags:

Properties

$m_attribute

Methods

[ Top ]

Descendants

Child Class	Description
test_atkattribute	Testcases for class atkattribute.
test_atkcurrencyattribute	Testcases for class atkCurrencyAttribute
test_atkmultiselectattribute	Testcases for class atkmultiselectattribute.
test_atknumberattribute	Testcases for class atkNumberAttribute
test_atktagattribute	Testcases for class atktagattribute.
test_atktextattribute	Testcases for class atkTextAttribute.

[ Top ]

Property Summary

mixed

$m_attribute

[ Top ]

Method Summary

void	apiTest()	Perform api test.
void	assertBoolean()	Assert if a value is a boolean (true or false).
void	assertDbFieldSize()	Assert if a value matches the dbFieldSize() output, which can be int or 'x,x'
void	assertInteger()	Assert if a value is an integer.
void	assertNumeric()	Assert if a value is numeric (checks only the actual value, not its type).
String	getTestValue()	Return the testvalue of the attribute.
void	_getMsg()	Get canonical test message (attribute classname + custom message + %s.
void	_testDbConversion()	Check if value2db and db2value are eachothers full opposite.
void	_testFlagGetSet()	Test addFlag, removeFlag and hasFlag.
void	_testIsEmpty()	Check if isEmpty returns true for empty records.
void	_testReturnValues()	Check return types for methods where the system is dependent on a proper use of the returned value.

[ Top ]

Properties

mixed $m_attribute = null [line 31]

Redefined in descendants as:

test_atktagattribute::$m_attribute

[ Top ]

Methods

apiTest [line 44]

void apiTest(

&$attribute, atkAttribute
$attribute 
)

Perform api test.

Checks an attribute for general characteristics, like valid return types for often overriden methods, the ability to check, add, remove flags, compatibility of value2db with db2value, and canonical reactions to methods like isEmpty when called with empty records.

Parameters:

atkAttribute	$attribute:	Instance of the attribute to check.
	&$attribute:

[ Top ]

assertBoolean [line 117]

void assertBoolean(
mixed
$value, [String
$msg = ""] 
)

Assert if a value is a boolean (true or false).

Parameters:

mixed	$value:	Value to check
String	$msg:	Message to display for test

[ Top ]

assertDbFieldSize [line 149]

void assertDbFieldSize(
mixed
$value, [String
$msg = ""] 
)

Assert if a value matches the dbFieldSize() output, which can be int or 'x,x'

Parameters:

mixed	$value:	Value to check
String	$msg:	Message to display for test

[ Top ]

assertInteger [line 138]

void assertInteger(
mixed
$value, [String
$msg = ""] 
)

Assert if a value is an integer.

Parameters:

mixed	$value:	Value to check
String	$msg:	Message to display for test

[ Top ]

assertNumeric [line 128]

void assertNumeric(
mixed
$value, [String
$msg = ""] 
)

Assert if a value is numeric (checks only the actual value, not its type).

Parameters:

mixed	$value:	Value to check
String	$msg:	Message to display for test

[ Top ]

getTestValue [line 170]

String getTestValue(
)

Return the testvalue of the attribute.

API Tags:

Return:

returns the testvalue which will be used by the testcases for inserting data in the database.

[ Top ]

_getMsg [line 159]

void _getMsg(
[String
$msg = ""] 
)

Get canonical test message (attribute classname + custom message + %s.

Parameters:

String

$msg:

Message to display for test

API Tags:

Access:

private

[ Top ]

_testDbConversion [line 73]

void _testDbConversion(
)

Check if value2db and db2value are eachothers full opposite.

API Tags:

Access:

private

[ Top ]

_testFlagGetSet [line 57]

void _testFlagGetSet(
)

Test addFlag, removeFlag and hasFlag.

API Tags:

Access:

private

[ Top ]

_testIsEmpty [line 87]

void _testIsEmpty(
)

Check if isEmpty returns true for empty records.

API Tags:

Access:

private

Redefined in descendants as:

test_atkmultiselectattribute::_testIsEmpty() : Check if isEmpty returns true for empty records.

[ Top ]

_testReturnValues [line 101]

void _testReturnValues(
)

Check return types for methods where the system is dependent on a proper use of the returned value.

API Tags:

Access:

private

[ Top ]