PHP Class PMA\libraries\plugins\export\TableProperty

Show file Open project: phpmyadmin/phpmyadmin Class Usage Examples

Public Properties

Property Type Description
$defaultValue mixed Default value
$ext string Extension
$key integer The key
$name string Name
$nullable boolean Whether the key is nullable or not
$type string Type

Public Methods

Method Description
__construct ( array $row ) Constructor
format ( string $text ) : string Formats a string
formatCs ( string $text ) : string Formats a string for C#
formatXml ( string $text ) : string Formats a string for XML
getDotNetObjectType ( ) : string Gets the .NET object type
getDotNetPrimitiveType ( ) : string Gets the .NET primitive type
getIndexName ( ) : string Gets the index name
getPureType ( ) : string Gets the pure type
isNotNull ( ) : boolean Tells whether the key is null or not
isPK ( ) : boolean Tells whether the key is primary or not
isUnique ( ) : boolean Tells whether the key is unique or not

Method Details

__construct() public method

Constructor
public __construct ( array $row )
$row array table row

format() public method

Formats a string
public format ( string $text ) : string
$text string string to be formatted
return string formatted text

formatCs() public method

Formats a string for C#
public formatCs ( string $text ) : string
$text string string to be formatted
return string formatted text

formatXml() public method

Formats a string for XML
public formatXml ( string $text ) : string
$text string string to be formatted
return string formatted text

getDotNetObjectType() public method

Gets the .NET object type
public getDotNetObjectType ( ) : string
return string type

getDotNetPrimitiveType() public method

Gets the .NET primitive type
public getDotNetPrimitiveType ( ) : string
return string type

getIndexName() public method

Gets the index name
public getIndexName ( ) : string
return string containing the name of the index

getPureType() public method

Gets the pure type
public getPureType ( ) : string
return string type

isNotNull() public method

Tells whether the key is null or not
public isNotNull ( ) : boolean
return boolean true if the key is not null, false otherwise

isPK() public method

Tells whether the key is primary or not
public isPK ( ) : boolean
return boolean true if the key is primary, false otherwise

isUnique() public method

Tells whether the key is unique or not
public isUnique ( ) : boolean
return boolean true if the key is unique, false otherwise

Property Details

$defaultValue public property

Default value
public mixed $defaultValue
return mixed

$ext public property

Extension
public string $ext
return string

$key public property

The key
public int $key
return integer

$name public property

Name
public string $name
return string

$nullable public property

Whether the key is nullable or not
public bool $nullable
return boolean

$type public property

Type
public string $type
return string