Skip to content
This repository has been archived by the owner on Jan 30, 2020. It is now read-only.

Add helper trait to provide type-hinting for zend-view #217

Merged
merged 11 commits into from
Dec 11, 2018
Merged

Add helper trait to provide type-hinting for zend-view #217

Changes from 8 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
8144229
Add helper trait to provide type-hinting for zend-view
thexpand Aug 11, 2018
a3ce681
Move the helper trait in the View directory
thexpand Aug 11, 2018
a12f676
Add comment on the top of the helper trait to ignore coding standards…
thexpand Aug 11, 2018
4256473
Add ending doc block annotation for ignoring coding standards
thexpand Sep 5, 2018
75412e6
Add doc block with copyright and license information
thexpand Sep 5, 2018
b69c127
Change comment in doc-block's description to properly address Zend Fr…
thexpand Sep 5, 2018
d8af106
Add a more descriptive title of the helper trait
thexpand Sep 5, 2018
a75308c
Add data types for all @method parameters in the helper trait
thexpand Sep 5, 2018
e633986
Replace the year range with the current year in the copyright doc-block
thexpand Sep 5, 2018
537029b
Add documentation for HelperTrait for IDE auto-completion
thexpand Sep 12, 2018
d209ef6
Fix wrong namespace in docs for HelperTrait and re-align code example
thexpand Sep 12, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 118 additions & 0 deletions src/View/HelperTrait.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
<?php
/**
* @see https://github.com/zendframework/zend-form for the canonical source repository
* @copyright Copyright (c) 2005-2018 Zend Technologies USA Inc. (http://www.zend.com)
thexpand marked this conversation as resolved.
Show resolved Hide resolved
* @license https://github.com/zendframework/zend-form/blob/master/LICENSE.md New BSD License
*/

thexpand marked this conversation as resolved.
Show resolved Hide resolved
namespace Zend\Form\View;

use IntlDateFormatter;
use Zend\Form\ElementInterface;
use Zend\Form\FormInterface;
use Zend\Form\View\Helper\Captcha\Dumb;
use Zend\Form\View\Helper\Captcha\Figlet;
use Zend\Form\View\Helper\Captcha\Image;
use Zend\Form\View\Helper\Captcha\ReCaptcha;
use Zend\Form\View\Helper\Form;
use Zend\Form\View\Helper\FormButton;
use Zend\Form\View\Helper\FormCaptcha;
use Zend\Form\View\Helper\FormCheckbox;
use Zend\Form\View\Helper\FormCollection;
use Zend\Form\View\Helper\FormColor;
use Zend\Form\View\Helper\FormDate;
use Zend\Form\View\Helper\FormDateSelect;
use Zend\Form\View\Helper\FormDateTime;
use Zend\Form\View\Helper\FormDateTimeLocal;
use Zend\Form\View\Helper\FormDateTimeSelect;
use Zend\Form\View\Helper\FormElement;
use Zend\Form\View\Helper\FormElementErrors;
use Zend\Form\View\Helper\FormEmail;
use Zend\Form\View\Helper\FormFile;
use Zend\Form\View\Helper\FormHidden;
use Zend\Form\View\Helper\FormImage;
use Zend\Form\View\Helper\FormInput;
use Zend\Form\View\Helper\FormLabel;
use Zend\Form\View\Helper\FormMonth;
use Zend\Form\View\Helper\FormMonthSelect;
use Zend\Form\View\Helper\FormMultiCheckbox;
use Zend\Form\View\Helper\FormNumber;
use Zend\Form\View\Helper\FormPassword;
use Zend\Form\View\Helper\FormRadio;
use Zend\Form\View\Helper\FormRange;
use Zend\Form\View\Helper\FormReset;
use Zend\Form\View\Helper\FormRow;
use Zend\Form\View\Helper\FormSearch;
use Zend\Form\View\Helper\FormSelect;
use Zend\Form\View\Helper\FormSubmit;
use Zend\Form\View\Helper\FormTel;
use Zend\Form\View\Helper\FormText;
use Zend\Form\View\Helper\FormTextarea;
use Zend\Form\View\Helper\FormTime;
use Zend\Form\View\Helper\FormUrl;
use Zend\Form\View\Helper\FormWeek;

// @codingStandardsIgnoreStart
thexpand marked this conversation as resolved.
Show resolved Hide resolved

/**
* Helper trait for auto-completion of code in modern IDEs.
*
* The trait provides convenience methods for view helpers,
* defined by the zend-form component. It is designed to be used
* for type-hinting $this variable inside zend-view templates via doc blocks.
*
* The base class is PhpRenderer, followed by the helper trait from
* the zend-form component. However, multiple helper traits from different
* Zend Framework components can be chained afterwards.
*
* @example @var \Zend\View\Renderer\PhpRenderer|\Zend\Form\View\HelperTrait $this
*
* @method string|Form form(FormInterface|null $form = null)
* @method string|FormButton formButton(ElementInterface|null $element = null, string|null $buttonContent = null)
* @method string|FormCaptcha formCaptcha(ElementInterface|null $element = null)
* @method string|Dumb formCaptchaDumb(ElementInterface|null $element = null)
* @method string|Figlet formCaptchaFiglet(ElementInterface|null $element = null)
* @method string|Image formCaptchaImage(ElementInterface|null $element = null)
* @method string|ReCaptcha formCaptchaRecaptcha(ElementInterface|null $element = null)
* @method string|FormCheckbox formCheckbox(ElementInterface|null $element = null)
* @method string|FormCollection formCollection(ElementInterface|null $element = null, bool $wrap = true)
* @method string|FormColor formColor(ElementInterface|null $element = null)
* @method string|FormDate formDate(ElementInterface|null $element = null)
* @method string|FormDateTime formDateTime(ElementInterface|null $element = null)
* @method string|FormDateTimeLocal formDateTimeLocal(ElementInterface|null $element = null)
* @method string|FormDateTimeSelect formDateTimeSelect(ElementInterface|null $element = null, int $dateType = IntlDateFormatter::LONG, int|null|string $timeType = IntlDateFormatter::LONG, string|null $locale = null)
* @method string|FormDateSelect formDateSelect(ElementInterface $element = null, $dateType = IntlDateFormatter::LONG, $locale = null)
* @method string|FormElement formElement(ElementInterface|null $element = null)
* @method string|FormElementErrors formElementErrors(ElementInterface|null $element = null, array $attributes = [])
* @method string|FormEmail formEmail(ElementInterface|null $element = null)
* @method string|FormFile formFile(ElementInterface|null $element = null)
* @method string formFileApcProgress(ElementInterface|null $element = null)
* @method string formFileSessionProgress(ElementInterface|null $element = null)
* @method string formFileUploadProgress(ElementInterface|null $element = null)
* @method string|FormHidden formHidden(ElementInterface|null $element = null)
* @method string|FormImage formImage(ElementInterface|null $element = null)
* @method string|FormInput formInput(ElementInterface|null $element = null)
* @method string|FormLabel formLabel(ElementInterface|null $element = null, string|null $labelContent = null, string|null $position = null)
* @method string|FormMonth formMonth(ElementInterface|null $element = null)
* @method string|FormMonthSelect formMonthSelect(ElementInterface|null $element = null, int $dateType = IntlDateFormatter::LONG, string|null $locale = null)
* @method string|FormMultiCheckbox formMultiCheckbox(ElementInterface|null $element = null, string|null $labelPosition = null)
* @method string|FormNumber formNumber(ElementInterface|null $element = null)
* @method string|FormPassword formPassword(ElementInterface|null $element = null)
* @method string|FormRadio formRadio(ElementInterface|null $element = null, string|null $labelPosition = null)
* @method string|FormRange formRange(ElementInterface|null $element = null)
* @method string|FormReset formReset(ElementInterface|null $element = null)
* @method string|FormRow formRow(ElementInterface|null $element = null, string|null $labelPosition = null, bool|null $renderErrors = null, string|null $partial = null)
* @method string|FormSearch formSearch(ElementInterface|null $element = null)
* @method string|FormSelect formSelect(ElementInterface|null $element = null)
* @method string|FormSubmit formSubmit(ElementInterface|null $element = null)
* @method string|FormTel formTel(ElementInterface|null $element = null)
* @method string|FormText formText(ElementInterface|null $element = null)
* @method string|FormTextarea formTextarea(ElementInterface|null $element = null)
* @method string|FormTime formTime(ElementInterface|null $element = null)
* @method string|FormUrl formUrl(ElementInterface|null $element = null)
* @method string|FormWeek formWeek(ElementInterface|null $element = null)
*/
trait HelperTrait
{
}
// @codingStandardsIgnoreEnd