From 1fb500077784638399be79b32fe354aec257413c Mon Sep 17 00:00:00 2001 From: Gabriel Potkány Date: Wed, 4 Feb 2015 01:45:59 +0100 Subject: Fixed inconsistent return types --- user_guide_src/source/database/utilities.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'user_guide_src/source') diff --git a/user_guide_src/source/database/utilities.rst b/user_guide_src/source/database/utilities.rst index 2da1f981d..7886be434 100644 --- a/user_guide_src/source/database/utilities.rst +++ b/user_guide_src/source/database/utilities.rst @@ -252,7 +252,7 @@ Class Reference .. php:method:: backup([$params = array()]) :param array $params: An associative array of options - :returns: void + :returns: mixed :rtype: void Perform a database backup, per user preferences. -- cgit v1.2.3-24-g4f1b From cea5fb713822d00460222deaa1cf66543effccf8 Mon Sep 17 00:00:00 2001 From: Gabriel Potkány Date: Wed, 4 Feb 2015 08:22:06 +0100 Subject: Adjusted returns/return types to suggestions --- user_guide_src/source/database/utilities.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'user_guide_src/source') diff --git a/user_guide_src/source/database/utilities.rst b/user_guide_src/source/database/utilities.rst index 7886be434..2aeadfdda 100644 --- a/user_guide_src/source/database/utilities.rst +++ b/user_guide_src/source/database/utilities.rst @@ -252,8 +252,8 @@ Class Reference .. php:method:: backup([$params = array()]) :param array $params: An associative array of options - :returns: mixed - :rtype: void + :returns: string + :rtype: string Perform a database backup, per user preferences. -- cgit v1.2.3-24-g4f1b From 40bbd60bcc5135f898f46e502f7b04ef065274e0 Mon Sep 17 00:00:00 2001 From: Gabriel Potkány Date: Wed, 4 Feb 2015 14:06:47 +0100 Subject: Adjusted return type for CI_DB_utility::backup to suggestions --- user_guide_src/source/database/utilities.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'user_guide_src/source') diff --git a/user_guide_src/source/database/utilities.rst b/user_guide_src/source/database/utilities.rst index 2aeadfdda..bafa08ed5 100644 --- a/user_guide_src/source/database/utilities.rst +++ b/user_guide_src/source/database/utilities.rst @@ -252,7 +252,7 @@ Class Reference .. php:method:: backup([$params = array()]) :param array $params: An associative array of options - :returns: string + :returns: raw/(g)zipped SQL query string :rtype: string Perform a database backup, per user preferences. -- cgit v1.2.3-24-g4f1b From 7efcd706711712cc3ac5250d820aa7100a16901e Mon Sep 17 00:00:00 2001 From: jim Date: Wed, 4 Feb 2015 14:23:33 -0800 Subject: Add pulldown menu to user guide. Integrating Rufnex's Javascript optional menu replacement :) Now you will see a small icon in the top right of the user guide browser window. Clicking this toggles between the readdocs style TOC, in the left sidebar, and the "classic" CI TOC, a pulldown activated by clicking on the "Table of Contents" icon at the top of the browser window. The tool use a cookie to remember your decision. Integrated on behalf of .... -- Have fun! Rufnex - codeigniter.de --- .../_themes/sphinx_rtd_theme/static/js/oldtheme.js | 47 ++++++++++++++ .../_themes/sphinx_rtd_theme/static/js/theme.js | 73 +++++++++++++++++++++- 2 files changed, 119 insertions(+), 1 deletion(-) create mode 100644 user_guide_src/source/_themes/sphinx_rtd_theme/static/js/oldtheme.js (limited to 'user_guide_src/source') diff --git a/user_guide_src/source/_themes/sphinx_rtd_theme/static/js/oldtheme.js b/user_guide_src/source/_themes/sphinx_rtd_theme/static/js/oldtheme.js new file mode 100644 index 000000000..60520cc3a --- /dev/null +++ b/user_guide_src/source/_themes/sphinx_rtd_theme/static/js/oldtheme.js @@ -0,0 +1,47 @@ +$( document ).ready(function() { + // Shift nav in mobile when clicking the menu. + $(document).on('click', "[data-toggle='wy-nav-top']", function() { + $("[data-toggle='wy-nav-shift']").toggleClass("shift"); + $("[data-toggle='rst-versions']").toggleClass("shift"); + }); + // Close menu when you click a link. + $(document).on('click', ".wy-menu-vertical .current ul li a", function() { + $("[data-toggle='wy-nav-shift']").removeClass("shift"); + $("[data-toggle='rst-versions']").toggleClass("shift"); + }); + $(document).on('click', "[data-toggle='rst-current-version']", function() { + $("[data-toggle='rst-versions']").toggleClass("shift-up"); + }); + // Make tables responsive + $("table.docutils:not(.field-list)").wrap("
"); +}); + +window.SphinxRtdTheme = (function (jquery) { + var stickyNav = (function () { + var navBar, + win, + stickyNavCssClass = 'stickynav', + applyStickNav = function () { + if (navBar.height() <= win.height()) { + navBar.addClass(stickyNavCssClass); + } else { + navBar.removeClass(stickyNavCssClass); + } + }, + enable = function () { + applyStickNav(); + win.on('resize', applyStickNav); + }, + init = function () { + navBar = jquery('nav.wy-nav-side:first'); + win = jquery(window); + }; + jquery(init); + return { + enable : enable + }; + }()); + return { + StickyNav : stickyNav + }; +}($)); diff --git a/user_guide_src/source/_themes/sphinx_rtd_theme/static/js/theme.js b/user_guide_src/source/_themes/sphinx_rtd_theme/static/js/theme.js index 60520cc3a..66edf2fa2 100644 --- a/user_guide_src/source/_themes/sphinx_rtd_theme/static/js/theme.js +++ b/user_guide_src/source/_themes/sphinx_rtd_theme/static/js/theme.js @@ -13,9 +13,80 @@ $( document ).ready(function() { $("[data-toggle='rst-versions']").toggleClass("shift-up"); }); // Make tables responsive - $("table.docutils:not(.field-list)").wrap("
"); + $("table.docutils:not(.field-list)").wrap("
"); + // --- + // START DOC MODIFICATION BY RUFNEX + // v1.0 04.02.2015 + // Add ToogleButton to get FullWidth-View by Johannes Gamperl codeigniter.de + var ciNav = ''; + ciNav += '
'; + $('body').prepend(ciNav); + // + var a = ['Index', 'CodeIgniter User Guide¶', 'Change Log¶', 'Developer’s Certificate of Origin 1.1¶', 'The MIT License (MIT)¶']; + if ($.inArray($('h1').text(), a) > 0 || $('h2').text() == 'Search Results') + { + $('table.ciNav a').each(function(){ + $(this).attr('href', $(this).attr("href").replace('../', '')); + }); + console.log(1111); + } + // + $('#openToc').click(function(){ + $('#nav').slideToggle(); + }); + $('.wy-breadcrumbs').append('
toc
'); + $('#closeMe').toggle( + function() + { + setCookie('ciNav', true, 365); + $('#nav2').show(); + $('#topMenu').remove(); + $('body').css({ background:'none' }); + $('.wy-nav-content-wrap').css({ background:'none', 'margin-left':0 }); + $('.wy-breadcrumbs').append('
'+$('.wy-form').parent().html()+'
');$('.wy-nav-side').toggle(); + }, + function() + { + setCookie('ciNav', false, 365); + $('#topMenu').remove(); + $('#nav').hide(); + $('#nav2').hide(); + $('body').css({ background:'#edf0f2;' }); + $('.wy-nav-content-wrap').css({ background:'none repeat scroll 0 0 #fcfcfc;', 'margin-left':'300px' }); + $('.wy-nav-side').show(); + } + ); + if (getCookie('ciNav') == 'true') + { + $('#closeMe').trigger('click'); + //$('#nav').slideToggle(); + } + // END MODIFICATION --- }); +// Rufnex Cookie functions +function setCookie(cname,cvalue,exdays) { + var d = new Date(); + d.setTime(d.getTime() + (exdays*24*60*60*1000)); + var expires = "expires=" + d.toGMTString(); + document.cookie = cname+"="+cvalue+"; "+expires; +} +function getCookie(cname) { + var name = cname + "="; + var ca = document.cookie.split(';'); + for(var i=0; i Date: Thu, 5 Feb 2015 15:15:46 +0200 Subject: update changelog for set_value() --- user_guide_src/source/changelog.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'user_guide_src/source') diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst index a0c0de83f..5c5cd5e54 100644 --- a/user_guide_src/source/changelog.rst +++ b/user_guide_src/source/changelog.rst @@ -105,6 +105,7 @@ Release Date: Not Released - :php:func:`form_dropdown()` will now also take an array for unity with other form helpers. - :php:func:`form_prep()` is now DEPRECATED and only acts as an alias for :doc:`common function ` :php:func:`html_escape()`. + - :php:func:`set_value()` will now also accept a third argument, allowing to turn off HTML escaping of the value. - :doc:`Security Helper ` changes include: -- cgit v1.2.3-24-g4f1b From b47763adba672e2226d9bf236646c60535426b9d Mon Sep 17 00:00:00 2001 From: Adrian Voicu Date: Thu, 5 Feb 2015 15:16:32 +0200 Subject: Update form_helper.rst --- user_guide_src/source/helpers/form_helper.rst | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) (limited to 'user_guide_src/source') diff --git a/user_guide_src/source/helpers/form_helper.rst b/user_guide_src/source/helpers/form_helper.rst index 15f5d7825..362c9c35d 100644 --- a/user_guide_src/source/helpers/form_helper.rst +++ b/user_guide_src/source/helpers/form_helper.rst @@ -581,7 +581,9 @@ The following functions are available: Permits you to set the value of an input form or textarea. You must supply the field name via the first parameter of the function. The second (optional) parameter allows you to set a default value for the - form. + form. The third (optional) parameter allows you to turn off HTML escaping + of the value, in case you need to use this function in combination with + i.e. :php:func:`form_input()` and avoid double-escaping. Example:: @@ -589,11 +591,7 @@ The following functions are available: The above form will show "0" when loaded for the first time. - .. note:: Only use this function with raw HTML fields, as it - internally calls :php:func:`html_escape()` and combining its - usage with other form helper functions will result in - double HTML encoding! - + .. php:function:: set_select($field[, $value = ''[, $default = FALSE]]) :param string $field: Field name @@ -718,4 +716,4 @@ The following functions are available: .. note:: This function is DEPRECATED and is just an alias for :doc:`common function <../general/common_functions>` - :func:`html_escape()` - please use that instead. \ No newline at end of file + :func:`html_escape()` - please use that instead. -- cgit v1.2.3-24-g4f1b From 7df6634b6ca69bfae76b3e9a7531035923579580 Mon Sep 17 00:00:00 2001 From: Andrey Andreev Date: Thu, 5 Feb 2015 15:58:09 +0200 Subject: [ci skip] Remove some whitespace --- user_guide_src/source/helpers/form_helper.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'user_guide_src/source') diff --git a/user_guide_src/source/helpers/form_helper.rst b/user_guide_src/source/helpers/form_helper.rst index 362c9c35d..4706ee706 100644 --- a/user_guide_src/source/helpers/form_helper.rst +++ b/user_guide_src/source/helpers/form_helper.rst @@ -591,7 +591,7 @@ The following functions are available: The above form will show "0" when loaded for the first time. - + .. php:function:: set_select($field[, $value = ''[, $default = FALSE]]) :param string $field: Field name -- cgit v1.2.3-24-g4f1b From b4b9bd3fc5bed95c19cd394d9fbf29772e94614a Mon Sep 17 00:00:00 2001 From: Rafael Schwemmer Date: Thu, 5 Feb 2015 15:30:13 +0100 Subject: Update transactions.rst Corrected a grammatical error in "CodeIgniter's Approach to Transactions" --- user_guide_src/source/database/transactions.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'user_guide_src/source') diff --git a/user_guide_src/source/database/transactions.rst b/user_guide_src/source/database/transactions.rst index e9190e59a..2e6d4b477 100644 --- a/user_guide_src/source/database/transactions.rst +++ b/user_guide_src/source/database/transactions.rst @@ -21,7 +21,7 @@ approach because it greatly simplifies the process of running transactions. In most cases all that is required are two lines of code. Traditionally, transactions have required a fair amount of work to -implement since they demand that you to keep track of your queries and +implement since they demand that you keep track of your queries and determine whether to commit or rollback based on the success or failure of your queries. This is particularly cumbersome with nested queries. In contrast, we've implemented a smart transaction system that does all -- cgit v1.2.3-24-g4f1b From 396eb89d1624f0bad6bc41ee477f40e824be41d9 Mon Sep 17 00:00:00 2001 From: Andrey Andreev Date: Fri, 6 Feb 2015 14:50:10 +0200 Subject: Polish changes following PR #3573 --- user_guide_src/source/changelog.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'user_guide_src/source') diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst index 5c5cd5e54..bc3ea34f6 100644 --- a/user_guide_src/source/changelog.rst +++ b/user_guide_src/source/changelog.rst @@ -767,6 +767,7 @@ Bug fixes for 3.0 - Fixed a bug in :doc:`Zip Library ` internal method ``_get_mod_time()`` where it was not parsing result returned by ``filemtime()``. - Fixed a bug (#3161) - :doc:`Cache Library ` methods `increment()`, `decrement()` didn't auto-create non-existent items when using redis and/or file storage. - Fixed a bug (#3189) - :doc:`Parser Library ` used double replacement on ``key->value`` pairs, exposing a potential template injection vulnerability. +- Fixed a bug (#3573) - :doc:`Email Library ` violated `RFC5321 `_ by sending 'localhost.localdomain' as a hostname. Version 2.2.1 ============= -- cgit v1.2.3-24-g4f1b From 789b1fe3e78f59cdb35ac5e6cf7166f6b97436c7 Mon Sep 17 00:00:00 2001 From: Andrey Andreev Date: Sat, 7 Feb 2015 19:30:30 +0200 Subject: Add 'sess_regenerate_destroy' setting --- user_guide_src/source/libraries/sessions.rst | 30 +++++++++++++++------------- 1 file changed, 16 insertions(+), 14 deletions(-) (limited to 'user_guide_src/source') diff --git a/user_guide_src/source/libraries/sessions.rst b/user_guide_src/source/libraries/sessions.rst index e2780683f..c8a1f1925 100644 --- a/user_guide_src/source/libraries/sessions.rst +++ b/user_guide_src/source/libraries/sessions.rst @@ -433,20 +433,22 @@ all of the options and their effects. You'll find the following Session related preferences in your **application/config/config.php** file: -======================== =============== ======================================== ============================================================================================ -Preference Default Options Description -======================== =============== ======================================== ============================================================================================ -**sess_driver** files files/database/redis/memcached/*custom* The session storage driver to use. -**sess_cookie_name** ci_session [A-Za-z\_-] characters only The name used for the session cookie. -**sess_expiration** 7200 (2 hours) Time in seconds (integer) The number of seconds you would like the session to last. - If you would like a non-expiring session (until browser is closed) set the value to zero: 0 -**sess_save_path** NULL None Specifies the storage location, depends on the driver being used. -**sess_time_to_update** 300 Time in seconds (integer) This option controls how often the session class will regenerate itself and create a new - session ID. Setting it to 0 will disable session ID regeneration. -**sess_match_ip** FALSE TRUE/FALSE (boolean) Whether to validate the user's IP address when reading the session cookie. - Note that some ISPs dynamically changes the IP, so if you want a non-expiring session you - will likely set this to FALSE. -======================== =============== ======================================== ============================================================================================ +============================ =============== ======================================== ============================================================================================ +Preference Default Options Description +============================ =============== ======================================== ============================================================================================ +**sess_driver** files files/database/redis/memcached/*custom* The session storage driver to use. +**sess_cookie_name** ci_session [A-Za-z\_-] characters only The name used for the session cookie. +**sess_expiration** 7200 (2 hours) Time in seconds (integer) The number of seconds you would like the session to last. + If you would like a non-expiring session (until browser is closed) set the value to zero: 0 +**sess_save_path** NULL None Specifies the storage location, depends on the driver being used. +**sess_match_ip** FALSE TRUE/FALSE (boolean) Whether to validate the user's IP address when reading the session cookie. + Note that some ISPs dynamically changes the IP, so if you want a non-expiring session you + will likely set this to FALSE. +**sess_time_to_update** 300 Time in seconds (integer) This option controls how often the session class will regenerate itself and create a new + session ID. Setting it to 0 will disable session ID regeneration. +**sess_regenerate_destroy** FALSE TRUE/FALSE (boolean) Whether to destroy session data associated with the old session ID when auto-regenerating + the session ID. When set to FALSE, the data will be later deleted by the garbage collector. +============================ =============== ======================================== ============================================================================================ .. note:: As a last resort, the Session library will try to fetch PHP's session related INI settings, as well as legacy CI settings such as -- cgit v1.2.3-24-g4f1b