summaryrefslogtreecommitdiffstats
path: root/user_guide_src
diff options
context:
space:
mode:
authorDerek Jones <derek.jones@ellislab.com>2011-10-05 23:12:36 +0200
committerDerek Jones <derek.jones@ellislab.com>2011-10-05 23:12:36 +0200
commit3e9fb1c78fcb1bf542f66d7743a725919505e148 (patch)
tree720c61ed61b6de76ccfa50934771ee9468799013 /user_guide_src
parent078625105db343685c92f5827c09bbc32f59dc41 (diff)
fixed code block spacing in Encryption lib docs
Diffstat (limited to 'user_guide_src')
-rw-r--r--user_guide_src/source/libraries/encryption.rst26
1 files changed, 18 insertions, 8 deletions
diff --git a/user_guide_src/source/libraries/encryption.rst b/user_guide_src/source/libraries/encryption.rst
index 27c6a6484..356465b21 100644
--- a/user_guide_src/source/libraries/encryption.rst
+++ b/user_guide_src/source/libraries/encryption.rst
@@ -69,24 +69,35 @@ $this->encrypt->encode()
Performs the data encryption and returns it as a string. Example::
- $msg = 'My secret message'; $encrypted_string = $this->encrypt->encode($msg);
+ $msg = 'My secret message';
+
+ $encrypted_string = $this->encrypt->encode($msg);
+
You can optionally pass your encryption key via the second parameter if
you don't want to use the one in your config file::
- $msg = 'My secret message'; $key = 'super-secret-key'; $encrypted_string = $this->encrypt->encode($msg, $key);
+ $msg = 'My secret message';
+ $key = 'super-secret-key';
+
+ $encrypted_string = $this->encrypt->encode($msg, $key);
$this->encrypt->decode()
========================
Decrypts an encoded string. Example::
- $encrypted_string = 'APANtByIGI1BpVXZTJgcsAG8GZl8pdwwa84'; $plaintext_string = $this->encrypt->decode($encrypted_string);
+ $encrypted_string = 'APANtByIGI1BpVXZTJgcsAG8GZl8pdwwa84';
+
+ $plaintext_string = $this->encrypt->decode($encrypted_string);
You can optionally pass your encryption key via the second parameter if
you don't want to use the one in your config file::
- $msg = 'My secret message'; $key = 'super-secret-key'; $encrypted_string = $this->encrypt->decode($msg, $key);
+ $msg = 'My secret message';
+ $key = 'super-secret-key';
+
+ $encrypted_string = $this->encrypt->decode($msg, $key);
$this->encrypt->set_cipher();
==============================
@@ -130,9 +141,8 @@ is to encode a hash it's simpler to use the native function::
If your server does not support SHA1 you can use the provided function.
-$this->encrypt->encode_from_legacy($orig_data, $legacy_mode =
-MCRYPT_MODE_ECB, $key = '');
-==============================
+$this->encrypt->encode_from_legacy($orig_data, $legacy_mode = MCRYPT_MODE_ECB, $key = '');
+==========================================================================================
Enables you to re-encode data that was originally encrypted with
CodeIgniter 1.x to be compatible with the Encryption library in
@@ -143,7 +153,7 @@ encrypted session data or transitory encrypted flashdata require no
intervention on your part. However, existing encrypted Sessions will be
destroyed since data encrypted prior to 2.x will not be decoded.
-**Why only a method to re-encode the data instead of maintaining legacy
+..important:: **Why only a method to re-encode the data instead of maintaining legacy
methods for both encoding and decoding?** The algorithms in the
Encryption library have improved in CodeIgniter 2.x both for performance
and security, and we do not wish to encourage continued use of the older