Programming Standards

Osclass PHP Coding Standards & Best Practices

Following proper coding standards ensures better maintainability, security, and performance in Osclass development. Below is an improved guide based on best practices observed in the latest Osclass coding style.

General Coding Conventions

Function Naming

Function names in Osclass follow the snake_case convention with an osc_ prefix to maintain consistency. Example:

function osc_get_currency_row($code, $cache = true) {
  ...
}

Data Validation

Data should be validated before processing. Example:

$code = strtoupper(trim((string)$code));

if ($code == '' || strlen($code) != 3) {
  return false;
}

This ensures that the currency code is always uppercase and exactly three characters long.

Using Caching to Improve Performance

Osclass caching system reduces redundant database queries. It checks if the data exists in the cache before querying the database:

if ($cache === true && View::newInstance()->_exists('currency_' . $code)) {
  return View::newInstance()->_get('currency_' . $code);
}

To store new data in the cache:

View::newInstance()->_exportVariableToView('currency_' . $code, $currency);

Efficient Database Queries

Instead of retrieving the entire database, use indexed queries for performance:

$currency = Currency::newInstance()->findByPrimaryKey($code);

Fetching all records efficiently:

function osc_get_currencies_all($by_pk = false) {
  $key = 'currencies_' . (string)$by_pk;
  
  if (!View::newInstance()->_exists($key)) {
    $currencies = Currency::newInstance()->listAllRaw();
    $output = [];

    if (!empty($currencies)) {
      foreach ($currencies as $cur_row) {
        $output[$by_pk ? $cur_row['pk_c_code'] : []] = $cur_row;
      }
    }

    View::newInstance()->_exportVariableToView($key, $output);
    return $output;
  }
  
  return View::newInstance()->_get($key);
}

Recommended Improvements

Use of Strict Typing

Adding strict typing improves readability and prevents unexpected errors. Example:

function osc_get_currency_row(string $code, bool $cache = true): array|false {
  ...
}

Error Handling & Logging

Ensure errors are logged properly instead of silently failing:

if (!$currency) {
  error_log('Currency not found: ' . $code);
}

Using empty() Instead of count()

Instead of checking both is_array() and count() > 0, simplify:

if (!empty($currencies)) { ... }

Conclusion

By following these coding standards, you ensure that Osclass applications remain optimized, maintainable, and secure. Implement proper validation, caching, and efficient queries to enhance performance.