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
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Commits
Issue Boards
Open sidebar
Rotua Panjaitan
yii2
Commits
86dd4282
Commit
86dd4282
authored
Dec 10, 2013
by
Alexander Makarov
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Added rules about namespace and package naming to extension docs
parent
ec7546ef
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
8 additions
and
1 deletion
+8
-1
extensions.md
docs/guide/extensions.md
+8
-1
No files found.
docs/guide/extensions.md
View file @
86dd4282
...
...
@@ -6,12 +6,19 @@ Code style
-
Extension code style should be similar to
[
core framework code style
](
https://github.com/yiisoft/yii2/wiki/Core-framework-code-style
)
.
-
In case of using getter and setter for defining a property it's preferred to use method in extension code rather than property.
-
TBD: namespace
-
All classes, methods and properties should be documented using phpdoc. Note that you can use markdown and like to API
documents using
`[[name()]]`
.
-
If you're displaying errors to developers do not translate these (i.e. do not use
`\Yii::t()`
). Errors should be
translated only if they're displayed to end users.
### Namespace and package names
-
Extension MUST use the type
`yii2-extension`
in
`composer.json`
file.
-
Extension MUST NOT use
`yii`
or
`yii2`
in the composer package name or in the namespaces used in the package.
-
Extension SHOULD use namespaces in this format
`vendor-name\package`
(all lowercase).
-
Extension MAY use a
`yii2-`
prefix in the composer vendor name (URL).
-
Extension MAY use a
`yii2-`
prefix in the repository name (URL).
Distribution
------------
...
...
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