.. _case-piwigo-structures-uselessbrackets:
Piwigo
++++++
:ref:`useless-brackets`, in picture.php:342.
There is no need for block braces with case. In fact, it does give a false sense of break, while the case will still fall over to the next one.
.. code-block:: php
case 'rate' :
{
include_once(PHPWG_ROOT_PATH.'include/functions_rate.inc.php');
rate_picture($page['image_id'], $_POST['rate']);
redirect($url_self);
}
.. _case-useless-catch:
Useless Catch
#############
.. _case-zurmo-exceptions-uselesscatch:
Zurmo
+++++
:ref:`useless-catch`, in app/protected/modules/workflows/forms/attributes/ExplicitReadWriteModelPermissionsWorkflowActionAttributeForm.php:99.
Catch the exception, then return. At least, the comment is honest.
.. code-block:: php
try
{
$group = Group::getById((int)$this->type);
$explicitReadWriteModelPermissions->addReadWritePermitable($group);
}
catch (NotFoundException $e)
{
//todo: handle exception better
return;
}
.. _case-prestashop-exceptions-uselesscatch:
PrestaShop
++++++++++
:ref:`useless-catch`, in src/Core/Addon/Module/ModuleManagerBuilder.php:170.
Here, the catch clause will intercept a IO problem while writing element on the disk, and will return false. Since this is a constructor, the returned value will be ignored and the object will be left in a wrong state, since it was not totally inited.
.. code-block:: php
private function __construct()
{
// More code......
try {
$filesystem = new Filesystem();
$filesystem->dumpFile($phpConfigFile, ' (int)$object->getId(),
'category_id = ?' => (int)$categoryId,
);
$write->delete($this->_productCategoryTable, $where);
}
}
.. _case-phinx-structures-uselesscheck:
Phinx
+++++
:ref:`useless-check`, in src/Phinx/Migration/Manager.php:828.
If $dependencies is not empty, foreach() skips the loops.
.. code-block:: php
private function getSeedDependenciesInstances(AbstractSeed $seed)
{
$dependenciesInstances = [];
$dependencies = $seed->getDependencies();
if (!empty($dependencies)) {
foreach ($dependencies as $dependency) {
foreach ($this->seeds as $seed) {
if (get_class($seed) === $dependency) {
$dependenciesInstances[get_class($seed)] = $seed;
}
}
}
}
return $dependenciesInstances;
}
.. _case-useless-global:
Useless Global
##############
.. _case-zencart-structures-uselessglobal:
Zencart
+++++++
:ref:`useless-global`, in admin/includes/modules/newsletters/newsletter.php:25.
$_GET is always a global variable. There is no need to declare it global in any scope.
.. code-block:: php
function choose_audience() {
global $_GET;
.. _case-humo-gen-structures-uselessglobal:
HuMo-Gen
++++++++
:ref:`useless-global`, in relations.php:332.
It is hard to spot that $generY is useless, but this is the only occurrence where $generY is refered to as a global. It is not accessed anywhere else as a global (there are occurrences of $generY being an argument), and it is not even assigned within that function.
.. code-block:: php
function calculate_ancestor($pers) {
global $db_functions, $reltext, $sexe, $sexe2, $spouse, $special_spouseY, $language, $ancestortext, $dutchtext, $selected_language, $spantext, $generY, $foundY_nr, $rel_arrayY;
.. _case-useless-interfaces:
Useless Interfaces
##################
.. _case-woocommerce-interfaces-uselessinterfaces:
Woocommerce
+++++++++++
:ref:`useless-interfaces`, in includes/interfaces/class-wc-order-item-data-store-interface.php:20.
WC_Order_Item_Data_Store_Interface is used to structure the class WC_Order_Item_Data_Store. It is not used anywhere else.
.. code-block:: php
interface WC_Order_Item_Data_Store_Interface {
////////
//includes/data-stores/class-wc-order-item-data-store.php
class WC_Order_Item_Data_Store implements WC_Order_Item_Data_Store_Interface {
.. _case-useless-parenthesis:
Useless Parenthesis
###################
.. _case-mautic-structures-uselessparenthesis:
Mautic
++++++
:ref:`useless-parenthesis`, in code/app/bundles/EmailBundle/Controller/AjaxController.php:85.
Parenthesis are useless around $progress[1], and around the division too.
.. code-block:: php
$dataArray['percent'] = ($progress[1]) ? ceil(($progress[0] / $progress[1]) * 100) : 100;
.. _case-woocommerce-structures-uselessparenthesis:
Woocommerce
+++++++++++
:ref:`useless-parenthesis`, in includes/class-wc-coupon.php:437.
Parenthesis are useless for calculating $discount_percent, as it is a divisition. Moreover, it is not needed with $discount, (float) applies to the next element, but it does make the expression more readable.
.. code-block:: php
if ( wc_prices_include_tax() ) {
$discount_percent = ( wc_get_price_including_tax( $cart_item['data'] ) * $cart_item_qty ) / WC()->cart->subtotal;
} else {
$discount_percent = ( wc_get_price_excluding_tax( $cart_item['data'] ) * $cart_item_qty ) / WC()->cart->subtotal_ex_tax;
}
$discount = ( (float) $this->get_amount() * $discount_percent ) / $cart_item_qty;
.. _case-useless-referenced-argument:
Useless Referenced Argument
###########################
.. _case-woocommerce-functions-uselessreferenceargument:
Woocommerce
+++++++++++
:ref:`useless-referenced-argument`, in includes/data-stores/class-wc-product-variation-data-store-cpt.php:414.
$product is defined with a reference in the method signature, but it is also used as an object with a dynamical property. As such, the reference in the argument definition is too much.
.. code-block:: php
public function update_post_meta( &$product, $force = false ) {
$meta_key_to_props = array(
'_variation_description' => 'description',
);
$props_to_update = $force ? $meta_key_to_props : $this->get_props_to_update( $product, $meta_key_to_props );
foreach ( $props_to_update as $meta_key => $prop ) {
$value = $product->{get_$prop}( 'edit' );
$updated = update_post_meta( $product->get_id(), $meta_key, $value );
if ( $updated ) {
$this->updated_props[] = $prop;
}
}
parent::update_post_meta( $product, $force );
.. _case-magento-functions-uselessreferenceargument:
Magento
+++++++
:ref:`useless-referenced-argument`, in setup/src/Magento/Setup/Module/Di/Compiler/Config/Chain/PreferencesResolving.php:63.
$value is defined with a reference. In the following code, it is only read and never written : for index search, or by itself. In fact, $preferences is also only read, and never written. As such, both could be removed.
.. code-block:: php
private function resolvePreferenceRecursive(&$value, &$preferences)
{
return isset($preferences[$value])
? $this->resolvePreferenceRecursive($preferences[$value], $preferences)
: $value;
}
.. _case-useless-return:
Useless Return
##############
.. _case-thinkphp-functions-uselessreturn:
ThinkPHP
++++++++
:ref:`useless-return`, in library/think/Request.php:2121.
__set() doesn't need a return, unlike __get().
.. code-block:: php
public function __set($name, $value)
{
return $this->param[$name] = $value;
}
.. _case-vanilla-functions-uselessreturn:
Vanilla
+++++++
:ref:`useless-return`, in applications/dashboard/views/attachments/attachment.php:14.
The final 'return' is useless : return void (here, return without argument), is the same as returning null, unless the 'void' return type is used. The other return, is in the two conditions, is important to skip the end of the functioncall.
.. code-block:: php
function writeAttachment($attachment) {
$customMethod = AttachmentModel::getWriteAttachmentMethodName($attachment['Type']);
if (function_exists($customMethod)) {
if (val('Error', $attachment)) {
writeErrorAttachment($attachment);
return;
}
$customMethod($attachment);
} else {
trace($customMethod, 'Write Attachment method not found');
trace($attachment, 'Attachment');
}
return;
}
.. _case-useless-switch:
Useless Switch
##############
.. _case-phpdocumentor-structures-uselessswitch:
Phpdocumentor
+++++++++++++
:ref:`useless-switch`, in fuel/modules/fuel/libraries/Inspection.php:349.
This method parses comments. In fact, comments are represented by other tokens, which may be added or removed at time while coding.
.. code-block:: php
public function parse_comments($code)
{
$comments = array();
$tokens = token_get_all($code);
foreach($tokens as $token)
{
switch($token[0])
{
case T_DOC_COMMENT:
$comments[] = $token[1];
break;
}
}
return $comments;
}
.. _case-dolphin-structures-uselessswitch:
Dolphin
+++++++
:ref:`useless-switch`, in Dolphin-v.7.3.5/inc/classes/BxDolModuleDb.php:34.
$aParams is an argument : this code looks like the switch is reserved for future use.
.. code-block:: php
function getModulesBy($aParams = array())
{
$sMethod = 'getAll';
$sPostfix = $sWhereClause = ;
$sOrderClause = ORDER BY `title`;
switch($aParams['type']) {
case 'path':
$sMethod = 'getRow';
$sPostfix .= '_path';
$sWhereClause .= "AND `path`='" . $aParams['value'] . "'";
break;
}
.. _case-useless-type-casting:
Useless Type Casting
####################
.. _case-fuelcms-structures-uselesscasting:
FuelCMS
+++++++
:ref:`useless-type-casting`, in fuel/codeigniter/core/URI.php:214.
substr() always returns a string, so there is no need to enforce this.
.. code-block:: php
if (isset($_SERVER['SCRIPT_NAME'][0]))
{
if (strpos($uri, $_SERVER['SCRIPT_NAME']) === 0)
{
$uri = (string) substr($uri, strlen($_SERVER['SCRIPT_NAME']));
}
elseif (strpos($uri, dirname($_SERVER['SCRIPT_NAME'])) === 0)
{
$uri = (string) substr($uri, strlen(dirname($_SERVER['SCRIPT_NAME'])));
}
}
.. _case-thinkphp-structures-uselesscasting:
ThinkPHP
++++++++
:ref:`useless-type-casting`, in ThinkPHP/Library/Think/Db/Driver/Sqlsrv.class.php:67.
A comparison always returns a boolean, except for the spaceship operator.
.. code-block:: php
foreach ($result as $key => $val) {
$info[$val['column_name']] = array(
'name' => $val['column_name'],
'type' => $val['data_type'],
'notnull' => (bool) ('' === $val['is_nullable']), // not null is empty, null is yes
'default' => $val['column_default'],
'primary' => false,
'autoinc' => false,
);
}
.. _case-useless-unset:
Useless Unset
#############
.. _case-tine20-structures-uselessunset:
Tine20
++++++
:ref:`useless-unset`, in tine20/Felamimail/Controller/Message.php:542.
$_rawContent is unset after being sent to the stream. The variable is a parameter, and will be freed at the end of the call of the method. No need to do it explicitly.
.. code-block:: php
protected function _createMimePart($_rawContent, $_partStructure)
{
if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__ . ' Content: ' . $_rawContent);
$stream = fopen(php://temp, 'r+');
fputs($stream, $_rawContent);
rewind($stream);
unset($_rawContent);
//..... More code, no usage of $_rawContent
}
.. _case-typo3-structures-uselessunset:
Typo3
+++++
:ref:`useless-unset`, in typo3/sysext/frontend/Classes/Page/PageRepository.php:708.
$row is unset under certain conditions : here, we can read it in the comments. Eventually, the $row will be returned, and turned into a NULL, by default. This will also create a notice in the logs. Here, the best would be to set a null value, instead of unsetting the variable.
.. code-block:: php
public function getRecordOverlay($table, $row, $sys_language_content, $OLmode = '')
{
//.... a lot more code, with usage of $row, and several unset($row)
//...... Reduced for simplicity
} else {
// When default language is displayed, we never want to return a record carrying
// another language!
if ($row[$GLOBALS['TCA'][$table]['ctrl']['languageField']] > 0) {
unset($row);
}
}
}
}
}
foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_page.php']['getRecordOverlay'] ?? [] as $className) {
$hookObject = GeneralUtility::makeInstance($className);
if (!$hookObject instanceof PageRepositoryGetRecordOverlayHookInterface) {
throw new \UnexpectedValueException($className . ' must implement interface ' . PageRepositoryGetRecordOverlayHookInterface::class, 1269881659);
}
$hookObject->getRecordOverlay_postProcess($table, $row, $sys_language_content, $OLmode, $this);
}
return $row;
}
.. _case-var-keyword:
Var Keyword
###########
.. _case-xataface-classes-oldstylevar:
xataface
++++++++
:ref:`var-keyword`, in SQL/Parser/wrapper.php:24.
With the usage of var and a first method bearing the name of the class, this is PHP 4 code that is still in use.
.. code-block:: php
class SQL_Parser_wrapper {
var $_data;
var $_tableLookup;
var $_parser;
function SQL_Parser_wrapper(&$data, $dialect='MySQL'){
.. _case-weak-typing:
Weak Typing
###########
.. _case-teampass-classes-weaktype:
TeamPass
++++++++
:ref:`weak-typing`, in includes/libraries/Tree/NestedTree/NestedTree.php:100.
The is_null() test detects a special situation, that requires usage of default values. The 'else' handles every other situations, including when the $node is an object, or anything else. $this->getNode() will gain from having typehints : it may be NULL, or the results of mysqli_fetch_object() : a stdClass object. The expected properties of nleft and nright are not certain to be available.
.. code-block:: php
public function getDescendants($id = 0, $includeSelf = false, $childrenOnly = false, $unique_id_list = false)
{
global $link;
$idField = $this->fields['id'];
$node = $this->getNode($id);
if (is_null($node)) {
$nleft = 0;
$nright = 0;
$parent_id = 0;
$personal_folder = 0;
} else {
$nleft = $node->nleft;
$nright = $node->nright;
$parent_id = $node->$idField;
$personal_folder = $node->personal_folder;
}
.. _case-while(list()-=-each()):
While(List() = Each())
######################
.. _case-openemr-structures-whilelisteach:
OpenEMR
+++++++
:ref:`while(list()-=-each())`, in library/report.inc:153.
The first while() is needed, to read the arbitrary long list returned by the SQL query. The second list may be upgraded with a foreach, to read both the key and the value. This is certainly faster to execute and to read.
.. code-block:: php
function getInsuranceReport($pid, $type = primary)
{
$sql = select * from insurance_data where pid=? and type=? order by date ASC;
$res = sqlStatement($sql, array($pid, $type));
while ($list = sqlFetchArray($res)) {
while (list($key, $value) = each($list)) {
if ($ret[$key]['content'] != $value && $ret[$key]['date'] < $list['date']) {
$ret[$key]['content'] = $value;
$ret[$key]['date'] = $list['date'];
}
}
}
return $ret;
}
.. _case-dolphin-structures-whilelisteach:
Dolphin
+++++++
:ref:`while(list()-=-each())`, in Dolphin-v.7.3.5/modules/boonex/forum/classes/Forum.php:1875.
This clever use of while() and list() is actually a foreach($a as $r) (the keys are ignored)
.. code-block:: php
function getRssUpdatedTopics ()
{
global $gConf;
$this->_rssPrepareConf ();
$a = $this->fdb->getRecentTopics (0);
$items = '';
$lastBuildDate = '';
$ui = array();
reset ($a);
while ( list (,$r) = each ($a) ) {
// acquire user info
if (!isset($ui[$r['last_post_user']]) && ($aa = $this->_getUserInfoReadyArray ($r['last_post_user'], false)))
$ui[$r['last_post_user']] = $aa;
$td = orca_mb_replace('/#/', $r['count_posts'], '[L[# posts]]') . ' · ' . orca_mb_replace('/#/', $ui[$r['last_post_user']]['title'], '[L[last reply by #]]') . ' · ' . $r['cat_name'] . ' » ' . $r['forum_title'];
.. _case-written-only-variables:
Written Only Variables
######################
.. _case-dolibarr-variables-writtenonlyvariable:
Dolibarr
++++++++
:ref:`written-only-variables`, in htdocs/ecm/class/ecmdirectory.class.php:692.
$val is only written, as only the keys are used. $val may be skipped by applying the foreach to array_keys($this->cats), instead of the whole array.
.. code-block:: php
// We add properties fullxxx to all elements
foreach($this->cats as $key => $val)
{
if (isset($motherof[$key])) continue;
$this->build_path_from_id_categ($key, 0);
}
.. _case-suitecrm-variables-writtenonlyvariable:
SuiteCrm
++++++++
:ref:`written-only-variables`, in modules/Campaigns/utils.php:820.
$email_health is used later in the method; while $email_components is only set, and never used.
.. code-block:: php
//run query for mail boxes of type 'bounce'
$email_health = 0;
$email_components = 2;
$mbox_qry = "select * from inbound_email where deleted ='0' and mailbox_type = 'bounce'";
$mbox_res = $focus->db->query($mbox_qry);
$mbox = array();
while ($mbox_row = $focus->db->fetchByAssoc($mbox_res)) {
$mbox[] = $mbox_row;
}
.. _case-wrong-access-style-to-property:
Wrong Access Style to Property
##############################
.. _case-humo-gen-classes-undeclaredstaticproperty:
HuMo-Gen
++++++++
:ref:`wrong-access-style-to-property`, in wp-admin/includes/misc.php:74.
lame_binary_path is a static property, but it is accessed as a normal property in the exception call, while it is checked with a valid syntax.
.. code-block:: php
protected function wavToMp3($data)
{
if (!file_exists(self::$lame_binary_path) || !is_executable(self::$lame_binary_path)) {
throw new Exception('Lame binary . $this->lame_binary_path . does not exist or is not executable');
}
.. _case-wrong-class-name-case:
Wrong Class Name Case
#####################
.. _case-wordpress-classes-wrongcase:
WordPress
+++++++++
:ref:`wrong-class-name-case`, in wp-admin/includes/misc.php:74.
This code actually loads the file, join it, then split it again. file() would be sufficient.
.. code-block:: php
$markerdata = explode( \n, implode( '', file( $filename ) ) );
.. _case-wrong-number-of-arguments:
Wrong Number Of Arguments
#########################
.. _case-xataface-functions-wrongnumberofarguments:
xataface
++++++++
:ref:`wrong-number-of-arguments`, in actions/existing_related_record.php:130.
df_display() actually requires only 2 arguments, while three are provided. The last argument is completely ignored. df_display() is called in a total of 9 places : this now looks like an API change that left many calls untouched.
.. code-block:: php
df_display($context, $template, true);
// in public-api.php :
function df_display($context, $template_name){
import( 'Dataface/SkinTool.php');
$st = Dataface_SkinTool::getInstance();
return $st->display($context, $template_name);
}
.. _case-wrong-optional-parameter:
Wrong Optional Parameter
########################
.. _case-fuelcms-functions-wrongoptionalparameter:
FuelCMS
+++++++
:ref:`wrong-optional-parameter`, in fuel/modules/fuel/helpers/validator_helper.php:78.
The $regex parameter should really be first, as it is compulsory. Though, if this is a legacy function, it may be better to give regex a default value, such as empty string or null, and test it before using it.
.. code-block:: php
if (!function_exists('regex'))
{
function regex($var = null, $regex)
{
return preg_match('#'.$regex.'#', $var);
}
}
.. _case-vanilla-functions-wrongoptionalparameter:
Vanilla
+++++++
:ref:`wrong-optional-parameter`, in applications/dashboard/modules/class.navmodule.php:99.
Note the second parameter, $dropdown, which has no default value. It is relayed to the addDropdown method, which as no default value too. Since both methods are documented, we can see that they should be an addDropdown : null is probably a good idea, coupled with an explicit check on the actual value.
.. code-block:: php
/**
* Add a dropdown to the items array if it satisfies the $isAllowed condition.
*
* @param bool|string|array $isAllowed Either a boolean to indicate whether to actually add the item
* or a permission string or array of permission strings (full match) to check.
* @param DropdownModule $dropdown The dropdown menu to add.
* @param string $key The item's key (for sorting and CSS targeting).
* @param string $cssClass The dropdown wrapper's CSS class.
* @param array|int $sort Either a numeric sort position or and array in the style: array('before|after', 'key').
* @return NavModule $this The calling object.
*/
public function addDropdownIf($isAllowed = true, $dropdown, $key = '', $cssClass = '', $sort = []) {
if (!$this->isAllowed($isAllowed)) {
return $this;
} else {
return $this->addDropdown($dropdown, $key, $cssClass, $sort);
}
}
.. _case-wrong-parameter-type:
Wrong Parameter Type
####################
.. _case-zencart-php-internalparametertype:
Zencart
+++++++
:ref:`wrong-parameter-type`, in admin/includes/header.php:180.
setlocale() may be called with null or '' (empty string), and will set values from the environment. When called with 0 (the string), it only reports the current setting. Using an integer is probably undocumented behavior, and falls back to the zero string.
.. code-block:: php
$loc = setlocale(LC_TIME, 0);
if ($loc !== FALSE) echo ' - ' . $loc; //what is the locale in use?
.. _case-wrong-range-check:
Wrong Range Check
#################
.. _case-dolibarr-structures-wrongrange:
Dolibarr
++++++++
:ref:`wrong-range-check`, in htdocs/includes/phpoffice/PhpSpreadsheet/Spreadsheet.php:1484.
When $tabRatio is 1001, then the condition is valid, and the ratio accepted. The right part of the condition is not executed.
.. code-block:: php
public function setTabRatio($tabRatio)
{
if ($tabRatio >= 0 || $tabRatio <= 1000) {
$this->tabRatio = (int) $tabRatio;
} else {
throw new Exception('Tab ratio must be between 0 and 1000.');
}
}
.. _case-wordpress-structures-wrongrange:
WordPress
+++++++++
:ref:`wrong-range-check`, in wp-includes/formatting.php:3634.
This condition may be easier to read as `$diff >= WEEK_IN_SECONDS && $diff < MONTH_IN_SECONDS`. When testing for outside this interval, using not is also more readable : `!($diff >= WEEK_IN_SECONDS && $diff < MONTH_IN_SECONDS)`.
.. code-block:: php
} elseif ( $diff < MONTH_IN_SECONDS && $diff >= WEEK_IN_SECONDS ) {
$weeks = round( $diff / WEEK_IN_SECONDS );
if ( $weeks <= 1 ) {
$weeks = 1;
}
/* translators: Time difference between two dates, in weeks. %s: Number of weeks */
$since = sprintf( _n( '%s week', '%s weeks', $weeks ), $weeks );
.. _case-wrong-fopen()-mode:
Wrong fopen() Mode
##################
.. _case-tikiwiki-php-fopenmode:
Tikiwiki
++++++++
:ref:`wrong-fopen()-mode`, in lib/tikilib.php:6777.
This fopen() mode doesn't exists. Use 'w' instead.
.. code-block:: php
fopen('php://temp', 'rw');
.. _case-humo-gen-php-fopenmode:
HuMo-Gen
++++++++
:ref:`wrong-fopen()-mode`, in include/phprtflite/lib/PHPRtfLite/StreamOutput.php:77.
This fopen() mode doesn't exists. Use 'w' instead.
.. code-block:: php
fopen($this->_filename, 'wr', false)
.. _case-\_\_dir\_\_-then-slash:
__DIR__ Then Slash
##################
.. _case-traq-structures-dirthenslash:
Traq
++++
:ref:`\_\_dir\_\_-then-slash`, in src/Kernel.php:60.
When executed in a path '/a/b/c', this code will require '/a../../vendor/autoload.php.
.. code-block:: php
static::$loader = require __DIR__.'../../vendor/autoload.php';
.. _case-\_\_debuginfo()-usage:
__debugInfo() Usage
###################
.. _case-dolibarr-php-debuginfousage:
Dolibarr
++++++++
:ref:`\_\_debuginfo()-usage`, in htdocs/includes/stripe/lib/StripeObject.php:108.
_values is a private property from the Stripe Class. The class contains other objects, but only _values are displayed with var_dump.
.. code-block:: php
// Magic method for var_dump output. Only works with PHP >= 5.6
public function __debugInfo()
{
return $this->_values;
}
.. _case-error\_reporting()-with-integers:
error_reporting() With Integers
###############################
.. _case-sugarcrm-structures-errorreportingwithinteger:
SugarCrm
++++++++
:ref:`error\_reporting()-with-integers`, in modules/UpgradeWizard/silentUpgrade_step1.php:436.
This only displays E_ERROR, the highest level of error reporting. It should be checked, as it happens in the 'silentUpgrade' script.
.. code-block:: php
ini_set('error_reporting', 1);
.. _case-eval()-without-try:
eval() Without Try
##################
.. _case-fuelcms-structures-evalwithouttry:
FuelCMS
+++++++
:ref:`eval()-without-try`, in fuel/modules/fuel/controllers/Blocks.php:268.
The @ will prevent any error, while the try/catch allows the processing of certain types of error, namely the Fatal ones.
.. code-block:: php
@eval($_name_var_eval)
.. _case-expressionengine-structures-evalwithouttry:
ExpressionEngine
++++++++++++++++
:ref:`eval()-without-try`, in system/ee/EllisLab/Addons/member/mod.member_memberlist.php:637.
$cond is build from values extracted from the $fields array. Although it is probably reasonably safe, a try/catch here will collect any unexpected situation cleaningly.
.. code-block:: php
elseif (isset($fields[$val['3']]))
{
if (array_key_exists('m_field_id_'.$fields[$val['3']], $row))
{
$v = $row['m_field_id_'.$fields[$val['3']]];
$lcond = str_replace($val['3'], $v, $lcond);
$cond = $lcond.' '.$rcond;
$cond = str_replace("|", "|", $cond);
eval("$result = ".$cond.";");
.. _case-include\_once()-usage:
include_once() Usage
####################
.. _case-xoops-structures-onceusage:
XOOPS
+++++
:ref:`include\_once()-usage`, in /htdocs/xoops_lib/modules/protector/admin/center.php:5.
Loading() classes should be down with autoload(). autload() may be build in several distinct functions, using spl_autoload_register().
.. code-block:: php
require_once dirname(__DIR__) . 'class/gtickets.php'
.. _case-tikiwiki-structures-onceusage:
Tikiwiki
++++++++
:ref:`include\_once()-usage`, in tiki-mytiki_shared.php :140.
Turn the code from tiki-mytiki_shared.php into a function or a method, and call it when needed.
.. code-block:: php
include_once('tiki-mytiki_shared.php');
.. _case-list()-may-omit-variables:
list() May Omit Variables
#########################
.. _case-openconf-structures-listomissions:
OpenConf
++++++++
:ref:`list()-may-omit-variables`, in openconf/author/privacy.php:29.
The first variable in the list(), $none, isn't reused anywhere in the script. In fact, its name convey the meaning that is it useless, but is in the array nonetheless.
.. code-block:: php
list($none, $OC_privacy_policy) = oc_getTemplate('privacy_policy');
.. _case-fuelcms-structures-listomissions:
FuelCMS
+++++++
:ref:`list()-may-omit-variables`, in wp-admin/includes/misc.php:74.
$a is never reused again. $b, on the other hand is. Not assigning any value to $a saves some memory, and avoid polluting the local variable space.
.. code-block:: php
list($b, $a) = array(reset($params->me), key($params->me));
.. _case-preg\_match\_all()-flag:
preg_match_all() Flag
#####################
.. _case-fuelcms-php-pregmatchallflag:
FuelCMS
+++++++
:ref:`preg\_match\_all()-flag`, in fuel/modules/fuel/helpers/MY_array_helper.php:205.
Using PREG_SET_ORDER will remove the usage of the ``$key``variable.
.. code-block:: php
function parse_string_to_array($str)
{
preg_match_all('#(\w+)=([\'"])(.*)\2#U', $str, $matches);
$params = array();
foreach($matches[1] as $key => $val)
{
if (!empty($matches[3]))
{
$params[$val] = $matches[3][$key];
}
}
return $params;
}
.. _case-preg\_replace-with-option-e:
preg_replace With Option e
##########################
.. _case-edusoho-structures-pregoptione:
Edusoho
+++++++
:ref:`preg\_replace-with-option-e`, in vendor_user/uc_client/lib/uccode.class.php:32.
This call extract text between [code] tags, then process it with $this->codedisp() and nest it again in the original string. preg_replace_callback() is a drop-in replacement for this piece of code.
.. code-block:: php
$message = preg_replace("/\s*\[code\](.+?)\[\/code\]\s*/ies", "$this->codedisp('\1')", $message);
.. _case-strpos()-too-much:
strpos() Too Much
#################
.. _case-wordpress-performances-strpostoomuch:
WordPress
+++++++++
:ref:`strpos()-too-much`, in core/traits/Request/Server.php:127.
Instead of searching for ``HTTP_``, it is faster to compare the first 5 chars to the literal ``HTTP_``. In case of absence, this solution returns faster.
.. code-block:: php
if (strpos($header, 'HTTP_') === 0) {
$header = substr($header, 5);
} elseif (strpos($header, 'CONTENT_') !== 0) {
continue;
}
.. _case-time()-vs-strtotime():
time() Vs strtotime()
#####################
.. _case-woocommerce-performances-timevsstrtotime:
Woocommerce
+++++++++++
:ref:`time()-vs-strtotime()`, in includes/class-wc-webhook.php:384.
time() would be faster here, as an entropy generator. Yet, it would still be better to use an actual secure entropy generator, like random_byte or random_int. In case of older version, microtime() would yield better entropy.
.. code-block:: php
public function get_new_delivery_id() {
// Since we no longer use comments to store delivery logs, we generate a unique hash instead based on current time and webhook ID.
return wp_hash( $this->get_id() . strtotime( 'now' ) );
}
.. _case-var\_dump()...-usage:
var_dump()... Usage
###################
.. _case-tine20-structures-vardumpusage:
Tine20
++++++
:ref:`var\_dump()...-usage`, in tine20/library/Ajam/Connection.php:122.
Two usage of var_dump(). They are protected by configuration, since the debug property must be set to 'true'. Yet, it is safer to avoid them altogether, and log the information to an external file.
.. code-block:: php
if($this->debug === true) {
var_dump($this->getLastRequest());
var_dump($response);
}
.. _case-piwigo-structures-vardumpusage:
Piwigo
++++++
:ref:`var\_dump()...-usage`, in include/ws_core.inc.php:273.
This is a hidden debug system : when the response format is not available, the whole object is dumped in the output.
.. code-block:: php
function run()
{
if ( is_null($this->_responseEncoder) )
{
set_status_header(400);
@header("Content-Type: text/plain");
echo ("Cannot process your request. Unknown response format.
Request format: ".@$this->_requestFormat." Response format: ".@$this->_responseFormat."\n");
var_export($this);
die(0);
}