Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
Y
yii2
Project
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
PSDI Army
yii2
Commits
6df4802e
Commit
6df4802e
authored
Mar 07, 2014
by
Larry Ullman
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Edited whole document
parent
db222533
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
14 additions
and
19 deletions
+14
-19
helpers.md
docs/guide/helpers.md
+14
-19
No files found.
docs/guide/helpers.md
View file @
6df4802e
Helper Classes
Helper Classes
==============
==============
Yii provides many helper classes to help simplify some common coding tasks, such as string
/
array manipulations,
Yii provides many helper classes to help simplify some common coding tasks, such as string
or
array manipulations,
HTML code generation. These helper classes are organized under the
`yii\helpers`
namespace and
HTML code generation
, and so forth
. These helper classes are organized under the
`yii\helpers`
namespace and
are all static classes (meaning they contain only static properties and methods and should not be instantiated).
are all static classes (meaning they contain only static properties and methods and should not be instantiated).
You use a helper class by directly calling its static method, like the following,
You use a helper class by directly calling its static method:
```
php
```
php
use
yii\helpers\ArrayHelper
;
use
yii\helpers\ArrayHelper
;
...
@@ -15,27 +17,20 @@ $c = ArrayHelper::merge($a, $b);
...
@@ -15,27 +17,20 @@ $c = ArrayHelper::merge($a, $b);
Extending Helper Classes
Extending Helper Classes
------------------------
------------------------
Static classes are typically hard to customize because when you use them, you already hardcode the class names
To make helper classes easier to extend, Yii breaks each into two classes: a base class (e.g.
`BaseArrayHelper`
)
in your code, and as a result your customized versions will not get used unless you do some global replacement in your code.
and a concrete class (e.g.
`ArrayHelper`
). When you use a helper, you should only use the concrete version, never use the base class.
To solve this problem, Yii breaks each helper into two classes: one is base class (e.g.
`BaseArrayHelper`
)
and the other the concrete class (e.g.
`ArrayHelper`
). When you use a helper, you should only use the concrete version.
If you want to customize a helper,
e.g.,
`ArrayHelper`
, do the following steps
:
If you want to customize a helper,
perform the following steps (using
`ArrayHelper`
as an example)
:
1.
Name your class the same as the concrete class provided by Yii, including the namespace part, e.g.,
1.
Name your class the same as the concrete class provided by Yii, including the namespace:
`yii\helpers\ArrayHelper`
`yii\helpers\ArrayHelper`
;
2.
Extend your class from the base class:
`class ArrayHelper extends \yii\helpers\BaseArrayHelper`
2.
Extend your class from the base class, e.g.,
`class ArrayHelper extends \yii\helpers\BaseArrayHelper`
;
3.
In your class, override any method or property as needed, or add new methods or properties
3.
In your class, override any method or property as your want, or add new methods or properties;
4.
Tell your application to use your version of the helper class by including the following line of code in the bootstrap script:
4.
In your application that you plan to use your own version of the helper class, include the following
line of code in the bootstrap script:
```
php
```
php
Yii
::
$classMap
[
'yii\helpers\ArrayHelper'
]
=
'path/to/ArrayHelper.php'
;
Yii
::
$classMap
[
'yii\helpers\ArrayHelper'
]
=
'path/to/ArrayHelper.php'
;
```
```
The Step 4 above will instruct Yii class autoloader to load your version of the helper instead of the one
Step 4 above will instruct the Yii class autoloader to load your version of the helper class instead of the oneincluded in the Yii distribution.
included in the Yii distribution.
> Tip: You can also use `Yii::$classMap` to replace ANY core Yii class, not necessarily helper classes,
> Tip: You can use `Yii::$classMap` to replace ANY core Yii class with your own customized version, not just helper classes.
> with your own customized version.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment