blob: 09c4549fd7539f0ec8652bc9316b7867eb7b1e70 [file] [log] [blame]
Derek Jones8ede1a22011-10-05 13:34:52 -05001##############
2Reserved Names
3##############
4
Andrey Andreev16a704c2012-11-09 17:25:00 +02005In order to help out, CodeIgniter uses a series of function, method,
6class and variable names in its operation. Because of this, some names
7cannot be used by a developer. Following is a list of reserved names
8that cannot be used.
Derek Jones8ede1a22011-10-05 13:34:52 -05009
10Controller names
11----------------
12
13Since your controller classes will extend the main application
Andrey Andreev16a704c2012-11-09 17:25:00 +020014controller you must be careful not to name your methods identically to
15the ones used by that class, otherwise your local methods will
Derek Jones8ede1a22011-10-05 13:34:52 -050016override them. The following is a list of reserved names. Do not name
17your controller any of these:
18
19- Controller
20- CI_Base
21- _ci_initialize
22- Default
23- index
24
25Functions
26---------
27
Derek Jones123bb202013-07-19 16:37:51 -070028- :func:`is_php()`
29- :func:`is_really_writable()`
Andrey Andreev16a704c2012-11-09 17:25:00 +020030- ``load_class()``
vlakoff9a6032d2013-03-05 23:03:12 +010031- ``is_loaded()``
Andrey Andreev16a704c2012-11-09 17:25:00 +020032- ``get_config()``
Derek Jones123bb202013-07-19 16:37:51 -070033- :func:`config_item()`
34- :func:`show_error()`
35- :func:`show_404()`
36- :func:`log_message()`
37- :func:`set_status_header()`
38- :func:`get_mimes()`
39- :func:`html_escape()`
40- :func:`remove_invisible_characters()`
41- :func:`is_https()`
42- :func:`function_usable()`
43- :func:`get_instance()`
Andrey Andreeva0471dc2014-11-04 19:22:38 +020044- ``_error_handler()``
Andrey Andreev16a704c2012-11-09 17:25:00 +020045- ``_exception_handler()``
46- ``_stringify_attributes()``
Derek Jones8ede1a22011-10-05 13:34:52 -050047
48Variables
49---------
50
Andrey Andreev16a704c2012-11-09 17:25:00 +020051- ``$config``
52- ``$db``
53- ``$lang``
Derek Jones8ede1a22011-10-05 13:34:52 -050054
55Constants
56---------
57
58- ENVIRONMENT
Derek Jones8ede1a22011-10-05 13:34:52 -050059- FCPATH
60- SELF
61- BASEPATH
62- APPPATH
vlakoff5f733c42012-09-15 10:48:17 +020063- VIEWPATH
Derek Jones8ede1a22011-10-05 13:34:52 -050064- CI_VERSION
Andrey Andreevbe1496d2014-02-11 22:48:45 +020065- MB_ENABLED
66- ICONV_ENABLED
67- UTF8_ENABLED
Derek Jones8ede1a22011-10-05 13:34:52 -050068- FILE_READ_MODE
69- FILE_WRITE_MODE
70- DIR_READ_MODE
71- DIR_WRITE_MODE
72- FOPEN_READ
73- FOPEN_READ_WRITE
74- FOPEN_WRITE_CREATE_DESTRUCTIVE
75- FOPEN_READ_WRITE_CREATE_DESTRUCTIVE
76- FOPEN_WRITE_CREATE
77- FOPEN_READ_WRITE_CREATE
78- FOPEN_WRITE_CREATE_STRICT
vlakoffb527bb52013-03-05 21:58:49 +010079- FOPEN_READ_WRITE_CREATE_STRICT
80- EXIT_SUCCESS
81- EXIT_ERROR
82- EXIT_CONFIG
83- EXIT_UNKNOWN_FILE
84- EXIT_UNKNOWN_CLASS
85- EXIT_UNKNOWN_METHOD
86- EXIT_USER_INPUT
87- EXIT_DATABASE
88- EXIT__AUTO_MIN
89- EXIT__AUTO_MAX