• Home
  • PodsField_Currency

PHP Class PodsField_Currency, pods

Inheritance: extends PodsField
Show file Open project: pods-framework/pods Class Usage Examples

Public Properties

Property Type Description
$currencies array Currency Formats
$group string Field Type Group
$label string Field Type Label
$prepare string Field Type Preparation
$type string Field Type Identifier

Public Methods

Method Description
__construct ( ) Do things like register/enqueue scripts and stylesheets
display ( mixed $value = null, string $name = null, array $options = null, array $pod = null, integer $id = null ) : mixed | null | string Change the way the value of the field is displayed with Pods::get
format ( mixed $value = null, string $name = null, array $options = null, array $pod = null, integer $id = null ) : string Reformat a number to the way the value of the field is displayed
input ( string $name, mixed $value = null, array $options = null, array $pod = null, integer $id = null ) Customize output of the form field
options ( ) : array Add options and set defaults to
pre_save ( mixed $value, integer $id = null, string $name = null, array $options = null, array $fields = null, array $pod = null, object $params = null ) : mixed | string Change the value or perform actions after validation but before saving to the DB
prepare ( array $options = null ) : array Define the current field's preparation for sprintf
regex ( mixed $value = null, string $name = null, array $options = null, string $pod = null, integer $id = null ) : boolean | string Build regex necessary for JS validation
schema ( array $options = null ) : array Define the current field's schema for DB table storage
ui ( integer $id, mixed $value, string $name = null, array $options = null, array $fields = null, array $pod = null ) : mixed | null | string Customize the Pods UI manage table column output
validate ( mixed $value, string $name = null, array $options = null, array $fields = null, array $pod = null, integer $id = null, null $params = null ) : boolean | mixed | void Validate a value before it's saved

Method Details

__construct() public method

Do things like register/enqueue scripts and stylesheets
Since: 2.0
public __construct ( )

display() public method

Change the way the value of the field is displayed with Pods::get
Since: 2.0
public display ( mixed $value = null, string $name = null, array $options = null, array $pod = null, integer $id = null ) : mixed | null | string
$value mixed
$name string
$options array
$pod array
$id integer
return mixed | null | string

format() public method

Reformat a number to the way the value of the field is displayed
Since: 2.0
public format ( mixed $value = null, string $name = null, array $options = null, array $pod = null, integer $id = null ) : string
$value mixed
$name string
$options array
$pod array
$id integer
return string

input() public method

Customize output of the form field
Since: 2.0
public input ( string $name, mixed $value = null, array $options = null, array $pod = null, integer $id = null )
$name string
$value mixed
$options array
$pod array
$id integer

options() public method

Add options and set defaults to
Since: 2.0
public options ( ) : array
return array

pre_save() public method

Change the value or perform actions after validation but before saving to the DB
Since: 2.0
public pre_save ( mixed $value, integer $id = null, string $name = null, array $options = null, array $fields = null, array $pod = null, object $params = null ) : mixed | string
$value mixed
$id integer
$name string
$options array
$fields array
$pod array
$params object
return mixed | string

prepare() public method

Define the current field's preparation for sprintf
Since: 2.0
public prepare ( array $options = null ) : array
$options array
return array

regex() public method

Build regex necessary for JS validation
Since: 2.0
public regex ( mixed $value = null, string $name = null, array $options = null, string $pod = null, integer $id = null ) : boolean | string
$value mixed
$name string
$options array
$pod string
$id integer
return boolean | string

schema() public method

Define the current field's schema for DB table storage
Since: 2.0
public schema ( array $options = null ) : array
$options array
return array

ui() public method

Customize the Pods UI manage table column output
Since: 2.0
public ui ( integer $id, mixed $value, string $name = null, array $options = null, array $fields = null, array $pod = null ) : mixed | null | string
$id integer
$value mixed
$name string
$options array
$fields array
$pod array
return mixed | null | string

validate() public method

Validate a value before it's saved
Since: 2.0
public validate ( mixed $value, string $name = null, array $options = null, array $fields = null, array $pod = null, integer $id = null, null $params = null ) : boolean | mixed | void
$value mixed
$name string
$options array
$fields array
$pod array
$id integer
$params null
return boolean | mixed | void

Property Details

$currencies public static property

Currency Formats
Since: 2.0
public static array $currencies
return array

$group public static property

Field Type Group
Since: 2.0
public static string $group
return string

$label public static property

Field Type Label
Since: 2.0
public static string $label
return string

$prepare public static property

Field Type Preparation
Since: 2.0
public static string $prepare
return string

$type public static property

Field Type Identifier
Since: 2.0
public static string $type
return string