fsMeta (ClassDoc)

Files

File	Comments
class/fsmeta.php	This is the main include file of fsMeta - all required classes will be loaded by this include. You can safely include this file several times - it will only load once. XoopsForm element classes are automatically loaded, if the XoopsForm class has already been loaded.
class/fsmeta_meta.php	-
class/fsmeta_factory.php	-
class/fsmeta_form.php	-
class/fsmeta_table.php	-
class/fsmeta_field.php	-
class/fsmeta_field_factory.php	-
class/fsmeta_choice.php	-
class/fsmeta_choice_factory.php	-
class/fsmeta_types.php	-

Classes

Class	Comments
fsMetaException	This is the exception-class used throughout the fsMeta system.
fsMeta	This is the main class used for reading, writing, rendering form inputs and parsing posted form input. (more...)
fsMetaFactory	This factory class can be used to query metadata, or as a helper to create JOIN statements in foreign factory classes.
XoopsFormMetaData	This XoopsFormElement can be used to render groups of metadata editors. (more...)
fsMetaTable	A table represents a single physical table containing metadata, and provides access to fields. (more...)
fsMetaField	Field-type determines the kind of type-handler class used to manage the field, refer to the fsMetaType classes for more information. (more...)
fsMetaFieldFactory	-
fsMetaChoice	This class implements a choice for a field (e.g. fields of type Select or Multi) (more...)
fsMetaChoiceFactory	-
fsMetaTypeHandler	This class provides utility functions related to field-type handlers. (more...)
fsMetaType	This abstract class defines abstract and default methods for all field-type handlers.
fsMetaType_String	This handler implements a simple string, stored in a VARCHAR(255) column
fsMetaType_Text	This handler implements a large string, stored in a TEXT column
fsMetaType_Int	This handler implements a signed integer number, stored in an INT column
fsMetaType_Time	This handler implements a date and time field, stored in a DATETIME column
fsMetaType_Select	This handler implements single selection from a collection of choices, stored as a single INT column. (more...)
fsMetaType_Multi	This class implements multiple selections from a collection of choices, stored as one TINYINT column per choice. (more...)

fsMetaException in file class/fsmeta.php

Extends: Exception

This is the exception-class used throughout the fsMeta system.

Member Methods

Method

Comments

__construct Has parameters

fsMeta in file class/fsmeta_meta.php

This is the main class used for reading, writing, rendering form inputs and parsing posted form input.

Use metadata accessor methods to get to the actual metadata.

Use the form input/output methods to easily render and parse form elements.

Member Methods

Method

Comments

~ fs Meta

If the provided tablename does not exist, a table with that name is automatically created. (more...)

public static fsMeta ( $tablename, $id )

If the provided tablename does not exist, a table with that name is automatically created.

The constructor will throw an fsMetaException, if the provided id is not a positive integer value.

Argument	Default	Comments
$tablename	-	the name of the physical table, NOT including the 'xoops_' prefix.
$id	null	primary id, optional - if omitted (or null), a "dummy" fsMeta object is created. You can use a "dummy" fsMeta object to render forms for new objects, when you do not yet know what the primary id is going to be.

Misc. accessors

get Table Name

get Id

Metadata accessors

get Value

Retrieves the value of the given metadata field.

set Value

Set the given field to the given value. (more...)

public setValue ( $fieldname, $value )

Set the given field to the given value.

Note that you have to call the save() method to physically save the new data.

Argument	Default	Comments
$fieldname	-	-
$value	-	-

get Values Has comments

Returns an associative array containing all metadata values. (more...)

save

Save changed values permanently in the database.

Form input/output methods

add Elements Has comments

Creates and configured a XoopsFormMetaData element for every group, and adds them to the given XoopsForm. (more...)

public addElements ( &$form, $extra, $prefix )

Creates and configured a XoopsFormMetaData element for every group, and adds them to the given XoopsForm.

Hint: This is the simplest method for adding metadata-inputs to your XoopsForm.

Argument	Default	Comments
&$form	-	-
$extra	''	-
$prefix	''	optional - prefix for form input names, rarely needed. (only if you have multiple metadata-editors for different objects on the same page)

get Element Has comments

Creates and configures a XoopsFormMetaData element, that you can add to your form with [XoopsForm::addElement()].

public getElement ( $groupname, $prefix )

Creates and configures a XoopsFormMetaData element, that you can add to your form with [XoopsForm::addElement()].

Argument	Default	Comments
$groupname	null	optional - if specified, only fields with the given group-name are added to the created form-element.
$prefix	''	optional - prefix for form input names, rarely needed. (only if you have multiple metadata-editors for different objects on the same page)

render

Renders the field with the given fieldname as a form INPUT element.

public render ( $fieldname, $prefix, $extra, $options )

Renders the field with the given fieldname as a form INPUT element.

Argument	Default	Comments
$fieldname	-	-
$prefix	''	optional - if supplied, this string is prefixed on the form INPUT NAME.
$extra	''	optional - use this if you need to inject (for example) a class or style attribute in the INPUT element.
$options	null	optional, an array with additional options. The available options differ for every field type - please refer to the fsMetaType classes.

parse

Parses a value from a POST or GET request, from an INPUT element rendered using the render() method, and returns a PHP-value (suitable for use with setValue).

public parse ( $fieldname, $prefix, $post )

Parses a value from a POST or GET request, from an INPUT element rendered using the render() method, and returns a PHP-value (suitable for use with setValue).

Argument	Default	Comments
$fieldname	-	-
$prefix	''	optional - if supplied, must match the prefix you specified when you used render().
$post	true	optional, defaults to true - if false, $_GET[] will be used instead of $_POST[].

pickup

Automatically pick up, parse and set values from a POST or GET request, from INPUT elements rendered using calls to render(). (more...)

public pickup ( $prefix, $groupname, $post )

Automatically pick up, parse and set values from a POST or GET request, from INPUT elements rendered using calls to render().

You still have to manually call save() after calling this method.

Hint: Use the XoopsFormMetaData class to easily add a group of fields to a XoopsForm.

Argument	Default	Comments
$prefix	''	optional - if supplied, must match the prefix used with previous render() calls.
$groupname	-1	optional - if supplied, picks up only fields with the given group-name. Use a null-argument to pick up only ungrouped fields.
$post	true	optional, defaults to true - if false, $_GET[] will be used instead of $_POST[].

Object removal

remove

Remove this metadata object.

Utility methods

get Table

Returns the fsMetaTable object associated with the table of this object.

get Fields Has comments

Returns an array containing fsMetaField objects.

public getFields ( $groupname )

Returns an array containing fsMetaField objects.

Argument	Default	Comments
$groupname	-1	optional - if specified, returns only fields with the given group-name. Use a null-argument to retrieve ungrouped fields.

Internal helper functions

init Values

fsMetaFactory in file class/fsmeta_factory.php

This factory class can be used to query metadata, or as a helper to create JOIN statements in foreign factory classes.

Member Methods

Method

Comments

~ fs Meta Factory

public fsMetaFactory ( $tablename, $logic )

Argument	Default	Comments
$tablename	-	-
$logic	"AND"	the logic to use when combining subsequent added criteria, e.g. "AND" or "OR".

Logic control methods

These methods enable you to build queries with complex logic.

begin Logic Has comments

Start a new logic block. (more...)

public beginLogic ( $logic )

Start a new logic block.

Any subsequent calls to criteria building methods, will add criteria to the new logic block.

Once you have added all your criteria, you must call endLogic() to end the logic block.

$logic: the logic to use when combining subsequent added criteria, e.g. "AND" or "OR".

Argument	Default	Comments
$logic	-	-

end Logic

End the current logic block. (more...)

Criteria building methods

add Criteria Has comments

Most comparisons can be done with this method, for example: (more...)

public addCriteria ( $fieldname, $value, $operator )

Most comparisons can be done with this method, for example:

$myfactory->addCriteria("email", "%@fyens.dk", "LIKE"); // "email" fields must end in "fyens.dk"

$myfactory->addCriteria("interest", array("sport", "art"), "IN"); // "interest" fields must contain either "sport" or "art"

$myfactory->addCriteria("age", 18, ">="); // "age" fields must contain values greater or equal to 18

Argument	Default	Comments
$fieldname	-	-
$value	-	-
$operator	-	-

add Null

Adds a null-comparison criteria: $fieldname must contain a NULL value ($null = true), or field value must NOT contain a NULL value ($null = false).

public addNull ( $fieldname, $null )

Adds a null-comparison criteria: $fieldname must contain a NULL value ($null = true), or field value must NOT contain a NULL value ($null = false).

Argument	Default	Comments
$fieldname	-	-
$null	true	-

Query methods

get Meta

Executes the query and returns an associative array of fsMeta objects, using record ids as array-keys. (more...)

count

Counts the number of records matching the criteria of this factory instance.

touch

Touches all records matching the criteria of this factory instance. (more...)

Helper functions

The following helper functions are used internally, but are also useful to foreign factory classes.

get Expression Has comments

Builds an expression you can use in the WHERE clause of an SQL statement.

get Source Has comments

Returns the source tablename, backtick-quoted, suitable for use in an SQL statement.

get Key

Returns the source table's primary key, fully qualified and backtick-quoted, suitable for use in an SQL statement.

get Column Has comments

Determines the column-name of the given field and value, returns a backtick-quoted, fully qualified column-name, suitable for use in a SQL statement - e.g. "`mytable`.`mycolumn`". (more...)

public getColumn ( $fieldname, $value )

Determines the column-name of the given field and value, returns a backtick-quoted, fully qualified column-name, suitable for use in a SQL statement - e.g. "`mytable`.`mycolumn`".

If used with a multi-column field (such as fieldtype Multi) the value argument must be used.

Note: this method returns null, if the given fieldname and value could not be resolved to a column-name.

Argument	Default	Comments
$fieldname	-	-
$value	null	-

get Value

Returns an SQL-value, suitable for use in a comparison expression in a WHERE clause. (more...)

public getValue ( $fieldname, &$value )

Returns an SQL-value, suitable for use in a comparison expression in a WHERE clause.

Note: this method returns null, if the given fieldname and value could not be resolved to a column-name.

Argument	Default	Comments
$fieldname	-	-
&$value	-	-

Private helper functions

_get S Q L Has parameters

XoopsFormMetaData in file class/fsmeta_form.php

Extends: XoopsFormElement

This XoopsFormElement can be used to render groups of metadata editors.

Use the standard method setExtra() to inject additional attributes into the <table> tag, e.g. class="myclass", etc.

You can use the fsMeta::pickup method to easily pick up groups of posted metadata values.

Member Methods

Method

Comments

~ Xoops Form Meta Data

public XoopsFormMetaData ( $caption, $name, $tablename, $id, $groupname )

Argument	Default	Comments
$caption	-	-
$name	-	-
$tablename	-	-
$id	null	-
$groupname	null	-

render

fsMetaTable in file class/fsmeta_table.php

Extends: fsObject

A table represents a single physical table containing metadata, and provides access to fields.

A field is often the same as a physical column in the underlying table, but not as a rule - the fieldtype Multi, for example, uses multiple columns to store selections.

Member Methods

Method

Comments

~ fs Meta Table

You should not call the constructor directly - instead, please use the static getTable() method.

public static fsMetaTable ( $tablename, $values )

You should not call the constructor directly - instead, please use the static getTable() method.

Argument	Default	Comments
$tablename	-	-
$values	array()	-

Instanciation

get Table

Returns an instance of fsMetaTable. (more...)

public static getTable ( $tablename )

Returns an instance of fsMetaTable.

Warning: If no table with the given tablename exists, an empty table is created. Therefore you can NOT use this method simply to check if a table exists!

Argument	Default	Comments
$tablename	-	-

Accessors

get Table Name

get Title

set Title

get Description

set Description Has parameters

Field management methods

get Fields Has comments

Returns an array containing all the fsMetaField objects of this fsMetaTable. (more...)

public getFields ( $groupname )

Returns an array containing all the fsMetaField objects of this fsMetaTable.

The returned associative array is indexed using fieldnames.

Argument	Default	Comments
$groupname	-1	optional - if specified, returns only fsMetaField objects with the given group-name. Use a null-argument to retrieve ungrouped fields.

get Field

Returns the fsMetaField object with the given fieldname. (more...)

public getField ( $fieldname )

Returns the fsMetaField object with the given fieldname.

Returns null if no field with the given fieldname exists in this table.

Argument	Default	Comments
$fieldname	-	-

create Field Has comments

Creates and returns a new fsMetaField object with the given fieldname and fieldtype. (more...)

public createField ( $fieldname, $fieldtype )

Creates and returns a new fsMetaField object with the given fieldname and fieldtype.

Throws an fsMetaException on failure, which could be due to duplicate fieldname, or invalid fieldtype.

Argument	Default	Comments
$fieldname	-	-
$fieldtype	-	-

Utility methods

get Schema Has comments

Returns the Schema object for this table.

get Groups Has comments

Returns an array containing all fsMetaGroup objects associated with this table. (more...)

Object creation

create

Creates and returns a new fsMetaTable with the given tablename. (more...)

public static create ( $tablename )

Creates and returns a new fsMetaTable with the given tablename.

May throw an fsMetaException, and returns false, if a table with the given name already exists.

Argument	Default	Comments
$tablename	-	-

Object removal

remove

Object retrieval

get All

Returns an array containing all fsMetaTable objects.

public static getAll ( $prefix )

Returns an array containing all fsMetaTable objects.

Argument	Default	Comments
$prefix	null	optional - if supplied, returns only tables with names beginning with the given prefix.

fsMetaField in file class/fsmeta_field.php

Extends: fsObject

Field-type determines the kind of type-handler class used to manage the field, refer to the fsMetaType classes for more information.

Fields are always ordered, ascending, first by group number, then by priority.

Group name is optional, and can be used to group fields together - the fsMeta class, for example, has a render() method which takes a $groupname argument, which can be used to render only a certain group of fields.

Field-options refer to a small collection of special options for the type-handler's render() method, and so is typically used to change the behavior or layout of the rendered html inputs. Each type-handler has a disctinct set of available options - most don't have any. The fsMetaType_Select handler, for example, has a "mode" option that can be used to render the field as a dropdown or group of radio buttons.

A field is often the same as a physical column in the underlying table, but not as a rule - the fieldtype Multi, for example, uses multiple columns to store selections. Such fields also always have choices associated with them.

Generally, you can use getHandler() to get the handler of a field, then use the handlers isMultiColumn() method to check if the field uses one or more columns to store it's value.

For single-column fields, the physical column-name in the field's table is simply the fieldname, e.g. getFieldName().

For multi-column fields, each associated choice is related to a physical column in the underlying table. Column-names are composed of the fieldname, followed by two underscores "__", followed by the choice-index.

Member Methods

Method

Comments

~ fs Meta Field

public static fsMetaField ( $tablename, $fieldname, $values )

Argument	Default	Comments
$tablename	-	-
$fieldname	-	-
$values	array()	-

Accessors

get Table Name

get Field Name

get Field Type

get Priority

set Priority Has parameters

get Title

set Title

get Hint

set Hint

get Description

set Description Has parameters

get Group Name

set Group Name Has parameters

get Field Options Has comments

An associative array containing options for this field's handler.

set Field Options Has parameters

Utility methods

get Handler

get Table

Form input/output methods

render

Renders this field as HTML code, using $value as the current value. (more...)

public render ( $value, $prefix, $extra, $options )

Renders this field as HTML code, using $value as the current value.

(if you're looking for a way to render your metadata as HTML code, you most likely want the [fsMeta::render] method.)

Argument	Default	Comments
$value	null	-
$prefix	''	-
$extra	''	-
$options	null	-

parse

Parses a value submitted from a FORM built using calls to render(). (more...)

public parse ( $prefix, $post )

Parses a value submitted from a FORM built using calls to render().

(if you're looking for a way to parse your metadata forms, you most likely want the [fsMeta::parse] method.)

Argument	Default	Comments
$prefix	''	-
$post	true	-

Choice management methods

get Choices Has comments

Returns all fsMetaChoice objects associated with this field. (more...)

public getChoices ( $index_by, $use_cache )

Returns all fsMetaChoice objects associated with this field.

The result is an associative array where the keys, by default, are the choice-indexes.

May return an empty array.

Argument	Default	Comments
$index_by	'index'	optional, defaults to 'index' - specifies which field to use as key in the the returned associative array. Also useful is 'value', to quickly look up a choice by its user-value.
$use_cache	true	used internally for optimization - do not use.

add Choice Has comments

Creates and returns a new fsMetaChoice object for this field. (more...)

public static addChoice ( $title, $value )

Creates and returns a new fsMetaChoice object for this field.

Throws an fsMetaException on error.

Argument	Default	Comments
$title	-	-
$value	-	-

Object creation

create

Creates and returns a new fsMetaField, and associates it with the fsMetaTable with the given tablename. (more...)

public static create ( $tablename, $fieldname, $fieldtype )

Creates and returns a new fsMetaField, and associates it with the fsMetaTable with the given tablename.

May throw an fsMetaException if a field with the given fieldname already exists in the given table, or if the requested fieldtype is invalid.

Argument	Default	Comments
$tablename	-	-
$fieldname	-	-
$fieldtype	-	-

Object removal

remove

Object retrieval

get Field

Returns an instance of a fsMetaField object - you should use this to acquire field objects, rather than the constructor. (more...)

public static getField ( $tablename, $fieldname, &$cache_inject )

Returns an instance of a fsMetaField object - you should use this to acquire field objects, rather than the constructor.

If the specified field can not be found, this method throws an fsMetaException.

$cache_inject: this parameter is used internally for caching - you should not use it.

Argument	Default	Comments
$tablename	-	-
$fieldname	-	-
&$cache_inject	array()	-

get By Table Name Has comments

Returns an associative array containing all fields for the given table. (more...)

public static getByTableName ( $tablename, $groupname )

Returns an associative array containing all fields for the given table.

The returned array is indexed using fieldnames.

Argument	Default	Comments
$tablename	-	-
$groupname	-1	optional - if specified, returns only fields with the given group-name. Use a null-argument to retrieve ungrouped fields.

Helper methods

is Valid Field Name Has parameters

fsMetaFieldFactory in file class/fsmeta_field_factory.php

Member Methods

Method

Comments

set Table Name Has parameters

set Field Name Has parameters

set Group Name Has parameters

get Fields Has parameters

public getFields ( $index_by )

Argument	Default	Comments
$index_by	null	which field to index the returned array by, for example 'fieldname' (optional, defaults to a plain numeric array)

fsMetaChoice in file class/fsmeta_choice.php

Extends: fsObject

This class implements a choice for a field (e.g. fields of type Select or Multi)

Choice-value refers to the underlying value of a choice - for example, when you get the value of a Select, this is the value that is returned.

Choices are idenitified by a triple-key: tablename, fieldname and index - the value of a Select or Multi is thus identified by the value's index, which means you can change the underlying choice-value of a choice without problems.

Member Methods

Method

Comments

~ fs Meta Choice

public fsMetaChoice ( $tablename, $fieldname, $index, $values )

Argument	Default	Comments
$tablename	-	-
$fieldname	-	-
$index	-	-
$values	array()	-

Accessors

get Table Name

get Field Name

get Index

get Title

set Title

get Choice Value

set Choice Value Has parameters

get Priority

set Priority Has parameters

Utility methods

get Field

get Column Name

Object creation

create

Creates and returns a new fsMetaChoice object. (more...)

public static create ( $tablename, $fieldname, $title, $value )

Creates and returns a new fsMetaChoice object.

Throws an fsMetaException if the provided title or value are invalid or missing, or if the provided tablename/fieldname does not exist.

Argument	Default	Comments
$tablename	-	-
$fieldname	-	-
$title	-	-
$value	-	-

Object removal

remove

fsMetaChoiceFactory in file class/fsmeta_choice_factory.php

Member Methods

Method

Comments

set Table Name Has parameters

set Field Name Has parameters

set Choice Value Has parameters

get Choices Has parameters

public getChoices ( $index_by )

Argument	Default	Comments
$index_by	null	which field to index the returned array by, for example 'index' (optional, defaults to a plain numeric array)

fsMetaTypeHandler in file class/fsmeta_types.php

This class provides utility functions related to field-type handlers.

You should not create instances of this class - all of its methods are static.

Member Methods

Method

Comments

is Valid Type Has comments

Use this function to check if the given typename is a valid typename.

get Valid Types Has comments

Returns an array of valid metatypenames.

get Handler Has comments

Returns a global instance of the given metatype handler.

fsMetaType in file class/fsmeta_types.php

Derived classes: fsMetaType_String, fsMetaType_Int, fsMetaType_Time, fsMetaType_Select, fsMetaType_Multi

This abstract class defines abstract and default methods for all field-type handlers.

Member Methods

Method

Comments

is Multi Column Has comments

Returns true if this field uses multiple columns to store its value. (more...)

has Choices Has comments

Returns true if this field-type can have choices. (more...)

render Options Has comments

Returns an array of form-elements specific to a field-type. (more...)

public renderOptions ( $prefix, &$options )

Returns an array of form-elements specific to a field-type.

The generated form-elements are prefixed with the given string.

Use parseOptions() with the same prefix to parse the posted options.

(admin/meta_field.php uses this method to display a field's options)

Argument	Default	Comments
$prefix	-	-
&$options	-	-

parse Options Has comments

Parses posted options, returns an associative array. (more...)

public parseOptions ( $prefix )

Parses posted options, returns an associative array.

Use renderOptions() to render form-elements

(admin/meta_field_save.php uses this method to save a field's options)

Argument	Default	Comments
$prefix	-	-

init Column Has comments

Initializes type and length (etc.) for the given SchemaColumn object, according to a type's specific requirements

encode

Encode (and quote) a given PHP-value as an SQL-value

decode

Decode a given SQL-value to a PHP-value

render

Renders a given field as an HTML input with the given current value.

parse

This returns a value from a FORM, via POST or GET request, and translates it to a PHP-value (e.g. compatible with [fsMeta::setValue])

public parse ( &$field, $prefix, $post )

This returns a value from a FORM, via POST or GET request, and translates it to a PHP-value (e.g. compatible with [fsMeta::setValue])

Argument	Default	Comments
&$field	-	-
$prefix	''	this must match the prefix you specified if you used a prefix to render() the form input.
$post	true	optional, defaults to true - if false, will pick up values from $_GET[] instead of $_POST[].

fsMetaType_String in file class/fsmeta_types.php

Derived classes: fsMetaType_Text Extends: fsMetaType

This handler implements a simple string, stored in a VARCHAR(255) column

Member Methods

Method

Comments

encode

decode

init Column Has parameters

render

public render ( &$field, $value, $prefix, $extra, $options )

Argument	Default	Comments
&$field	-	-
$value	null	-
$prefix	''	-
$extra	''	-
$options	null	-

[fsMetaType]

is Multi Column Has comments

Returns true if this field uses multiple columns to store its value. (more...)

has Choices Has comments

Returns true if this field-type can have choices. (more...)

render Options Has comments

Returns an array of form-elements specific to a field-type. (more...)

public renderOptions ( $prefix, &$options )

Returns an array of form-elements specific to a field-type.

The generated form-elements are prefixed with the given string.

Use parseOptions() with the same prefix to parse the posted options.

(admin/meta_field.php uses this method to display a field's options)

Argument	Default	Comments
$prefix	-	-
&$options	-	-

parse Options Has comments

Parses posted options, returns an associative array. (more...)

public parseOptions ( $prefix )

Parses posted options, returns an associative array.

Use renderOptions() to render form-elements

(admin/meta_field_save.php uses this method to save a field's options)

Argument	Default	Comments
$prefix	-	-

parse

This returns a value from a FORM, via POST or GET request, and translates it to a PHP-value (e.g. compatible with [fsMeta::setValue])

public parse ( &$field, $prefix, $post )

This returns a value from a FORM, via POST or GET request, and translates it to a PHP-value (e.g. compatible with [fsMeta::setValue])

Argument	Default	Comments
&$field	-	-
$prefix	''	this must match the prefix you specified if you used a prefix to render() the form input.
$post	true	optional, defaults to true - if false, will pick up values from $_GET[] instead of $_POST[].

fsMetaType_Text in file class/fsmeta_types.php

Extends: fsMetaType_String

This handler implements a large string, stored in a TEXT column

Member Methods

Method

Comments

init Column Has parameters

render

public render ( &$field, $value, $prefix, $extra, $options )

Argument	Default	Comments
&$field	-	-
$value	null	-
$prefix	''	-
$extra	''	-
$options	null	-

[fsMetaType_String]

encode

decode

[fsMetaType_String] :: [fsMetaType]

is Multi Column Has comments

Returns true if this field uses multiple columns to store its value. (more...)

has Choices Has comments

Returns true if this field-type can have choices. (more...)

render Options Has comments

Returns an array of form-elements specific to a field-type. (more...)

public renderOptions ( $prefix, &$options )

Returns an array of form-elements specific to a field-type.

The generated form-elements are prefixed with the given string.

Use parseOptions() with the same prefix to parse the posted options.

(admin/meta_field.php uses this method to display a field's options)

Argument	Default	Comments
$prefix	-	-
&$options	-	-

parse Options Has comments

Parses posted options, returns an associative array. (more...)

public parseOptions ( $prefix )

Parses posted options, returns an associative array.

Use renderOptions() to render form-elements

(admin/meta_field_save.php uses this method to save a field's options)

Argument	Default	Comments
$prefix	-	-

parse

This returns a value from a FORM, via POST or GET request, and translates it to a PHP-value (e.g. compatible with [fsMeta::setValue])

public parse ( &$field, $prefix, $post )

This returns a value from a FORM, via POST or GET request, and translates it to a PHP-value (e.g. compatible with [fsMeta::setValue])

Argument	Default	Comments
&$field	-	-
$prefix	''	this must match the prefix you specified if you used a prefix to render() the form input.
$post	true	optional, defaults to true - if false, will pick up values from $_GET[] instead of $_POST[].

fsMetaType_Int in file class/fsmeta_types.php

Extends: fsMetaType

This handler implements a signed integer number, stored in an INT column

Member Methods

Method

Comments

encode

decode

init Column Has parameters

render

public render ( &$field, $value, $prefix, $extra, $options )

Argument	Default	Comments
&$field	-	-
$value	null	-
$prefix	''	-
$extra	''	-
$options	null	-

parse

[fsMetaType]

is Multi Column Has comments

Returns true if this field uses multiple columns to store its value. (more...)

has Choices Has comments

Returns true if this field-type can have choices. (more...)

render Options Has comments

Returns an array of form-elements specific to a field-type. (more...)

public renderOptions ( $prefix, &$options )

Returns an array of form-elements specific to a field-type.

The generated form-elements are prefixed with the given string.

Use parseOptions() with the same prefix to parse the posted options.

(admin/meta_field.php uses this method to display a field's options)

Argument	Default	Comments
$prefix	-	-
&$options	-	-

parse Options Has comments

Parses posted options, returns an associative array. (more...)

public parseOptions ( $prefix )

Parses posted options, returns an associative array.

Use renderOptions() to render form-elements

(admin/meta_field_save.php uses this method to save a field's options)

Argument	Default	Comments
$prefix	-	-

fsMetaType_Time in file class/fsmeta_types.php

Extends: fsMetaType

This handler implements a date and time field, stored in a DATETIME column

Member Methods

Method

Comments

encode

decode

init Column Has parameters

render

public render ( &$field, $value, $prefix, $extra, $options )

Argument	Default	Comments
&$field	-	-
$value	null	-
$prefix	''	-
$extra	''	-
$options	null	-

parse

[fsMetaType]

is Multi Column Has comments

Returns true if this field uses multiple columns to store its value. (more...)

has Choices Has comments

Returns true if this field-type can have choices. (more...)

render Options Has comments

Returns an array of form-elements specific to a field-type. (more...)

public renderOptions ( $prefix, &$options )

Returns an array of form-elements specific to a field-type.

The generated form-elements are prefixed with the given string.

Use parseOptions() with the same prefix to parse the posted options.

(admin/meta_field.php uses this method to display a field's options)

Argument	Default	Comments
$prefix	-	-
&$options	-	-

parse Options Has comments

Parses posted options, returns an associative array. (more...)

public parseOptions ( $prefix )

Parses posted options, returns an associative array.

Use renderOptions() to render form-elements

(admin/meta_field_save.php uses this method to save a field's options)

Argument	Default	Comments
$prefix	-	-

fsMetaType_Select in file class/fsmeta_types.php

Extends: fsMetaType

This handler implements single selection from a collection of choices, stored as a single INT column.

The stored value is the choice-index of the selected choice.

Member Methods

Method

Comments

encode

decode

init Column Has parameters

has Choices

render Options Has parameters

parse Options Has parameters

render

public render ( &$field, $value, $prefix, $extra, $options )

Argument	Default	Comments
&$field	-	-
$value	null	-
$prefix	''	-
$extra	''	-
$options	null	use array("mode" => "radios") to render as a group of radio buttons, and/or array("separator" => "...") to change the code inserted between each radio input (defaults to "<br />").

[fsMetaType]

is Multi Column Has comments

Returns true if this field uses multiple columns to store its value. (more...)

parse

This returns a value from a FORM, via POST or GET request, and translates it to a PHP-value (e.g. compatible with [fsMeta::setValue])

public parse ( &$field, $prefix, $post )

This returns a value from a FORM, via POST or GET request, and translates it to a PHP-value (e.g. compatible with [fsMeta::setValue])

Argument	Default	Comments
&$field	-	-
$prefix	''	this must match the prefix you specified if you used a prefix to render() the form input.
$post	true	optional, defaults to true - if false, will pick up values from $_GET[] instead of $_POST[].

fsMetaType_Multi in file class/fsmeta_types.php

Extends: fsMetaType

This class implements multiple selections from a collection of choices, stored as one TINYINT column per choice.

On the PHP-side, the selections are read/written as associative arrays, containing one element per available choice. The keys of this array, are choice-values, and the value of each element is a boolean true/false.

Member Methods

Method

Comments

encode

decode

init Column Has parameters

is Multi Column

has Choices

render Options Has parameters

parse Options Has parameters

render

public render ( &$field, $value, $prefix, $extra, $options )

Argument	Default	Comments
&$field	-	-
$value	null	-
$prefix	''	-
$extra	''	-
$options	null	use array("mode" => "checkboxes") to render as a group of checkboxes, and/or array("separator" => "...") to change the code inserted between each checkbox input (defaults to "<br />").

parse