Permalink
Browse files

Create help files for Yii 1.1.10

  • Loading branch information...
1 parent 598744f commit 6c5e513a7601ea2b7904218509171c7f3229c31d @mikehaertl committed Feb 18, 2012
View
0 README.markdown → README.md
File renamed without changes.
View
19 doc/CActiveForm.txt
@@ -596,5 +596,24 @@ METHOD DETAILS
'$_POST[ModelClass]'.
+*CActiveForm::validateTabular* public
+>
+ validateTabular($models, $attributes=NULL, $loadInput=true)
+<
+(string) the JSON representation of the validation error messages.
+
+ Validates an array of model instances and returns the results in JSON format.
+ This is a helper method that simplifies the way of writing AJAX validation
+ code for tabular input.
+ [models] (mixed) an array of model instances.
+ [attributes] (array) list of attributes that should be validated. Defaults
+ to null, meaning any attribute listed in the applicable validation rules
+ of the models should be validated. If this parameter is given as a list of
+ attributes, only the listed attributes will be validated.
+ [loadInput] (boolean) whether to load the data from $_POST array in this
+ method. If this is true, the model will be populated from
+ '$_POST[ModelClass][$i]'.
+
+
vim:tw=78:ts=8:ft=help:norl:
View
6 doc/CActiveRecord.txt
@@ -1001,9 +1001,9 @@ data will be populated to this active record.
separated by commas or specified as an array in format of
array('key1','key2'). In case you need to specify custom PK->FK association
you can define it as array('fk'=>'pk'). For composite keys it will be
- array('fk_c1'=>'pk_с1','fk_c2'=>'pk_c2'). and for foreign keys used in
- MANY_MANY relation, the joining table must be declared as well (e.g.
- 'join_table(fk1, fk2)').
+ array('fk_c1'=>'pk_с1','fk_c2'=>'pk_c2'). For foreign keys used in MANY_MANY
+ relation, the joining table must be declared as well (e.g. 'join_table(fk1,
+ fk2)').
Additional options may be specified as name-value pairs in the rest array
elements:
View
3 doc/CClientScript.txt
@@ -123,7 +123,8 @@ METHOD DETAILS
>
addPackage($name, $definition)
<
-(void)
+(CClientScript) the CClientScript object itself (to support method chaining,
+available since version 1.1.10).
Adds a package to packages list.
[name] (string) the name of the script package.
View
3 doc/CCodeModel.txt
@@ -35,6 +35,9 @@ PROPERTY DETAILS
generated. The |CCodeModel::prepare| method is responsible to populate this
property.
+<keywords> *CCodeModel::keywords*
+ ()
+
<status> *CCodeModel::status*
(integer) the status of this model. T The value of this property is
internally managed by |CCodeGenerator|.
View
4 doc/CGridView.txt
@@ -115,8 +115,8 @@ PROPERTY DETAILS
when |CGridView::ajaxUpdate| is not false.
<baseScriptUrl> *CGridView::baseScriptUrl*
- (string) the base script URL for all grid view resources (e.g. javascript,
- CSS file, images). Defaults to null, meaning using the integrated grid view
+ (string) the base script URL for all grid view resources (eg javascript, CSS
+ file, images). Defaults to null, meaning using the integrated grid view
resources (which are published as assets).
<beforeAjaxUpdate> *CGridView::beforeAjaxUpdate*
View
2 doc/CHtmlPurifier.txt
@@ -33,7 +33,7 @@ PROPERTY DETAILS
------------------------------------------------------------------------------
<options> *CHtmlPurifier::options*
- (mixed) the options to be passed to 'HTML Purifier'. This can be a
+ (mixed) the options to be passed to HTML Purifier instance. This can be a
HTMLPurifier_Config object, an array of directives (Namespace.Directive =>
Value) or the filename of an ini file.
View
34 doc/CHttpRequest.txt
@@ -162,6 +162,19 @@ METHOD DETAILS
cookie.
+*CHttpRequest::decodePathInfo* protected
+>
+ decodePathInfo($pathInfo)
+<
+(string) decoded path info
+
+ Decodes the path info. This method is an improved variant of the native
+ urldecode() function and used in |CHttpRequest::getPathInfo| to decode the
+ path part of the request URI. You may override this method to change the way
+ the path info is being decoded.
+ [pathInfo] (string) encoded path info
+
+
*CHttpRequest::getAcceptTypes* public
>
getAcceptTypes()
@@ -651,7 +664,7 @@ configuration (in most cases it is not decoded).
>
xSendFile($filePath, $options=array())
<
-(boolean) false if file not found, true otherwise.
+(void)
Sends existing file to a browser as a download using x-sendfile.
@@ -671,7 +684,7 @@ configuration (in most cases it is not decoded).
different web servers applications:
{Apache} 'X-Sendfile'
Lighttpd v1.4: 'X-LIGHTTPD-send-file'
- Lighttpd v1.5: X-Sendfile 'X-Sendfile'
+ Lighttpd v1.5: 'X-Sendfile'
{Nginx} 'X-Accel-Redirect'
{Cherokee} 'X-Sendfile and X-Accel-Redirect'So for this method to work the
X-SENDFILE option/module should be enabled by the web server and a proper
@@ -688,24 +701,27 @@ configuration (in most cases it is not decoded).
<b>Example</b>:
>
<?php
- Yii::app()->request->xSendFile('/home/user/Pictures/picture1.jpg',array(
- 'saveName'=>'image1.jpg',
- 'mimeType'=>'image/jpeg',
- 'terminate'=>false,
- ));
+ Yii::app()->request->xSendFile('/home/user/Pictures/picture1.jpg',array(
+ 'saveName'=>'image1.jpg',
+ 'mimeType'=>'image/jpeg',
+ 'terminate'=>false,
+ ));
?>
<
[filePath] (string) file name with full path
[options] (array) additional options:
{saveName} file name shown to the user, if not set real file name
will be used
{mimeType} mime type of the file, if not set it will be guessed
- automatically based on the file name.
+ automatically based on the file name, if set to null no
+ content-type header will be sent.
{xHeader} appropriate x-sendfile header, defaults to "X-Sendfile"
{terminate} whether to terminate the current application after
calling this method, defaults to true
{forceDownload} specifies whether the file will be downloaded or
- shown inline. Defaults to true. (Since version 1.1.9.)
+ shown inline, defaults to true. (Since version 1.1.9.)
+ {addHeaders} an array of additional http headers in header-value
+ pairs (available since version 1.1.10)
View
8 doc/CSecurityManager.txt
@@ -150,6 +150,14 @@ set, a random one is generated and returned.
null, meaning using |CSecurityManager::validationKey|.
+*CSecurityManager::init* public
+>
+ init()
+<
+(void)
+
+
+
*CSecurityManager::openCryptModule* protected
>
openCryptModule()
View
15 doc/CSort.txt
@@ -121,7 +121,7 @@ PROPERTY DETAILS
example,
>
'defaultOrder'=>array(
- 'price'=>true,
+ 'price'=>CSort::SORT_DESC,
)
<
Please note when using array to specify the default order, the corresponding
@@ -224,16 +224,16 @@ METHOD DETAILS
[controller] (CController) the controller that will be used to create the
URL.
[directions] (array) the sort directions indexed by attribute names. The
- sort direction is true if the corresponding attribute should be sorted in
- descending order.
+ sort direction can be either CSort::SORT_ASC for ascending order or
+ CSort::SORT_DESC for descending order.
*CSort::getDirection* public
>
getDirection($attribute)
<
-(mixed) the sort direction of the attribut. True if the attribute should be
-sorted in descending order, false if in ascending order, and null if the
+(mixed) Sort direction of the attribute. Can be either CSort::SORT_ASC for
+ascending order or CSort::SORT_DESC for descending order. Value is null if the
attribute doesn't need to be sorted.
Returns the sort direction of the specified attribute in the current request.
@@ -244,8 +244,9 @@ attribute doesn't need to be sorted.
>
getDirections()
<
-(array) sort directions indexed by attribute names. The sort direction is true
-if the corresponding attribute should be sorted in descending order.
+(array) sort directions indexed by attribute names. Sort direction can be
+either CSort::SORT_ASC for ascending order or CSort::SORT_DESC for descending
+order.
Returns the currently requested sort information.
View
4 doc/tags
@@ -84,6 +84,7 @@ CActiveForm::summaryID CActiveForm.txt /*CActiveForm::summaryID*
CActiveForm::textArea CActiveForm.txt /*CActiveForm::textArea*
CActiveForm::textField CActiveForm.txt /*CActiveForm::textField*
CActiveForm::validate CActiveForm.txt /*CActiveForm::validate*
+CActiveForm::validateTabular CActiveForm.txt /*CActiveForm::validateTabular*
CActiveRecord CActiveRecord.txt /*CActiveRecord*
CActiveRecord::__call CActiveRecord.txt /*CActiveRecord::__call*
CActiveRecord::__construct CActiveRecord.txt /*CActiveRecord::__construct*
@@ -749,6 +750,7 @@ CCodeModel::files CCodeModel.txt /*CCodeModel::files*
CCodeModel::getStickyFile CCodeModel.txt /*CCodeModel::getStickyFile*
CCodeModel::getTemplatePath CCodeModel.txt /*CCodeModel::getTemplatePath*
CCodeModel::getTemplates CCodeModel.txt /*CCodeModel::getTemplates*
+CCodeModel::keywords CCodeModel.txt /*CCodeModel::keywords*
CCodeModel::loadStickyAttributes CCodeModel.txt /*CCodeModel::loadStickyAttributes*
CCodeModel::pluralize CCodeModel.txt /*CCodeModel::pluralize*
CCodeModel::prepare CCodeModel.txt /*CCodeModel::prepare*
@@ -2046,6 +2048,7 @@ CHttpRequest::createCsrfCookie CHttpRequest.txt /*CHttpRequest::createCsrfCookie
CHttpRequest::csrfCookie CHttpRequest.txt /*CHttpRequest::csrfCookie*
CHttpRequest::csrfToken CHttpRequest.txt /*CHttpRequest::csrfToken*
CHttpRequest::csrfTokenName CHttpRequest.txt /*CHttpRequest::csrfTokenName*
+CHttpRequest::decodePathInfo CHttpRequest.txt /*CHttpRequest::decodePathInfo*
CHttpRequest::enableCookieValidation CHttpRequest.txt /*CHttpRequest::enableCookieValidation*
CHttpRequest::enableCsrfValidation CHttpRequest.txt /*CHttpRequest::enableCsrfValidation*
CHttpRequest::getAcceptTypes CHttpRequest.txt /*CHttpRequest::getAcceptTypes*
@@ -3068,6 +3071,7 @@ CSecurityManager::getValidation CSecurityManager.txt /*CSecurityManager::getVali
CSecurityManager::getValidationKey CSecurityManager.txt /*CSecurityManager::getValidationKey*
CSecurityManager::hashAlgorithm CSecurityManager.txt /*CSecurityManager::hashAlgorithm*
CSecurityManager::hashData CSecurityManager.txt /*CSecurityManager::hashData*
+CSecurityManager::init CSecurityManager.txt /*CSecurityManager::init*
CSecurityManager::openCryptModule CSecurityManager.txt /*CSecurityManager::openCryptModule*
CSecurityManager::setEncryptionKey CSecurityManager.txt /*CSecurityManager::setEncryptionKey*
CSecurityManager::setValidation CSecurityManager.txt /*CSecurityManager::setValidation*

0 comments on commit 6c5e513

Please sign in to comment.