Documentation

upgrade-helper.php

Simple Machines Forum (SMF)

Tags
author

Simple Machines https://www.simplemachines.org

copyright

2025 Simple Machines and individual contributors

license

https://www.simplemachines.org/about/smf/license.php BSD

version
3.0

Alpha 2

This file contains helper functions for upgrade.php

Table of Contents

Functions

upgrade_clean_cache()  : mixed
Clean the cache using the SMF 2.1 CacheAPI.
getMemberGroups()  : array<string|int, mixed>
Returns a list of member groups. Used to upgrade 1.0 and 1.1.
makeFilesWritable()  : bool
Make files writable. First try to use regular chmod, but if that fails, try to use FTP.
quickFileWritable()  : bool
The quick version of makeFilesWritable, which does not support FTP.
deleteFile()  : mixed
Delete a file. Check permissions first, just in case.
print_error()  : mixed
Prints an error to stderr.
throw_error()  : bool
Throws a graphical error message.
smf_mysql_fetch_assoc()  : array<string|int, mixed>|null
smf_mysql_fetch_row()  : array<string|int, mixed>|null
smf_mysql_free_result()  : mixed
smf_mysql_insert_id()  : int|string
smf_mysql_num_rows()  : int
smf_mysql_real_escape_string()  : mixed
array_column()  : mixed
upgradeCacheSettings()  : string
Creates the json_encoded array for the current cache option.

Functions

upgrade_clean_cache()

Clean the cache using the SMF 2.1 CacheAPI.

upgrade_clean_cache() : mixed

If coming from SMF 2.0 and below it should wipe the cache using the SMF backend.

getMemberGroups()

Returns a list of member groups. Used to upgrade 1.0 and 1.1.

getMemberGroups() : array<string|int, mixed>
Return values
array<string|int, mixed>

makeFilesWritable()

Make files writable. First try to use regular chmod, but if that fails, try to use FTP.

makeFilesWritable(mixed &$files) : bool
Parameters
$files : mixed
Return values
bool

quickFileWritable()

The quick version of makeFilesWritable, which does not support FTP.

quickFileWritable(string $file) : bool
Parameters
$file : string
Return values
bool

deleteFile()

Delete a file. Check permissions first, just in case.

deleteFile(string $file) : mixed
Parameters
$file : string

print_error()

Prints an error to stderr.

print_error(mixed $message[, bool $fatal = false ]) : mixed
Parameters
$message : mixed
$fatal : bool = false

throw_error()

Throws a graphical error message.

throw_error(mixed $message) : bool
Parameters
$message : mixed
Return values
bool

smf_mysql_fetch_assoc()

smf_mysql_fetch_assoc(mixed $rs) : array<string|int, mixed>|null
Parameters
$rs : mixed
Return values
array<string|int, mixed>|null

smf_mysql_fetch_row()

smf_mysql_fetch_row(mixed $rs) : array<string|int, mixed>|null
Parameters
$rs : mixed
Return values
array<string|int, mixed>|null

smf_mysql_free_result()

smf_mysql_free_result(mixed $rs) : mixed
Parameters
$rs : mixed

smf_mysql_insert_id()

smf_mysql_insert_id([mixed $rs = null ]) : int|string
Parameters
$rs : mixed = null

Ignored

Return values
int|string

smf_mysql_num_rows()

smf_mysql_num_rows(mixed $rs) : int
Parameters
$rs : mixed
Return values
int

smf_mysql_real_escape_string()

smf_mysql_real_escape_string(mixed $string) : mixed
Parameters
$string : mixed

array_column()

array_column(mixed $input, mixed $column_key[, mixed $index_key = null ]) : mixed
Parameters
$input : mixed
$column_key : mixed
$index_key : mixed = null

upgradeCacheSettings()

Creates the json_encoded array for the current cache option.

upgradeCacheSettings() : string
Return values
string —

a json_encoded array with the selected API options


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results