Method namings

This commit is contained in:
Hans-Jürgen Petrich 2013-05-25 14:08:17 +07:00
parent 5429504aee
commit 35f1b8dc2b
6 changed files with 33 additions and 33 deletions

View File

@ -198,10 +198,10 @@ class Crypt_AES extends Crypt_Rijndael {
* *
* Validates all the variables. * Validates all the variables.
* *
* @see Crypt_Base::_mcryptSetup() * @see Crypt_Base::_setupMcrypt()
* @access private * @access private
*/ */
function _mcryptSetup() function _setupMcrypt()
{ {
if (!$this->explicit_key_length) { if (!$this->explicit_key_length) {
// this just copied from Crypt_Rijndael::_setup() // this just copied from Crypt_Rijndael::_setup()
@ -231,7 +231,7 @@ class Crypt_AES extends Crypt_Rijndael {
$this->password_key_size = $this->key_size; $this->password_key_size = $this->key_size;
$this->key = str_pad(substr($this->key, 0, $this->key_size), $this->key_size, chr(0)); $this->key = str_pad(substr($this->key, 0, $this->key_size), $this->key_size, chr(0));
parent::_mcryptSetup(); parent::_setupMcrypt();
} }
} }

View File

@ -243,7 +243,7 @@ class Crypt_Base {
* @link http://phpseclib.sourceforge.net/cfb-demo.phps * @link http://phpseclib.sourceforge.net/cfb-demo.phps
* @see Crypt_Base::encrypt() * @see Crypt_Base::encrypt()
* @see Crypt_Base::decrypt() * @see Crypt_Base::decrypt()
* @see Crypt_Base::_mcryptSetup() * @see Crypt_Base::_setupMcrypt()
* @var Resource * @var Resource
* @access private * @access private
*/ */
@ -328,7 +328,7 @@ class Crypt_Base {
* *
* @link http://www.php.net/mcrypt_module_open * @link http://www.php.net/mcrypt_module_open
* @link http://www.php.net/mcrypt_list_algorithms * @link http://www.php.net/mcrypt_list_algorithms
* @see Crypt_Base::_mcryptSetup() * @see Crypt_Base::_setupMcrypt()
* @var String * @var String
* @access private * @access private
*/ */
@ -383,7 +383,7 @@ class Crypt_Base {
* *
* @see Crypt_Base::encrypt() * @see Crypt_Base::encrypt()
* @see Crypt_Base::decrypt() * @see Crypt_Base::decrypt()
* @see Crypt_Base::_inlineCryptSetup() * @see Crypt_Base::_setupInlineCrypt()
* @see Crypt_Base::$use_inline_crypt * @see Crypt_Base::$use_inline_crypt
* @var Callback * @var Callback
* @access private * @access private
@ -606,7 +606,7 @@ class Crypt_Base {
{ {
if ($this->engine == CRYPT_MODE_MCRYPT) { if ($this->engine == CRYPT_MODE_MCRYPT) {
if ($this->changed) { if ($this->changed) {
$this->_mcryptSetup(); $this->_setupMcrypt();
$this->changed = false; $this->changed = false;
} }
if ($this->enchanged) { if ($this->enchanged) {
@ -835,7 +835,7 @@ class Crypt_Base {
if ($this->engine == CRYPT_MODE_MCRYPT) { if ($this->engine == CRYPT_MODE_MCRYPT) {
$block_size = $this->block_size; $block_size = $this->block_size;
if ($this->changed) { if ($this->changed) {
$this->_mcryptSetup(); $this->_setupMcrypt();
$this->changed = false; $this->changed = false;
} }
if ($this->dechanged) { if ($this->dechanged) {
@ -1187,7 +1187,7 @@ class Crypt_Base {
$this->_setupKey(); $this->_setupKey();
if ($this->use_inline_crypt) { if ($this->use_inline_crypt) {
$this->_inlineCryptSetup(); $this->_setupInlineCrypt();
} }
} }
@ -1197,7 +1197,7 @@ class Crypt_Base {
* (re)init, if necessary, the (ext)mcrypt resources and flush all $buffers * (re)init, if necessary, the (ext)mcrypt resources and flush all $buffers
* Used (only) if $engine = CRYPT_MODE_MCRYPT * Used (only) if $engine = CRYPT_MODE_MCRYPT
* *
* _mcryptSetup() will be called each time if $changed === true * _setupMcrypt() will be called each time if $changed === true
* typically this happens when using one or more of following public methods: * typically this happens when using one or more of following public methods:
* *
* - setKey() * - setKey()
@ -1216,7 +1216,7 @@ class Crypt_Base {
* @see disableContinuousBuffer() * @see disableContinuousBuffer()
* @access private * @access private
*/ */
function _mcryptSetup() function _setupMcrypt()
{ {
$this->_clearBuffers(); $this->_clearBuffers();
$this->enchanged = $this->dechanged = true; $this->enchanged = $this->dechanged = true;
@ -1402,7 +1402,7 @@ class Crypt_Base {
* *
* Internally for phpseclib developers: * Internally for phpseclib developers:
* *
* _inlineCryptSetup() would be called only if: * _setupInlineCrypt() would be called only if:
* *
* - $engine == CRYPT_MODE_INTERNAL and * - $engine == CRYPT_MODE_INTERNAL and
* *
@ -1411,21 +1411,21 @@ class Crypt_Base {
* - each time on _setup(), after(!) _setupKey() * - each time on _setup(), after(!) _setupKey()
* *
* *
* This ensures that _inlineCryptSetup() has allways a * This ensures that _setupInlineCrypt() has allways a
* full ready2go initializated internal cipher $engine state * full ready2go initializated internal cipher $engine state
* where, for example, the keys allready expanded, * where, for example, the keys allready expanded,
* keys/block_size calculated and such. * keys/block_size calculated and such.
* *
* It is, each time if called, the responsibility of _inlineCryptSetup(): * It is, each time if called, the responsibility of _setupInlineCrypt():
* *
* - to set $this->inline_crypt to a valid and fully working callback function * - to set $this->inline_crypt to a valid and fully working callback function
* as a (faster) replacement for encrypt() / decrypt() * as a (faster) replacement for encrypt() / decrypt()
* *
* - NOT to create unlimited callback functions (for memory reasons!) * - NOT to create unlimited callback functions (for memory reasons!)
* no matter how often _inlineCryptSetup() would be called. At some * no matter how often _setupInlineCrypt() would be called. At some
* point of amount they must be generic re-useable. * point of amount they must be generic re-useable.
* *
* - the code of _inlineCryptSetup() it self, * - the code of _setupInlineCrypt() it self,
* and the generated callback code, * and the generated callback code,
* must be, in following order: * must be, in following order:
* - 100% safe * - 100% safe
@ -1434,11 +1434,11 @@ class Crypt_Base {
* compatibility (down to php4) or fallback is provided * compatibility (down to php4) or fallback is provided
* - readable/maintainable/understandable/commented and... not-cryptic-styled-code :-) * - readable/maintainable/understandable/commented and... not-cryptic-styled-code :-)
* - >= 10% faster than encrypt()/decrypt() [which is, by the way, * - >= 10% faster than encrypt()/decrypt() [which is, by the way,
* the reason for the existence of _inlineCryptSetup() :-)] * the reason for the existence of _setupInlineCrypt() :-)]
* - memory-nice * - memory-nice
* - short (as good as possible) * - short (as good as possible)
* *
* Note: _inlineCryptSetup() is using _createInlineCryptFunction() to create the full callback function code. * Note: _setupInlineCrypt() is using _createInlineCryptFunction() to create the full callback function code.
* *
* Note: In case of using inline crypting, it must extend by the child Crypt_* class * Note: In case of using inline crypting, it must extend by the child Crypt_* class
* *
@ -1448,9 +1448,9 @@ class Crypt_Base {
* @see Crypt_Base::decrypt() * @see Crypt_Base::decrypt()
* @access private * @access private
*/ */
function _inlineCryptSetup() function _setupInlineCrypt()
{ {
// If a Crypt_* class providing inline crypting it must extend _inlineCryptSetup() // If a Crypt_* class providing inline crypting it must extend _setupInlineCrypt()
// If, for any reason, an extending Crypt_Base() Crypt_* class // If, for any reason, an extending Crypt_Base() Crypt_* class
// not using inline crypting then it must be ensured that: $this->use_inline_crypt = false // not using inline crypting then it must be ensured that: $this->use_inline_crypt = false
@ -1468,7 +1468,7 @@ class Crypt_Base {
* *
* _createInlineCryptFunction(): * _createInlineCryptFunction():
* *
* - merge the $cipher_code [setup'ed by _inlineCryptSetup()] * - merge the $cipher_code [setup'ed by _setupInlineCrypt()]
* with the current [$this->]mode of operation code * with the current [$this->]mode of operation code
* *
* - create the $inline function, which called by encrypt() / decrypt() * - create the $inline function, which called by encrypt() / decrypt()
@ -1547,7 +1547,7 @@ class Crypt_Base {
* +----------------------------------------------------------------------------------------------+ * +----------------------------------------------------------------------------------------------+
* </code> * </code>
* *
* See also the Crypt_*::_inlineCryptSetup()'s for * See also the Crypt_*::_setupInlineCrypt()'s for
* productive inline $cipher_code's how they works. * productive inline $cipher_code's how they works.
* *
* Structure of: * Structure of:
@ -1561,7 +1561,7 @@ class Crypt_Base {
* ); * );
* </code> * </code>
* *
* @see Crypt_Base::_inlineCryptSetup() * @see Crypt_Base::_setupInlineCrypt()
* @see Crypt_Base::encrypt() * @see Crypt_Base::encrypt()
* @see Crypt_Base::decrypt() * @see Crypt_Base::decrypt()
* @param Array $cipher_code * @param Array $cipher_code
@ -1923,7 +1923,7 @@ class Crypt_Base {
* Holds the lambda_functions table (classwide) * Holds the lambda_functions table (classwide)
* *
* Each name of the lambda function, created from * Each name of the lambda function, created from
* _inlineCryptSetup() && _createInlineCryptFunction() * _setupInlineCrypt() && _createInlineCryptFunction()
* is stored, classwide (!), here for reusing. * is stored, classwide (!), here for reusing.
* *
* The string-based index of $function is a classwide * The string-based index of $function is a classwide

View File

@ -557,10 +557,10 @@ class Crypt_Blowfish extends Crypt_Base {
/** /**
* Setup the performance-optimized function for de/encrypt() * Setup the performance-optimized function for de/encrypt()
* *
* @see Crypt_Base::_inlineCryptSetup() * @see Crypt_Base::_setupInlineCrypt()
* @access private * @access private
*/ */
function _inlineCryptSetup() function _setupInlineCrypt()
{ {
$lambda_functions =& Crypt_Blowfish::_getLambdaFunctions(); $lambda_functions =& Crypt_Blowfish::_getLambdaFunctions();

View File

@ -1373,10 +1373,10 @@ class Crypt_DES extends Crypt_Base {
/** /**
* Setup the performance-optimized function for de/encrypt() * Setup the performance-optimized function for de/encrypt()
* *
* @see Crypt_Base::_inlineCryptSetup() * @see Crypt_Base::_setupInlineCrypt()
* @access private * @access private
*/ */
function _inlineCryptSetup() function _setupInlineCrypt()
{ {
$lambda_functions =& Crypt_DES::_getLambdaFunctions(); $lambda_functions =& Crypt_DES::_getLambdaFunctions();

View File

@ -1097,12 +1097,12 @@ class Crypt_Rijndael extends Crypt_Base {
/** /**
* Setup the performance-optimized function for de/encrypt() * Setup the performance-optimized function for de/encrypt()
* *
* @see Crypt_Base::_inlineCryptSetup() * @see Crypt_Base::_setupInlineCrypt()
* @access private * @access private
*/ */
function _inlineCryptSetup() function _setupInlineCrypt()
{ {
// Note: _inlineCryptSetup() will be called only if $this->changed === true // Note: _setupInlineCrypt() will be called only if $this->changed === true
// So here we are'nt under the same heavy timing-stress as we are in _de/encryptBlock() or de/encrypt(). // So here we are'nt under the same heavy timing-stress as we are in _de/encryptBlock() or de/encrypt().
// However...the here generated function- $code, stored as php callback in $this->inline_crypt, must work as fast as even possible. // However...the here generated function- $code, stored as php callback in $this->inline_crypt, must work as fast as even possible.

View File

@ -772,10 +772,10 @@ class Crypt_Twofish extends Crypt_Base {
/** /**
* Setup the performance-optimized function for de/encrypt() * Setup the performance-optimized function for de/encrypt()
* *
* @see Crypt_Base::_inlineCryptSetup() * @see Crypt_Base::_setupInlineCrypt()
* @access private * @access private
*/ */
function _inlineCryptSetup() function _setupInlineCrypt()
{ {
$lambda_functions =& Crypt_Twofish::_getLambdaFunctions(); $lambda_functions =& Crypt_Twofish::_getLambdaFunctions();