Browse Source

- Changed docs format to markdown (.md extension).

- Added changelog.md, license.md, readme.md.
- Added code_style.md.
- Added class diagrams.
tags/2.0.0-beta
Alexander Makarov 13 years ago
parent
commit
bfc0cbb648
  1. 7
      changelog.md
  2. 43
      docs/code_style.md
  3. BIN
      docs/full_2011_11_12.png
  4. BIN
      docs/hierarchy_2011_11_12.png
  5. 31
      license.md
  6. 64
      readme.md
  7. 4
      todo.md
  8. 39
      upgrade.md
  9. 15
      upgrade.txt

7
changelog.md

@ -0,0 +1,7 @@
Yii Framework 2 Change Log
==========================
Version 2
---------
- Initial release.

43
docs/code_style.md

@ -0,0 +1,43 @@
Yii2 core code style
====================
### Brackets
~~~
class MyClass
{
public function myClassMethod()
{
if($x)
{
// do it
}
else
{
// some code
}
}
}
~~~
Proposals
---------
### Use type hinting like
~~~
public function __construct(CDbConnection $connection)
{
$this->connection = $connection;
}
~~~
instead of
~~~
public function __construct($connection)
{
$this->connection = $connection;
}
~~~

BIN
docs/full_2011_11_12.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 298 KiB

BIN
docs/hierarchy_2011_11_12.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

31
license.md

@ -0,0 +1,31 @@
The Yii framework is free software. It is released under the terms of
the following BSD License.
Copyright © 2008-2012 by Yii Software LLC (http://www.yiisoft.com)
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the
distribution.
* Neither the name of Yii Software LLC nor the names of its
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.

64
readme.md

@ -0,0 +1,64 @@
Yii 2 Web Programming Framework
===============================
Thank you for choosing Yii 2 — a high-performance component-based PHP framework.
INSTALLATION
------------
Please make sure the release file is unpacked under a Web-accessible
directory. You shall see the following files and directories:
demos/ demos
framework/ framework source files
requirements/ requirement checker
changelog.md describing changes in every Yii release
license.md license of Yii
readme.md this file
updgrade.md upgrading instructions
REQUIREMENTS
------------
The minimum requirement by Yii is that your Web server supports
PHP 5.3.8 or above. Yii has been tested with Apache HTTP server
on Windows and Linux operating systems.
Please access the following URL to check if your Web server reaches
the requirements by Yii, assuming "YiiPath" is where Yii is installed:
http://hostname/YiiPath/requirements/index.php
QUICK START
-----------
Yii comes with a command line tool called "yiic" that can create
a skeleton Yii application for you to start with.
On command line, type in the following commands:
$ cd YiiPath/framework (Linux)
cd YiiPath\framework (Windows)
$ ./yiic webapp ../testdrive (Linux)
yiic webapp ..\testdrive (Windows)
The new Yii application will be created at "YiiPath/testdrive".
You can access it with the following URL:
http://hostname/YiiPath/testdrive/index.php
WHAT's NEXT
-----------
Please visit the project website for tutorials, class reference
and join discussions with other Yii users.
The Yii Developer Team
http://www.yiiframework.com

4
todo.txt → todo.md

@ -4,6 +4,7 @@
* Toolbar ? * Toolbar ?
- base - base
* error/exception handling * error/exception handling
* Convert all PHP errors into exceptions, remove YII_ENABLE_ERROR_HANDLER and error handler (?)
* module * module
* application * application
* http exception * http exception
@ -56,6 +57,7 @@
* use HTML5 instead of XHTML * use HTML5 instead of XHTML
- assets - assets
* ability to manage scripts order (store these in a vector?) * ability to manage scripts order (store these in a vector?)
* http://ryanbigg.com/guides/asset_pipeline.html, use content hash instead of mtime + directory hash. * http://ryanbigg.com/guides/asset_pipeline.html, http://guides.rubyonrails.org/asset_pipeline.html, use content hash instead of mtime + directory hash.
- collections - collections
* http://code.google.com/p/yii/source/detail?r=3428 * http://code.google.com/p/yii/source/detail?r=3428
- Requirement checker

39
upgrade.md

@ -0,0 +1,39 @@
Upgrading Instructions for Yii Framework v2
===========================================
!!!IMPORTANT!!!
The following upgrading instructions are cumulative. That is,
if you want to upgrade from version A to version C and there is
version B between A and C, you need to following the instructions
for both A and B.
General upgrade intructions
---------------------------
- Make a backup.
- Clean up your 'assets' folder.
- Replace 'framework' dir with the new one or point SVN to a fresh
release and update.
- Check if everything is OK, if not — revert from backup and post
issues to Yii issue tracker.
Upgrading from v1.1.x
---------------------
- All framework classes are now namespaced, and the name prefix `C` is removed.
- The format of path alias is changed to `@yii/base/Component`.
In 1.x, this would be `system.base.CComponent`. See guide for more details.
- The root alias `@yii` now represents the framework installation directory.
In 1.x, this is named as `system`. We also removed `zii` root alias.
- `CList` is renamed to `Vector`, and `CMap` is renamed to `Dictionary`.
Other collection classes are dropped in favor of SPL classes.
- `CFormModel` is removed. Please use `yii\base\Model` instead.

15
upgrade.txt

@ -1,15 +0,0 @@
- All framework classes are now namespaced, and the name prefix `C` is removed.
- The format of path alias is changed to `@yii/base/Component`.
In 1.x, this would be `system.base.CComponent`. See guide for more details.
- The root alias `@yii` now represents the framework installation directory.
In 1.x, this is named as `system`. We also removed `zii` root alias.
- `CList` is renamed to `Vector`, and `CMap` is renamed to `Dictionary`.
Other collection classes are dropped in favor of SPL classes.
- `CFormModel` is removed. Please use `yii\base\Model` instead.
Loading…
Cancel
Save