archive/php-src
1
0
Fork 0
mirror of https://github.com/php/php-src.git synced 2025-08-16 05:58:45 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Fixed typos in comments

Browse source
This commit is contained in:
Yasuo Ohgaki 2015-02-04 05:00:03 +09:00
parent 55cefb2814
commit dbb1298fdb
1 changed files with 14 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

28
ext/session/mod_files.c
View file

@ -25,7 +25,7 @@
* - PS_CREATE_ID() is called if session ID(key) is not * - PS_CREATE_ID() is called if session ID(key) is not
* provided or invalid. PS_VALIDATE_SID() is called to * provided or invalid. PS_VALIDATE_SID() is called to
* verify session ID already exists or not to mitigate * verify session ID already exists or not to mitigate
* session adoption vulunerabilty risk. * session adoption vulnerability risk.
* PS_READ_FUNC() - Read data from storage. * PS_READ_FUNC() - Read data from storage.
* PS_GC_FUNC() - Perform GC. Called by probability * PS_GC_FUNC() - Perform GC. Called by probability
* (session.gc_probability/session.gc_divisor). * (session.gc_probability/session.gc_divisor).
@ -34,7 +34,7 @@
* It depends on session data change. * It depends on session data change.
* PS_CLOSE_FUNC() - Clean up module data created by PS_OPEN_FUNC(). * PS_CLOSE_FUNC() - Clean up module data created by PS_OPEN_FUNC().
* *
* Session module gurantees PS_OPEN_FUNC() is called before calling other * Session module guarantees PS_OPEN_FUNC() is called before calling other
* PS_*_FUNC() functions. Other than this, session module may call any * PS_*_FUNC() functions. Other than this, session module may call any
* PS_*_FUNC() at any time. You may assume non null *mod_data created by * PS_*_FUNC() at any time. You may assume non null *mod_data created by
* PS_OPEN_FUNC() is passed to PS_*_FUNC(). * PS_OPEN_FUNC() is passed to PS_*_FUNC().
@ -46,7 +46,7 @@
* - Save handler _MUST_ use PS_GET_MOD_DATA()/PS_SET_MOD_DATA() macro to * - Save handler _MUST_ use PS_GET_MOD_DATA()/PS_SET_MOD_DATA() macro to
* set/get save handler module data(mod_data). mod_data contains * set/get save handler module data(mod_data). mod_data contains
* data required by PS modules. It will not be NULL except PS_OPEN_FUNC(). * data required by PS modules. It will not be NULL except PS_OPEN_FUNC().
* - Refer to PS_* macros in php_session.h for function/parameter defitions. * - Refer to PS_* macros in php_session.h for function/parameter definitions.
* - Returning FAILURE state from PS_* function results in raising errors. * - Returning FAILURE state from PS_* function results in raising errors.
* Avoid failure state as much as possible. * Avoid failure state as much as possible.
* - Use static ps_[module name]_[function name] functions for internal use. * - Use static ps_[module name]_[function name] functions for internal use.
@ -336,7 +336,7 @@ static int ps_files_key_exists(ps_files *data, const char *key)
* Files save handler checks/create save_path directory and setup ps_files data. * Files save handler checks/create save_path directory and setup ps_files data.
* Note that files save handler supports splitting session data into multiple * Note that files save handler supports splitting session data into multiple
* directories. * directories.
* *mod_data, *save_path, *session_name are guranteed to have non-NULL values. * *mod_data, *save_path, *session_name are guaranteed to have non-NULL values.
*/ */
PS_OPEN_FUNC(files) PS_OPEN_FUNC(files)
{ {
@ -409,7 +409,7 @@ PS_OPEN_FUNC(files)
* RETURN VALUE: SUCCESS. Must set PS module data(void **mod_data) to NULL. * RETURN VALUE: SUCCESS. Must set PS module data(void **mod_data) to NULL.
* *
* Files save handler closes open files and it's memory. * Files save handler closes open files and it's memory.
* *mod_data is guranteed to have non-NULL value. * *mod_data is guaranteed to have non-NULL value.
* PS_CLOSE_FUNC() must set *mod_data to NULL. PS_CLOSE_FUNC() should not * PS_CLOSE_FUNC() must set *mod_data to NULL. PS_CLOSE_FUNC() should not
* fail. * fail.
*/ */
@ -439,7 +439,7 @@ PS_CLOSE_FUNC(files)
* *
* Files save handler supports splitting session data into multiple * Files save handler supports splitting session data into multiple
* directories. * directories.
* *mod_data, *key are guranteed to have non-NULL values. * *mod_data, *key are guaranteed to have non-NULL values.
*/ */
PS_READ_FUNC(files) PS_READ_FUNC(files)
{ {
@ -493,7 +493,7 @@ PS_READ_FUNC(files)
* RETURN VALUE: SUCCESS or FAILURE. * RETURN VALUE: SUCCESS or FAILURE.
* *
* PS_WRITE_FUNC() must write session data(zend_string *val) unconditionally. * PS_WRITE_FUNC() must write session data(zend_string *val) unconditionally.
* *mod_data, *key, *val are guranteed to have non-NULL values. * *mod_data, *key, *val are guaranteed to have non-NULL values.
*/ */
PS_WRITE_FUNC(files) PS_WRITE_FUNC(files)
{ {
@ -511,10 +511,10 @@ PS_WRITE_FUNC(files)
* PS_UPDATE_TIMESTAMP_FUNC() updates time stamp(mtime) so that active session * PS_UPDATE_TIMESTAMP_FUNC() updates time stamp(mtime) so that active session
* data files will not be purged by GC. If session data storage does not need to * data files will not be purged by GC. If session data storage does not need to
* update timestamp, it should return SUCCESS simply. (e.g. Memcache) * update timestamp, it should return SUCCESS simply. (e.g. Memcache)
* *mod_data, *key, *val are guranteed to have non-NULL values. * *mod_data, *key, *val are guaranteed to have non-NULL values.
* *
* NOTE: Updating access timestamp at PS_READ_FUNC() may extend life of obsolete * NOTE: Updating access timestamp at PS_READ_FUNC() may extend life of obsolete
* session data. Use of PS_UPDATE_TIMESTAMP_FUNC() is prefered whenenver it is * session data. Use of PS_UPDATE_TIMESTAMP_FUNC() is preferred whenever it is
* possible. * possible.
*/ */
PS_UPDATE_TIMESTAMP_FUNC(files) PS_UPDATE_TIMESTAMP_FUNC(files)
@ -553,7 +553,7 @@ PS_UPDATE_TIMESTAMP_FUNC(files)
* PS_DESTROY_FUNC() must remove the session data specified by *key from * PS_DESTROY_FUNC() must remove the session data specified by *key from
* session data storage unconditionally. It must not return FAILURE for * session data storage unconditionally. It must not return FAILURE for
* non-existent session data. * non-existent session data.
* *mod_data, *key are guranteed to have non-NULL values. * *mod_data, *key are guaranteed to have non-NULL values.
*/ */
PS_DESTROY_FUNC(files) PS_DESTROY_FUNC(files)
{ {
@ -589,7 +589,7 @@ PS_DESTROY_FUNC(files)
* 'session.maxlifetime'(seconds). If storage does not need manual GC, it * 'session.maxlifetime'(seconds). If storage does not need manual GC, it
* may return SUCCESS simply. (e.g. Memcache) It must set number of records * may return SUCCESS simply. (e.g. Memcache) It must set number of records
* deleted(nrdels). * deleted(nrdels).
* *mod_data is guranteed to have non-NULL value. * *mod_data is guaranteed to have non-NULL value.
*/ */
PS_GC_FUNC(files) PS_GC_FUNC(files)
{ {
@ -614,7 +614,7 @@ PS_GC_FUNC(files)
* *
* PS_CREATE_SID_FUNC() must check collision. i.e. Check session data if * PS_CREATE_SID_FUNC() must check collision. i.e. Check session data if
* new sid exists already. * new sid exists already.
* *mod_data is guranteed to have non-NULL value. * *mod_data is guaranteed to have non-NULL value.
* NOTE: Default php_session_create_id() does not check collision. If * NOTE: Default php_session_create_id() does not check collision. If
* NULL is returned, session module create new ID by using php_session_create_id(). * NULL is returned, session module create new ID by using php_session_create_id().
* If php_session_create_id() fails due to invalid configuration, it raises E_ERROR. * If php_session_create_id() fails due to invalid configuration, it raises E_ERROR.
@ -657,9 +657,9 @@ PS_CREATE_SID_FUNC(files)
* PARAMETERS: PS_VALIDATE_SID_ARGS in php_session.h * PARAMETERS: PS_VALIDATE_SID_ARGS in php_session.h
* RETURN VALUE: SUCCESS or FAILURE. * RETURN VALUE: SUCCESS or FAILURE.
* *
* Return SUCCESS for valid key(already exsting session). * Return SUCCESS for valid key(already existing session).
* Return FAILURE for invalid key(non-existing session). * Return FAILURE for invalid key(non-existing session).
* *mod_data, *key are guranteed to have non-NULL values. * *mod_data, *key are guaranteed to have non-NULL values.
*/ */
PS_VALIDATE_SID_FUNC(files) PS_VALIDATE_SID_FUNC(files)
{ {