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
5caac5b0
Commit
5caac5b0
authored
Dec 10, 2013
by
Alexander Makarov
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Moved extensions docs draft from wiki to main repository
parent
e56d60ad
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
44 additions
and
2 deletions
+44
-2
extensions.md
docs/guide/extensions.md
+44
-2
No files found.
docs/guide/extensions.md
View file @
5caac5b0
Extending Yii
Extending Yii
=============
=============
TDB
Code style
\ No newline at end of file
----------
-
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.
Distribution
------------
-
There should be a
`readme.md`
file clearly describing what extension does in English, its requirements, how to install
and use it. It should be written using markdown. If you want to provide translated readme, name it as
`readme_ru.md`
where
`ru`
is your language code.
-
TBD: composer.json
Working with database
---------------------
-
If extension creates or modifies database schema always use Yii migrations instead of SQL files or custom scripts.
Assets
------
TBD
Events
------
TBD
i18n
----
TBD
Testing your extension
----------------------
TBD
\ No newline at end of file
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