diff options
Diffstat (limited to 'user_guide_src/source')
20 files changed, 163 insertions, 553 deletions
diff --git a/user_guide_src/source/_themes/eldocs/static/asset/css/common.css b/user_guide_src/source/_themes/eldocs/static/asset/css/common.css index f0ce8c80c..f9883477b 100644 --- a/user_guide_src/source/_themes/eldocs/static/asset/css/common.css +++ b/user_guide_src/source/_themes/eldocs/static/asset/css/common.css @@ -4,20 +4,30 @@ http://codeigniter.com An open source application development framework for PHP 5.2.4 or newer -NOTICE OF LICENSE - -Licensed under the Open Software License version 3.0 - -This source file is subject to the Open Software License (OSL 3.0) that is -bundled with this package in the files license.txt / license.rst. It is -also available through the world wide web at this URL: -http://opensource.org/licenses/OSL-3.0 -If you did not receive a copy of the license and are unable to obtain it -through the world wide web, please send an email to -licensing@ellislab.com so we can send you a copy immediately. +This content is released under the MIT License (MIT) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. Copyright (c) 2008 - 2014, EllisLab, Inc. (http://ellislab.com/) -http://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0) +Copyright (c) 2014, British Columbia Institute of Technology (http://bcit.ca/) + +http://opensource.org/licenses/MIT MIT License */ html, body, diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst index 0e4930289..25f6f2cea 100644 --- a/user_guide_src/source/changelog.rst +++ b/user_guide_src/source/changelog.rst @@ -9,12 +9,7 @@ Release Date: Not Released - License - - CodeIgniter has been relicensed with the Open Software License (3.0), eliminating its old proprietary licensing. - - - All system files are licensed with OSL 3.0. - - Config, error, and sample files shipped in the application folder are - licensed with the Academic Free License (3.0) to allow you to retain - all licensing authority over your own application code. + - CodeIgniter has been relicensed with the `MIT License <http://opensource.org/licenses/MIT>`_, eliminating its old proprietary licensing. - General Changes @@ -47,9 +42,9 @@ Release Date: Not Released Only entries in ``$autoload['libraries']`` are auto-loaded now. - Removed previously deprecated EXT constant. - Updated all classes to be written in PHP 5 style, with visibility declarations and no ``var`` usage for properties. - - Moved error templates to *application/views/errors/*. + - Added an Exception handler. + - Moved error templates to *application/views/errors/* and made the path configurable via ``$config['error_views_path']``. - Added support non-HTML error templates for CLI applications. - - Made error templates path configurable using ``$config['error_views_path']``. - Moved the Log class to *application/core/* - Global config files are loaded first, then environment ones. Environment config keys overwrite base ones, allowing to only set the keys we want changed per environment. - Changed detection of ``$view_folder`` so that if it's not found in the current path, it will now also be searched for under the application folder. @@ -173,6 +168,7 @@ Release Date: Not Released - Added Interbase/Firebird database support via the *ibase* driver. - Added ODBC support for ``create_database()``, ``drop_database()`` and ``drop_table()`` in :doc:`Database Forge <database/forge>`. - Added **save_queries** configuration setting to *application/config/database.php* (defaults to ``TRUE``). + - Added support to binding arrays as ``IN()`` sets in ``query()``. - :doc:`Query Builder <database/query_builder>` changes include: @@ -258,6 +254,7 @@ Release Date: Not Released - Added support for passing a custom database object to the loader. - Added support for passing custom table attributes (such as ``ENGINE`` for MySQL) to ``create_table()``. - Added support for usage of the *FIRST* clause in ``add_column()`` for MySQL and CUBRID. + - Added partial support for field comments (MySQL, PostgreSQL, Oracle). - Deprecated ``add_column()``'s third method. *AFTER* clause should now be added to the field definition array instead. - Overall improved support for all of the drivers. @@ -484,7 +481,8 @@ Release Date: Not Released - Added function :func:`get_mimes()` to return the *application/config/mimes.php* array. - Added support for HTTP code 303 ("See Other") in :func:`set_status_header()`. - Removed redundant conditional to determine HTTP server protocol in :func:`set_status_header()`. - - Changed ``_exception_handler()`` to respect php.ini *display_errors* setting. + - Renamed ``_exception_handler()`` to ``_error_handler()`` and replaced it with a real exception handler. + - Changed ``_error_handler()`` to respect php.ini *display_errors* setting. - Added function :func:`is_https()` to check if a secure connection is used. - Added function :func:`is_cli()` to replace the ``CI_Input::is_cli_request()`` method. - Added function :func:`function_usable()` to work around a bug in `Suhosin <http://www.hardened-php.net/suhosin/>`. @@ -507,6 +505,7 @@ Release Date: Not Released - Removed internal method ``_assign_to_config()`` and moved its implementation to *CodeIgniter.php* instead. - ``item()`` now returns NULL instead of FALSE when the required config item doesn't exist. - Added an optional second parameter to both ``base_url()`` and ``site_url()`` that allows enforcing of a protocol different than the one in the *base_url* configuration setting. + - Added HTTP "Host" header character validation to prevent cache poisoning attacks when ``base_url`` auto-detection is used. - :doc:`Security Library <libraries/security>` changes include: @@ -520,6 +519,7 @@ Release Date: Not Released - :doc:`Language Library <libraries/language>` changes include: - Changed method ``load()`` to filter the language name with ``ctype_alpha()``. + - Changed method ``load()`` to also accept an array of language files. - Added an optional second parameter to method ``line()`` to disable error logging for line keys that were not found. - Language files are now loaded in a cascading style with the one in **system/** always loaded and overriden afterwards, if another one is found. @@ -550,7 +550,7 @@ Release Date: Not Released - Removed ``CI_CORE`` boolean constant from *CodeIgniter.php* (no longer Reactor and Core versions). - Added support for HTTP-Only cookies with new config option *cookie_httponly* (default FALSE). - ``$config['time_reference']`` now supports all timezone strings supported by PHP. - - Fatal PHP errors are now also passed to ``_exception_handler()``, so they can be logged. + - Fatal PHP errors are now also passed to ``_error_handler()``, so they can be logged. Bug fixes for 3.0 @@ -750,7 +750,7 @@ Bug fixes for 3.0 - Partially fixed a bug (#261) - UTF-8 class method ``clean_string()`` generating log messages and/or not producing the desired result due to an upstream bug in iconv. - Fixed a bug where ``CI_Xmlrpcs::parseRequest()`` could fail if ``$HTTP_RAW_POST_DATA`` is not populated. - Fixed a bug in :doc:`Zip Library <libraries/zip>` internal method ``_get_mod_time()`` where it was not parsing result returned by ``filemtime()``. -- Fixed a bug (#3161) - :doc:`Cache Library <libraries/cache>` methods `increment()`, `decrement()` didn't auto-create non-existent items when using redis and/or file storage. +- Fixed a bug (#3161) - :doc:`Cache Library <libraries/caching>` methods `increment()`, `decrement()` didn't auto-create non-existent items when using redis and/or file storage. - Fixed a bug (#3189) - :doc:`Parser Library <libraries/parser>` used double replacement on ``key->value`` pairs, exposing a potential template injection vulnerability. Version 2.2.0 diff --git a/user_guide_src/source/conf.py b/user_guide_src/source/conf.py index 3f9b2e476..5089cf5a2 100644 --- a/user_guide_src/source/conf.py +++ b/user_guide_src/source/conf.py @@ -41,7 +41,7 @@ master_doc = 'index' # General information about the project. project = u'CodeIgniter' -copyright = u'2014, EllisLab, Inc.' +copyright = u'2014, British Columbia Institute of Technology' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -92,12 +92,22 @@ highlight_language = 'ci' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'eldocs' +# +# Reverting to default sphinx theme, to remove dependency on EllisLab corporate style +#html_theme = 'eldocs' +html_theme = 'default' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -#html_theme_options = {} +# +# Specifying a few options; just a starting point & we can play with it. +html_theme_options = { + "collapsiblesidebar" : "true", + "sidebarbgcolor" : "#4b7eb0", + "codebgcolor": "#fffded", + "headbgcolor": "#ffeebd" +} # Add any paths that contain custom themes here, relative to this directory. html_theme_path = ["./_themes"] @@ -116,7 +126,7 @@ html_theme_path = ["./_themes"] # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -#html_favicon = None +html_favicon = 'images/ci-icon.ico' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, @@ -181,7 +191,7 @@ html_copy_source = False # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ ('index', 'CodeIgniter.tex', u'CodeIgniter Documentation', - u'EllisLab, Inc.', 'manual'), + u'British Columbia Institute of Technology', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -214,7 +224,7 @@ latex_documents = [ # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'codeigniter', u'CodeIgniter Documentation', - [u'EllisLab, Inc.'], 1) + [u'British Columbia Institute of Technology'], 1) ] @@ -222,9 +232,9 @@ man_pages = [ # Bibliographic Dublin Core info. epub_title = u'CodeIgniter' -epub_author = u'EllisLab, Inc.' -epub_publisher = u'EllisLab, Inc.' -epub_copyright = u'2014, EllisLab, Inc.' +epub_author = u'British Columbia Institute of Technology' +epub_publisher = u'British Columbia Institute of Technology' +epub_copyright = u'2014, British Columbia Institute of Technology' # The language of the text. It defaults to the language option # or en if the language is not set. diff --git a/user_guide_src/source/contributing/index.rst b/user_guide_src/source/contributing/index.rst index 4d3fe6ede..c784a59e5 100644 --- a/user_guide_src/source/contributing/index.rst +++ b/user_guide_src/source/contributing/index.rst @@ -5,8 +5,8 @@ Contributing to CodeIgniter CodeIgniter is a community driven project and accepts contributions of code and documentation from the community. These contributions are made in the form of Issues or `Pull Requests <http://help.github.com/send-pull-requests/>`_ on -the `EllisLab CodeIgniter repository -<https://github.com/EllisLab/CodeIgniter>`_ on GitHub. +the `CodeIgniter repository +<https://github.com/bcit-ci/CodeIgniter>`_ on GitHub. Issues are a quick way to point out a bug. If you find a bug or documentation error in CodeIgniter then please check a few things first: @@ -20,6 +20,42 @@ Reporting issues is helpful but an even better approach is to send a Pull Request, which is done by "Forking" the main repository and committing to your own copy. This will require you to use the version control system called Git. +******* +Support +******* + +Note that GitHub is not for general support questions! + +If you are having trouble using a feature of CodeIgniter, ask for help on the forum. + +If you are wondering if you are using +something correctly or if you have found a bug, ask on the forum first. + +*************************** +Tips for a Good Issue Report +*************************** + +Use a descriptive subject line (eg parser library chokes on commas) rather than a vague one (eg. your code broke). + +Address a single issue in a report. + +Identify the CodeIgniter version (eg 3.0-develop) and the component if you know it (eg. parser library) + +Explain what you expected to happen, and what did happen. +Include error messages and stacktrace, if any. + +Include short code segments if they help to explain. +Use a pastebin or dropbox facility to include longer segments of code or screenshots - do not include them in the issue report itself. +This means setting a reasonable expiry for those, until the issue is resolved or closed. + +If you know how to fix the issue, you can do so in your own fork & branch, and submit a pull request. +The issue report information above should be part of that. + +If your issue report can describe the steps to reproduce the problem, that is great. +If you can include a unit test that reproduces the problem, that is even better, as it gives whoever is fixing +it a clearer target! + + ********** Guidelines ********** @@ -33,7 +69,7 @@ PHP Style ========= All code must meet the `Style Guide -<http://ellislab.com/codeigniter/user-guide/general/styleguide.html>`_, which is +<http://codeigniter.com/user_guide/general/styleguide.html>`_, which is essentially the `Allman indent style <http://en.wikipedia.org/wiki/Indent_style#Allman_style>`_, underscores and readable operators. This makes certain that all code is the same format as the diff --git a/user_guide_src/source/database/queries.rst b/user_guide_src/source/database/queries.rst index 90f49afb1..76ff1083f 100644 --- a/user_guide_src/source/database/queries.rst +++ b/user_guide_src/source/database/queries.rst @@ -132,6 +132,15 @@ put the queries together for you. Consider the following example:: The question marks in the query are automatically replaced with the values in the array in the second parameter of the query function. +Binding also work with arrays, which will be transformed to IN sets:: + + $sql = "SELECT * FROM some_table WHERE id IN ? AND status = ? AND author = ?"; + $this->db->query($sql, array(array(3, 6), 'live', 'Rick')); + +The resulting query will be:: + + SELECT * FROM some_table WHERE id IN (3,6) AND status = 'live' AND author = 'Rick' + The secondary benefit of using binds is that the values are automatically escaped, producing safer queries. You don't have to remember to manually escape data; the engine does it automatically for diff --git a/user_guide_src/source/documentation/index.rst b/user_guide_src/source/documentation/index.rst index b080c0efa..38124f7f2 100644 --- a/user_guide_src/source/documentation/index.rst +++ b/user_guide_src/source/documentation/index.rst @@ -42,7 +42,7 @@ Pygments, so that code blocks can be properly highlighted. .. code-block:: bash - easy_install sphinx + easy_install "sphinx==1.2.3" easy_install sphinxcontrib-phpdomain Then follow the directions in the README file in the :samp:`cilexer` folder diff --git a/user_guide_src/source/general/credits.rst b/user_guide_src/source/general/credits.rst index 03ee83dd6..371808fe4 100644 --- a/user_guide_src/source/general/credits.rst +++ b/user_guide_src/source/general/credits.rst @@ -2,18 +2,21 @@ Credits ####### -CodeIgniter was originally developed by `Rick -Ellis <http://www.ellislab.com/>`_ (CEO of `EllisLab, -Inc. <http://ellislab.com/>`_). The framework was written for -performance in the real world, with many of the class libraries, -helpers, and sub-systems borrowed from the code-base of -`ExpressionEngine <http://www.expressionengine.com/>`_. +CodeIgniter was originally developed by `Rick Ellis <http://www.ellislab.com/>`_ +(CEO of `EllisLab, Inc. <http://ellislab.com/>`_). The framework was written for +performance in the real world, with many of the class libraries, helpers, and +sub-systems borrowed from the code-base of `ExpressionEngine +<http://www.expressionengine.com/>`_. + +It was, for years, developed and maintained by EllisLab, the ExpressionEngine +Development Team and a group of community members called the Reactor Team. + +In 2014, CodeIgniter was acquired by the `British Columbia Institute of Technology +<http://bcit.ca/>`_ and was then officially announced as a community-maintaned +project. -It is currently developed and maintained by the ExpressionEngine -Development Team. Bleeding edge development is spearheaded by the handpicked contributors of the Reactor Team. -A hat tip goes to Ruby on Rails for inspiring us to create a PHP -framework, and for bringing frameworks into the general consciousness of -the web community.
\ No newline at end of file +A hat tip goes to Ruby on Rails for inspiring us to create a PHP framework, and +for bringing frameworks into the general consciousness of the web community.
\ No newline at end of file diff --git a/user_guide_src/source/general/environments.rst b/user_guide_src/source/general/environments.rst index d74ebb8d5..1ce4fde3a 100644 --- a/user_guide_src/source/general/environments.rst +++ b/user_guide_src/source/general/environments.rst @@ -20,7 +20,7 @@ the value provided in ``$_SERVER['CI_ENV']``, otherwise defaults to This server variable can be set in your .htaccess file, or Apache config using `SetEnv <https://httpd.apache.org/docs/2.2/mod/mod_env.html#setenv>`_. Alternative methods are available for nginx and other servers, or you can -remove this logic entirely and set the constant based on the HTTP_HOST or IP. +remove this logic entirely and set the constant based on the server's IP address. In addition to affecting some basic framework behavior (see the next section), you may use this constant in your own development to diff --git a/user_guide_src/source/general/models.rst b/user_guide_src/source/general/models.rst index c4fd12476..1cfe736de 100644 --- a/user_guide_src/source/general/models.rst +++ b/user_guide_src/source/general/models.rst @@ -137,7 +137,7 @@ view:: { $this->load->model('blog'); - $data['query'] = $this->Blog->get_last_ten_entries(); + $data['query'] = $this->blog->get_last_ten_entries(); $this->load->view('blog', $data); } diff --git a/user_guide_src/source/general/profiling.rst b/user_guide_src/source/general/profiling.rst index 63a261cc6..2716d1781 100644 --- a/user_guide_src/source/general/profiling.rst +++ b/user_guide_src/source/general/profiling.rst @@ -82,8 +82,9 @@ Key Description hidden. ======================= =================================================================== ======== -.. note:: Disabling the (save_queries)[http://ellislab.com/codeigniter/user-guide/database/configuration.html] setting in your database configuration - will also effectively disable profiling for database queries and render - the 'queries' setting above useless. You can optionally override this - setting with `$this->db->save_queries = TRUE;`. Without this setting you - won't be able to view the queries or the (last_query)[http://ellislab.com/codeigniter/user-guide/database/helpers.html]. +.. note:: Disabling the :doc:`save_queries </database/configuration>` setting in + your database configuration will also effectively disable profiling for + database queries and render the 'queries' setting above useless. You can + optionally override this setting with ``$this->db->save_queries = TRUE;``. + Without this setting you won't be able to view the queries or the + `last_query <database/helpers>`.
\ No newline at end of file diff --git a/user_guide_src/source/general/reserved_names.rst b/user_guide_src/source/general/reserved_names.rst index 81a05ace6..09c4549fd 100644 --- a/user_guide_src/source/general/reserved_names.rst +++ b/user_guide_src/source/general/reserved_names.rst @@ -41,6 +41,7 @@ Functions - :func:`is_https()` - :func:`function_usable()` - :func:`get_instance()` +- ``_error_handler()`` - ``_exception_handler()`` - ``_stringify_attributes()`` diff --git a/user_guide_src/source/images/ci-icon.ico b/user_guide_src/source/images/ci-icon.ico Binary files differnew file mode 100644 index 000000000..7ecfce214 --- /dev/null +++ b/user_guide_src/source/images/ci-icon.ico diff --git a/user_guide_src/source/installation/downloads.rst b/user_guide_src/source/installation/downloads.rst index 93c5cc21b..63029856b 100644 --- a/user_guide_src/source/installation/downloads.rst +++ b/user_guide_src/source/installation/downloads.rst @@ -3,6 +3,7 @@ Downloading CodeIgniter ####################### - `CodeIgniter v3.0.0 (Current version) <http://ellislab.com/codeigniter/download>`_ +- `CodeIgniter v2.2.0 <http://ellislab.com/asset/ci_download_files/CodeIgniter_2.2.0.zip>`_ (MD5 Checksum: dbfddde4ec0b12027aee5156fbdd634b) - `CodeIgniter v2.1.4 <http://ellislab.com/asset/ci_download_files/CodeIgniter_2.1.4.zip>`_ (MD5 Checksum: e74a296c1d412a855c025b9cd468a513) - `CodeIgniter v2.1.3 <http://ellislab.com/asset/ci_download_files/CodeIgniter_2.1.3.zip>`_ (MD5 Checksum: 781d06be06eaa36f10759ef82c8594d5) - `CodeIgniter v2.1.2 <http://ellislab.com/asset/ci_download_files/CodeIgniter_2.1.2.zip>`_ (MD5 Checksum: c7a2980dff2774c97bd38bfbf450d8d5) @@ -42,9 +43,9 @@ GitHub `Git <http://git-scm.com/about>`_ is a distributed version control system. -Public Git access is available at `GitHub <https://github.com/EllisLab/CodeIgniter>`_. +Public Git access is available at `GitHub <https://github.com/bcit-ci/CodeIgniter>`_. Please note that while every effort is made to keep this code base functional, we cannot guarantee the functionality of code taken from the develop branch. -Beginning with version 2.0.3, stable versions are also available via `GitHub Releases <https://github.com/EllisLab/CodeIgniter/releases>`_.
\ No newline at end of file +Beginning with version 2.0.3, stable versions are also available via `GitHub Releases <https://github.com/bcit-ci/CodeIgniter/releases>`_.
\ No newline at end of file diff --git a/user_guide_src/source/libraries/language.rst b/user_guide_src/source/libraries/language.rst index 3014d8f09..6949c11c9 100644 --- a/user_guide_src/source/libraries/language.rst +++ b/user_guide_src/source/libraries/language.rst @@ -66,6 +66,11 @@ file extension), and language is the language set containing it (ie, english). If the second parameter is missing, the default language set in your **application/config/config.php** file will be used. +You can also load multiple language files at the same time by passing an array of language files as first parameter. +:: + + $this->lang->load(array('filename1', 'filename2')); + .. note:: The *language* parameter can only consist of letters. Fetching a Line of Text @@ -110,7 +115,7 @@ Class Reference .. method:: load($langfile[, $idiom = ''[, $return = FALSE[, $add_suffix = TRUE[, $alt_path = '']]]]) - :param string $langfile: Language file to load + :param mixed $langfile: Language file to load or array with multiple files :param string $idiom: Language name (i.e. 'english') :param bool $return: Whether to return the loaded array of translations :param bool $add_suffix: Whether to add the '_lang' suffix to the language file name diff --git a/user_guide_src/source/libraries/output.rst b/user_guide_src/source/libraries/output.rst index 218ec5896..e808561bd 100644 --- a/user_guide_src/source/libraries/output.rst +++ b/user_guide_src/source/libraries/output.rst @@ -220,6 +220,7 @@ Class Reference call it manually unless you are aborting script execution using ``exit()`` or ``die()`` in your code. Example:: + $response = array('status' => 'OK'); $this->output diff --git a/user_guide_src/source/license.rst b/user_guide_src/source/license.rst index 17179a95c..c57bf0945 100644 --- a/user_guide_src/source/license.rst +++ b/user_guide_src/source/license.rst @@ -1,245 +1,23 @@ -################################### -Open Software License ("OSL") v 3.0 -################################### - -This Open Software License (the "License") applies to any original work of -authorship (the "Original Work") whose owner (the "Licensor") has placed the -following licensing notice adjacent to the copyright notice for the Original -Work: - -*Licensed under the Open Software License version 3.0* - - -***************************** -1) Grant of Copyright License -***************************** - -Licensor grants You a worldwide, royalty-free, non-exclusive, sublicensable -license, for the duration of the copyright, to do the following: - - *a)* to reproduce the Original Work in copies, either alone or as part of - a collective work; - - *b)* to translate, adapt, alter, transform, modify, or arrange the - Original Work, thereby creating derivative works ("Derivative Works") - based upon the Original Work; - - *c)* to distribute or communicate copies of the Original Work and - Derivative Works to the public, *with the proviso that copies of Original - Work or Derivative Works that You distribute or communicate shall be - licensed under this Open Software License*; - - *d)* to perform the Original Work publicly; and - - *e)* to display the Original Work publicly. - - -************************** -2) Grant of Patent License -************************** - -Licensor grants You a worldwide, royalty-free, non-exclusive, sublicensable -license, under patent claims owned or controlled by the Licensor that are -embodied in the Original Work as furnished by the Licensor, for the duration -of the patents, to make, use, sell, offer for sale, have made, and import the -Original Work and Derivative Works. - - -******************************* -3) Grant of Source Code License -******************************* - -The term "Source Code" means the preferred form of the Original Work for -making modifications to it and all available documentation describing how to -modify the Original Work. Licensor agrees to provide a machine-readable copy -of the Source Code of the Original Work along with each copy of the Original -Work that Licensor distributes. Licensor reserves the right to satisfy this -obligation by placing a machine-readable copy of the Source Code in an -information repository reasonably calculated to permit inexpensive and -convenient access by You for as long as Licensor continues to distribute the -Original Work. - - -******************************** -4) Exclusions From License Grant -******************************** - -Neither the names of Licensor, nor the names of any contributors to the -Original Work, nor any of their trademarks or service marks, may be used to -endorse or promote products derived from this Original Work without express -prior permission of the Licensor. Except as expressly stated herein, nothing -in this License grants any license to Licensor's trademarks, copyrights, -patents, trade secrets or any other intellectual property. No patent license -is granted to make, use, sell, offer for sale, have made, or import -embodiments of any patent claims other than the licensed claims defined in -Section 2) No license is granted to the trademarks of Licensor even if such -marks are included in the Original Work. Nothing in this License shall be -interpreted to prohibit Licensor from licensing under terms different from -this License any Original Work that Licensor otherwise would have a right to -license. - - -********************** -5) External Deployment -********************** - -The term "External Deployment" means the use, distribution, or communication -of the Original Work or Derivative Works in any way such that the Original -Work or Derivative Works may be used by anyone other than You, whether those -works are distributed or communicated to those persons or made available as an -application intended for use over a network. As an express condition for the -grants of license hereunder, You must treat any External Deployment by You of -the Original Work or a Derivative Work as a distribution under section 1(c). - - -********************* -6) Attribution Rights -********************* - -You must retain, in the Source Code of any Derivative Works that You create, -all copyright, patent, or trademark notices from the Source Code of the -Original Work, as well as any notices of licensing and any descriptive text -identified therein as an "Attribution Notice." You must cause the Source Code -for any Derivative Works that You create to carry a prominent Attribution -Notice reasonably calculated to inform recipients that You have modified the -Original Work. - - -**************************************************** -7) Warranty of Provenance and Disclaimer of Warranty -**************************************************** - -Licensor warrants that the copyright in and to the Original Work and the -patent rights granted herein by Licensor are owned by the Licensor or are -sublicensed to You under the terms of this License with the permission of the -contributor(s) of those copyrights and patent rights. Except as expressly -stated in the immediately preceding sentence, the Original Work is provided -under this License on an "AS IS" BASIS and WITHOUT WARRANTY, either express or -implied, including, without limitation, the warranties of non-infringement, -merchantability or fitness for a particular purpose. THE ENTIRE RISK AS TO THE -QUALITY OF THE ORIGINAL WORK IS WITH YOU. This DISCLAIMER OF WARRANTY -constitutes an essential part of this License. No license to the Original Work -is granted by this License except under this disclaimer. - - -************************** -8) Limitation of Liability -************************** - -Under no circumstances and under no legal theory, whether in tort (including -negligence), contract, or otherwise, shall the Licensor be liable to anyone -for any indirect, special, incidental, or consequential damages of any -character arising as a result of this License or the use of the Original Work -including, without limitation, damages for loss of goodwill, work stoppage, -computer failure or malfunction, or any and all other commercial damages or -losses. This limitation of liability shall not apply to the extent applicable -law prohibits such limitation. - - -***************************** -9) Acceptance and Termination -***************************** - -If, at any time, You expressly assented to this License, that assent indicates -your clear and irrevocable acceptance of this License and all of its terms and -conditions. If You distribute or communicate copies of the Original Work or a -Derivative Work, You must make a reasonable effort under the circumstances to -obtain the express assent of recipients to the terms of this License. This -License conditions your rights to undertake the activities listed in Section -1, including your right to create Derivative Works based upon the Original -Work, and doing so without honoring these terms and conditions is prohibited -by copyright law and international treaty. Nothing in this License is intended -to affect copyright exceptions and limitations (including "fair use" or "fair -dealing"). This License shall terminate immediately and You may no longer -exercise any of the rights granted to You by this License upon your failure to -honor the conditions in Section 1(c). - - -********************************* -10) Termination for Patent Action -********************************* - -This License shall terminate automatically and You may no longer exercise any -of the rights granted to You by this License as of the date You commence an -action, including a cross-claim or counterclaim, against Licensor or any -licensee alleging that the Original Work infringes a patent. This termination -provision shall not apply for an action alleging patent infringement by -combinations of the Original Work with other software or hardware. - - -***************************************** -11) Jurisdiction, Venue and Governing Law -***************************************** - -Any action or suit relating to this License may be brought only in the courts -of a jurisdiction wherein the Licensor resides or in which Licensor conducts -its primary business, and under the laws of that jurisdiction excluding its -conflict-of-law provisions. The application of the United Nations Convention -on Contracts for the International Sale of Goods is expressly excluded. Any -use of the Original Work outside the scope of this License or after its -termination shall be subject to the requirements and penalties of copyright or -patent law in the appropriate jurisdiction. This section shall survive the -termination of this License. - - -******************* -12) Attorneys' Fees -******************* - -In any action to enforce the terms of this License or seeking damages relating -thereto, the prevailing party shall be entitled to recover its costs and -expenses, including, without limitation, reasonable attorneys' fees and costs -incurred in connection with such action, including any appeal of such action. -This section shall survive the termination of this License. - - -***************** -13) Miscellaneous -***************** - -If any provision of this License is held to be unenforceable, such provision -shall be reformed only to the extent necessary to make it enforceable. - - -*************************************** -14) Definition of "You" in This License -*************************************** - -"You" throughout this License, whether in upper or lower case, means an -individual or a legal entity exercising rights under, and complying with all -of the terms of, this License. For legal entities, "You" includes any entity -that controls, is controlled by, or is under common control with you. For -purposes of this definition, "control" means (i) the power, direct or -indirect, to cause the direction or management of such entity, whether by -contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the -outstanding shares, or (iii) beneficial ownership of such entity. - - -**************** -15) Right to Use -**************** - -You may use the Original Work in all ways not otherwise restricted or -conditioned by this License or by law, and Licensor promises not to interfere -with or be responsible for such uses by You. - - -******************************** -16) Modification of This License -******************************** - -This License is Copyright © 2005 Lawrence Rosen. Permission is granted to -copy, distribute, or communicate this License without modification. Nothing in -this License permits You to modify this License as applied to the Original -Work or to Derivative Works. However, You may modify the text of this License -and copy, distribute or communicate your modified version (the "Modified -License") and apply it to other original works of authorship subject to the -following conditions: (i) You may not indicate in any way that your Modified -License is the "Open Software License" or "OSL" and you may not use those -names in the name of your Modified License; (ii) You must replace the notice -specified in the first paragraph above with the notice "Licensed under <insert -your license name here>" or with a notice of your own that is not confusingly -similar to the notice in this License; and (iii) You may not claim that your -original works are open source software unless your Modified License has been -approved by Open Source Initiative (OSI) and You comply with its license -review and certification process.
\ No newline at end of file +##################### +The MIT License (MIT) +##################### + +Copyright (c) 2014, British Columbia Institute of Technology + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE.
\ No newline at end of file diff --git a/user_guide_src/source/license_afl.rst b/user_guide_src/source/license_afl.rst deleted file mode 100644 index ca39be9b6..000000000 --- a/user_guide_src/source/license_afl.rst +++ /dev/null @@ -1,245 +0,0 @@ -################################### -Academic Free License ("AFL") v 3.0 -################################### - -This Academic Free License (the "License") applies to any original work of -authorship (the "Original Work") whose owner (the "Licensor") has placed the -following licensing notice adjacent to the copyright notice for the Original -Work: - -*Licensed under the Academic Free License version 3.0* - - -***************************** -1) Grant of Copyright License -***************************** - -Licensor grants You a worldwide, royalty-free, non-exclusive, sublicensable -license, for the duration of the copyright, to do the following: - - *a)* to reproduce the Original Work in copies, either alone or as part of - a collective work; - - *b)* to translate, adapt, alter, transform, modify, or arrange the - Original Work, thereby creating derivative works ("Derivative Works") - based upon the Original Work; - - *c)* to distribute or communicate copies of the Original Work and - Derivative Works to the public, *under any license of your choice that - does not contradict the terms and conditions, including Licensor's - reserved rights and remedies, in this Academic Free License*; - - *d)* to perform the Original Work publicly; and - - *e)* to display the Original Work publicly. - - -************************** -2) Grant of Patent License -************************** - -Licensor grants You a worldwide, royalty-free, non-exclusive, sublicensable -license, under patent claims owned or controlled by the Licensor that are -embodied in the Original Work as furnished by the Licensor, for the duration -of the patents, to make, use, sell, offer for sale, have made, and import the -Original Work and Derivative Works. - - -******************************* -3) Grant of Source Code License -******************************* - -The term "Source Code" means the preferred form of the Original Work for -making modifications to it and all available documentation describing how to -modify the Original Work. Licensor agrees to provide a machine-readable copy -of the Source Code of the Original Work along with each copy of the Original -Work that Licensor distributes. Licensor reserves the right to satisfy this -obligation by placing a machine-readable copy of the Source Code in an -information repository reasonably calculated to permit inexpensive and -convenient access by You for as long as Licensor continues to distribute the -Original Work. - - -******************************** -4) Exclusions From License Grant -******************************** - -Neither the names of Licensor, nor the names of any contributors to the -Original Work, nor any of their trademarks or service marks, may be used to -endorse or promote products derived from this Original Work without express -prior permission of the Licensor. Except as expressly stated herein, nothing -in this License grants any license to Licensor's trademarks, copyrights, -patents, trade secrets or any other intellectual property. No patent license -is granted to make, use, sell, offer for sale, have made, or import -embodiments of any patent claims other than the licensed claims defined in -Section 2) No license is granted to the trademarks of Licensor even if such -marks are included in the Original Work. Nothing in this License shall be -interpreted to prohibit Licensor from licensing under terms different from -this License any Original Work that Licensor otherwise would have a right to -license. - - -********************** -5) External Deployment -********************** - -The term "External Deployment" means the use, distribution, or communication -of the Original Work or Derivative Works in any way such that the Original -Work or Derivative Works may be used by anyone other than You, whether those -works are distributed or communicated to those persons or made available as an -application intended for use over a network. As an express condition for the -grants of license hereunder, You must treat any External Deployment by You of -the Original Work or a Derivative Work as a distribution under section 1(c). - - -********************* -6) Attribution Rights -********************* - -You must retain, in the Source Code of any Derivative Works that You create, -all copyright, patent, or trademark notices from the Source Code of the -Original Work, as well as any notices of licensing and any descriptive text -identified therein as an "Attribution Notice." You must cause the Source Code -for any Derivative Works that You create to carry a prominent Attribution -Notice reasonably calculated to inform recipients that You have modified the -Original Work. - - -**************************************************** -7) Warranty of Provenance and Disclaimer of Warranty -**************************************************** - -Licensor warrants that the copyright in and to the Original Work and the -patent rights granted herein by Licensor are owned by the Licensor or are -sublicensed to You under the terms of this License with the permission of the -contributor(s) of those copyrights and patent rights. Except as expressly -stated in the immediately preceding sentence, the Original Work is provided -under this License on an "AS IS" BASIS and WITHOUT WARRANTY, either express or -implied, including, without limitation, the warranties of non-infringement, -merchantability or fitness for a particular purpose. THE ENTIRE RISK AS TO THE -QUALITY OF THE ORIGINAL WORK IS WITH YOU. This DISCLAIMER OF WARRANTY -constitutes an essential part of this License. No license to the Original Work -is granted by this License except under this disclaimer. - - -************************** -8) Limitation of Liability -************************** - -Under no circumstances and under no legal theory, whether in tort (including -negligence), contract, or otherwise, shall the Licensor be liable to anyone -for any indirect, special, incidental, or consequential damages of any -character arising as a result of this License or the use of the Original Work -including, without limitation, damages for loss of goodwill, work stoppage, -computer failure or malfunction, or any and all other commercial damages or -losses. This limitation of liability shall not apply to the extent applicable -law prohibits such limitation. - - -***************************** -9) Acceptance and Termination -***************************** - -If, at any time, You expressly assented to this License, that assent indicates -your clear and irrevocable acceptance of this License and all of its terms and -conditions. If You distribute or communicate copies of the Original Work or a -Derivative Work, You must make a reasonable effort under the circumstances to -obtain the express assent of recipients to the terms of this License. This -License conditions your rights to undertake the activities listed in Section -1, including your right to create Derivative Works based upon the Original -Work, and doing so without honoring these terms and conditions is prohibited -by copyright law and international treaty. Nothing in this License is intended -to affect copyright exceptions and limitations (including "fair use" or "fair -dealing"). This License shall terminate immediately and You may no longer -exercise any of the rights granted to You by this License upon your failure to -honor the conditions in Section 1(c). - - -********************************* -10) Termination for Patent Action -********************************* - -This License shall terminate automatically and You may no longer exercise any -of the rights granted to You by this License as of the date You commence an -action, including a cross-claim or counterclaim, against Licensor or any -licensee alleging that the Original Work infringes a patent. This termination -provision shall not apply for an action alleging patent infringement by -combinations of the Original Work with other software or hardware. - - -***************************************** -11) Jurisdiction, Venue and Governing Law -***************************************** - -Any action or suit relating to this License may be brought only in the courts -of a jurisdiction wherein the Licensor resides or in which Licensor conducts -its primary business, and under the laws of that jurisdiction excluding its -conflict-of-law provisions. The application of the United Nations Convention -on Contracts for the International Sale of Goods is expressly excluded. Any -use of the Original Work outside the scope of this License or after its -termination shall be subject to the requirements and penalties of copyright or -patent law in the appropriate jurisdiction. This section shall survive the -termination of this License. - - -******************* -12) Attorneys' Fees -******************* - -In any action to enforce the terms of this License or seeking damages relating -thereto, the prevailing party shall be entitled to recover its costs and -expenses, including, without limitation, reasonable attorneys' fees and costs -incurred in connection with such action, including any appeal of such action. -This section shall survive the termination of this License. - - -***************** -13) Miscellaneous -***************** - -If any provision of this License is held to be unenforceable, such provision -shall be reformed only to the extent necessary to make it enforceable. - - -*************************************** -14) Definition of "You" in This License -*************************************** - -"You" throughout this License, whether in upper or lower case, means an -individual or a legal entity exercising rights under, and complying with all -of the terms of, this License. For legal entities, "You" includes any entity -that controls, is controlled by, or is under common control with you. For -purposes of this definition, "control" means (i) the power, direct or -indirect, to cause the direction or management of such entity, whether by -contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the -outstanding shares, or (iii) beneficial ownership of such entity. - - -**************** -15) Right to Use -**************** - -You may use the Original Work in all ways not otherwise restricted or -conditioned by this License or by law, and Licensor promises not to interfere -with or be responsible for such uses by You. - - -******************************** -16) Modification of This License -******************************** - -This License is Copyright © 2005 Lawrence Rosen. Permission is granted to -copy, distribute, or communicate this License without modification. Nothing in -this License permits You to modify this License as applied to the Original -Work or to Derivative Works. However, You may modify the text of this License -and copy, distribute or communicate your modified version (the "Modified -License") and apply it to other original works of authorship subject to the -following conditions: (i) You may not indicate in any way that your Modified -License is the "Academic Free License" or "AFL" and you may not use those -names in the name of your Modified License; (ii) You must replace the notice -specified in the first paragraph above with the notice "Licensed under <insert -your license name here>" or with a notice of your own that is not confusingly -similar to the notice in this License; and (iii) You may not claim that your -original works are open source software unless your Modified License has been -approved by Open Source Initiative (OSI) and You comply with its license -review and certification process.
\ No newline at end of file diff --git a/user_guide_src/source/overview/at_a_glance.rst b/user_guide_src/source/overview/at_a_glance.rst index da323b907..facbedaee 100644 --- a/user_guide_src/source/overview/at_a_glance.rst +++ b/user_guide_src/source/overview/at_a_glance.rst @@ -111,4 +111,4 @@ CodeIgniter has a Friendly Community of Users ============================================= Our growing community of users can be seen actively participating in our -`Community Forums <http://ellislab.com/forums/>`_. +`Community Forums <http://forum.codeigniter.com/>`_. diff --git a/user_guide_src/source/overview/getting_started.rst b/user_guide_src/source/overview/getting_started.rst index feaad5908..04ee50df7 100644 --- a/user_guide_src/source/overview/getting_started.rst +++ b/user_guide_src/source/overview/getting_started.rst @@ -19,6 +19,6 @@ Reference** and **Helper Reference** pages to learn to utilize the native libraries and helper files. Feel free to take advantage of our `Community -Forums <http://ellislab.com/forums/>`_ if you have questions or -problems, and our `Wiki <https://github.com/EllisLab/CodeIgniter/wiki>`_ to see code +Forums <http://forum.codeigniter.com/>`_ if you have questions or +problems, and our `Wiki <https://github.com/bcit-ci/CodeIgniter/wiki>`_ to see code examples posted by other users. diff --git a/user_guide_src/source/tutorial/conclusion.rst b/user_guide_src/source/tutorial/conclusion.rst index a5f69b4e7..0d90cde6f 100644 --- a/user_guide_src/source/tutorial/conclusion.rst +++ b/user_guide_src/source/tutorial/conclusion.rst @@ -20,7 +20,7 @@ CodeIgniter within a few days. If you still have questions about the framework or your own CodeIgniter code, you can: -- Check out our `forums <http://ellislab.com/forums>`_ -- Visit our `IRC chatroom <https://github.com/EllisLab/CodeIgniter/wiki/IRC>`_ -- Explore the `Wiki <https://github.com/EllisLab/CodeIgniter/wiki/>`_ +- Check out our `forums <http://forum.codeigniter.com/>`_ +- Visit our `IRC chatroom <https://github.com/bcit-ci/CodeIgniter/wiki/IRC>`_ +- Explore the `Wiki <https://github.com/bcit-ci/CodeIgniter/wiki/>`_ |