PRADO Component Framework for PHP 5
  • Home
  • About
  • Testimonials
  • Demos
  • Download
  • Documentation
  • Forum
  • Development
  • Tutorials
  • Class Docs
  • API Manual
  • Wiki

Packages

  • None
  • System
    • Caching
    • Collections
    • Data
      • ActiveRecord
        • Relations
        • Scaffold
          • InputBuilder
      • Commom
        • Sqlite
      • Common
        • Mssql
        • Mysql
        • Oracle
        • Pgsql
        • Sqlite
      • DataGateway
      • SqlMap
        • Configuration
        • Statements
    • Exceptions
    • I18N
    • IO
    • Security
    • Util
    • Web
      • Javascripts
      • Services
      • UI
        • ActiveControls
        • WebControls
    • Xml
  • Wsat
    • pages
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class TPropertyValue

TPropertyValue class

TPropertyValue is a utility class that provides static methods to convert component property values to specific types.

TPropertyValue is commonly used in component setter methods to ensure the new property value is of specific type. For example, a boolean-typed property setter method would be as follows,

function setPropertyName($value) {
    $value=TPropertyValue::ensureBoolean($value);
    // $value is now of boolean type
}

Properties can be of the following types with specific type conversion rules:

  • string: a boolean value will be converted to 'true' or 'false'.
  • boolean: string 'true' (case-insensitive) will be converted to true, string 'false' (case-insensitive) will be converted to false.
  • integer
  • float
  • array: string starting with '(' and ending with ')' will be considered as as an array expression and will be evaluated. Otherwise, an array with the value to be ensured is returned.
  • object
  • enum: enumerable type, represented by an array of strings.
Package: System
Copyright: Copyright © 2005-2014 PradoSoft
License: http://www.pradosoft.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0
Located at TComponent.php
Methods summary
public static boolean
# ensureBoolean( mixed $value )

Converts a value to boolean type. Note, string 'true' (case-insensitive) will be converted to true, string 'false' (case-insensitive) will be converted to false. If a string represents a non-zero number, it will be treated as true.

Converts a value to boolean type. Note, string 'true' (case-insensitive) will be converted to true, string 'false' (case-insensitive) will be converted to false. If a string represents a non-zero number, it will be treated as true.

Parameters

$value
mixed
the value to be converted.

Returns

boolean
public static string
# ensureString( mixed $value )

Converts a value to string type. Note, a boolean value will be converted to 'true' if it is true and 'false' if it is false.

Converts a value to string type. Note, a boolean value will be converted to 'true' if it is true and 'false' if it is false.

Parameters

$value
mixed
the value to be converted.

Returns

string
public static integer
# ensureInteger( mixed $value )

Converts a value to integer type.

Converts a value to integer type.

Parameters

$value
mixed
the value to be converted.

Returns

integer
public static float
# ensureFloat( mixed $value )

Converts a value to float type.

Converts a value to float type.

Parameters

$value
mixed
the value to be converted.

Returns

float
public static array
# ensureArray( mixed $value )

Converts a value to array type. If the value is a string and it is in the form (a,b,c) then an array consisting of each of the elements will be returned. If the value is a string and it is not in this form then an array consisting of just the string will be returned. If the value is not a string then

Converts a value to array type. If the value is a string and it is in the form (a,b,c) then an array consisting of each of the elements will be returned. If the value is a string and it is not in this form then an array consisting of just the string will be returned. If the value is not a string then

Parameters

$value
mixed
the value to be converted.

Returns

array
public static object
# ensureObject( mixed $value )

Converts a value to object type.

Converts a value to object type.

Parameters

$value
mixed
the value to be converted.

Returns

object
public static string
# ensureEnum( mixed $value, mixed $enums )

Converts a value to enum type.

Converts a value to enum type.

This method checks if the value is of the specified enumerable type. A value is a valid enumerable value if it is equal to the name of a constant in the specified enumerable type (class). For more details about enumerable, see TEnumerable.

For backward compatibility, this method also supports sanity check of a string value to see if it is among the given list of strings.

Parameters

$value
mixed
the value to be converted.
$enums
mixed
class name of the enumerable type, or array of valid enumeration values. If this is not an array, the method considers its parameters are of variable length, and the second till the last parameters are enumeration values.

Returns

string
the valid enumeration value

Throws

TInvalidDataValueException
if the original value is not in the string array.
public static mixed
# ensureNullIfEmpty( mixed $value )

Converts the value to 'null' if the given value is empty

Converts the value to 'null' if the given value is empty

Parameters

$value
mixed
value to be converted

Returns

mixed
input or NULL if input is empty
Terms of Service | Contact Us
PRADO v3.2.4 API Manual API documentation generated by ApiGen 2.8.0
Copyright © 2006-2014 by the PRADO Group.
Powered by PRADO