PHPonTrax
[ class tree: PHPonTrax ] [ index: PHPonTrax ] [ all elements ]

Class: ActiveRecordHelper

Source Location: /vendor/trax/action_view/helpers/active_record_helper.php

Class Overview

Helpers
   |
   --ActiveRecordHelper



Author(s):

Variables

Methods


Inherited Variables

Inherited Methods

Class: Helpers

Helpers::__construct()
Construct a Helpers object
Helpers::boolean_attribute()
Convert an attribute to proper XML boolean form
Helpers::cdata_section()
Wrap CDATA begin and end tags around argument
Helpers::content_tag()
Generate an open/close pair of tags with optional attributes and content between
Helpers::convert_options()
Convert selected attributes to proper XML boolean form
Helpers::object()
Given the name of an ActiveRecord subclass, find an instance
Helpers::tag()
Generate an HTML or XML tag with optional attributes and self-ending
Helpers::tag_options()
Convert array of tag attribute names and values to string
Helpers::to_content_tag()
Helpers::value()
Get value of current attribute in the current ActiveRecord object

Class Details

[line 36]


Tags:

todo:  Document this class


[ Top ]


Class Variables

$scaffolding =  false

[line 45]

Whether to generate scaffolding HTML

Set to true in form_scaffolding.phtml. If true generate HTML scaffold otherwise generate final HTML




Tags:

usedby:  ActiveRecordHelper::default_input_block()
access:  public

Type:   boolean


[ Top ]



Class Methods


method all_input_tags [line 186]

void all_input_tags( mixed $record, mixed $record_name, mixed $options)



Tags:

usedby:  ActiveRecordHelper::form()
uses:  ActiveRecordHelper::default_input_block()
todo:  Document this method


[ Top ]

method column_type [line 480]

void column_type( )



Tags:



[ Top ]

method content_tag [line 387]

void content_tag( mixed $name, mixed $value, [mixed $options = array()])



Tags:



Overrides Helpers::content_tag() (Generate an open/close pair of tags with optional attributes and content between)

[ Top ]

method content_tag_without_error_wrapping [line 375]

void content_tag_without_error_wrapping( )



Tags:

usedby:  ActiveRecordHelper::content_tag()
uses:  ActiveRecordHelper::content_tag()
todo:  Document this method


[ Top ]

method default_input_block [line 208]

void default_input_block( )



Tags:



[ Top ]

method error_message [line 469]

void error_message( )



Tags:

uses:  Helpers::object()
uses:  Helpers::$attribute_name
todo:  Document this method


[ Top ]

method error_messages_for [line 160]

void error_messages_for( mixed $object_name, [string[] $options = array()])

Returns a string with a div containing all the error messages for the object located as an instance variable by the name of <tt>object_name</tt>. This div can be tailored by the following options:

<tt>header_tag</tt> - Used for the header of the error div (default: h2) <tt>id</tt> - The id of the error div (default: errorExplanation) <tt>class</tt> - The class of the error div (default: errorExplanation)




Tags:



Parameters:

mixed   $object_name   object_name The name of a PHP class, or an object instance of that class
string[]   $options   options Set of options: 'header_tag', 'id', 'class'

[ Top ]

method error_message_on [line 137]

void error_message_on( mixed $object_name, mixed $attribute_name, [mixed $prepend_text = ""], [mixed $append_text = ""], [mixed $css_class = "formError"])

Returns a string containing the error message attached to the +method+ on the +object+, if one exists.

This error message is wrapped in a DIV tag, which can be specialized to include both a +prepend_text+ and +append_text+ to properly introduce the error and a +css_class+ to style it accordingly. Examples (post has an error message "can't be empty" on the title attribute):

<?= error_message_on("post", "title") ?> => <div class="formError">can't be empty</div>

<?= error_message_on "post", "title", "Title simply ", " (or it won't work)", "inputError" ?> => <div class="inputError">Title simply can't be empty (or it won't work)</div>




Tags:



[ Top ]

method error_wrapping [line 459]

void error_wrapping( string $html_tag, boolean $has_error)



Tags:



Parameters:

string   $html_tag  
boolean   $has_error  

[ Top ]

method form [line 106]

void form( mixed $record_name, [mixed $options = array()])

Returns an entire form with input tags and everything for a specified Active Record object. Example

(post is a new record that has a title using VARCHAR and a body using TEXT): form("post") => <form action='/post/create' method='post'> <p> <label for="post_title">Title</label>
<input id="post_title" name="post[title]" size="30" type="text" value="Hello World" /> </p> <p> <label for="post_body">Body</label>
<textarea cols="40" id="post_body" name="post[body]" rows="20"> Back to the hill and over it again! </textarea> </p> <input type='submit' value='Create' /> </form>

It's possible to specialize the form builder by using a different action name and by supplying another block renderer. Example (entry is a new record that has a message attribute using VARCHAR):

form("entry", array('action' => "sign", 'input_block' => 'foreach($record->content_columns() as $column_name => $column) $contents .= Inflector::humanize($column_name) . ": " . input($record, $column) . "
"')) =>

<form action='/post/sign' method='post'> Message: <input id="post_title" name="post[title]" size="30" type="text" value="Hello World" />
<input type='submit' value='Sign' /> </form>

It's also possible to add additional content to the form by giving it a block, such as:

form("entry", array('action' => "sign", 'block' => content_tag("b", "Department") . collection_select("department", "id", $departments, "id", "name")) )




Tags:



[ Top ]

method input [line 54]

void input( mixed $object_name, mixed $attribute_name, [mixed $options = array()])

Returns a default input tag for the type of object returned by the method. Example

(title is a VARCHAR column and holds "Hello World"): input("post", "title") => <input id="post_title" name="post[title]" size="30" type="text" value="Hello World" />




Tags:



[ Top ]

method input_scaffolding [line 62]

void input_scaffolding( mixed $object_name, mixed $attribute_name, [mixed $options = array()])



Tags:

usedby:  input_scaffolding()
usedby:  ActiveRecordHelper::default_input_block()
uses:  ActiveRecordHelper::to_scaffold_tag()
todo:  Document this method


[ Top ]

method tag [line 362]

void tag( mixed $name, [mixed $options = array()])



Tags:



Overrides Helpers::tag() (Generate an HTML or XML tag with optional attributes and self-ending)

[ Top ]

method tag_without_error_wrapping [line 350]

void tag_without_error_wrapping( )



Tags:

usedby:  ActiveRecordHelper::tag()
uses:  ActiveRecordHelper::tag()
todo:  Document this method


[ Top ]

method to_datetime_select_tag [line 445]

void to_datetime_select_tag( [mixed $options = array()])



Tags:



[ Top ]

method to_datetime_select_tag_without_error_wrapping [line 430]

void to_datetime_select_tag_without_error_wrapping( )



Tags:



[ Top ]

method to_date_select_tag [line 415]

void to_date_select_tag( [mixed $options = array()])



Tags:

todo:  Document this method


[ Top ]

method to_date_select_tag_without_error_wrapping [line 406]

void to_date_select_tag_without_error_wrapping( )



Tags:

uses:  DateHelper::to_date_select_tag()
uses:  Helpers::$attribute_name
uses:  Helpers::$object_name
todo:  Document this method


[ Top ]

method to_scaffold_tag [line 289]

void to_scaffold_tag( mixed $object_name, mixed $attribute_name, [mixed $options = array()])



Tags:



[ Top ]

method to_tag [line 233]

void to_tag( string $object_name, string $attribute_name, [string[] $options = array()])



Tags:



Parameters:

string   $object_name   object_name Name of an ActiveRecord subclass
string   $attribute_name   attribute_name Name of an attribute of $object_name
string[]   $options   options

[ Top ]


Documentation generated on Thu, 04 May 2006 19:47:15 -0600 by phpDocumentor 1.3.0RC4