diff options
author | Andrey Andreev <narf@devilix.net> | 2014-12-14 17:01:04 +0100 |
---|---|---|
committer | Andrey Andreev <narf@devilix.net> | 2014-12-14 17:01:04 +0100 |
commit | fb81cd85175a2d5020a21315cf7c58d099126dc0 (patch) | |
tree | 348a938ea239dbdc04df4a6b5fc4a3244f7ef964 /user_guide_src/source/libraries | |
parent | c9963f45f648af713e1a46d3fb5bcf018a0758eb (diff) | |
parent | 71b93b34a678e607e1935f5185836664056a3ccc (diff) |
Merge pull request #3410 from druu/feature/userguide_redesign
Feature/userguide redesign
Diffstat (limited to 'user_guide_src/source/libraries')
-rw-r--r-- | user_guide_src/source/libraries/input.rst | 20 | ||||
-rw-r--r-- | user_guide_src/source/libraries/zip.rst | 16 |
2 files changed, 21 insertions, 15 deletions
diff --git a/user_guide_src/source/libraries/input.rst b/user_guide_src/source/libraries/input.rst index 112347129..695a650e0 100644 --- a/user_guide_src/source/libraries/input.rst +++ b/user_guide_src/source/libraries/input.rst @@ -136,15 +136,17 @@ Class Reference $this->input->post(NULL, TRUE); // returns all POST items with XSS filter $this->input->post(NULL, FALSE); // returns all POST items without XSS filter - + To return an array of multiple POST parameters, pass all the required keys as an array. :: + $this->input->post(array('field1', 'field2')); - + Same rule applied here, to retrive the parameters with XSS filtering enabled, set the second parameter to boolean TRUE. :: + $this->input->post(array('field1', 'field2'), TRUE); .. method:: get([$index = NULL[, $xss_clean = NULL]]) @@ -167,15 +169,17 @@ Class Reference $this->input->get(NULL, TRUE); // returns all GET items with XSS filter $this->input->get(NULL, FALSE); // returns all GET items without XSS filtering - + To return an array of multiple GET parameters, pass all the required keys as an array. :: + $this->input->get(array('field1', 'field2')); - + Same rule applied here, to retrive the parameters with XSS filtering enabled, set the second parameter to boolean TRUE. :: + $this->input->get(array('field1', 'field2'), TRUE); .. method:: post_get($index[, $xss_clean = NULL]) @@ -218,10 +222,11 @@ Class Reference $this->input->cookie('some_cookie'); $this->input->cookie('some_cookie, TRUE); // with XSS filter - + To return an array of multiple cookie values, pass all the required keys as an array. :: + $this->input->cookie(array('some_cookie', 'some_cookie2')); .. method:: server($index[, $xss_clean = NULL]) @@ -239,7 +244,8 @@ Class Reference To return an array of multiple ``$_SERVER`` values, pass all the required keys as an array. :: - $this->input->server(array('SERVER_PROTOCOL', 'REQUEST_URI')); + + $this->input->server(array('SERVER_PROTOCOL', 'REQUEST_URI')); .. method:: input_stream([$index = NULL[, $xss_clean = NULL]]) @@ -437,4 +443,4 @@ Class Reference echo $this->input->method(TRUE); // Outputs: POST echo $this->input->method(FALSE); // Outputs: post - echo $this->input->method(); // Outputs: post
\ No newline at end of file + echo $this->input->method(); // Outputs: post diff --git a/user_guide_src/source/libraries/zip.rst b/user_guide_src/source/libraries/zip.rst index 0f255755e..b509236de 100644 --- a/user_guide_src/source/libraries/zip.rst +++ b/user_guide_src/source/libraries/zip.rst @@ -43,7 +43,7 @@ your server, and download it to your desktop. $this->zip->add_data($name, $data); // Write the zip file to a folder on your server. Name it "my_backup.zip" - $this->zip->archive('/path/to/directory/my_backup.zip'); + $this->zip->archive('/path/to/directory/my_backup.zip'); // Download the file to your desktop. Name it "my_backup.zip" $this->zip->download('my_backup.zip'); @@ -80,7 +80,7 @@ Class Reference $name = 'mydata2.txt'; $data = 'Another Data String!'; $this->zip->add_data($name, $data); - + When adding multiple files, the first parameter must contain *file => contents* pairs and the second parameter is ignored:: @@ -124,7 +124,7 @@ Class Reference $path = '/path/to/photo.jpg'; - $this->zip->read_file($path); + $this->zip->read_file($path); // Download the file to your desktop. Name it "my_backup.zip" $this->zip->download('my_backup.zip'); @@ -134,7 +134,7 @@ Class Reference $path = '/path/to/photo.jpg'; - $this->zip->read_file($path, TRUE); + $this->zip->read_file($path, TRUE); // Download the file to your desktop. Name it "my_backup.zip" $this->zip->download('my_backup.zip'); @@ -165,14 +165,14 @@ Class Reference $path = '/path/to/your/directory/'; - $this->zip->read_dir($path); + $this->zip->read_dir($path); // Download the file to your desktop. Name it "my_backup.zip" $this->zip->download('my_backup.zip'); By default the Zip archive will place all directories listed in the first parameter inside the zip. If you want the tree preceding the target directory to be ignored, - you can pass FALSE (boolean) in the second parameter. Example:: + you can pass FALSE (boolean) in the second parameter. Example:: $path = '/path/to/your/directory/'; @@ -236,9 +236,9 @@ Class Reference $this->zip->add_data($name, $data); $zip_file = $this->zip->get_zip(); - $this->zip->clear_data(); + $this->zip->clear_data(); $name = 'photo.jpg'; $this->zip->read_file("/path/to/photo.jpg"); // Read the file's contents - $this->zip->download('myphotos.zip');
\ No newline at end of file + $this->zip->download('myphotos.zip'); |