Alpha Framework 3.0.0 API Documentation
  • Namespace
  • Class

Namespaces

  • Alpha
    • Controller
      • Front
    • Exception
    • Model
      • Type
    • Task
    • Util
      • Backup
      • Cache
      • Code
        • Highlight
        • Metric
      • Config
      • Convertor
      • Email
      • Extension
      • Feed
      • File
      • Graph
      • Helper
      • Http
        • Filter
        • Session
      • Image
      • Logging
      • Search
      • Security
      • Service
    • View
      • Renderer
        • Html
        • Json
      • Widget

Classes

  • Button
  • DateBox
  • Image
  • RecordSelector
  • SmallTextBox
  • TagCloud
  • TextBox

Class RecordSelector

Record selection HTML widget.

Namespace: Alpha\View\Widget
Copyright:

Copyright (c) 2018, 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.

License: The BSD License
Author: John Collins dev@alphaframework.org
Since: 1.0
Located at View/Widget/RecordSelector.php

Methods summary

public
# __construct( Alpha\Model\Type\Relation $relation, string $label = '', string $name = '', string $accessingClassName = '' )

The constructor.

The constructor.

Parameters

$relation
$label
$name
$accessingClassName

Throws

Alpha\Exception\IllegalArguementException

Since

1.0
public string
# render( boolean $expanded = false, boolean $buttons = true )

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

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

Parameters

$expanded
Render the related fields in expanded format or not (optional)
$buttons
Render buttons for expanding/contacting the related fields (optional)

Returns

string

Since

1.0
public string
# renderSelector( string $fieldname, array $lookupIDs = array() )

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

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

Parameters

$fieldname
The hidden HTML form field in the parent to pass values back to.
$lookupIDs
An optional array of related look-up IDs, only required for rendering MANY-TO-MANY rels

Returns

string

Since

1.0
Alpha Framework 3.0.0 API Documentation API documentation generated by ApiGen