blob: 9da94b3982cb1ee5d6b7fa15a2eaf57c4c201f21 [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
vlakoff0cd17c32015-01-04 20:27:29 +010019- CI_Controller
Derek Jones8ede1a22011-10-05 13:34:52 -050020- Default
21- index
22
23Functions
24---------
25
Derek Jones123bb202013-07-19 16:37:51 -070026- :func:`is_php()`
27- :func:`is_really_writable()`
Andrey Andreev16a704c2012-11-09 17:25:00 +020028- ``load_class()``
vlakoff9a6032d2013-03-05 23:03:12 +010029- ``is_loaded()``
Andrey Andreev16a704c2012-11-09 17:25:00 +020030- ``get_config()``
Derek Jones123bb202013-07-19 16:37:51 -070031- :func:`config_item()`
32- :func:`show_error()`
33- :func:`show_404()`
34- :func:`log_message()`
35- :func:`set_status_header()`
36- :func:`get_mimes()`
37- :func:`html_escape()`
38- :func:`remove_invisible_characters()`
39- :func:`is_https()`
40- :func:`function_usable()`
41- :func:`get_instance()`
Andrey Andreeva0471dc2014-11-04 19:22:38 +020042- ``_error_handler()``
Andrey Andreev16a704c2012-11-09 17:25:00 +020043- ``_exception_handler()``
44- ``_stringify_attributes()``
Derek Jones8ede1a22011-10-05 13:34:52 -050045
46Variables
47---------
48
Andrey Andreev16a704c2012-11-09 17:25:00 +020049- ``$config``
50- ``$db``
51- ``$lang``
Derek Jones8ede1a22011-10-05 13:34:52 -050052
53Constants
54---------
55
56- ENVIRONMENT
Derek Jones8ede1a22011-10-05 13:34:52 -050057- FCPATH
58- SELF
59- BASEPATH
60- APPPATH
vlakoff5f733c42012-09-15 10:48:17 +020061- VIEWPATH
Derek Jones8ede1a22011-10-05 13:34:52 -050062- CI_VERSION
Andrey Andreevbe1496d2014-02-11 22:48:45 +020063- MB_ENABLED
64- ICONV_ENABLED
65- UTF8_ENABLED
Derek Jones8ede1a22011-10-05 13:34:52 -050066- FILE_READ_MODE
67- FILE_WRITE_MODE
68- DIR_READ_MODE
69- DIR_WRITE_MODE
70- FOPEN_READ
71- FOPEN_READ_WRITE
72- FOPEN_WRITE_CREATE_DESTRUCTIVE
73- FOPEN_READ_WRITE_CREATE_DESTRUCTIVE
74- FOPEN_WRITE_CREATE
75- FOPEN_READ_WRITE_CREATE
76- FOPEN_WRITE_CREATE_STRICT
vlakoffb527bb52013-03-05 21:58:49 +010077- FOPEN_READ_WRITE_CREATE_STRICT
78- EXIT_SUCCESS
79- EXIT_ERROR
80- EXIT_CONFIG
81- EXIT_UNKNOWN_FILE
82- EXIT_UNKNOWN_CLASS
83- EXIT_UNKNOWN_METHOD
84- EXIT_USER_INPUT
85- EXIT_DATABASE
86- EXIT__AUTO_MIN
87- EXIT__AUTO_MAX