\Dewdrop\View\HelperInputDate

This helper uses a jQuery UI based date picker to manipulate date values. In most situations, you'll want to filter the value coming back from the client to ensure it can be saved back to the database, etc.

Example usage:

echo $this->wpInputText($this->fields->get('animals:latin_name'));

Summary

Methods
Properties
Constants
directArray()
direct()
__construct()
partial()
No public properties found
No constants found
directField()
directExplicit()
delegateIfArgsProvided()
delegateByArgs()
checkRequired()
getHelperName()
ensurePresent()
ensureArray()
$view
N/A
prepareOptionsArray()
No private properties found
N/A

Properties

$view

$view : \Dewdrop\View\View

The view that instantiated this helper.

Type

\Dewdrop\View\View

Methods

directArray()

directArray(array  $options) : string

Queue up client-side resources and render the basic text input.

Parameters

array $options

Returns

string

direct()

direct() : string

Render the input.

This method will delegate to directField(), directExplicit(), or directArray() depending upon the arguments that are passed to it.

Returns

string

__construct()

__construct(\Dewdrop\View\View  $view) 

Create helper, accepting a reference to the related view object

Parameters

\Dewdrop\View\View $view

partial()

partial(string  $name, array  $data) : string

Render a partial view script.

Generally, your helper should render HTML with partial view scripts rather than generating the markup in the helper class directly. This makes it easier for frontend developers to make modifications to the HTML.

The $data parameter should contain key-value pairs for each variable you'd like available in your partial view.

Parameters

string $name
array $data

Returns

string —

The rendered output

directField()

directField(\Dewdrop\Db\Field  $field, array  $options = array()) : string

Use the supplied \Dewdrop\Db\Field object to set the helper's options and then render the input.

Parameters

\Dewdrop\Db\Field $field
array $options

Returns

string

directExplicit()

directExplicit(string  $name, mixed  $value, mixed  $classes = null, boolean  $required = false) : string

Explicitly set the basic arguments for this helper and then render the input.

Parameters

string $name
mixed $value
mixed $classes
boolean $required

Returns

string

delegateIfArgsProvided()

delegateIfArgsProvided(array  $args, string  $method = 'directWithArgs') : $this|string

Useful in cases where you want to just return the helper if the user didn't provide any args to direct(), but want to call a short-cut method if they did.

Parameters

array $args
string $method

Returns

$this|string

delegateByArgs()

delegateByArgs(array  $args, string  $methodPrefix) : mixed

Delegate to one of three methods depending upon the contents of the $args array:

  • If $args[0] is an instance of \Dewdrop\Db\Field, call "{$methodPrefix}Field".
  • If $args[0] is an array, call "{$methodPrefix}Array".
  • Otherwise, call "{$methodPrefix}Explicit".

Parameters

array $args

The arguments to pass the delegated method.

string $methodPrefix

Returns

mixed

checkRequired()

checkRequired(array  $options, array  $required) : \Dewdrop\View\Helper\AbstractHelper

Check that the values in $required are present as keys in $options.

Use this in methods accepting parameters as an array of key-value pairs to ensure that required parameters are present. If one of the required parameters is absent, an exception is thrown.

Parameters

array $options
array $required

Throws

\Dewdrop\Exception

Returns

\Dewdrop\View\Helper\AbstractHelper

getHelperName()

getHelperName() : string

Get the helper name, which is the suffix at the end of the fully qualified class name after the final namespace separator ("\").

Returns

string

ensurePresent()

ensurePresent(array  $options, array  $present) : \Dewdrop\View\Helper\AbstractHelper

Ensure that the values in $present are keys in $options.

If the key is absent from $options, it will be added with a null value. Therefore, this method differs from checkRequired() in that the user must supply a value (even if that value is null) before checkRequired(), but for ensurePresent() the key will simply be added if the user hadn't already specified a value.

Note: Notice that the $options parameter is handled by-reference to allow creation of the missing keys while still allowing chaining to other methods.

Parameters

array $options
array $present

Returns

\Dewdrop\View\Helper\AbstractHelper

ensureArray()

ensureArray(array  $options, array  $isArray) : \Dewdrop\View\Helper\AbstractHelper

Ensure that the values in the $isArray parameter are present in $options as an array.

If the option's current value is null, it will be converted to an array. If the option's current value is not null but also not an array, it will be wrapped in an array. For example, if you had a "classes" option that let the user specify one or more CSS classes, they could use a string to define a single class and this method would wrap that single value in array array to make the handling of the various options simpler and more consistent for the view helper developer.

Note: Notice that the $options parameter is handled by-reference to allow creation of the missing keys while still allowing chaining to other methods.

Parameters

array $options
array $isArray

Returns

\Dewdrop\View\Helper\AbstractHelper

prepareOptionsArray()

prepareOptionsArray(array  $options) : array

Prepare the options array for the directArray() method, checking that required options are set, ensuring "classes" is an array and adding "classes" and "id" to the options array, if they are not present already.

Parameters

array $options

Returns

array