Docs For Class Xyster_Data

Description

A mediator that applies values to a target object

copyright: Copyright (c) 2007-2008 Irrational Logic (http://irrationallogic.net)
license: New BSD License

Direct descendents

Class	Description
Xyster_Orm_Binder	A binder for entities

Variable Summary

mixed $_allowed

Xyster_Data_Binder_Setter $_defaultSetter

mixed $_disallowed

mixed $_setters

mixed $_target

Method Summary

Xyster_Data_Binder __construct (object $target)

Xyster_Data_Binder addSetter (Xyster_Data_Binder_Setter_Interface $setter, [mixed $property = null])

void bind ( $values)

array getAllowedFields ()

array getDisallowedFields ()

object getTarget ()

boolean isAllowed (string $field)

Xyster_Data_Binder setAllowedFields ( $fields)

Xyster_Data_Binder setDisallowedFields ( $fields)

Xyster_Data_Binder_Setter_Interface _getSetter (string $field)

Variables

mixed $_allowed = array() (line 32)

access: protected

Xyster_Data_Binder_Setter $_defaultSetter (line 41)

access: protected

mixed $_disallowed = array() (line 34)

access: protected

mixed $_setters = array() (line 36)

access: protected

mixed $_target (line 30)

access: protected

Methods

Constructor __construct (line 48)

Creates a new binder

access: public

Xyster_Data_Binder __construct (object $target)

object $target

Redefined in descendants as:

Xyster_Orm_Binder::__construct() : Creates a new binder for an entity

addSetter (line 67)

Adds a setter to handle a type and property

Setting the property argument to null will apply the setter to all fields

return: provides a fluent interface
access: public

Xyster_Data_Binder addSetter (Xyster_Data_Binder_Setter_Interface $setter, [mixed $property = null])

Xyster_Data_Binder_Setter_Interface $setter: The setter to add
mixed $property: Optional. A property name to which the setter applies.

bind (line 82)

Binds the values in the array to the target

access: public

void bind ( $values)

array $values

Redefined in descendants as:

Xyster_Orm_Binder::bind() : Bind the values to the target

getAllowedFields (line 97)

Gets the allowed fields

access: public

array getAllowedFields ()

getDisallowedFields (line 107)

Gets the disallowed fields

access: public

array getDisallowedFields ()

getTarget (line 117)

Gets the target object

access: public

object getTarget ()

isAllowed (line 128)

Tests if a field is allowed

access: public

boolean isAllowed (string $field)

string $field

Redefined in descendants as:

Xyster_Orm_Binder::isAllowed() : Tests if a field is allowed

setAllowedFields (line 140)

Sets the allowed fields

return: provides a fluent interface
access: public

Xyster_Data_Binder setAllowedFields ( $fields)

array $fields

setDisallowedFields (line 155)

Sets the disallowed fields

For security reasons, it is much more preferable to set the allowed fields explicitly using setAllowedFields.

return: provides a fluent interface
access: public

Xyster_Data_Binder setDisallowedFields ( $fields)

array $fields

_getSetter (line 168)

Gets a setter for the field supplied

access: protected

Xyster_Data_Binder_Setter_Interface _getSetter (string $field)

string $field: The field name

Class Xyster_Data_Binder