Alpha Framework alpha--view--widgets
[ class tree: alpha--view--widgets ] [ index: alpha--view--widgets ] [ all elements ]

Class: RecordSelector

Source Location: /view/widgets/RecordSelector.inc

Class RecordSelector

Class Overview

Record selection HTML widget.

Located in /view/widgets/RecordSelector.inc [line 58]



		
				Author(s):
		
  • John Collins <dev@alphaframework.org>
Information Tags:
Version:  $Id: RecordSelector.inc 1453 2011-12-04 15:12:54Z johnc $
Copyright:  

Copyright (c) 2011, John Collins (founder of Alpha Framework). All rights reserved.

 Redistribution and use in source and binary forms, with or
 without modification, are permitted provided that the
 following conditions are met:

 * Redistributions of source code must retain the above
   copyright notice, this list of conditions and the
   following disclaimer.
 * Redistributions in binary form must reproduce the above
   copyright notice, this list of conditions and the
   following disclaimer in the documentation and/or other
   materials provided with the distribution.
 * Neither the name of the Alpha Framework nor the names
   of its contributors may be used to endorse or promote
   products derived from this software without specific
   prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Since:  1.0
License:  The BSD License

Methods

[ Top ]
Method Summary
RecordSelector   __construct()   The constructor.
string   render()   Renders the text boxes and buttons for the widget, that will appear in user forms.
string   renderSelector()   Returns the HTML for the record selector that will appear in a pop-up window.

[ Top ]
Methods
Constructor __construct  [line 118]

  RecordSelector __construct( Relation $relation, [string $label = ''], [string $name = ''], [string $accessingClassName = '']  )

The constructor.

Parameters:
Relation   $relation: 
string   $label: 
string   $name: 
string   $accessingClassName: 

API Tags:
Access:  public

Information Tags:
Since:  1.0
Throws:  IllegalArguementException

[ Top ]
render  [line 142]

  string render( [bool $tableTags = true], [bool $expanded = false], [bool $buttons = true]  )

Renders the text boxes and buttons for the widget, that will appear in user forms.

Parameters:
bool   $tableTags:  Include table tags and label (optional)
bool   $expanded:  Render the related fields in expanded format or not (optional)
bool   $buttons:  Render buttons for expanding/contacting the related fields (optional)

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
renderSelector  [line 341]

  string renderSelector( [array $lookupOIDs = array()]  )

Returns the HTML for the record selector that will appear in a pop-up window.

Parameters:
array   $lookupOIDs:  An optional array of related look-up OIDs, only required for rendering MANY-TO-MANY rels

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]

Documentation generated on Tue, 13 Dec 2011 20:27:20 +0000 by phpDocumentor 1.4.3