diff options
Diffstat (limited to 'user_guide_src')
206 files changed, 0 insertions, 32975 deletions
diff --git a/user_guide_src/Makefile b/user_guide_src/Makefile deleted file mode 100644 index 519e1136f..000000000 --- a/user_guide_src/Makefile +++ /dev/null @@ -1,130 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = build - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source - -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest - -help: - @echo "Please use \`make <target>' where <target> is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - -clean: - -rm -rf $(BUILDDIR)/* - -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/CodeIgniter.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/CodeIgniter.qhc" - -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/CodeIgniter" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/CodeIgniter" - @echo "# devhelp" - -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - make -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." diff --git a/user_guide_src/README.rst b/user_guide_src/README.rst deleted file mode 100644 index b31db7cf8..000000000 --- a/user_guide_src/README.rst +++ /dev/null @@ -1,65 +0,0 @@ -###################### -CodeIgniter User Guide -###################### - -****************** -Setup Instructions -****************** - -The CodeIgniter user guide uses Sphinx to manage the documentation and -output it to various formats. Pages are written in human-readable -`ReStructured Text <http://sphinx.pocoo.org/rest.html>`_ format. - -Prerequisites -============= - -Sphinx requires Python 2.7. If you are on OS X, then you already have Python. -You can confirm in a Terminal window by executing the ``python`` command -without any parameters. It should load up and tell you which version you have -installed. - -Note: If you're not on Python 2.7, then you must upgrade. E.g. Install 2.7.2 -from http://python.org/download/releases/2.7.2/ - -Installation -============ - -1. Install `easy_install <http://peak.telecommunity.com/DevCenter/EasyInstall#installing-easy-install>`_ -2. ``easy_install "sphinx==1.6.3"`` -3. ``easy_install "sphinxcontrib-phpdomain==0.1.3.post1"`` -4. Install the CI Lexer which allows PHP, HTML, CSS, and JavaScript syntax highlighting in code examples (see *cilexer/README*) -5. ``cd user_guide_src`` -6. ``make html`` - -Editing and Creating Documentation -================================== - -All of the source files exist under *source/* and is where you will add new -documentation or modify existing documentation. Just as with code changes, -we recommend working from feature branches and making pull requests to -the *develop* branch of this repo. - -So where's the HTML? -==================== - -Obviously, the HTML documentation is what we care most about, as it is the -primary documentation that our users encounter. Since revisions to the built -files are not of value, they are not under source control. This also allows -you to regenerate as necessary if you want to "preview" your work. Generating -the HTML is very simple. From the root directory of your user guide repo -fork issue the command you used at the end of the installation instructions:: - - make html - -You will see it do a whiz-bang compilation, at which point the fully rendered -user guide and images will be in *build/html/*. After the HTML has been built, -each successive build will only rebuild files that have changed, saving -considerable time. If for any reason you want to "reset" your build files, -simply delete the *build* folder's contents and rebuild. - -*************** -Style Guideline -*************** - -Please refer to source/documentation/index.rst for general guidelines for -using Sphinx to document CodeIgniter. diff --git a/user_guide_src/cilexer/README b/user_guide_src/cilexer/README deleted file mode 100644 index b9d9baf09..000000000 --- a/user_guide_src/cilexer/README +++ /dev/null @@ -1,22 +0,0 @@ -To install the CodeIgniter Lexer to Pygments, run: - - sudo python setup.py install - -Confirm with - - pygmentize -L - - -You should see in the lexer output: - -* ci, codeigniter: - CodeIgniter (filenames *.html, *.css, *.php, *.xml, *.static) - -You will need to run setup.py and install the cilexer package anytime after cilexer/cilexer.py is updated - -NOTE: Depending on how you installed Sphinx and Pygments, -you may be installing to the wrong version. -If you need to install to a different version of python -specify its path when using setup.py, e.g.: - - sudo /usr/bin/python2.5 setup.py install
\ No newline at end of file diff --git a/user_guide_src/cilexer/cilexer/__init__.py b/user_guide_src/cilexer/cilexer/__init__.py deleted file mode 100644 index 8b1378917..000000000 --- a/user_guide_src/cilexer/cilexer/__init__.py +++ /dev/null @@ -1 +0,0 @@ - diff --git a/user_guide_src/cilexer/cilexer/cilexer.py b/user_guide_src/cilexer/cilexer/cilexer.py deleted file mode 100644 index 4ecfd0bc4..000000000 --- a/user_guide_src/cilexer/cilexer/cilexer.py +++ /dev/null @@ -1,56 +0,0 @@ -# CodeIgniter -# https://codeigniter.com -# -# An open source application development framework for PHP -# -# This content is released under the MIT License (MIT) -# -# Copyright (c) 2014 - 2017, 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. -# -# Copyright (c) 2008 - 2014, EllisLab, Inc. (https://ellislab.com/) -# Copyright (c) 2014 - 2016, British Columbia Institute of Technology (http://bcit.ca/) -# -# http://opensource.org/licenses/MIT MIT License - -import re -import copy - -from pygments.lexer import DelegatingLexer -from pygments.lexers.web import PhpLexer, HtmlLexer - -__all__ = ['CodeIgniterLexer'] - - -class CodeIgniterLexer(DelegatingLexer): - """ - Handles HTML, PHP, JavaScript, and CSS is highlighted - PHP is highlighted with the "startline" option - """ - - name = 'CodeIgniter' - aliases = ['ci', 'codeigniter'] - filenames = ['*.html', '*.css', '*.php', '*.xml', '*.static'] - mimetypes = ['text/html', 'application/xhtml+xml'] - - def __init__(self, **options): - super(CodeIgniterLexer, self).__init__(HtmlLexer, - PhpLexer, - startinline=True) diff --git a/user_guide_src/cilexer/setup.py b/user_guide_src/cilexer/setup.py deleted file mode 100644 index db4bbea43..000000000 --- a/user_guide_src/cilexer/setup.py +++ /dev/null @@ -1,23 +0,0 @@ -""" -Install and setup CodeIgniter highlighting for Pygments. -""" - -from setuptools import setup - -entry_points = """ -[pygments.lexers] -cilexer = cilexer.cilexer:CodeIgniterLexer -""" - -setup( - name='pycilexer', - version='0.1', - description=__doc__, - author="EllisLab, Inc.", - packages=['cilexer'], - install_requires=( - 'sphinx >= 1.0.7', - 'sphinxcontrib-phpdomain >= 0.1.3-1' - ), - entry_points=entry_points -) diff --git a/user_guide_src/source/DCO.rst b/user_guide_src/source/DCO.rst deleted file mode 100644 index c8f9b49c6..000000000 --- a/user_guide_src/source/DCO.rst +++ /dev/null @@ -1,27 +0,0 @@ -##################################### -Developer's Certificate of Origin 1.1 -##################################### - -By making a contribution to this project, I certify that: - -(1) The contribution was created in whole or in part by me and I - have the right to submit it under the open source license - indicated in the file; or - -(2) The contribution is based upon previous work that, to the best - of my knowledge, is covered under an appropriate open source - license and I have the right under that license to submit that - work with modifications, whether created in whole or in part - by me, under the same open source license (unless I am - permitted to submit under a different license), as indicated - in the file; or - -(3) The contribution was provided directly to me by some other - person who certified (1), (2) or (3) and I have not modified - it. - -(4) I understand and agree that this project and the contribution - are public and that a record of the contribution (including all - personal information I submit with it, including my sign-off) is - maintained indefinitely and may be redistributed consistent with - this project or the open source license(s) involved. diff --git a/user_guide_src/source/_themes/sphinx_rtd_theme/LICENSE b/user_guide_src/source/_themes/sphinx_rtd_theme/LICENSE deleted file mode 100644 index 921f07388..000000000 --- a/user_guide_src/source/_themes/sphinx_rtd_theme/LICENSE +++ /dev/null @@ -1,20 +0,0 @@ -The MIT License (MIT) - -Copyright (c) 2013 Dave Snider - -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. diff --git a/user_guide_src/source/_themes/sphinx_rtd_theme/__init__.py b/user_guide_src/source/_themes/sphinx_rtd_theme/__init__.py deleted file mode 100644 index 1440863d6..000000000 --- a/user_guide_src/source/_themes/sphinx_rtd_theme/__init__.py +++ /dev/null @@ -1,17 +0,0 @@ -"""Sphinx ReadTheDocs theme. - -From https://github.com/ryan-roemer/sphinx-bootstrap-theme. - -""" -import os - -VERSION = (0, 1, 5) - -__version__ = ".".join(str(v) for v in VERSION) -__version_full__ = __version__ - - -def get_html_theme_path(): - """Return list of HTML theme paths.""" - cur_dir = os.path.abspath(os.path.dirname(os.path.dirname(__file__))) - return cur_dir diff --git a/user_guide_src/source/_themes/sphinx_rtd_theme/breadcrumbs.html b/user_guide_src/source/_themes/sphinx_rtd_theme/breadcrumbs.html deleted file mode 100644 index 60343661a..000000000 --- a/user_guide_src/source/_themes/sphinx_rtd_theme/breadcrumbs.html +++ /dev/null @@ -1,22 +0,0 @@ -<div role="navigation" aria-label="breadcrumbs navigation"> - <ul class="wy-breadcrumbs"> - <li><a href="{{ pathto(master_doc) }}">Docs</a> »</li> - {% for doc in parents %} - <li><a href="{{ doc.link|e }}">{{ doc.title }}</a> »</li> - {% endfor %} - <li>{{ title }}</li> - <li class="wy-breadcrumbs-aside"> - {% if display_github %} - <a href="https://github.com/{{ github_user }}/{{ github_repo }}/blob/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ source_suffix }}" class="fa fa-github"> Edit on GitHub</a> - {% elif display_bitbucket %} - <a href="https://bitbucket.org/{{ bitbucket_user }}/{{ bitbucket_repo }}/src/{{ bitbucket_version}}{{ conf_py_path }}{{ pagename }}{{ source_suffix }}" class="fa fa-bitbucket"> Edit on Bitbucket</a> - {% elif show_source and has_source and sourcename %} - <a href="{{ pathto('_sources/' + sourcename, true)|e }}" rel="nofollow"> View page source</a> - {% endif %} - </li> - <div style="float:right;margin-left:5px;" id="closeMe"> - <img title="Classic Layout" alt="classic layout" src="data:image/gif;base64,R0lGODlhFAAUAJEAAAAAADMzM////wAAACH5BAUUAAIALAAAAAAUABQAAAImlI+py+0PU5gRBRDM3DxbWoXis42X13USOLauUIqnlsaH/eY6UwAAOw==" /> - </div> - </ul> - <hr/> -</div> diff --git a/user_guide_src/source/_themes/sphinx_rtd_theme/footer.html b/user_guide_src/source/_themes/sphinx_rtd_theme/footer.html deleted file mode 100644 index 94f6dc371..000000000 --- a/user_guide_src/source/_themes/sphinx_rtd_theme/footer.html +++ /dev/null @@ -1,33 +0,0 @@ -<footer> - {% if next or prev %} - <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - {% if next %} - <a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}">Next <span class="fa fa-arrow-circle-right"></span></a> - {% endif %} - {% if prev %} - <a href="{{ prev.link|e }}" class="btn btn-neutral" title="{{ prev.title|striptags|e }}"><span class="fa fa-arrow-circle-left"></span> Previous</a> - {% endif %} - </div> - {% endif %} - - <hr/> - - <div role="contentinfo"> - <p> - {%- if show_copyright %} - {%- if hasdoc('copyright') %} - {% trans path=pathto('copyright'), copyright=copyright|e %}© <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %} - {%- else %} - {% trans copyright=copyright|e %}© Copyright {{ copyright }}.{% endtrans %} - {%- endif %} - {%- endif %} - - {%- if last_updated %} - {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %} - {%- endif %} - </p> - </div> - - {% trans %}Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>{% endtrans %}. - -</footer> diff --git a/user_guide_src/source/_themes/sphinx_rtd_theme/layout.html b/user_guide_src/source/_themes/sphinx_rtd_theme/layout.html deleted file mode 100644 index 20ede7d32..000000000 --- a/user_guide_src/source/_themes/sphinx_rtd_theme/layout.html +++ /dev/null @@ -1,166 +0,0 @@ -{# TEMPLATE VAR SETTINGS #} -{%- set url_root = pathto('', 1) %} -{%- if url_root == '#' %}{% set url_root = '' %}{% endif %} -{%- if not embedded and docstitle %} - {%- set titlesuffix = " — "|safe + docstitle|e %} -{%- else %} - {%- set titlesuffix = "" %} -{%- endif %} - -<!DOCTYPE html> -<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> -<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> -<head> - <meta charset="utf-8"> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - {% block htmltitle %} - <title>{{ title|striptags|e }}{{ titlesuffix }}</title> - {% endblock %} - - {# FAVICON #} - {% if favicon %} - <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/> - {% endif %} - - {# CSS #} - <link href='https://fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic|Roboto+Slab:400,700|Inconsolata:400,700&subset=latin,cyrillic' rel='stylesheet' type='text/css'> - - {# OPENSEARCH #} - {% if not embedded %} - {% if use_opensearch %} - <link rel="search" type="application/opensearchdescription+xml" title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}" href="{{ pathto('_static/opensearch.xml', 1) }}"/> - {% endif %} - - {% endif %} - - {# RTD hosts this file, so just load on non RTD builds #} - {% if not READTHEDOCS %} - <link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" /> - {% endif %} - - {% for cssfile in css_files %} - <link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" /> - {% endfor %} - - {%- block linktags %} - {%- if hasdoc('about') %} - <link rel="author" title="{{ _('About these documents') }}" - href="{{ pathto('about') }}"/> - {%- endif %} - {%- if hasdoc('genindex') %} - <link rel="index" title="{{ _('Index') }}" - href="{{ pathto('genindex') }}"/> - {%- endif %} - {%- if hasdoc('search') %} - <link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}"/> - {%- endif %} - {%- if hasdoc('copyright') %} - <link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}"/> - {%- endif %} - <link rel="top" title="{{ docstitle|e }}" href="{{ pathto('index') }}"/> - {%- if parents %} - <link rel="up" title="{{ parents[-1].title|striptags|e }}" href="{{ parents[-1].link|e }}"/> - {%- endif %} - {%- if next %} - <link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}"/> - {%- endif %} - {%- if prev %} - <link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}"/> - {%- endif %} - {%- endblock %} - {%- block extrahead %} {% endblock %} - - {# Keep modernizr in head - http://modernizr.com/docs/#installing #} - <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script> - -</head> - -<body class="wy-body-for-nav" role="document"> - - {% include "pulldown.html" %} - - <div class="wy-grid-for-nav"> - - {# SIDE NAV, TOGGLES ON MOBILE #} - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> - <div class="wy-side-nav-search"> - {% block sidebartitle %} - <a href="{{ pathto(master_doc) }}" class="fa fa-home"> {{ project }}</a> - {% endblock %} - {% include "searchbox.html" %} - </div> - - <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> - {% block menu %} - {% set toctree = toctree(maxdepth=2, collapse=False, includehidden=False) %} - {% if toctree %} - {{ toctree }} - {% else %} - <!-- Local TOC --> - <div class="local-toc">{{ toc }}</div> - {% endif %} - {% endblock %} - </div> - - </nav> - - <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> - - {# MOBILE NAV, TRIGGLES SIDE NAV ON TOGGLE #} - <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="{{ pathto(master_doc) }}">{{ project }}</a> - </nav> - - - {# PAGE CONTENT #} - <div class="wy-nav-content"> - <div class="rst-content"> - {% include "breadcrumbs.html" %} - <div role="main" class="document"> - {% block body %}{% endblock %} - </div> - {% include "footer.html" %} - </div> - </div> - - </section> - - </div> - {% include "versions.html" %} - - {% if not embedded %} - - <script type="text/javascript"> - var DOCUMENTATION_OPTIONS = { - URL_ROOT:'{{ url_root }}', - VERSION:'{{ release|e }}', - COLLAPSE_INDEX:false, - FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}', - HAS_SOURCE: {{ has_source|lower }} - }; - </script> - {%- for scriptfile in script_files %} - <script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script> - {%- endfor %} - - {% endif %} - - {# RTD hosts this file, so just load on non RTD builds #} - {% if not READTHEDOCS %} - <script type="text/javascript" src="{{ pathto('_static/js/theme.js', 1) }}"></script> - {% endif %} - - {# STICKY NAVIGATION #} - {% if theme_sticky_navigation %} - <script type="text/javascript"> - jQuery(function () { - SphinxRtdTheme.StickyNav.enable(); - }); - </script> - {% endif %} - - {%- block footer %} {% endblock %} - -</body> -</html> diff --git a/user_guide_src/source/_themes/sphinx_rtd_theme/layout_old.html b/user_guide_src/source/_themes/sphinx_rtd_theme/layout_old.html deleted file mode 100644 index deb8df2a1..000000000 --- a/user_guide_src/source/_themes/sphinx_rtd_theme/layout_old.html +++ /dev/null @@ -1,205 +0,0 @@ -{# - basic/layout.html - ~~~~~~~~~~~~~~~~~ - - Master layout template for Sphinx themes. - - :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. -#} -{%- block doctype -%} -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> -{%- endblock %} -{%- set reldelim1 = reldelim1 is not defined and ' »' or reldelim1 %} -{%- set reldelim2 = reldelim2 is not defined and ' |' or reldelim2 %} -{%- set render_sidebar = (not embedded) and (not theme_nosidebar|tobool) and - (sidebars != []) %} -{%- set url_root = pathto('', 1) %} -{# XXX necessary? #} -{%- if url_root == '#' %}{% set url_root = '' %}{% endif %} -{%- if not embedded and docstitle %} - {%- set titlesuffix = " — "|safe + docstitle|e %} -{%- else %} - {%- set titlesuffix = "" %} -{%- endif %} - -{%- macro relbar() %} - <div class="related"> - <h3>{{ _('Navigation') }}</h3> - <ul> - {%- for rellink in rellinks %} - <li class="right" {% if loop.first %}style="margin-right: 10px"{% endif %}> - <a href="{{ pathto(rellink[0]) }}" title="{{ rellink[1]|striptags|e }}" - {{ accesskey(rellink[2]) }}>{{ rellink[3] }}</a> - {%- if not loop.first %}{{ reldelim2 }}{% endif %}</li> - {%- endfor %} - {%- block rootrellink %} - <li><a href="{{ pathto(master_doc) }}">{{ shorttitle|e }}</a>{{ reldelim1 }}</li> - {%- endblock %} - {%- for parent in parents %} - <li><a href="{{ parent.link|e }}" {% if loop.last %}{{ accesskey("U") }}{% endif %}>{{ parent.title }}</a>{{ reldelim1 }}</li> - {%- endfor %} - {%- block relbaritems %} {% endblock %} - </ul> - </div> -{%- endmacro %} - -{%- macro sidebar() %} - {%- if render_sidebar %} - <div class="sphinxsidebar"> - <div class="sphinxsidebarwrapper"> - {%- block sidebarlogo %} - {%- if logo %} - <p class="logo"><a href="{{ pathto(master_doc) }}"> - <img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/> - </a></p> - {%- endif %} - {%- endblock %} - {%- if sidebars != None %} - {#- new style sidebar: explicitly include/exclude templates #} - {%- for sidebartemplate in sidebars %} - {%- include sidebartemplate %} - {%- endfor %} - {%- else %} - {#- old style sidebars: using blocks -- should be deprecated #} - {%- block sidebartoc %} - {%- include "localtoc.html" %} - {%- endblock %} - {%- block sidebarrel %} - {%- include "relations.html" %} - {%- endblock %} - {%- block sidebarsourcelink %} - {%- include "sourcelink.html" %} - {%- endblock %} - {%- if customsidebar %} - {%- include customsidebar %} - {%- endif %} - {%- block sidebarsearch %} - {%- include "searchbox.html" %} - {%- endblock %} - {%- endif %} - </div> - </div> - {%- endif %} -{%- endmacro %} - -{%- macro script() %} - <script type="text/javascript"> - var DOCUMENTATION_OPTIONS = { - URL_ROOT: '{{ url_root }}', - VERSION: '{{ release|e }}', - COLLAPSE_INDEX: false, - FILE_SUFFIX: '{{ '' if no_search_suffix else file_suffix }}', - HAS_SOURCE: {{ has_source|lower }} - }; - </script> - {%- for scriptfile in script_files %} - <script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script> - {%- endfor %} -{%- endmacro %} - -{%- macro css() %} - <link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" /> - <link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" /> - {%- for cssfile in css_files %} - <link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" /> - {%- endfor %} -{%- endmacro %} - -<html xmlns="http://www.w3.org/1999/xhtml"> - <head> - <meta http-equiv="Content-Type" content="text/html; charset={{ encoding }}" /> - {{ metatags }} - {%- block htmltitle %} - <title>{{ title|striptags|e }}{{ titlesuffix }}</title> - {%- endblock %} - {{ css() }} - {%- if not embedded %} - {{ script() }} - {%- if use_opensearch %} - <link rel="search" type="application/opensearchdescription+xml" - title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}" - href="{{ pathto('_static/opensearch.xml', 1) }}"/> - {%- endif %} - {%- if favicon %} - <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/> - {%- endif %} - {%- endif %} -{%- block linktags %} - {%- if hasdoc('about') %} - <link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" /> - {%- endif %} - {%- if hasdoc('genindex') %} - <link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}" /> - {%- endif %} - {%- if hasdoc('search') %} - <link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}" /> - {%- endif %} - {%- if hasdoc('copyright') %} - <link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}" /> - {%- endif %} - <link rel="top" title="{{ docstitle|e }}" href="{{ pathto('index') }}" /> - {%- if parents %} - <link rel="up" title="{{ parents[-1].title|striptags|e }}" href="{{ parents[-1].link|e }}" /> - {%- endif %} - {%- if next %} - <link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}" /> - {%- endif %} - {%- if prev %} - <link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}" /> - {%- endif %} -{%- endblock %} -{%- block extrahead %} {% endblock %} - </head> - <body> -{%- block header %}{% endblock %} - -{%- block relbar1 %}{{ relbar() }}{% endblock %} - -{%- block content %} - {%- block sidebar1 %} {# possible location for sidebar #} {% endblock %} - - <div class="document"> - {%- block document %} - <div class="documentwrapper"> - {%- if render_sidebar %} - <div class="bodywrapper"> - {%- endif %} - <div class="body"> - {% block body %} {% endblock %} - </div> - {%- if render_sidebar %} - </div> - {%- endif %} - </div> - {%- endblock %} - - {%- block sidebar2 %}{{ sidebar() }}{% endblock %} - <div class="clearer"></div> - </div> -{%- endblock %} - -{%- block relbar2 %}{{ relbar() }}{% endblock %} - -{%- block footer %} - <div class="footer"> - {%- if show_copyright %} - {%- if hasdoc('copyright') %} - {% trans path=pathto('copyright'), copyright=copyright|e %}© <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %} - {%- else %} - {% trans copyright=copyright|e %}© Copyright {{ copyright }}.{% endtrans %} - {%- endif %} - {%- endif %} - {%- if last_updated %} - {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %} - {%- endif %} - {%- if show_sphinx %} - {% trans sphinx_version=sphinx_version|e %}Created using <a href="http://sphinx-doc.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %} - {%- endif %} - </div> - <p>asdf asdf asdf asdf 22</p> -{%- endblock %} - </body> -</html> - diff --git a/user_guide_src/source/_themes/sphinx_rtd_theme/pulldown.html b/user_guide_src/source/_themes/sphinx_rtd_theme/pulldown.html deleted file mode 100644 index 7877346d8..000000000 --- a/user_guide_src/source/_themes/sphinx_rtd_theme/pulldown.html +++ /dev/null @@ -1,17 +0,0 @@ -<div id="nav"> - <div id="nav_inner"> - {% block ciNav %} - {% set toctree = toctree(maxdepth=2, collapse=False, includehidden=False) %} - {% if toctree %} - <div id="pulldown-menu" class="ciNav"> - {{ toctree }} - </div> - {% endif %} - {% endblock %} - </div> -</div> -<div id="nav2"> - <a href="#" id="openToc"> - <img src="data:image/jpeg;base64,/9j/4AAQSkZJRgABAgAAZABkAAD/7AARRHVja3kAAQAEAAAARgAA/+4ADkFkb2JlAGTAAAAAAf/bAIQABAMDAwMDBAMDBAYEAwQGBwUEBAUHCAYGBwYGCAoICQkJCQgKCgwMDAwMCgwMDQ0MDBERERERFBQUFBQUFBQUFAEEBQUIBwgPCgoPFA4ODhQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQU/8AAEQgAKwCaAwERAAIRAQMRAf/EAHsAAQAABwEBAAAAAAAAAAAAAAABAwQFBgcIAgkBAQAAAAAAAAAAAAAAAAAAAAAQAAEDAwICBwYEAgsAAAAAAAIBAwQAEQUSBiEHkROTVNQWGDFBUVIUCHEiMtOUFWGBobHRQlMkZIRVEQEAAAAAAAAAAAAAAAAAAAAA/9oADAMBAAIRAxEAPwDSC+ygkOOaUoKigUCgUCgUCgUCgUCgUCgUCgkuGguIP9FBMFb0Hqg7We+3jlmIqqYFf4ub+/QYlnOR/LqIBKGFUbf8qWv971BytQXXE7Y3Lnm3HsFhp2TaZJAdchRXpIgSpdEJWxJEW3xoKV7F5OMy7JkQn2o7D6w33XGjEAkoiqrJEqIiOIiKuhePCgqp22dyYyS3CyWHnQ5joG61HkRnmnTbaFSMhExRVQRRVJU9iUHjE7ez+fJ0MFipmUNhBV8YUd2SoIV9KkjQla9ltegttBdPLW4/qocL+UTfrMiHW4+P9M71shuyrqaHTcxsl7jegpsji8nh5ZwMvDfgTm0RTjSmjYdFCS6KoOIipdFunCgmNYTMv457MMY6U7iI6oMieDDhRm1VbIhuoOkbqtuK0Hpzb+eZcYZexUxt6UyUqK2cd0SdjtgrhOgijcgERUlJOCIl6CpgbP3blRI8XgMjNARAyKNDfeRBdFDBVUAXgQrqH4pxoJTu2NysY97LP4ac1io5q1InHFeGO24LnVKJuKOkSQ/yKir+rh7aCLG1dzypZQI2FnvTgccYOM3FeN0XWERXAUEFVQgQkUktdLpegm+Td3/Xli/L+S/mYNJIOF9G/wBeLKrZHFb0akG6W1WtQWSg3Dyg5e7V3fipE3O4/wCrktyzYA+ufas2LbZIlmnAT2kvuoN1wft95augilglX/tzP3qCu9O3LL/wV/i5v79BvmTADq14UGu91467Z6U9y0HzH/ncj/U/sT/CgynZG7I2NezpZGUjIycJkYkZSG+uQ81pbBNKLxJfjwoMqZ3/ALYHl35AJ7/cuwHcu5k7r1Q5pHetBjquqVVJWGxj9Zrtcl/Ggy3dHMvauR3HFZj5nHNxSyW5JISYDMoIwx8tFIGHZhPNaykGapr6rUAiicEoMG21lMRj8buPAz8xhJrr7uOeiPTCyAwXUaGR1mgozbTusOsFLEiJ7fbQa/h7gcjy2H3V6xppwDNtUSxCJIqp7valBuWVzJ22xuCROXNNZiJkMtms0DbjUkAZjzoDrTMd9dDRI44ZC2YsrYdKWP2WDT2S3N9dNdlRYrGMYc06IURXSYb0igrpWS485xVNS6nF4rwslkoMwnbpgZLB7bmt5uMweAhDEl4B5uSLzzqTnnyVpW2jaJHRMSIjdDiiotvy3DOE5rYTEbkl5yFn28k7JyG4c7AU2HtLH1uKfaiMPI40CdYbpNtmLdwTSn5rewLNld+7TLdeal4WarWBkbVKBjgdElMJJwAAY5fl4kB3b1fp4XvagsGS3FjJfLzDNtS8aeXx7LzT7TyzByQE5PccRGRC0ZRUDRV6y62vbjagzLmJzS2vuPK43JY6aP1TW6Jz+RIWyFtyC06y3EkiiinAo7YCqfq1AqqnGgsOH3lhZO8d1pmcpB8j5XIm9OYlBJSQ/FSS4427DKO0RC8AlcEMhFdViRR1WDWR5t3WXVuL1d106kG9vdeye2g60+1FDyW0shIcXVpyroXt8I8dfd+NB1vioAdWnD3UF1+gD4UFc6CEKpagxXN43rwJLUHz7yX2c8zokt9uHlsPIhA4aRnnHJTLptIS6CNsY7iASpxUUMkReGpfbQW0vtN5pitvrsN28rwtBD0nc0+/Yft5XhaB6TuaXfsP28rwtA9J3NPv2H7eV4Wgek7mn37D9vK8LQPSdzT79h+3leFoHpO5pd+w/byvC0D0nc0u/Yft5XhaB6TuaXfsP28rwtA9J3NLv2H7eV4Wgek7ml37D9vK8LQPSdzS79h+3leFoHpO5p9+w/byvC0E9r7Reazy2HIYVPxkS/CUHVn26cosxyv2g7h89LYmZSXOenvLEQ1YaQ222RATcQCP8rSGqqA8S02W2pQ6FhMoAIlqCtsnwoCpdKClejI4i3Sgtb+GBxVuNBSFt1pV/RQefLjPyUDy4z8lA8uM/JQPLjPyUDy4z8lA8uM/JQPLjPyUDy4z8lA8uM/JQPLjPyUDy4z8lA8utJ/koJ7WCbBU/LQXOPAFq1koK8B0pag90CggtBBf6qB0UDooHRQOigdFA6KB0UDooHRQOigdFA6KB0UDooI0EaBQf//Z" title="Toggle Table of Contents" alt="Toggle Table of Contents" /> - </a> -</div> diff --git a/user_guide_src/source/_themes/sphinx_rtd_theme/search.html b/user_guide_src/source/_themes/sphinx_rtd_theme/search.html deleted file mode 100644 index e3aa9b5c6..000000000 --- a/user_guide_src/source/_themes/sphinx_rtd_theme/search.html +++ /dev/null @@ -1,50 +0,0 @@ -{# - basic/search.html - ~~~~~~~~~~~~~~~~~ - - Template for the search page. - - :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. -#} -{%- extends "layout.html" %} -{% set title = _('Search') %} -{% set script_files = script_files + ['_static/searchtools.js'] %} -{% block footer %} - <script type="text/javascript"> - jQuery(function() { Search.loadIndex("{{ pathto('searchindex.js', 1) }}"); }); - </script> - {# this is used when loading the search index using $.ajax fails, - such as on Chrome for documents on localhost #} - <script type="text/javascript" id="searchindexloader"></script> - {{ super() }} -{% endblock %} -{% block body %} - <noscript> - <div id="fallback" class="admonition warning"> - <p class="last"> - {% trans %}Please activate JavaScript to enable the search - functionality.{% endtrans %} - </p> - </div> - </noscript> - - {% if search_performed %} - <h2>{{ _('Search Results') }}</h2> - {% if not search_results %} - <p>{{ _('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.') }}</p> - {% endif %} - {% endif %} - <div id="search-results"> - {% if search_results %} - <ul> - {% for href, caption, context in search_results %} - <li> - <a href="{{ pathto(item.href) }}">{{ caption }}</a> - <p class="context">{{ context|e }}</p> - </li> - {% endfor %} - </ul> - {% endif %} - </div> -{% endblock %} diff --git a/user_guide_src/source/_themes/sphinx_rtd_theme/searchbox.html b/user_guide_src/source/_themes/sphinx_rtd_theme/searchbox.html deleted file mode 100644 index 35ad52c5f..000000000 --- a/user_guide_src/source/_themes/sphinx_rtd_theme/searchbox.html +++ /dev/null @@ -1,9 +0,0 @@ -{%- if builder != 'singlehtml' %} -<div role="search"> - <form id="rtd-search-form" class="wy-form" action="{{ pathto('search') }}" method="get"> - <input type="text" name="q" placeholder="Search docs" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> -</div> -{%- endif %} diff --git a/user_guide_src/source/_themes/sphinx_rtd_theme/static/css/badge_only.css b/user_guide_src/source/_themes/sphinx_rtd_theme/static/css/badge_only.css deleted file mode 100644 index 7e17fb148..000000000 --- a/user_guide_src/source/_themes/sphinx_rtd_theme/static/css/badge_only.css +++ /dev/null @@ -1,2 +0,0 @@ -.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-weight:normal;font-style:normal;src:url("../font/fontawesome_webfont.eot");src:url("../font/fontawesome_webfont.eot?#iefix") format("embedded-opentype"),url("../font/fontawesome_webfont.woff") format("woff"),url("../font/fontawesome_webfont.ttf") format("truetype"),url("../font/fontawesome_webfont.svg#FontAwesome") format("svg")}.fa:before{display:inline-block;font-family:FontAwesome;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa{display:inline-block;text-decoration:inherit}li .fa{display:inline-block}li .fa-large:before,li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-0.8em}ul.fas li .fa{width:0.8em}ul.fas li .fa-large:before,ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before{content:""}.icon-book:before{content:""}.fa-caret-down:before{content:""}.icon-caret-down:before{content:""}.fa-caret-up:before{content:""}.icon-caret-up:before{content:""}.fa-caret-left:before{content:""}.icon-caret-left:before{content:""}.fa-caret-right:before{content:""}.icon-caret-right:before{content:""}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;border-top:solid 10px #343131;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}img{width:100%;height:auto}} -/*# sourceMappingURL=badge_only.css.map */ diff --git a/user_guide_src/source/_themes/sphinx_rtd_theme/static/css/citheme.css b/user_guide_src/source/_themes/sphinx_rtd_theme/static/css/citheme.css deleted file mode 100644 index a2a3b3e91..000000000 --- a/user_guide_src/source/_themes/sphinx_rtd_theme/static/css/citheme.css +++ /dev/null @@ -1,88 +0,0 @@ -@import 'theme.css'; - -.highlighted { - padding: 0px !important; - font-weight: inherit !important; - background-color: #f1d40f !important; -} - -#nav { - background-color: #494949; - margin: 0; - padding: 0; - display: none; -} - -#nav2 { - background: url(data:image/jpeg;base64,/9j/4AAQSkZJRgABAgAAZABkAAD/7AARRHVja3kAAQAEAAAARgAA/+4ADkFkb2JlAGTAAAAAAf/bAIQABAMDAwMDBAMDBAYEAwQGBwUEBAUHCAYGBwYGCAoICQkJCQgKCgwMDAwMCgwMDQ0MDBERERERFBQUFBQUFBQUFAEEBQUIBwgPCgoPFA4ODhQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQU/8AAEQgAMgAzAwERAAIRAQMRAf/EAFkAAQADAQAAAAAAAAAAAAAAAAABBQcIAQEAAAAAAAAAAAAAAAAAAAAAEAABAgYDAAAAAAAAAAAAAAAAAVERAtMEFJRVBxgRAQAAAAAAAAAAAAAAAAAAAAD/2gAMAwEAAhEDEQA/AMRAAAAAAAA7a87dZcCu3e1wHnbrLgV272uA87dZcCu3e1wHnbrLgV272uA87dZcCu3e1wHnbrLgV272uA87dZcCu3e1wN/wJGAYEjAMCRgGBIwDAkYBgSMAwJGAsoIwCCMAgjAIIwCCMAgjAIIwEgAAAAAAAAAAAAAAAAAAAAAAAH//2Q==) repeat-x scroll left top transparent; - margin: 0; - padding: 0 310px 0 0; - text-align: right; - display: none; -} - -#nav_inner { - background-color: transparent; - font-family: Lucida Grande,Verdana,Geneva,sans-serif; - font-size: 11px; - margin: 0; - padding: 8px 12px 0 20px; -} - -div#pulldown-menu { - -moz-column-count: 5; - -moz-column-gap: 20px; - -webkit-column-count: 5; - -webkit-column-gap: 20px; - column-count: 5; - column-gap: 20px; - -webkit-column-rule: 1px groove #b8b8b8; - -moz-column-rule: 1px groove #b8b8b8; - column-rule: 1px groove #b8b8b8; -} - -#pulldown-menu > ul { - padding-top: 10px; - padding-bottom: 10px; - -webkit-column-break-inside: avoid; /*Chrome, Safari*/ - display: table; /*Firefox*/ - break-inside: avoid; /*IE 10+ theoretically*/ -} - -#pulldown-menu ul li.toctree-l2 { - font-size: 0.82em; - margin-left: 20px; - list-style-image: url(data:image/gif;base64,R0lGODlhCwAJALMJAO7u7uTk5PLy8unp6fb29t7e3vj4+Li4uIWFheTk5AAAAAAAAAAAAAAAAAAAAAAAACH5BAEAAAkALAAAAAALAAkAAAQoMJ1JqTQ4Z3SI98jHCWSJkByArCyiHkMsIzEX3DeCc0Xv+4hEa5iIAAA7); -} - -#pulldown-menu ul li.toctree-l1 a { - color: #ffffff; - text-decoration: none; - font-size: 12px; - font-family: "Roboto Slab","ff-tisa-web-pro","Georgia",Arial,sans-serif; - font-weight: 700; -} - -#pulldown-menu ul li.toctree-l2 a { - text-decoration: none; - font-size: 11px; - line-height: 1.4em; - font-weight: 300; - font-family: Lucida Grande,Verdana,Geneva,sans-serif; - color: #aaaaaa; -} - -/*hide pulldown menu on mobile devices*/ -@media (max-width: 768px) { /*tablet size defined by theme*/ - #closeMe { - display: none; - } - - #pulldown { - display: none; - } - - #openToc { - display: none; - } -}
\ No newline at end of file diff --git a/user_guide_src/source/_themes/sphinx_rtd_theme/static/css/theme.css b/user_guide_src/source/_themes/sphinx_rtd_theme/static/css/theme.css deleted file mode 100644 index 64d41142a..000000000 --- a/user_guide_src/source/_themes/sphinx_rtd_theme/static/css/theme.css +++ /dev/null @@ -1,5 +0,0 @@ -*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}audio:not([controls]){display:none}[hidden]{display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:hover,a:active{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:bold}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;color:#000;text-decoration:none}mark{background:#ff0;color:#000;font-style:italic;font-weight:bold}pre,code,.rst-content tt,kbd,samp{font-family:monospace,serif;_font-family:"courier new",monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:before,q:after{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-0.5em}sub{bottom:-0.25em}ul,ol,dl{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure{margin:0}form{margin:0}fieldset{border:0;margin:0;padding:0}label{cursor:pointer}legend{border:0;*margin-left:-7px;padding:0;white-space:normal}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type="button"],input[type="reset"],input[type="submit"]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0;*width:13px;*height:13px}input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}input[type="search"]::-webkit-search-decoration,input[type="search"]::-webkit-search-cancel-button{-webkit-appearance:none}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}textarea{overflow:auto;vertical-align:top;resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:0.2em 0;background:#ccc;color:#000;padding:0.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none !important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{html,body,section{background:none !important}*{box-shadow:none !important;text-shadow:none !important;filter:none !important;-ms-filter:none !important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:1.5cm 0.5cm 2.5cm}p,h2,h3{orphans:3;widows:3}h2,h3{page-break-after:avoid}}.fa:before,.rst-content .admonition-title:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content dl dt .headerlink:before,.icon:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-alert,.rst-content .note,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .warning,.rst-content .seealso,.rst-content .admonition-todo,.btn,input[type="text"],input[type="password"],input[type="email"],input[type="url"],input[type="date"],input[type="month"],input[type="time"],input[type="datetime"],input[type="datetime-local"],input[type="week"],input[type="number"],input[type="search"],input[type="tel"],input[type="color"],select,textarea,.wy-menu-vertical li.on a,.wy-menu-vertical li.current>a,.wy-side-nav-search>a,.wy-side-nav-search .wy-dropdown>a,.wy-nav-top a{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}/*! - * Font Awesome 4.1.0 by @davegandy - http://fontawesome.io - @fontawesome - * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) - */@font-face{font-family:'FontAwesome';src:url("../fonts/fontawesome-webfont.eot?v=4.1.0");src:url("../fonts/fontawesome-webfont.eot?#iefix&v=4.1.0") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff?v=4.1.0") format("woff"),url("../fonts/fontawesome-webfont.ttf?v=4.1.0") format("truetype"),url("../fonts/fontawesome-webfont.svg?v=4.1.0#fontawesomeregular") format("svg");font-weight:normal;font-style:normal}.fa,.rst-content .admonition-title,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink,.icon{display:inline-block;font-family:FontAwesome;font-style:normal;font-weight:normal;line-height:1;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:0.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:0.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:solid 0.08em #eee;border-radius:.1em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.rst-content .pull-left.admonition-title,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content dl dt .pull-left.headerlink,.pull-left.icon{margin-right:.3em}.fa.pull-right,.rst-content .pull-right.admonition-title,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content dl dt .pull-right.headerlink,.pull-right.icon{margin-left:.3em}.fa-spin{-webkit-animation:spin 2s infinite linear;-moz-animation:spin 2s infinite linear;-o-animation:spin 2s infinite linear;animation:spin 2s infinite linear}@-moz-keyframes spin{0%{-moz-transform:rotate(0deg)}100%{-moz-transform:rotate(359deg)}}@-webkit-keyframes spin{0%{-webkit-transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg)}}@-o-keyframes spin{0%{-o-transform:rotate(0deg)}100%{-o-transform:rotate(359deg)}}@keyframes spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=1);-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=2);-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=3);-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=0);-webkit-transform:scale(-1, 1);-moz-transform:scale(-1, 1);-ms-transform:scale(-1, 1);-o-transform:scale(-1, 1);transform:scale(-1, 1)}.fa-flip-vertical{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=2);-webkit-transform:scale(1, -1);-moz-transform:scale(1, -1);-ms-transform:scale(1, -1);-o-transform:scale(1, -1);transform:scale(1, -1)}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-gear:before,.fa-cog:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-rotate-right:before,.fa-repeat:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-photo:before,.fa-image:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.rst-content .admonition-title:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-warning:before,.fa-exclamation-triangle:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-gears:before,.fa-cogs:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-save:before,.fa-floppy-o:before{content:""}.fa-square:before{content:""}.fa-navicon:before,.fa-reorder:before,.fa-bars:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.wy-dropdown .caret:before,.icon-caret-down:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-unsorted:before,.fa-sort:before{content:""}.fa-sort-down:before,.fa-sort-desc:before{content:""}.fa-sort-up:before,.fa-sort-asc:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-legal:before,.fa-gavel:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-flash:before,.fa-bolt:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-paste:before,.fa-clipboard:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-unlink:before,.fa-chain-broken:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-toggle-down:before,.fa-caret-square-o-down:before{content:""}.fa-toggle-up:before,.fa-caret-square-o-up:before{content:""}.fa-toggle-right:before,.fa-caret-square-o-right:before{content:""}.fa-euro:before,.fa-eur:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-rupee:before,.fa-inr:before{content:""}.fa-cny:before,.fa-rmb:before,.fa-yen:before,.fa-jpy:before{content:""}.fa-ruble:before,.fa-rouble:before,.fa-rub:before{content:""}.fa-won:before,.fa-krw:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-toggle-left:before,.fa-caret-square-o-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-turkish-lira:before,.fa-try:before{content:""}.fa-plus-square-o:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-institution:before,.fa-bank:before,.fa-university:before{content:""}.fa-mortar-board:before,.fa-graduation-cap:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-square:before,.fa-pied-piper:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-photo-o:before,.fa-file-picture-o:before,.fa-file-image-o:before{content:""}.fa-file-zip-o:before,.fa-file-archive-o:before{content:""}.fa-file-sound-o:before,.fa-file-audio-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-saver:before,.fa-support:before,.fa-life-ring:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before{content:""}.fa-ge:before,.fa-empire:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-send:before,.fa-paper-plane:before{content:""}.fa-send-o:before,.fa-paper-plane-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa,.rst-content .admonition-title,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink,.icon,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context{font-family:inherit}.fa:before,.rst-content .admonition-title:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content dl dt .headerlink:before,.icon:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before{font-family:"FontAwesome";display:inline-block;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa,a .rst-content .admonition-title,.rst-content a .admonition-title,a .rst-content h1 .headerlink,.rst-content h1 a .headerlink,a .rst-content h2 .headerlink,.rst-content h2 a .headerlink,a .rst-content h3 .headerlink,.rst-content h3 a .headerlink,a .rst-content h4 .headerlink,.rst-content h4 a .headerlink,a .rst-content h5 .headerlink,.rst-content h5 a .headerlink,a .rst-content h6 .headerlink,.rst-content h6 a .headerlink,a .rst-content dl dt .headerlink,.rst-content dl dt a .headerlink,a .icon{display:inline-block;text-decoration:inherit}.btn .fa,.btn .rst-content .admonition-title,.rst-content .btn .admonition-title,.btn .rst-content h1 .headerlink,.rst-content h1 .btn .headerlink,.btn .rst-content h2 .headerlink,.rst-content h2 .btn .headerlink,.btn .rst-content h3 .headerlink,.rst-content h3 .btn .headerlink,.btn .rst-content h4 .headerlink,.rst-content h4 .btn .headerlink,.btn .rst-content h5 .headerlink,.rst-content h5 .btn .headerlink,.btn .rst-content h6 .headerlink,.rst-content h6 .btn .headerlink,.btn .rst-content dl dt .headerlink,.rst-content dl dt .btn .headerlink,.btn .icon,.nav .fa,.nav .rst-content .admonition-title,.rst-content .nav .admonition-title,.nav .rst-content h1 .headerlink,.rst-content h1 .nav .headerlink,.nav .rst-content h2 .headerlink,.rst-content h2 .nav .headerlink,.nav .rst-content h3 .headerlink,.rst-content h3 .nav .headerlink,.nav .rst-content h4 .headerlink,.rst-content h4 .nav .headerlink,.nav .rst-content h5 .headerlink,.rst-content h5 .nav .headerlink,.nav .rst-content h6 .headerlink,.rst-content h6 .nav .headerlink,.nav .rst-content dl dt .headerlink,.rst-content dl dt .nav .headerlink,.nav .icon{display:inline}.btn .fa.fa-large,.btn .rst-content .fa-large.admonition-title,.rst-content .btn .fa-large.admonition-title,.btn .rst-content h1 .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.btn .rst-content dl dt .fa-large.headerlink,.rst-content dl dt .btn .fa-large.headerlink,.btn .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .fa-large.admonition-title,.rst-content .nav .fa-large.admonition-title,.nav .rst-content h1 .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.nav .rst-content dl dt .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.nav .fa-large.icon{line-height:0.9em}.btn .fa.fa-spin,.btn .rst-content .fa-spin.admonition-title,.rst-content .btn .fa-spin.admonition-title,.btn .rst-content h1 .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.btn .rst-content dl dt .fa-spin.headerlink,.rst-content dl dt .btn .fa-spin.headerlink,.btn .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .fa-spin.admonition-title,.rst-content .nav .fa-spin.admonition-title,.nav .rst-content h1 .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.nav .rst-content dl dt .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.nav .fa-spin.icon{display:inline-block}.btn.fa:before,.rst-content .btn.admonition-title:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content dl dt .btn.headerlink:before,.btn.icon:before{opacity:0.5;-webkit-transition:opacity 0.05s ease-in;-moz-transition:opacity 0.05s ease-in;transition:opacity 0.05s ease-in}.btn.fa:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.btn.icon:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .rst-content .admonition-title:before,.rst-content .btn-mini .admonition-title:before,.btn-mini .rst-content h1 .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.btn-mini .rst-content dl dt .headerlink:before,.rst-content dl dt .btn-mini .headerlink:before,.btn-mini .icon:before{font-size:14px;vertical-align:-15%}.wy-alert,.rst-content .note,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .warning,.rst-content .seealso,.rst-content .admonition-todo{padding:12px;line-height:24px;margin-bottom:24px;background:#dedede}.wy-alert-title,.rst-content .admonition-title{color:#fff;font-weight:bold;display:block;color:#fff;background:#8ba8af;margin:-12px;padding:6px 12px;margin-bottom:12px}.wy-alert.wy-alert-danger,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.admonition-todo{background:#fdf3f2}.wy-alert.wy-alert-danger .wy-alert-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .danger .wy-alert-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .danger .admonition-title,.rst-content .error .admonition-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title{background:#f29f97}.wy-alert.wy-alert-warning,.rst-content .wy-alert-warning.note,.rst-content .attention,.rst-content .caution,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.tip,.rst-content .warning,.rst-content .wy-alert-warning.seealso,.rst-content .admonition-todo{background:#ffedcc}.wy-alert.wy-alert-warning .wy-alert-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .attention .wy-alert-title,.rst-content .caution .wy-alert-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .admonition-todo .wy-alert-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .attention .admonition-title,.rst-content .caution .admonition-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .warning .admonition-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .admonition-todo .admonition-title{background:#f0b37e}.wy-alert.wy-alert-info,.rst-content .note,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.rst-content .seealso,.rst-content .wy-alert-info.admonition-todo{background:#dedede}.wy-alert.wy-alert-info .wy-alert-title,.rst-content .note .wy-alert-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.rst-content .note .admonition-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .seealso .admonition-title,.rst-content .wy-alert-info.admonition-todo .admonition-title{background:#8ba8af}.wy-alert.wy-alert-success,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.warning,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.admonition-todo{background:#dedede}.wy-alert.wy-alert-success .wy-alert-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .hint .wy-alert-title,.rst-content .important .wy-alert-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .hint .admonition-title,.rst-content .important .admonition-title,.rst-content .tip .admonition-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.admonition-todo .admonition-title{background:#dd4814}.wy-alert.wy-alert-neutral,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.admonition-todo{background:#f3f6f6}.wy-alert.wy-alert-neutral .wy-alert-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .admonition-title{color:#404040;background:#e1e4e5}.wy-alert.wy-alert-neutral a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.admonition-todo a{color:#dd4814}.wy-alert p:last-child,.rst-content .note p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.rst-content .seealso p:last-child,.rst-content .admonition-todo p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0px;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,0.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all 0.3s ease-in;-moz-transition:all 0.3s ease-in;transition:all 0.3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27AE60}.wy-tray-container li.wy-tray-item-info{background:#dd4814}.wy-tray-container li.wy-tray-item-warning{background:#E67E22}.wy-tray-container li.wy-tray-item-danger{background:#E74C3C}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width: 768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px 12px;color:#fff;border:1px solid rgba(0,0,0,0.1);background-color:#27AE60;text-decoration:none;font-weight:normal;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;box-shadow:0px 1px 2px -1px rgba(255,255,255,0.5) inset,0px -2px 0px 0px rgba(0,0,0,0.1) inset;outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all 0.1s linear;-moz-transition:all 0.1s linear;transition:all 0.1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:0px -1px 0px 0px rgba(0,0,0,0.05) inset,0px 2px 0px 0px rgba(0,0,0,0.1) inset;padding:8px 12px 6px 12px}.btn:visited{color:#fff}.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:0.4;cursor:not-allowed;box-shadow:none}.btn-disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:0.4;cursor:not-allowed;box-shadow:none}.btn-disabled:hover,.btn-disabled:focus,.btn-disabled:active{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:0.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#dd4814 !important}.btn-info:hover{background-color:#2e8ece !important}.btn-neutral{background-color:#f3f6f6 !important;color:#404040 !important}.btn-neutral:hover{background-color:#e5ebeb !important;color:#404040}.btn-neutral:visited{color:#404040 !important}.btn-success{background-color:#27AE60 !important}.btn-success:hover{background-color:#295 !important}.btn-danger{background-color:#E74C3C !important}.btn-danger:hover{background-color:#ea6153 !important}.btn-warning{background-color:#E67E22 !important}.btn-warning:hover{background-color:#e98b39 !important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f !important}.btn-link{background-color:transparent !important;color:#dd4814;box-shadow:none;border-color:transparent !important}.btn-link:hover{background-color:transparent !important;color:#409ad5 !important;box-shadow:none}.btn-link:active{background-color:transparent !important;color:#409ad5 !important;box-shadow:none}.btn-link:visited{color:#97310e}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:before,.wy-btn-group:after{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:solid 1px #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,0.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#dd4814;color:#fff}.wy-dropdown-menu>dd.divider{border-top:solid 1px #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type="search"]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#dd4814;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned input,.wy-form-aligned textarea,.wy-form-aligned select,.wy-form-aligned .wy-help-inline,.wy-form-aligned label{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{border:0;margin:0;padding:0}legend{display:block;width:100%;border:0;padding:0;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label{display:block;margin:0 0 0.3125em 0;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;*zoom:1;max-width:68em;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:before,.wy-control-group:after{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group:before,.wy-control-group:after{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#E74C3C}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full input[type="text"],.wy-control-group .wy-form-full input[type="password"],.wy-control-group .wy-form-full input[type="email"],.wy-control-group .wy-form-full input[type="url"],.wy-control-group .wy-form-full input[type="date"],.wy-control-group .wy-form-full input[type="month"],.wy-control-group .wy-form-full input[type="time"],.wy-control-group .wy-form-full input[type="datetime"],.wy-control-group .wy-form-full input[type="datetime-local"],.wy-control-group .wy-form-full input[type="week"],.wy-control-group .wy-form-full input[type="number"],.wy-control-group .wy-form-full input[type="search"],.wy-control-group .wy-form-full input[type="tel"],.wy-control-group .wy-form-full input[type="color"],.wy-control-group .wy-form-halves input[type="text"],.wy-control-group .wy-form-halves input[type="password"],.wy-control-group .wy-form-halves input[type="email"],.wy-control-group .wy-form-halves input[type="url"],.wy-control-group .wy-form-halves input[type="date"],.wy-control-group .wy-form-halves input[type="month"],.wy-control-group .wy-form-halves input[type="time"],.wy-control-group .wy-form-halves input[type="datetime"],.wy-control-group .wy-form-halves input[type="datetime-local"],.wy-control-group .wy-form-halves input[type="week"],.wy-control-group .wy-form-halves input[type="number"],.wy-control-group .wy-form-halves input[type="search"],.wy-control-group .wy-form-halves input[type="tel"],.wy-control-group .wy-form-halves input[type="color"],.wy-control-group .wy-form-thirds input[type="text"],.wy-control-group .wy-form-thirds input[type="password"],.wy-control-group .wy-form-thirds input[type="email"],.wy-control-group .wy-form-thirds input[type="url"],.wy-control-group .wy-form-thirds input[type="date"],.wy-control-group .wy-form-thirds input[type="month"],.wy-control-group .wy-form-thirds input[type="time"],.wy-control-group .wy-form-thirds input[type="datetime"],.wy-control-group .wy-form-thirds input[type="datetime-local"],.wy-control-group .wy-form-thirds input[type="week"],.wy-control-group .wy-form-thirds input[type="number"],.wy-control-group .wy-form-thirds input[type="search"],.wy-control-group .wy-form-thirds input[type="tel"],.wy-control-group .wy-form-thirds input[type="color"]{width:100%}.wy-control-group .wy-form-full{float:left;display:block;margin-right:2.35765%;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child{margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(2n+1){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child{margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control{margin:6px 0 0 0;font-size:90%}.wy-control-no-input{display:inline-block;margin:6px 0 0 0;font-size:90%}.wy-control-group.fluid-input input[type="text"],.wy-control-group.fluid-input input[type="password"],.wy-control-group.fluid-input input[type="email"],.wy-control-group.fluid-input input[type="url"],.wy-control-group.fluid-input input[type="date"],.wy-control-group.fluid-input input[type="month"],.wy-control-group.fluid-input input[type="time"],.wy-control-group.fluid-input input[type="datetime"],.wy-control-group.fluid-input input[type="datetime-local"],.wy-control-group.fluid-input input[type="week"],.wy-control-group.fluid-input input[type="number"],.wy-control-group.fluid-input input[type="search"],.wy-control-group.fluid-input input[type="tel"],.wy-control-group.fluid-input input[type="color"]{width:100%}.wy-form-message-inline{display:inline-block;padding-left:0.3em;color:#666;vertical-align:middle;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:0.3125em;font-style:italic}input{line-height:normal}input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;*overflow:visible}input[type="text"],input[type="password"],input[type="email"],input[type="url"],input[type="date"],input[type="month"],input[type="time"],input[type="datetime"],input[type="datetime-local"],input[type="week"],input[type="number"],input[type="search"],input[type="tel"],input[type="color"]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border 0.3s linear;-moz-transition:border 0.3s linear;transition:border 0.3s linear}input[type="datetime-local"]{padding:0.34375em 0.625em}input[disabled]{cursor:default}input[type="checkbox"],input[type="radio"]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box;padding:0;margin-right:0.3125em;*height:13px;*width:13px}input[type="search"]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}input[type="text"]:focus,input[type="password"]:focus,input[type="email"]:focus,input[type="url"]:focus,input[type="date"]:focus,input[type="month"]:focus,input[type="time"]:focus,input[type="datetime"]:focus,input[type="datetime-local"]:focus,input[type="week"]:focus,input[type="number"]:focus,input[type="search"]:focus,input[type="tel"]:focus,input[type="color"]:focus{outline:0;outline:thin dotted \9;border-color:#333}input.no-focus:focus{border-color:#ccc !important}input[type="file"]:focus,input[type="radio"]:focus,input[type="checkbox"]:focus{outline:thin dotted #333;outline:1px auto #129FEA}input[type="text"][disabled],input[type="password"][disabled],input[type="email"][disabled],input[type="url"][disabled],input[type="date"][disabled],input[type="month"][disabled],input[type="time"][disabled],input[type="datetime"][disabled],input[type="datetime-local"][disabled],input[type="week"][disabled],input[type="number"][disabled],input[type="search"][disabled],input[type="tel"][disabled],input[type="color"][disabled]{cursor:not-allowed;background-color:#f3f6f6;color:#cad2d3}input:focus:invalid,textarea:focus:invalid,select:focus:invalid{color:#E74C3C;border:1px solid #E74C3C}input:focus:invalid:focus,textarea:focus:invalid:focus,select:focus:invalid:focus{border-color:#E74C3C}input[type="file"]:focus:invalid:focus,input[type="radio"]:focus:invalid:focus,input[type="checkbox"]:focus:invalid:focus{outline-color:#E74C3C}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif}select,textarea{padding:0.5em 0.625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border 0.3s linear;-moz-transition:border 0.3s linear;transition:border 0.3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}select[disabled],textarea[disabled],input[readonly],select[readonly],textarea[readonly]{cursor:not-allowed;background-color:#fff;color:#cad2d3;border-color:transparent}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:solid 1px #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#E74C3C}.wy-control-group.wy-control-group-error input[type="text"],.wy-control-group.wy-control-group-error input[type="password"],.wy-control-group.wy-control-group-error input[type="email"],.wy-control-group.wy-control-group-error input[type="url"],.wy-control-group.wy-control-group-error input[type="date"],.wy-control-group.wy-control-group-error input[type="month"],.wy-control-group.wy-control-group-error input[type="time"],.wy-control-group.wy-control-group-error input[type="datetime"],.wy-control-group.wy-control-group-error input[type="datetime-local"],.wy-control-group.wy-control-group-error input[type="week"],.wy-control-group.wy-control-group-error input[type="number"],.wy-control-group.wy-control-group-error input[type="search"],.wy-control-group.wy-control-group-error input[type="tel"],.wy-control-group.wy-control-group-error input[type="color"]{border:solid 1px #E74C3C}.wy-control-group.wy-control-group-error textarea{border:solid 1px #E74C3C}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:0.5em 0.625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27AE60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#E74C3C}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#E67E22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#dd4814}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width: 480px){.wy-form button[type="submit"]{margin:0.7em 0 0}.wy-form input[type="text"],.wy-form input[type="password"],.wy-form input[type="email"],.wy-form input[type="url"],.wy-form input[type="date"],.wy-form input[type="month"],.wy-form input[type="time"],.wy-form input[type="datetime"],.wy-form input[type="datetime-local"],.wy-form input[type="week"],.wy-form input[type="number"],.wy-form input[type="search"],.wy-form input[type="tel"],.wy-form input[type="color"]{margin-bottom:0.3em;display:block}.wy-form label{margin-bottom:0.3em;display:block}.wy-form input[type="password"],.wy-form input[type="email"],.wy-form input[type="url"],.wy-form input[type="date"],.wy-form input[type="month"],.wy-form input[type="time"],.wy-form input[type="datetime"],.wy-form input[type="datetime-local"],.wy-form input[type="week"],.wy-form input[type="number"],.wy-form input[type="search"],.wy-form input[type="tel"],.wy-form input[type="color"]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:0.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0 0}.wy-form .wy-help-inline,.wy-form-message-inline,.wy-form-message{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width: 768px){.tablet-hide{display:none}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}}@media screen and (max-width: 480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.wy-table,.rst-content table.docutils,.rst-content table.field-list{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.wy-table caption,.rst-content table.docutils caption,.rst-content table.field-list caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.wy-table td,.rst-content table.docutils td,.rst-content table.field-list td,.wy-table th,.rst-content table.docutils th,.rst-content table.field-list th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.wy-table td:first-child,.rst-content table.docutils td:first-child,.rst-content table.field-list td:first-child,.wy-table th:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list th:first-child{border-left-width:0}.wy-table thead,.rst-content table.docutils thead,.rst-content table.field-list thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.wy-table thead th,.rst-content table.docutils thead th,.rst-content table.field-list thead th{font-weight:bold;border-bottom:solid 2px #e1e4e5}.wy-table td,.rst-content table.docutils td,.rst-content table.field-list td{background-color:transparent;vertical-align:middle}.wy-table td p,.rst-content table.docutils td p,.rst-content table.field-list td p{line-height:18px}.wy-table td p:last-child,.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child{margin-bottom:0}.wy-table .wy-table-cell-min,.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min{width:1%;padding-right:0}.wy-table .wy-table-cell-min input[type=checkbox],.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox],.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:gray;font-size:90%}.wy-table-tertiary{color:gray;font-size:80%}.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td,.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td{background-color:#f3f6f6}.wy-table-backed{background-color:#f3f6f6}.wy-table-bordered-all,.rst-content table.docutils{border:1px solid #e1e4e5}.wy-table-bordered-all td,.rst-content table.docutils td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.wy-table-bordered-all tbody>tr:last-child td,.rst-content table.docutils tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px 0;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0 !important}a{color:#dd4814;text-decoration:none;cursor:pointer}a:hover{color:#97310e}a:visited{color:#97310e}html{height:100%;overflow-x:hidden}body{font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;font-weight:normal;color:#404040;min-height:100%;overflow-x:hidden;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#E67E22 !important}a.wy-text-warning:hover{color:#eb9950 !important}.wy-text-info{color:#dd4814 !important}a.wy-text-info:hover{color:#409ad5 !important}.wy-text-success{color:#27AE60 !important}a.wy-text-success:hover{color:#36d278 !important}.wy-text-danger{color:#E74C3C !important}a.wy-text-danger:hover{color:#ed7669 !important}.wy-text-neutral{color:#404040 !important}a.wy-text-neutral:hover{color:#595959 !important}h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:"Roboto Slab","ff-tisa-web-pro","Georgia",Arial,sans-serif}p{line-height:24px;margin:0;font-size:16px;margin-bottom:24px}h1{font-size:175%}h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}code,.rst-content tt{white-space:nowrap;max-width:100%;background:#fff;border:solid 1px #e1e4e5;font-size:75%;padding:0 5px;font-family:Consolas,"Andale Mono WT","Andale Mono","Lucida Console","Lucida Sans Typewriter","DejaVu Sans Mono","Bitstream Vera Sans Mono","Liberation Mono","Nimbus Mono L",Monaco,"Courier New",Courier,monospace;color:#E74C3C;overflow-x:auto}code.code-large,.rst-content tt.code-large{font-size:90%}.wy-plain-list-disc,.rst-content .section ul,.rst-content .toctree-wrapper ul,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.wy-plain-list-disc li,.rst-content .section ul li,.rst-content .toctree-wrapper ul li,article ul li{list-style:disc;margin-left:24px}.wy-plain-list-disc li p:last-child,.rst-content .section ul li p:last-child,.rst-content .toctree-wrapper ul li p:last-child,article ul li p:last-child{margin-bottom:0}.wy-plain-list-disc li ul,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li ul,article ul li ul{margin-bottom:0}.wy-plain-list-disc li li,.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,article ul li li{list-style:circle}.wy-plain-list-disc li li li,.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,article ul li li li{list-style:square}.wy-plain-list-disc li ol li,.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,article ul li ol li{list-style:decimal}.wy-plain-list-decimal,.rst-content .section ol,.rst-content ol.arabic,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.wy-plain-list-decimal li,.rst-content .section ol li,.rst-content ol.arabic li,article ol li{list-style:decimal;margin-left:24px}.wy-plain-list-decimal li p:last-child,.rst-content .section ol li p:last-child,.rst-content ol.arabic li p:last-child,article ol li p:last-child{margin-bottom:0}.wy-plain-list-decimal li ul,.rst-content .section ol li ul,.rst-content ol.arabic li ul,article ol li ul{margin-bottom:0}.wy-plain-list-decimal li ul li,.rst-content .section ol li ul li,.rst-content ol.arabic li ul li,article ol li ul li{list-style:disc}.codeblock-example{border:1px solid #e1e4e5;border-bottom:none;padding:24px;padding-top:48px;font-weight:500;background:#fff;position:relative}.codeblock-example:after{content:"Example";position:absolute;top:0px;left:0px;background:#97310e;color:#fff;padding:6px 12px}.codeblock-example.prettyprint-example-only{border:1px solid #e1e4e5;margin-bottom:24px}.codeblock,pre.literal-block,.rst-content .literal-block,.rst-content pre.literal-block,div[class^='highlight']{border:1px solid #e1e4e5;padding:0px;overflow-x:auto;background:#fff;margin:1px 0 24px 0}.codeblock div[class^='highlight'],pre.literal-block div[class^='highlight'],.rst-content .literal-block div[class^='highlight'],div[class^='highlight'] div[class^='highlight']{border:none;background:none;margin:0}div[class^='highlight'] td.code{width:100%}.linenodiv pre{border-right:solid 1px #e6e9ea;margin:0;padding:12px 12px;font-family:Consolas,"Andale Mono WT","Andale Mono","Lucida Console","Lucida Sans Typewriter","DejaVu Sans Mono","Bitstream Vera Sans Mono","Liberation Mono","Nimbus Mono L",Monaco,"Courier New",Courier,monospace;font-size:12px;line-height:1.5;color:#d9d9d9}div[class^='highlight'] pre{white-space:pre;margin:0;padding:12px 12px;font-family:Consolas,"Andale Mono WT","Andale Mono","Lucida Console","Lucida Sans Typewriter","DejaVu Sans Mono","Bitstream Vera Sans Mono","Liberation Mono","Nimbus Mono L",Monaco,"Courier New",Courier,monospace;font-size:12px;line-height:1.5;display:block;overflow:auto;color:#404040}@media print{.codeblock,pre.literal-block,.rst-content .literal-block,.rst-content pre.literal-block,div[class^='highlight'],div[class^='highlight'] pre{white-space:pre-wrap}}.hll{background-color:#ffc;margin:0 -12px;padding:0 12px;display:block}.c{color:#998;font-style:italic}.err{color:#a61717;background-color:#e3d2d2}.k{font-weight:bold}.o{font-weight:bold}.cm{color:#998;font-style:italic}.cp{color:#999;font-weight:bold}.c1{color:#998;font-style:italic}.cs{color:#999;font-weight:bold;font-style:italic}.gd{color:#000;background-color:#fdd}.gd .x{color:#000;background-color:#faa}.ge{font-style:italic}.gr{color:#a00}.gh{color:#999}.gi{color:#000;background-color:#dfd}.gi .x{color:#000;background-color:#afa}.go{color:#888}.gp{color:#555}.gs{font-weight:bold}.gu{color:purple;font-weight:bold}.gt{color:#a00}.kc{font-weight:bold}.kd{font-weight:bold}.kn{font-weight:bold}.kp{font-weight:bold}.kr{font-weight:bold}.kt{color:#458;font-weight:bold}.m{color:#099}.s{color:#d14}.n{color:#333}.na{color:teal}.nb{color:#0086b3}.nc{color:#458;font-weight:bold}.no{color:teal}.ni{color:purple}.ne{color:#900;font-weight:bold}.nf{color:#900;font-weight:bold}.nn{color:#555}.nt{color:navy}.nv{color:teal}.ow{font-weight:bold}.w{color:#bbb}.mf{color:#099}.mh{color:#099}.mi{color:#099}.mo{color:#099}.sb{color:#d14}.sc{color:#d14}.sd{color:#d14}.s2{color:#d14}.se{color:#d14}.sh{color:#d14}.si{color:#d14}.sx{color:#d14}.sr{color:#009926}.s1{color:#d14}.ss{color:#990073}.bp{color:#999}.vc{color:teal}.vg{color:teal}.vi{color:teal}.il{color:#099}.gc{color:#999;background-color:#EAF2F5}.wy-breadcrumbs li{display:inline-block}.wy-breadcrumbs li.wy-breadcrumbs-aside{float:right}.wy-breadcrumbs li a{display:inline-block;padding:5px}.wy-breadcrumbs li a:first-child{padding-left:0}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width: 480px){.wy-breadcrumbs-extra{display:none}.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:before,.wy-menu-horiz:after{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz ul,.wy-menu-horiz li{display:inline-block}.wy-menu-horiz li:hover{background:rgba(255,255,255,0.1)}.wy-menu-horiz li.divide-left{border-left:solid 1px #404040}.wy-menu-horiz li.divide-right{border-right:solid 1px #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical header{height:32px;display:inline-block;line-height:32px;padding:0 1.618em;display:block;font-weight:bold;text-transform:uppercase;font-size:80%;color:#dd4814;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:solid 1px #404040}.wy-menu-vertical li.divide-bottom{border-bottom:solid 1px #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:gray;border-right:solid 1px #c9c9c9;padding:0.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.wy-menu-vertical li.on a,.wy-menu-vertical li.current>a{color:#404040;padding:0.4045em 1.618em;font-weight:bold;position:relative;background:#fcfcfc;border:none;border-bottom:solid 1px #c9c9c9;border-top:solid 1px #c9c9c9;padding-left:1.618em -4px}.wy-menu-vertical li.on a:hover,.wy-menu-vertical li.current>a:hover{background:#fcfcfc}.wy-menu-vertical li.toctree-l2.current>a{background:#c9c9c9;padding:0.4045em 2.427em}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical .local-toc li ul{display:block}.wy-menu-vertical li ul li a{margin-bottom:0;color:#b3b3b3;font-weight:normal}.wy-menu-vertical a{display:inline-block;line-height:18px;padding:0.4045em 1.618em;display:block;position:relative;font-size:90%;color:#b3b3b3}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:active{background-color:#dd4814;cursor:pointer;color:#fff}.wy-side-nav-search{z-index:200;background-color:#dd4814;text-align:center;padding:0.809em;display:block;color:#fcfcfc;margin-bottom:0.809em}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#97310e}.wy-side-nav-search img{display:block;margin:auto auto 0.809em auto;height:45px;width:45px;background-color:#dd4814;padding:5px;border-radius:100%}.wy-side-nav-search>a,.wy-side-nav-search .wy-dropdown>a{color:#fcfcfc;font-size:100%;font-weight:bold;display:inline-block;padding:4px 6px;margin-bottom:0.809em}.wy-side-nav-search>a:hover,.wy-side-nav-search .wy-dropdown>a:hover{background:rgba(255,255,255,0.1)}.wy-nav .wy-menu-vertical header{color:#dd4814}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#dd4814;color:#fff}[data-menu-wrap]{-webkit-transition:all 0.2s ease-in;-moz-transition:all 0.2s ease-in;transition:all 0.2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:left repeat-y #fcfcfc;background-image:url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAIAAACQd1PeAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyRpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDoxOERBMTRGRDBFMUUxMUUzODUwMkJCOThDMEVFNURFMCIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDoxOERBMTRGRTBFMUUxMUUzODUwMkJCOThDMEVFNURFMCI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOjE4REExNEZCMEUxRTExRTM4NTAyQkI5OEMwRUU1REUwIiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOjE4REExNEZDMEUxRTExRTM4NTAyQkI5OEMwRUU1REUwIi8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+EwrlwAAAAA5JREFUeNpiMDU0BAgwAAE2AJgB9BnaAAAAAElFTkSuQmCC);background-size:300px 1px}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:absolute;top:0;left:0;width:300px;overflow:hidden;min-height:100%;background:#343131;z-index:200}.wy-nav-top{display:none;background:#dd4814;color:#fff;padding:0.4045em 0.809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:before,.wy-nav-top:after{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:bold}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#dd4814;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100x;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,0.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:#999}footer p{margin-bottom:12px}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:before,.rst-footer-buttons:after{display:table;content:""}.rst-footer-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:solid 1px #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:solid 1px #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:gray;font-size:90%}@media screen and (max-width: 768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width: 1400px){.wy-nav-content-wrap{background:rgba(0,0,0,0.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,footer,.wy-nav-side{display:none}.wy-nav-content-wrap{margin-left:0}}nav.stickynav{position:fixed;top:0}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;border-top:solid 10px #343131;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#dd4814;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-versions .rst-current-version .icon{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}img{width:100%;height:auto}}.rst-content img{max-width:100%;height:auto !important}.rst-content div.figure{margin-bottom:24px}.rst-content div.figure.align-center{text-align:center}.rst-content .section>img,.rst-content .section>a>img{margin-bottom:24px}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content .note .last,.rst-content .attention .last,.rst-content .caution .last,.rst-content .danger .last,.rst-content .error .last,.rst-content .hint .last,.rst-content .important .last,.rst-content .tip .last,.rst-content .warning .last,.rst-content .seealso .last,.rst-content .admonition-todo .last{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,0.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent !important;border-color:rgba(0,0,0,0.1) !important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha li{list-style:upper-alpha}.rst-content .section ol p,.rst-content .section ul p{margin-bottom:12px}.rst-content .line-block{margin-left:24px}.rst-content .topic-title{font-weight:bold;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0px 0px 24px 24px}.rst-content .align-left{float:left;margin:0px 24px 24px 0px}.rst-content .align-center{margin:auto;display:block}.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content dl dt .headerlink{display:none;visibility:hidden;font-size:14px}.rst-content h1 .headerlink:after,.rst-content h2 .headerlink:after,.rst-content h3 .headerlink:after,.rst-content h4 .headerlink:after,.rst-content h5 .headerlink:after,.rst-content h6 .headerlink:after,.rst-content dl dt .headerlink:after{visibility:visible;content:"";font-family:FontAwesome;display:inline-block}.rst-content h1:hover .headerlink,.rst-content h2:hover .headerlink,.rst-content h3:hover .headerlink,.rst-content h4:hover .headerlink,.rst-content h5:hover .headerlink,.rst-content h6:hover .headerlink,.rst-content dl dt:hover .headerlink{display:inline-block}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:solid 1px #e1e4e5}.rst-content .sidebar p,.rst-content .sidebar ul,.rst-content .sidebar dl{font-size:90%}.rst-content .sidebar .last{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:"Roboto Slab","ff-tisa-web-pro","Georgia",Arial,sans-serif;font-weight:bold;background:#e1e4e5;padding:6px 12px;margin:-24px;margin-bottom:24px;font-size:100%}.rst-content .highlighted{background:#F1C40F;display:inline-block;font-weight:bold;padding:0 6px}.rst-content .footnote-reference,.rst-content .citation-reference{vertical-align:super;font-size:90%}.rst-content table.docutils.citation,.rst-content table.docutils.footnote{background:none;border:none;color:#999}.rst-content table.docutils.citation td,.rst-content table.docutils.citation tr,.rst-content table.docutils.footnote td,.rst-content table.docutils.footnote tr{border:none;background-color:transparent !important;white-space:normal}.rst-content table.docutils.citation td.label,.rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}.rst-content table.field-list{border:none}.rst-content table.field-list td{border:none;padding-top:5px}.rst-content table.field-list td>strong{display:inline-block;margin-top:3px}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left;padding-left:0}.rst-content tt{color:#000}.rst-content tt big,.rst-content tt em{font-size:100% !important;line-height:normal}.rst-content tt .xref,a .rst-content tt{font-weight:bold}.rst-content a tt{color:#dd4814}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:bold}.rst-content dl p,.rst-content dl table,.rst-content dl ul,.rst-content dl ol{margin-bottom:12px !important}.rst-content dl dd{margin:0 0 12px 24px}.rst-content dl:not(.docutils){margin-bottom:24px}.rst-content dl:not(.docutils) dt{display:inline-block;margin:6px 0;font-size:90%;line-height:normal;background:#dedede;color:#dd4814;border-top:solid 3px #8ba8af;padding:6px;position:relative}.rst-content dl:not(.docutils) dt:before{color:#8ba8af}.rst-content dl:not(.docutils) dt .headerlink{color:#404040;font-size:100% !important}.rst-content dl:not(.docutils) dl dt{margin-bottom:6px;border:none;border-left:solid 3px #ccc;background:#f0f0f0;color:gray}.rst-content dl:not(.docutils) dl dt .headerlink{color:#404040;font-size:100% !important}.rst-content dl:not(.docutils) dt:first-child{margin-top:0}.rst-content dl:not(.docutils) tt{font-weight:bold}.rst-content dl:not(.docutils) tt.descname,.rst-content dl:not(.docutils) tt.descclassname{background-color:transparent;border:none;padding:0;font-size:100% !important}.rst-content dl:not(.docutils) tt.descname{font-weight:bold}.rst-content dl:not(.docutils) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:bold}.rst-content dl:not(.docutils) .property{display:inline-block;padding-right:8px}.rst-content .viewcode-link,.rst-content .viewcode-back{display:inline-block;color:#27AE60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:bold}@media screen and (max-width: 480px){.rst-content .sidebar{width:100%}}span[id*='MathJax-Span']{color:#404040}.math{text-align:center} -/*# sourceMappingURL=theme.css.map */ diff --git a/user_guide_src/source/_themes/sphinx_rtd_theme/static/fonts/FontAwesome.otf b/user_guide_src/source/_themes/sphinx_rtd_theme/static/fonts/FontAwesome.otf Binary files differdeleted file mode 100644 index 8b0f54e47..000000000 --- a/user_guide_src/source/_themes/sphinx_rtd_theme/static/fonts/FontAwesome.otf +++ /dev/null diff --git a/user_guide_src/source/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.eot b/user_guide_src/source/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.eot Binary files differdeleted file mode 100644 index 7c79c6a6b..000000000 --- a/user_guide_src/source/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.eot +++ /dev/null diff --git a/user_guide_src/source/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.svg b/user_guide_src/source/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.svg deleted file mode 100644 index 45fdf3383..000000000 --- a/user_guide_src/source/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.svg +++ /dev/null @@ -1,414 +0,0 @@ -<?xml version="1.0" standalone="no"?> -<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd" > -<svg xmlns="http://www.w3.org/2000/svg"> -<metadata></metadata> -<defs> -<font id="fontawesomeregular" horiz-adv-x="1536" > -<font-face units-per-em="1792" ascent="1536" descent="-256" /> -<missing-glyph horiz-adv-x="448" /> -<glyph unicode=" " horiz-adv-x="448" /> -<glyph unicode="	" horiz-adv-x="448" /> -<glyph unicode=" " horiz-adv-x="448" /> -<glyph unicode="¨" horiz-adv-x="1792" /> -<glyph unicode="©" horiz-adv-x="1792" /> -<glyph unicode="®" horiz-adv-x="1792" /> -<glyph unicode="´" horiz-adv-x="1792" /> -<glyph unicode="Æ" horiz-adv-x="1792" /> -<glyph unicode=" " horiz-adv-x="768" /> -<glyph unicode=" " /> -<glyph unicode=" " horiz-adv-x="768" /> -<glyph unicode=" " /> -<glyph unicode=" " horiz-adv-x="512" /> -<glyph unicode=" " horiz-adv-x="384" /> -<glyph unicode=" " horiz-adv-x="256" /> -<glyph unicode=" " horiz-adv-x="256" /> -<glyph unicode=" " horiz-adv-x="192" /> -<glyph unicode=" " horiz-adv-x="307" /> -<glyph unicode=" " horiz-adv-x="85" /> -<glyph unicode=" " horiz-adv-x="307" /> -<glyph unicode=" " horiz-adv-x="384" /> -<glyph unicode="™" horiz-adv-x="1792" /> -<glyph unicode="∞" horiz-adv-x="1792" /> -<glyph unicode="≠" horiz-adv-x="1792" /> -<glyph unicode="" horiz-adv-x="500" d="M0 0z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1699 1350q0 -35 -43 -78l-632 -632v-768h320q26 0 45 -19t19 -45t-19 -45t-45 -19h-896q-26 0 -45 19t-19 45t19 45t45 19h320v768l-632 632q-43 43 -43 78q0 23 18 36.5t38 17.5t43 4h1408q23 0 43 -4t38 -17.5t18 -36.5z" /> -<glyph unicode="" d="M1536 1312v-1120q0 -50 -34 -89t-86 -60.5t-103.5 -32t-96.5 -10.5t-96.5 10.5t-103.5 32t-86 60.5t-34 89t34 89t86 60.5t103.5 32t96.5 10.5q105 0 192 -39v537l-768 -237v-709q0 -50 -34 -89t-86 -60.5t-103.5 -32t-96.5 -10.5t-96.5 10.5t-103.5 32t-86 60.5t-34 89 t34 89t86 60.5t103.5 32t96.5 10.5q105 0 192 -39v967q0 31 19 56.5t49 35.5l832 256q12 4 28 4q40 0 68 -28t28 -68z" /> -<glyph unicode="" horiz-adv-x="1664" d="M1152 704q0 185 -131.5 316.5t-316.5 131.5t-316.5 -131.5t-131.5 -316.5t131.5 -316.5t316.5 -131.5t316.5 131.5t131.5 316.5zM1664 -128q0 -52 -38 -90t-90 -38q-54 0 -90 38l-343 342q-179 -124 -399 -124q-143 0 -273.5 55.5t-225 150t-150 225t-55.5 273.5 t55.5 273.5t150 225t225 150t273.5 55.5t273.5 -55.5t225 -150t150 -225t55.5 -273.5q0 -220 -124 -399l343 -343q37 -37 37 -90z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1664 32v768q-32 -36 -69 -66q-268 -206 -426 -338q-51 -43 -83 -67t-86.5 -48.5t-102.5 -24.5h-1h-1q-48 0 -102.5 24.5t-86.5 48.5t-83 67q-158 132 -426 338q-37 30 -69 66v-768q0 -13 9.5 -22.5t22.5 -9.5h1472q13 0 22.5 9.5t9.5 22.5zM1664 1083v11v13.5t-0.5 13 t-3 12.5t-5.5 9t-9 7.5t-14 2.5h-1472q-13 0 -22.5 -9.5t-9.5 -22.5q0 -168 147 -284q193 -152 401 -317q6 -5 35 -29.5t46 -37.5t44.5 -31.5t50.5 -27.5t43 -9h1h1q20 0 43 9t50.5 27.5t44.5 31.5t46 37.5t35 29.5q208 165 401 317q54 43 100.5 115.5t46.5 131.5z M1792 1120v-1088q0 -66 -47 -113t-113 -47h-1472q-66 0 -113 47t-47 113v1088q0 66 47 113t113 47h1472q66 0 113 -47t47 -113z" /> -<glyph unicode="" horiz-adv-x="1792" d="M896 -128q-26 0 -44 18l-624 602q-10 8 -27.5 26t-55.5 65.5t-68 97.5t-53.5 121t-23.5 138q0 220 127 344t351 124q62 0 126.5 -21.5t120 -58t95.5 -68.5t76 -68q36 36 76 68t95.5 68.5t120 58t126.5 21.5q224 0 351 -124t127 -344q0 -221 -229 -450l-623 -600 q-18 -18 -44 -18z" /> -<glyph unicode="" horiz-adv-x="1664" d="M1664 889q0 -22 -26 -48l-363 -354l86 -500q1 -7 1 -20q0 -21 -10.5 -35.5t-30.5 -14.5q-19 0 -40 12l-449 236l-449 -236q-22 -12 -40 -12q-21 0 -31.5 14.5t-10.5 35.5q0 6 2 20l86 500l-364 354q-25 27 -25 48q0 37 56 46l502 73l225 455q19 41 49 41t49 -41l225 -455 l502 -73q56 -9 56 -46z" /> -<glyph unicode="" horiz-adv-x="1664" d="M1137 532l306 297l-422 62l-189 382l-189 -382l-422 -62l306 -297l-73 -421l378 199l377 -199zM1664 889q0 -22 -26 -48l-363 -354l86 -500q1 -7 1 -20q0 -50 -41 -50q-19 0 -40 12l-449 236l-449 -236q-22 -12 -40 -12q-21 0 -31.5 14.5t-10.5 35.5q0 6 2 20l86 500 l-364 354q-25 27 -25 48q0 37 56 46l502 73l225 455q19 41 49 41t49 -41l225 -455l502 -73q56 -9 56 -46z" /> -<glyph unicode="" horiz-adv-x="1408" d="M1408 131q0 -120 -73 -189.5t-194 -69.5h-874q-121 0 -194 69.5t-73 189.5q0 53 3.5 103.5t14 109t26.5 108.5t43 97.5t62 81t85.5 53.5t111.5 20q9 0 42 -21.5t74.5 -48t108 -48t133.5 -21.5t133.5 21.5t108 48t74.5 48t42 21.5q61 0 111.5 -20t85.5 -53.5t62 -81 t43 -97.5t26.5 -108.5t14 -109t3.5 -103.5zM1088 1024q0 -159 -112.5 -271.5t-271.5 -112.5t-271.5 112.5t-112.5 271.5t112.5 271.5t271.5 112.5t271.5 -112.5t112.5 -271.5z" /> -<glyph unicode="" horiz-adv-x="1920" d="M384 -64v128q0 26 -19 45t-45 19h-128q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45t45 -19h128q26 0 45 19t19 45zM384 320v128q0 26 -19 45t-45 19h-128q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45t45 -19h128q26 0 45 19t19 45zM384 704v128q0 26 -19 45t-45 19h-128 q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45t45 -19h128q26 0 45 19t19 45zM1408 -64v512q0 26 -19 45t-45 19h-768q-26 0 -45 -19t-19 -45v-512q0 -26 19 -45t45 -19h768q26 0 45 19t19 45zM384 1088v128q0 26 -19 45t-45 19h-128q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45 t45 -19h128q26 0 45 19t19 45zM1792 -64v128q0 26 -19 45t-45 19h-128q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45t45 -19h128q26 0 45 19t19 45zM1408 704v512q0 26 -19 45t-45 19h-768q-26 0 -45 -19t-19 -45v-512q0 -26 19 -45t45 -19h768q26 0 45 19t19 45zM1792 320v128 q0 26 -19 45t-45 19h-128q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45t45 -19h128q26 0 45 19t19 45zM1792 704v128q0 26 -19 45t-45 19h-128q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45t45 -19h128q26 0 45 19t19 45zM1792 1088v128q0 26 -19 45t-45 19h-128q-26 0 -45 -19 t-19 -45v-128q0 -26 19 -45t45 -19h128q26 0 45 19t19 45zM1920 1248v-1344q0 -66 -47 -113t-113 -47h-1600q-66 0 -113 47t-47 113v1344q0 66 47 113t113 47h1600q66 0 113 -47t47 -113z" /> -<glyph unicode="" horiz-adv-x="1664" d="M768 512v-384q0 -52 -38 -90t-90 -38h-512q-52 0 -90 38t-38 90v384q0 52 38 90t90 38h512q52 0 90 -38t38 -90zM768 1280v-384q0 -52 -38 -90t-90 -38h-512q-52 0 -90 38t-38 90v384q0 52 38 90t90 38h512q52 0 90 -38t38 -90zM1664 512v-384q0 -52 -38 -90t-90 -38 h-512q-52 0 -90 38t-38 90v384q0 52 38 90t90 38h512q52 0 90 -38t38 -90zM1664 1280v-384q0 -52 -38 -90t-90 -38h-512q-52 0 -90 38t-38 90v384q0 52 38 90t90 38h512q52 0 90 -38t38 -90z" /> -<glyph unicode="" horiz-adv-x="1792" d="M512 288v-192q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h320q40 0 68 -28t28 -68zM512 800v-192q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h320q40 0 68 -28t28 -68zM1152 288v-192q0 -40 -28 -68t-68 -28h-320 q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h320q40 0 68 -28t28 -68zM512 1312v-192q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h320q40 0 68 -28t28 -68zM1152 800v-192q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v192q0 40 28 68t68 28 h320q40 0 68 -28t28 -68zM1792 288v-192q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h320q40 0 68 -28t28 -68zM1152 1312v-192q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h320q40 0 68 -28t28 -68zM1792 800v-192 q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h320q40 0 68 -28t28 -68zM1792 1312v-192q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h320q40 0 68 -28t28 -68z" /> -<glyph unicode="" horiz-adv-x="1792" d="M512 288v-192q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h320q40 0 68 -28t28 -68zM512 800v-192q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h320q40 0 68 -28t28 -68zM1792 288v-192q0 -40 -28 -68t-68 -28h-960 q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h960q40 0 68 -28t28 -68zM512 1312v-192q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h320q40 0 68 -28t28 -68zM1792 800v-192q0 -40 -28 -68t-68 -28h-960q-40 0 -68 28t-28 68v192q0 40 28 68t68 28 h960q40 0 68 -28t28 -68zM1792 1312v-192q0 -40 -28 -68t-68 -28h-960q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h960q40 0 68 -28t28 -68z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1671 970q0 -40 -28 -68l-724 -724l-136 -136q-28 -28 -68 -28t-68 28l-136 136l-362 362q-28 28 -28 68t28 68l136 136q28 28 68 28t68 -28l294 -295l656 657q28 28 68 28t68 -28l136 -136q28 -28 28 -68z" /> -<glyph unicode="" horiz-adv-x="1408" d="M1298 214q0 -40 -28 -68l-136 -136q-28 -28 -68 -28t-68 28l-294 294l-294 -294q-28 -28 -68 -28t-68 28l-136 136q-28 28 -28 68t28 68l294 294l-294 294q-28 28 -28 68t28 68l136 136q28 28 68 28t68 -28l294 -294l294 294q28 28 68 28t68 -28l136 -136q28 -28 28 -68 t-28 -68l-294 -294l294 -294q28 -28 28 -68z" /> -<glyph unicode="" horiz-adv-x="1664" d="M1024 736v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-224v-224q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v224h-224q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h224v224q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5v-224h224 q13 0 22.5 -9.5t9.5 -22.5zM1152 704q0 185 -131.5 316.5t-316.5 131.5t-316.5 -131.5t-131.5 -316.5t131.5 -316.5t316.5 -131.5t316.5 131.5t131.5 316.5zM1664 -128q0 -53 -37.5 -90.5t-90.5 -37.5q-54 0 -90 38l-343 342q-179 -124 -399 -124q-143 0 -273.5 55.5 t-225 150t-150 225t-55.5 273.5t55.5 273.5t150 225t225 150t273.5 55.5t273.5 -55.5t225 -150t150 -225t55.5 -273.5q0 -220 -124 -399l343 -343q37 -37 37 -90z" /> -<glyph unicode="" horiz-adv-x="1664" d="M1024 736v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-576q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h576q13 0 22.5 -9.5t9.5 -22.5zM1152 704q0 185 -131.5 316.5t-316.5 131.5t-316.5 -131.5t-131.5 -316.5t131.5 -316.5t316.5 -131.5t316.5 131.5t131.5 316.5z M1664 -128q0 -53 -37.5 -90.5t-90.5 -37.5q-54 0 -90 38l-343 342q-179 -124 -399 -124q-143 0 -273.5 55.5t-225 150t-150 225t-55.5 273.5t55.5 273.5t150 225t225 150t273.5 55.5t273.5 -55.5t225 -150t150 -225t55.5 -273.5q0 -220 -124 -399l343 -343q37 -37 37 -90z " /> -<glyph unicode="" d="M1536 640q0 -156 -61 -298t-164 -245t-245 -164t-298 -61t-298 61t-245 164t-164 245t-61 298q0 182 80.5 343t226.5 270q43 32 95.5 25t83.5 -50q32 -42 24.5 -94.5t-49.5 -84.5q-98 -74 -151.5 -181t-53.5 -228q0 -104 40.5 -198.5t109.5 -163.5t163.5 -109.5 t198.5 -40.5t198.5 40.5t163.5 109.5t109.5 163.5t40.5 198.5q0 121 -53.5 228t-151.5 181q-42 32 -49.5 84.5t24.5 94.5q31 43 84 50t95 -25q146 -109 226.5 -270t80.5 -343zM896 1408v-640q0 -52 -38 -90t-90 -38t-90 38t-38 90v640q0 52 38 90t90 38t90 -38t38 -90z" /> -<glyph unicode="" horiz-adv-x="1792" d="M256 96v-192q0 -14 -9 -23t-23 -9h-192q-14 0 -23 9t-9 23v192q0 14 9 23t23 9h192q14 0 23 -9t9 -23zM640 224v-320q0 -14 -9 -23t-23 -9h-192q-14 0 -23 9t-9 23v320q0 14 9 23t23 9h192q14 0 23 -9t9 -23zM1024 480v-576q0 -14 -9 -23t-23 -9h-192q-14 0 -23 9t-9 23 v576q0 14 9 23t23 9h192q14 0 23 -9t9 -23zM1408 864v-960q0 -14 -9 -23t-23 -9h-192q-14 0 -23 9t-9 23v960q0 14 9 23t23 9h192q14 0 23 -9t9 -23zM1792 1376v-1472q0 -14 -9 -23t-23 -9h-192q-14 0 -23 9t-9 23v1472q0 14 9 23t23 9h192q14 0 23 -9t9 -23z" /> -<glyph unicode="" d="M1024 640q0 106 -75 181t-181 75t-181 -75t-75 -181t75 -181t181 -75t181 75t75 181zM1536 749v-222q0 -12 -8 -23t-20 -13l-185 -28q-19 -54 -39 -91q35 -50 107 -138q10 -12 10 -25t-9 -23q-27 -37 -99 -108t-94 -71q-12 0 -26 9l-138 108q-44 -23 -91 -38 q-16 -136 -29 -186q-7 -28 -36 -28h-222q-14 0 -24.5 8.5t-11.5 21.5l-28 184q-49 16 -90 37l-141 -107q-10 -9 -25 -9q-14 0 -25 11q-126 114 -165 168q-7 10 -7 23q0 12 8 23q15 21 51 66.5t54 70.5q-27 50 -41 99l-183 27q-13 2 -21 12.5t-8 23.5v222q0 12 8 23t19 13 l186 28q14 46 39 92q-40 57 -107 138q-10 12 -10 24q0 10 9 23q26 36 98.5 107.5t94.5 71.5q13 0 26 -10l138 -107q44 23 91 38q16 136 29 186q7 28 36 28h222q14 0 24.5 -8.5t11.5 -21.5l28 -184q49 -16 90 -37l142 107q9 9 24 9q13 0 25 -10q129 -119 165 -170q7 -8 7 -22 q0 -12 -8 -23q-15 -21 -51 -66.5t-54 -70.5q26 -50 41 -98l183 -28q13 -2 21 -12.5t8 -23.5z" /> -<glyph unicode="" horiz-adv-x="1408" d="M512 800v-576q0 -14 -9 -23t-23 -9h-64q-14 0 -23 9t-9 23v576q0 14 9 23t23 9h64q14 0 23 -9t9 -23zM768 800v-576q0 -14 -9 -23t-23 -9h-64q-14 0 -23 9t-9 23v576q0 14 9 23t23 9h64q14 0 23 -9t9 -23zM1024 800v-576q0 -14 -9 -23t-23 -9h-64q-14 0 -23 9t-9 23v576 q0 14 9 23t23 9h64q14 0 23 -9t9 -23zM1152 76v948h-896v-948q0 -22 7 -40.5t14.5 -27t10.5 -8.5h832q3 0 10.5 8.5t14.5 27t7 40.5zM480 1152h448l-48 117q-7 9 -17 11h-317q-10 -2 -17 -11zM1408 1120v-64q0 -14 -9 -23t-23 -9h-96v-948q0 -83 -47 -143.5t-113 -60.5h-832 q-66 0 -113 58.5t-47 141.5v952h-96q-14 0 -23 9t-9 23v64q0 14 9 23t23 9h309l70 167q15 37 54 63t79 26h320q40 0 79 -26t54 -63l70 -167h309q14 0 23 -9t9 -23z" /> -<glyph unicode="" horiz-adv-x="1664" d="M1408 544v-480q0 -26 -19 -45t-45 -19h-384v384h-256v-384h-384q-26 0 -45 19t-19 45v480q0 1 0.5 3t0.5 3l575 474l575 -474q1 -2 1 -6zM1631 613l-62 -74q-8 -9 -21 -11h-3q-13 0 -21 7l-692 577l-692 -577q-12 -8 -24 -7q-13 2 -21 11l-62 74q-8 10 -7 23.5t11 21.5 l719 599q32 26 76 26t76 -26l244 -204v195q0 14 9 23t23 9h192q14 0 23 -9t9 -23v-408l219 -182q10 -8 11 -21.5t-7 -23.5z" /> -<glyph unicode="" horiz-adv-x="1280" d="M128 0h1024v768h-416q-40 0 -68 28t-28 68v416h-512v-1280zM768 896h376q-10 29 -22 41l-313 313q-12 12 -41 22v-376zM1280 864v-896q0 -40 -28 -68t-68 -28h-1088q-40 0 -68 28t-28 68v1344q0 40 28 68t68 28h640q40 0 88 -20t76 -48l312 -312q28 -28 48 -76t20 -88z " /> -<glyph unicode="" d="M896 992v-448q0 -14 -9 -23t-23 -9h-320q-14 0 -23 9t-9 23v64q0 14 9 23t23 9h224v352q0 14 9 23t23 9h64q14 0 23 -9t9 -23zM1312 640q0 148 -73 273t-198 198t-273 73t-273 -73t-198 -198t-73 -273t73 -273t198 -198t273 -73t273 73t198 198t73 273zM1536 640 q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" horiz-adv-x="1920" d="M1111 540v4l-24 320q-1 13 -11 22.5t-23 9.5h-186q-13 0 -23 -9.5t-11 -22.5l-24 -320v-4q-1 -12 8 -20t21 -8h244q12 0 21 8t8 20zM1870 73q0 -73 -46 -73h-704q13 0 22 9.5t8 22.5l-20 256q-1 13 -11 22.5t-23 9.5h-272q-13 0 -23 -9.5t-11 -22.5l-20 -256 q-1 -13 8 -22.5t22 -9.5h-704q-46 0 -46 73q0 54 26 116l417 1044q8 19 26 33t38 14h339q-13 0 -23 -9.5t-11 -22.5l-15 -192q-1 -14 8 -23t22 -9h166q13 0 22 9t8 23l-15 192q-1 13 -11 22.5t-23 9.5h339q20 0 38 -14t26 -33l417 -1044q26 -62 26 -116z" /> -<glyph unicode="" horiz-adv-x="1664" d="M1280 192q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1536 192q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1664 416v-320q0 -40 -28 -68t-68 -28h-1472q-40 0 -68 28t-28 68v320q0 40 28 68t68 28h465l135 -136 q58 -56 136 -56t136 56l136 136h464q40 0 68 -28t28 -68zM1339 985q17 -41 -14 -70l-448 -448q-18 -19 -45 -19t-45 19l-448 448q-31 29 -14 70q17 39 59 39h256v448q0 26 19 45t45 19h256q26 0 45 -19t19 -45v-448h256q42 0 59 -39z" /> -<glyph unicode="" d="M1120 608q0 -12 -10 -24l-319 -319q-11 -9 -23 -9t-23 9l-320 320q-15 16 -7 35q8 20 30 20h192v352q0 14 9 23t23 9h192q14 0 23 -9t9 -23v-352h192q14 0 23 -9t9 -23zM768 1184q-148 0 -273 -73t-198 -198t-73 -273t73 -273t198 -198t273 -73t273 73t198 198t73 273 t-73 273t-198 198t-273 73zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" d="M1118 660q-8 -20 -30 -20h-192v-352q0 -14 -9 -23t-23 -9h-192q-14 0 -23 9t-9 23v352h-192q-14 0 -23 9t-9 23q0 12 10 24l319 319q11 9 23 9t23 -9l320 -320q15 -16 7 -35zM768 1184q-148 0 -273 -73t-198 -198t-73 -273t73 -273t198 -198t273 -73t273 73t198 198 t73 273t-73 273t-198 198t-273 73zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" d="M1023 576h316q-1 3 -2.5 8t-2.5 8l-212 496h-708l-212 -496q-1 -2 -2.5 -8t-2.5 -8h316l95 -192h320zM1536 546v-482q0 -26 -19 -45t-45 -19h-1408q-26 0 -45 19t-19 45v482q0 62 25 123l238 552q10 25 36.5 42t52.5 17h832q26 0 52.5 -17t36.5 -42l238 -552 q25 -61 25 -123z" /> -<glyph unicode="" d="M1184 640q0 -37 -32 -55l-544 -320q-15 -9 -32 -9q-16 0 -32 8q-32 19 -32 56v640q0 37 32 56q33 18 64 -1l544 -320q32 -18 32 -55zM1312 640q0 148 -73 273t-198 198t-273 73t-273 -73t-198 -198t-73 -273t73 -273t198 -198t273 -73t273 73t198 198t73 273zM1536 640 q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" d="M1536 1280v-448q0 -26 -19 -45t-45 -19h-448q-42 0 -59 40q-17 39 14 69l138 138q-148 137 -349 137q-104 0 -198.5 -40.5t-163.5 -109.5t-109.5 -163.5t-40.5 -198.5t40.5 -198.5t109.5 -163.5t163.5 -109.5t198.5 -40.5q119 0 225 52t179 147q7 10 23 12q14 0 25 -9 l137 -138q9 -8 9.5 -20.5t-7.5 -22.5q-109 -132 -264 -204.5t-327 -72.5q-156 0 -298 61t-245 164t-164 245t-61 298t61 298t164 245t245 164t298 61q147 0 284.5 -55.5t244.5 -156.5l130 129q29 31 70 14q39 -17 39 -59z" /> -<glyph unicode="" d="M1511 480q0 -5 -1 -7q-64 -268 -268 -434.5t-478 -166.5q-146 0 -282.5 55t-243.5 157l-129 -129q-19 -19 -45 -19t-45 19t-19 45v448q0 26 19 45t45 19h448q26 0 45 -19t19 -45t-19 -45l-137 -137q71 -66 161 -102t187 -36q134 0 250 65t186 179q11 17 53 117 q8 23 30 23h192q13 0 22.5 -9.5t9.5 -22.5zM1536 1280v-448q0 -26 -19 -45t-45 -19h-448q-26 0 -45 19t-19 45t19 45l138 138q-148 137 -349 137q-134 0 -250 -65t-186 -179q-11 -17 -53 -117q-8 -23 -30 -23h-199q-13 0 -22.5 9.5t-9.5 22.5v7q65 268 270 434.5t480 166.5 q146 0 284 -55.5t245 -156.5l130 129q19 19 45 19t45 -19t19 -45z" /> -<glyph unicode="" horiz-adv-x="1792" d="M384 352v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM384 608v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5z M384 864v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM1536 352v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-960q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h960q13 0 22.5 -9.5t9.5 -22.5z M1536 608v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-960q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h960q13 0 22.5 -9.5t9.5 -22.5zM1536 864v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-960q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h960q13 0 22.5 -9.5 t9.5 -22.5zM1664 160v832q0 13 -9.5 22.5t-22.5 9.5h-1472q-13 0 -22.5 -9.5t-9.5 -22.5v-832q0 -13 9.5 -22.5t22.5 -9.5h1472q13 0 22.5 9.5t9.5 22.5zM1792 1248v-1088q0 -66 -47 -113t-113 -47h-1472q-66 0 -113 47t-47 113v1088q0 66 47 113t113 47h1472q66 0 113 -47 t47 -113z" /> -<glyph unicode="" horiz-adv-x="1152" d="M320 768h512v192q0 106 -75 181t-181 75t-181 -75t-75 -181v-192zM1152 672v-576q0 -40 -28 -68t-68 -28h-960q-40 0 -68 28t-28 68v576q0 40 28 68t68 28h32v192q0 184 132 316t316 132t316 -132t132 -316v-192h32q40 0 68 -28t28 -68z" /> -<glyph unicode="" horiz-adv-x="1792" d="M320 1280q0 -72 -64 -110v-1266q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v1266q-64 38 -64 110q0 53 37.5 90.5t90.5 37.5t90.5 -37.5t37.5 -90.5zM1792 1216v-763q0 -25 -12.5 -38.5t-39.5 -27.5q-215 -116 -369 -116q-61 0 -123.5 22t-108.5 48 t-115.5 48t-142.5 22q-192 0 -464 -146q-17 -9 -33 -9q-26 0 -45 19t-19 45v742q0 32 31 55q21 14 79 43q236 120 421 120q107 0 200 -29t219 -88q38 -19 88 -19q54 0 117.5 21t110 47t88 47t54.5 21q26 0 45 -19t19 -45z" /> -<glyph unicode="" horiz-adv-x="1664" d="M1664 650q0 -166 -60 -314l-20 -49l-185 -33q-22 -83 -90.5 -136.5t-156.5 -53.5v-32q0 -14 -9 -23t-23 -9h-64q-14 0 -23 9t-9 23v576q0 14 9 23t23 9h64q14 0 23 -9t9 -23v-32q71 0 130 -35.5t93 -95.5l68 12q29 95 29 193q0 148 -88 279t-236.5 209t-315.5 78 t-315.5 -78t-236.5 -209t-88 -279q0 -98 29 -193l68 -12q34 60 93 95.5t130 35.5v32q0 14 9 23t23 9h64q14 0 23 -9t9 -23v-576q0 -14 -9 -23t-23 -9h-64q-14 0 -23 9t-9 23v32q-88 0 -156.5 53.5t-90.5 136.5l-185 33l-20 49q-60 148 -60 314q0 151 67 291t179 242.5 t266 163.5t320 61t320 -61t266 -163.5t179 -242.5t67 -291z" /> -<glyph unicode="" horiz-adv-x="768" d="M768 1184v-1088q0 -26 -19 -45t-45 -19t-45 19l-333 333h-262q-26 0 -45 19t-19 45v384q0 26 19 45t45 19h262l333 333q19 19 45 19t45 -19t19 -45z" /> -<glyph unicode="" horiz-adv-x="1152" d="M768 1184v-1088q0 -26 -19 -45t-45 -19t-45 19l-333 333h-262q-26 0 -45 19t-19 45v384q0 26 19 45t45 19h262l333 333q19 19 45 19t45 -19t19 -45zM1152 640q0 -76 -42.5 -141.5t-112.5 -93.5q-10 -5 -25 -5q-26 0 -45 18.5t-19 45.5q0 21 12 35.5t29 25t34 23t29 35.5 t12 57t-12 57t-29 35.5t-34 23t-29 25t-12 35.5q0 27 19 45.5t45 18.5q15 0 25 -5q70 -27 112.5 -93t42.5 -142z" /> -<glyph unicode="" horiz-adv-x="1664" d="M768 1184v-1088q0 -26 -19 -45t-45 -19t-45 19l-333 333h-262q-26 0 -45 19t-19 45v384q0 26 19 45t45 19h262l333 333q19 19 45 19t45 -19t19 -45zM1152 640q0 -76 -42.5 -141.5t-112.5 -93.5q-10 -5 -25 -5q-26 0 -45 18.5t-19 45.5q0 21 12 35.5t29 25t34 23t29 35.5 t12 57t-12 57t-29 35.5t-34 23t-29 25t-12 35.5q0 27 19 45.5t45 18.5q15 0 25 -5q70 -27 112.5 -93t42.5 -142zM1408 640q0 -153 -85 -282.5t-225 -188.5q-13 -5 -25 -5q-27 0 -46 19t-19 45q0 39 39 59q56 29 76 44q74 54 115.5 135.5t41.5 173.5t-41.5 173.5 t-115.5 135.5q-20 15 -76 44q-39 20 -39 59q0 26 19 45t45 19q13 0 26 -5q140 -59 225 -188.5t85 -282.5zM1664 640q0 -230 -127 -422.5t-338 -283.5q-13 -5 -26 -5q-26 0 -45 19t-19 45q0 36 39 59q7 4 22.5 10.5t22.5 10.5q46 25 82 51q123 91 192 227t69 289t-69 289 t-192 227q-36 26 -82 51q-7 4 -22.5 10.5t-22.5 10.5q-39 23 -39 59q0 26 19 45t45 19q13 0 26 -5q211 -91 338 -283.5t127 -422.5z" /> -<glyph unicode="" horiz-adv-x="1408" d="M384 384v-128h-128v128h128zM384 1152v-128h-128v128h128zM1152 1152v-128h-128v128h128zM128 129h384v383h-384v-383zM128 896h384v384h-384v-384zM896 896h384v384h-384v-384zM640 640v-640h-640v640h640zM1152 128v-128h-128v128h128zM1408 128v-128h-128v128h128z M1408 640v-384h-384v128h-128v-384h-128v640h384v-128h128v128h128zM640 1408v-640h-640v640h640zM1408 1408v-640h-640v640h640z" /> -<glyph unicode="" horiz-adv-x="1792" d="M63 0h-63v1408h63v-1408zM126 1h-32v1407h32v-1407zM220 1h-31v1407h31v-1407zM377 1h-31v1407h31v-1407zM534 1h-62v1407h62v-1407zM660 1h-31v1407h31v-1407zM723 1h-31v1407h31v-1407zM786 1h-31v1407h31v-1407zM943 1h-63v1407h63v-1407zM1100 1h-63v1407h63v-1407z M1226 1h-63v1407h63v-1407zM1352 1h-63v1407h63v-1407zM1446 1h-63v1407h63v-1407zM1635 1h-94v1407h94v-1407zM1698 1h-32v1407h32v-1407zM1792 0h-63v1408h63v-1408z" /> -<glyph unicode="" d="M448 1088q0 53 -37.5 90.5t-90.5 37.5t-90.5 -37.5t-37.5 -90.5t37.5 -90.5t90.5 -37.5t90.5 37.5t37.5 90.5zM1515 512q0 -53 -37 -90l-491 -492q-39 -37 -91 -37q-53 0 -90 37l-715 716q-38 37 -64.5 101t-26.5 117v416q0 52 38 90t90 38h416q53 0 117 -26.5t102 -64.5 l715 -714q37 -39 37 -91z" /> -<glyph unicode="" horiz-adv-x="1920" d="M448 1088q0 53 -37.5 90.5t-90.5 37.5t-90.5 -37.5t-37.5 -90.5t37.5 -90.5t90.5 -37.5t90.5 37.5t37.5 90.5zM1515 512q0 -53 -37 -90l-491 -492q-39 -37 -91 -37q-53 0 -90 37l-715 716q-38 37 -64.5 101t-26.5 117v416q0 52 38 90t90 38h416q53 0 117 -26.5t102 -64.5 l715 -714q37 -39 37 -91zM1899 512q0 -53 -37 -90l-491 -492q-39 -37 -91 -37q-36 0 -59 14t-53 45l470 470q37 37 37 90q0 52 -37 91l-715 714q-38 38 -102 64.5t-117 26.5h224q53 0 117 -26.5t102 -64.5l715 -714q37 -39 37 -91z" /> -<glyph unicode="" horiz-adv-x="1664" d="M1639 1058q40 -57 18 -129l-275 -906q-19 -64 -76.5 -107.5t-122.5 -43.5h-923q-77 0 -148.5 53.5t-99.5 131.5q-24 67 -2 127q0 4 3 27t4 37q1 8 -3 21.5t-3 19.5q2 11 8 21t16.5 23.5t16.5 23.5q23 38 45 91.5t30 91.5q3 10 0.5 30t-0.5 28q3 11 17 28t17 23 q21 36 42 92t25 90q1 9 -2.5 32t0.5 28q4 13 22 30.5t22 22.5q19 26 42.5 84.5t27.5 96.5q1 8 -3 25.5t-2 26.5q2 8 9 18t18 23t17 21q8 12 16.5 30.5t15 35t16 36t19.5 32t26.5 23.5t36 11.5t47.5 -5.5l-1 -3q38 9 51 9h761q74 0 114 -56t18 -130l-274 -906 q-36 -119 -71.5 -153.5t-128.5 -34.5h-869q-27 0 -38 -15q-11 -16 -1 -43q24 -70 144 -70h923q29 0 56 15.5t35 41.5l300 987q7 22 5 57q38 -15 59 -43zM575 1056q-4 -13 2 -22.5t20 -9.5h608q13 0 25.5 9.5t16.5 22.5l21 64q4 13 -2 22.5t-20 9.5h-608q-13 0 -25.5 -9.5 t-16.5 -22.5zM492 800q-4 -13 2 -22.5t20 -9.5h608q13 0 25.5 9.5t16.5 22.5l21 64q4 13 -2 22.5t-20 9.5h-608q-13 0 -25.5 -9.5t-16.5 -22.5z" /> -<glyph unicode="" horiz-adv-x="1280" d="M1164 1408q23 0 44 -9q33 -13 52.5 -41t19.5 -62v-1289q0 -34 -19.5 -62t-52.5 -41q-19 -8 -44 -8q-48 0 -83 32l-441 424l-441 -424q-36 -33 -83 -33q-23 0 -44 9q-33 13 -52.5 41t-19.5 62v1289q0 34 19.5 62t52.5 41q21 9 44 9h1048z" /> -<glyph unicode="" horiz-adv-x="1664" d="M384 0h896v256h-896v-256zM384 640h896v384h-160q-40 0 -68 28t-28 68v160h-640v-640zM1536 576q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1664 576v-416q0 -13 -9.5 -22.5t-22.5 -9.5h-224v-160q0 -40 -28 -68t-68 -28h-960q-40 0 -68 28t-28 68 v160h-224q-13 0 -22.5 9.5t-9.5 22.5v416q0 79 56.5 135.5t135.5 56.5h64v544q0 40 28 68t68 28h672q40 0 88 -20t76 -48l152 -152q28 -28 48 -76t20 -88v-256h64q79 0 135.5 -56.5t56.5 -135.5z" /> -<glyph unicode="" horiz-adv-x="1920" d="M960 864q119 0 203.5 -84.5t84.5 -203.5t-84.5 -203.5t-203.5 -84.5t-203.5 84.5t-84.5 203.5t84.5 203.5t203.5 84.5zM1664 1280q106 0 181 -75t75 -181v-896q0 -106 -75 -181t-181 -75h-1408q-106 0 -181 75t-75 181v896q0 106 75 181t181 75h224l51 136 q19 49 69.5 84.5t103.5 35.5h512q53 0 103.5 -35.5t69.5 -84.5l51 -136h224zM960 128q185 0 316.5 131.5t131.5 316.5t-131.5 316.5t-316.5 131.5t-316.5 -131.5t-131.5 -316.5t131.5 -316.5t316.5 -131.5z" /> -<glyph unicode="" horiz-adv-x="1664" d="M725 977l-170 -450q73 -1 153.5 -2t119 -1.5t52.5 -0.5l29 2q-32 95 -92 241q-53 132 -92 211zM21 -128h-21l2 79q22 7 80 18q89 16 110 31q20 16 48 68l237 616l280 724h75h53l11 -21l205 -480q103 -242 124 -297q39 -102 96 -235q26 -58 65 -164q24 -67 65 -149 q22 -49 35 -57q22 -19 69 -23q47 -6 103 -27q6 -39 6 -57q0 -14 -1 -26q-80 0 -192 8q-93 8 -189 8q-79 0 -135 -2l-200 -11l-58 -2q0 45 4 78l131 28q56 13 68 23q12 12 12 27t-6 32l-47 114l-92 228l-450 2q-29 -65 -104 -274q-23 -64 -23 -84q0 -31 17 -43 q26 -21 103 -32q3 0 13.5 -2t30 -5t40.5 -6q1 -28 1 -58q0 -17 -2 -27q-66 0 -349 20l-48 -8q-81 -14 -167 -14z" /> -<glyph unicode="" horiz-adv-x="1408" d="M555 15q76 -32 140 -32q131 0 216 41t122 113q38 70 38 181q0 114 -41 180q-58 94 -141 126q-80 32 -247 32q-74 0 -101 -10v-144l-1 -173l3 -270q0 -15 12 -44zM541 761q43 -7 109 -7q175 0 264 65t89 224q0 112 -85 187q-84 75 -255 75q-52 0 -130 -13q0 -44 2 -77 q7 -122 6 -279l-1 -98q0 -43 1 -77zM0 -128l2 94q45 9 68 12q77 12 123 31q17 27 21 51q9 66 9 194l-2 497q-5 256 -9 404q-1 87 -11 109q-1 4 -12 12q-18 12 -69 15q-30 2 -114 13l-4 83l260 6l380 13l45 1q5 0 14 0.5t14 0.5q1 0 21.5 -0.5t40.5 -0.5h74q88 0 191 -27 q43 -13 96 -39q57 -29 102 -76q44 -47 65 -104t21 -122q0 -70 -32 -128t-95 -105q-26 -20 -150 -77q177 -41 267 -146q92 -106 92 -236q0 -76 -29 -161q-21 -62 -71 -117q-66 -72 -140 -108q-73 -36 -203 -60q-82 -15 -198 -11l-197 4q-84 2 -298 -11q-33 -3 -272 -11z" /> -<glyph unicode="" horiz-adv-x="1024" d="M0 -126l17 85q4 1 77 20q76 19 116 39q29 37 41 101l27 139l56 268l12 64q8 44 17 84.5t16 67t12.5 46.5t9 30.5t3.5 11.5l29 157l16 63l22 135l8 50v38q-41 22 -144 28q-28 2 -38 4l19 103l317 -14q39 -2 73 -2q66 0 214 9q33 2 68 4.5t36 2.5q-2 -19 -6 -38 q-7 -29 -13 -51q-55 -19 -109 -31q-64 -16 -101 -31q-12 -31 -24 -88q-9 -44 -13 -82q-44 -199 -66 -306l-61 -311l-38 -158l-43 -235l-12 -45q-2 -7 1 -27q64 -15 119 -21q36 -5 66 -10q-1 -29 -7 -58q-7 -31 -9 -41q-18 0 -23 -1q-24 -2 -42 -2q-9 0 -28 3q-19 4 -145 17 l-198 2q-41 1 -174 -11q-74 -7 -98 -9z" /> -<glyph unicode="" horiz-adv-x="1792" d="M81 1407l54 -27q20 -5 211 -5h130l19 3l115 1l215 -1h293l34 -2q14 -1 28 7t21 16l7 8l42 1q15 0 28 -1v-104.5t1 -131.5l1 -100l-1 -58q0 -32 -4 -51q-39 -15 -68 -18q-25 43 -54 128q-8 24 -15.5 62.5t-11.5 65.5t-6 29q-13 15 -27 19q-7 2 -42.5 2t-103.5 -1t-111 -1 q-34 0 -67 -5q-10 -97 -8 -136l1 -152v-332l3 -359l-1 -147q-1 -46 11 -85q49 -25 89 -32q2 0 18 -5t44 -13t43 -12q30 -8 50 -18q5 -45 5 -50q0 -10 -3 -29q-14 -1 -34 -1q-110 0 -187 10q-72 8 -238 8q-88 0 -233 -14q-48 -4 -70 -4q-2 22 -2 26l-1 26v9q21 33 79 49 q139 38 159 50q9 21 12 56q8 192 6 433l-5 428q-1 62 -0.5 118.5t0.5 102.5t-2 57t-6 15q-6 5 -14 6q-38 6 -148 6q-43 0 -100 -13.5t-73 -24.5q-13 -9 -22 -33t-22 -75t-24 -84q-6 -19 -19.5 -32t-20.5 -13q-44 27 -56 44v297v86zM1744 128q33 0 42 -18.5t-11 -44.5 l-126 -162q-20 -26 -49 -26t-49 26l-126 162q-20 26 -11 44.5t42 18.5h80v1024h-80q-33 0 -42 18.5t11 44.5l126 162q20 26 49 26t49 -26l126 -162q20 -26 11 -44.5t-42 -18.5h-80v-1024h80z" /> -<glyph unicode="" d="M81 1407l54 -27q20 -5 211 -5h130l19 3l115 1l446 -1h318l34 -2q14 -1 28 7t21 16l7 8l42 1q15 0 28 -1v-104.5t1 -131.5l1 -100l-1 -58q0 -32 -4 -51q-39 -15 -68 -18q-25 43 -54 128q-8 24 -15.5 62.5t-11.5 65.5t-6 29q-13 15 -27 19q-7 2 -58.5 2t-138.5 -1t-128 -1 q-94 0 -127 -5q-10 -97 -8 -136l1 -152v52l3 -359l-1 -147q-1 -46 11 -85q49 -25 89 -32q2 0 18 -5t44 -13t43 -12q30 -8 50 -18q5 -45 5 -50q0 -10 -3 -29q-14 -1 -34 -1q-110 0 -187 10q-72 8 -238 8q-82 0 -233 -13q-45 -5 -70 -5q-2 22 -2 26l-1 26v9q21 33 79 49 q139 38 159 50q9 21 12 56q6 137 6 433l-5 44q0 265 -2 278q-2 11 -6 15q-6 5 -14 6q-38 6 -148 6q-50 0 -168.5 -14t-132.5 -24q-13 -9 -22 -33t-22 -75t-24 -84q-6 -19 -19.5 -32t-20.5 -13q-44 27 -56 44v297v86zM1505 113q26 -20 26 -49t-26 -49l-162 -126 q-26 -20 -44.5 -11t-18.5 42v80h-1024v-80q0 -33 -18.5 -42t-44.5 11l-162 126q-26 20 -26 49t26 49l162 126q26 20 44.5 11t18.5 -42v-80h1024v80q0 33 18.5 42t44.5 -11z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1792 192v-128q0 -26 -19 -45t-45 -19h-1664q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1664q26 0 45 -19t19 -45zM1408 576v-128q0 -26 -19 -45t-45 -19h-1280q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1280q26 0 45 -19t19 -45zM1664 960v-128q0 -26 -19 -45 t-45 -19h-1536q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1536q26 0 45 -19t19 -45zM1280 1344v-128q0 -26 -19 -45t-45 -19h-1152q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1152q26 0 45 -19t19 -45z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1792 192v-128q0 -26 -19 -45t-45 -19h-1664q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1664q26 0 45 -19t19 -45zM1408 576v-128q0 -26 -19 -45t-45 -19h-896q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h896q26 0 45 -19t19 -45zM1664 960v-128q0 -26 -19 -45t-45 -19 h-1408q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1408q26 0 45 -19t19 -45zM1280 1344v-128q0 -26 -19 -45t-45 -19h-640q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h640q26 0 45 -19t19 -45z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1792 192v-128q0 -26 -19 -45t-45 -19h-1664q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1664q26 0 45 -19t19 -45zM1792 576v-128q0 -26 -19 -45t-45 -19h-1280q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1280q26 0 45 -19t19 -45zM1792 960v-128q0 -26 -19 -45 t-45 -19h-1536q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1536q26 0 45 -19t19 -45zM1792 1344v-128q0 -26 -19 -45t-45 -19h-1152q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1152q26 0 45 -19t19 -45z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1792 192v-128q0 -26 -19 -45t-45 -19h-1664q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1664q26 0 45 -19t19 -45zM1792 576v-128q0 -26 -19 -45t-45 -19h-1664q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1664q26 0 45 -19t19 -45zM1792 960v-128q0 -26 -19 -45 t-45 -19h-1664q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1664q26 0 45 -19t19 -45zM1792 1344v-128q0 -26 -19 -45t-45 -19h-1664q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1664q26 0 45 -19t19 -45z" /> -<glyph unicode="" horiz-adv-x="1792" d="M256 224v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-192q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h192q13 0 22.5 -9.5t9.5 -22.5zM256 608v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-192q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h192q13 0 22.5 -9.5 t9.5 -22.5zM256 992v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-192q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h192q13 0 22.5 -9.5t9.5 -22.5zM1792 224v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1344q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1344 q13 0 22.5 -9.5t9.5 -22.5zM256 1376v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-192q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h192q13 0 22.5 -9.5t9.5 -22.5zM1792 608v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1344q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5 t22.5 9.5h1344q13 0 22.5 -9.5t9.5 -22.5zM1792 992v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1344q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1344q13 0 22.5 -9.5t9.5 -22.5zM1792 1376v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1344q-13 0 -22.5 9.5t-9.5 22.5v192 q0 13 9.5 22.5t22.5 9.5h1344q13 0 22.5 -9.5t9.5 -22.5z" /> -<glyph unicode="" horiz-adv-x="1792" d="M384 992v-576q0 -13 -9.5 -22.5t-22.5 -9.5q-14 0 -23 9l-288 288q-9 9 -9 23t9 23l288 288q9 9 23 9q13 0 22.5 -9.5t9.5 -22.5zM1792 224v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1728q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1728q13 0 22.5 -9.5 t9.5 -22.5zM1792 608v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1088q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1088q13 0 22.5 -9.5t9.5 -22.5zM1792 992v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1088q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1088 q13 0 22.5 -9.5t9.5 -22.5zM1792 1376v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1728q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1728q13 0 22.5 -9.5t9.5 -22.5z" /> -<glyph unicode="" horiz-adv-x="1792" d="M352 704q0 -14 -9 -23l-288 -288q-9 -9 -23 -9q-13 0 -22.5 9.5t-9.5 22.5v576q0 13 9.5 22.5t22.5 9.5q14 0 23 -9l288 -288q9 -9 9 -23zM1792 224v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1728q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1728q13 0 22.5 -9.5 t9.5 -22.5zM1792 608v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1088q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1088q13 0 22.5 -9.5t9.5 -22.5zM1792 992v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1088q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1088 q13 0 22.5 -9.5t9.5 -22.5zM1792 1376v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1728q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1728q13 0 22.5 -9.5t9.5 -22.5z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1792 1184v-1088q0 -42 -39 -59q-13 -5 -25 -5q-27 0 -45 19l-403 403v-166q0 -119 -84.5 -203.5t-203.5 -84.5h-704q-119 0 -203.5 84.5t-84.5 203.5v704q0 119 84.5 203.5t203.5 84.5h704q119 0 203.5 -84.5t84.5 -203.5v-165l403 402q18 19 45 19q12 0 25 -5 q39 -17 39 -59z" /> -<glyph unicode="" horiz-adv-x="1920" d="M640 960q0 -80 -56 -136t-136 -56t-136 56t-56 136t56 136t136 56t136 -56t56 -136zM1664 576v-448h-1408v192l320 320l160 -160l512 512zM1760 1280h-1600q-13 0 -22.5 -9.5t-9.5 -22.5v-1216q0 -13 9.5 -22.5t22.5 -9.5h1600q13 0 22.5 9.5t9.5 22.5v1216 q0 13 -9.5 22.5t-22.5 9.5zM1920 1248v-1216q0 -66 -47 -113t-113 -47h-1600q-66 0 -113 47t-47 113v1216q0 66 47 113t113 47h1600q66 0 113 -47t47 -113z" /> -<glyph unicode="" d="M363 0l91 91l-235 235l-91 -91v-107h128v-128h107zM886 928q0 22 -22 22q-10 0 -17 -7l-542 -542q-7 -7 -7 -17q0 -22 22 -22q10 0 17 7l542 542q7 7 7 17zM832 1120l416 -416l-832 -832h-416v416zM1515 1024q0 -53 -37 -90l-166 -166l-416 416l166 165q36 38 90 38 q53 0 91 -38l235 -234q37 -39 37 -91z" /> -<glyph unicode="" horiz-adv-x="1024" d="M768 896q0 106 -75 181t-181 75t-181 -75t-75 -181t75 -181t181 -75t181 75t75 181zM1024 896q0 -109 -33 -179l-364 -774q-16 -33 -47.5 -52t-67.5 -19t-67.5 19t-46.5 52l-365 774q-33 70 -33 179q0 212 150 362t362 150t362 -150t150 -362z" /> -<glyph unicode="" d="M768 96v1088q-148 0 -273 -73t-198 -198t-73 -273t73 -273t198 -198t273 -73zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" horiz-adv-x="1024" d="M512 384q0 36 -20 69q-1 1 -15.5 22.5t-25.5 38t-25 44t-21 50.5q-4 16 -21 16t-21 -16q-7 -23 -21 -50.5t-25 -44t-25.5 -38t-15.5 -22.5q-20 -33 -20 -69q0 -53 37.5 -90.5t90.5 -37.5t90.5 37.5t37.5 90.5zM1024 512q0 -212 -150 -362t-362 -150t-362 150t-150 362 q0 145 81 275q6 9 62.5 90.5t101 151t99.5 178t83 201.5q9 30 34 47t51 17t51.5 -17t33.5 -47q28 -93 83 -201.5t99.5 -178t101 -151t62.5 -90.5q81 -127 81 -275z" /> -<glyph unicode="" horiz-adv-x="1792" d="M888 352l116 116l-152 152l-116 -116v-56h96v-96h56zM1328 1072q-16 16 -33 -1l-350 -350q-17 -17 -1 -33t33 1l350 350q17 17 1 33zM1408 478v-190q0 -119 -84.5 -203.5t-203.5 -84.5h-832q-119 0 -203.5 84.5t-84.5 203.5v832q0 119 84.5 203.5t203.5 84.5h832 q63 0 117 -25q15 -7 18 -23q3 -17 -9 -29l-49 -49q-14 -14 -32 -8q-23 6 -45 6h-832q-66 0 -113 -47t-47 -113v-832q0 -66 47 -113t113 -47h832q66 0 113 47t47 113v126q0 13 9 22l64 64q15 15 35 7t20 -29zM1312 1216l288 -288l-672 -672h-288v288zM1756 1084l-92 -92 l-288 288l92 92q28 28 68 28t68 -28l152 -152q28 -28 28 -68t-28 -68z" /> -<glyph unicode="" horiz-adv-x="1664" d="M1408 547v-259q0 -119 -84.5 -203.5t-203.5 -84.5h-832q-119 0 -203.5 84.5t-84.5 203.5v832q0 119 84.5 203.5t203.5 84.5h255v0q13 0 22.5 -9.5t9.5 -22.5q0 -27 -26 -32q-77 -26 -133 -60q-10 -4 -16 -4h-112q-66 0 -113 -47t-47 -113v-832q0 -66 47 -113t113 -47h832 q66 0 113 47t47 113v214q0 19 18 29q28 13 54 37q16 16 35 8q21 -9 21 -29zM1645 1043l-384 -384q-18 -19 -45 -19q-12 0 -25 5q-39 17 -39 59v192h-160q-323 0 -438 -131q-119 -137 -74 -473q3 -23 -20 -34q-8 -2 -12 -2q-16 0 -26 13q-10 14 -21 31t-39.5 68.5t-49.5 99.5 t-38.5 114t-17.5 122q0 49 3.5 91t14 90t28 88t47 81.5t68.5 74t94.5 61.5t124.5 48.5t159.5 30.5t196.5 11h160v192q0 42 39 59q13 5 25 5q26 0 45 -19l384 -384q19 -19 19 -45t-19 -45z" /> -<glyph unicode="" horiz-adv-x="1664" d="M1408 606v-318q0 -119 -84.5 -203.5t-203.5 -84.5h-832q-119 0 -203.5 84.5t-84.5 203.5v832q0 119 84.5 203.5t203.5 84.5h832q63 0 117 -25q15 -7 18 -23q3 -17 -9 -29l-49 -49q-10 -10 -23 -10q-3 0 -9 2q-23 6 -45 6h-832q-66 0 -113 -47t-47 -113v-832 q0 -66 47 -113t113 -47h832q66 0 113 47t47 113v254q0 13 9 22l64 64q10 10 23 10q6 0 12 -3q20 -8 20 -29zM1639 1095l-814 -814q-24 -24 -57 -24t-57 24l-430 430q-24 24 -24 57t24 57l110 110q24 24 57 24t57 -24l263 -263l647 647q24 24 57 24t57 -24l110 -110 q24 -24 24 -57t-24 -57z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1792 640q0 -26 -19 -45l-256 -256q-19 -19 -45 -19t-45 19t-19 45v128h-384v-384h128q26 0 45 -19t19 -45t-19 -45l-256 -256q-19 -19 -45 -19t-45 19l-256 256q-19 19 -19 45t19 45t45 19h128v384h-384v-128q0 -26 -19 -45t-45 -19t-45 19l-256 256q-19 19 -19 45 t19 45l256 256q19 19 45 19t45 -19t19 -45v-128h384v384h-128q-26 0 -45 19t-19 45t19 45l256 256q19 19 45 19t45 -19l256 -256q19 -19 19 -45t-19 -45t-45 -19h-128v-384h384v128q0 26 19 45t45 19t45 -19l256 -256q19 -19 19 -45z" /> -<glyph unicode="" horiz-adv-x="1024" d="M979 1395q19 19 32 13t13 -32v-1472q0 -26 -13 -32t-32 13l-710 710q-9 9 -13 19v-678q0 -26 -19 -45t-45 -19h-128q-26 0 -45 19t-19 45v1408q0 26 19 45t45 19h128q26 0 45 -19t19 -45v-678q4 11 13 19z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1747 1395q19 19 32 13t13 -32v-1472q0 -26 -13 -32t-32 13l-710 710q-9 9 -13 19v-710q0 -26 -13 -32t-32 13l-710 710q-9 9 -13 19v-678q0 -26 -19 -45t-45 -19h-128q-26 0 -45 19t-19 45v1408q0 26 19 45t45 19h128q26 0 45 -19t19 -45v-678q4 11 13 19l710 710 q19 19 32 13t13 -32v-710q4 11 13 19z" /> -<glyph unicode="" horiz-adv-x="1664" d="M1619 1395q19 19 32 13t13 -32v-1472q0 -26 -13 -32t-32 13l-710 710q-8 9 -13 19v-710q0 -26 -13 -32t-32 13l-710 710q-19 19 -19 45t19 45l710 710q19 19 32 13t13 -32v-710q5 11 13 19z" /> -<glyph unicode="" horiz-adv-x="1408" d="M1384 609l-1328 -738q-23 -13 -39.5 -3t-16.5 36v1472q0 26 16.5 36t39.5 -3l1328 -738q23 -13 23 -31t-23 -31z" /> -<glyph unicode="" d="M1536 1344v-1408q0 -26 -19 -45t-45 -19h-512q-26 0 -45 19t-19 45v1408q0 26 19 45t45 19h512q26 0 45 -19t19 -45zM640 1344v-1408q0 -26 -19 -45t-45 -19h-512q-26 0 -45 19t-19 45v1408q0 26 19 45t45 19h512q26 0 45 -19t19 -45z" /> -<glyph unicode="" d="M1536 1344v-1408q0 -26 -19 -45t-45 -19h-1408q-26 0 -45 19t-19 45v1408q0 26 19 45t45 19h1408q26 0 45 -19t19 -45z" /> -<glyph unicode="" horiz-adv-x="1664" d="M45 -115q-19 -19 -32 -13t-13 32v1472q0 26 13 32t32 -13l710 -710q8 -8 13 -19v710q0 26 13 32t32 -13l710 -710q19 -19 19 -45t-19 -45l-710 -710q-19 -19 -32 -13t-13 32v710q-5 -10 -13 -19z" /> -<glyph unicode="" horiz-adv-x="1792" d="M45 -115q-19 -19 -32 -13t-13 32v1472q0 26 13 32t32 -13l710 -710q8 -8 13 -19v710q0 26 13 32t32 -13l710 -710q8 -8 13 -19v678q0 26 19 45t45 19h128q26 0 45 -19t19 -45v-1408q0 -26 -19 -45t-45 -19h-128q-26 0 -45 19t-19 45v678q-5 -10 -13 -19l-710 -710 q-19 -19 -32 -13t-13 32v710q-5 -10 -13 -19z" /> -<glyph unicode="" horiz-adv-x="1024" d="M45 -115q-19 -19 -32 -13t-13 32v1472q0 26 13 32t32 -13l710 -710q8 -8 13 -19v678q0 26 19 45t45 19h128q26 0 45 -19t19 -45v-1408q0 -26 -19 -45t-45 -19h-128q-26 0 -45 19t-19 45v678q-5 -10 -13 -19z" /> -<glyph unicode="" horiz-adv-x="1538" d="M14 557l710 710q19 19 45 19t45 -19l710 -710q19 -19 13 -32t-32 -13h-1472q-26 0 -32 13t13 32zM1473 0h-1408q-26 0 -45 19t-19 45v256q0 26 19 45t45 19h1408q26 0 45 -19t19 -45v-256q0 -26 -19 -45t-45 -19z" /> -<glyph unicode="" horiz-adv-x="1152" d="M742 -37l-652 651q-37 37 -37 90.5t37 90.5l652 651q37 37 90.5 37t90.5 -37l75 -75q37 -37 37 -90.5t-37 -90.5l-486 -486l486 -485q37 -38 37 -91t-37 -90l-75 -75q-37 -37 -90.5 -37t-90.5 37z" /> -<glyph unicode="" horiz-adv-x="1152" d="M1099 704q0 -52 -37 -91l-652 -651q-37 -37 -90 -37t-90 37l-76 75q-37 39 -37 91q0 53 37 90l486 486l-486 485q-37 39 -37 91q0 53 37 90l76 75q36 38 90 38t90 -38l652 -651q37 -37 37 -90z" /> -<glyph unicode="" d="M1216 576v128q0 26 -19 45t-45 19h-256v256q0 26 -19 45t-45 19h-128q-26 0 -45 -19t-19 -45v-256h-256q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45t45 -19h256v-256q0 -26 19 -45t45 -19h128q26 0 45 19t19 45v256h256q26 0 45 19t19 45zM1536 640q0 -209 -103 -385.5 t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" d="M1216 576v128q0 26 -19 45t-45 19h-768q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45t45 -19h768q26 0 45 19t19 45zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5 t103 -385.5z" /> -<glyph unicode="" d="M1149 414q0 26 -19 45l-181 181l181 181q19 19 19 45q0 27 -19 46l-90 90q-19 19 -46 19q-26 0 -45 -19l-181 -181l-181 181q-19 19 -45 19q-27 0 -46 -19l-90 -90q-19 -19 -19 -46q0 -26 19 -45l181 -181l-181 -181q-19 -19 -19 -45q0 -27 19 -46l90 -90q19 -19 46 -19 q26 0 45 19l181 181l181 -181q19 -19 45 -19q27 0 46 19l90 90q19 19 19 46zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" d="M1284 802q0 28 -18 46l-91 90q-19 19 -45 19t-45 -19l-408 -407l-226 226q-19 19 -45 19t-45 -19l-91 -90q-18 -18 -18 -46q0 -27 18 -45l362 -362q19 -19 45 -19q27 0 46 19l543 543q18 18 18 45zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103 t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" d="M896 160v192q0 14 -9 23t-23 9h-192q-14 0 -23 -9t-9 -23v-192q0 -14 9 -23t23 -9h192q14 0 23 9t9 23zM1152 832q0 88 -55.5 163t-138.5 116t-170 41q-243 0 -371 -213q-15 -24 8 -42l132 -100q7 -6 19 -6q16 0 25 12q53 68 86 92q34 24 86 24q48 0 85.5 -26t37.5 -59 q0 -38 -20 -61t-68 -45q-63 -28 -115.5 -86.5t-52.5 -125.5v-36q0 -14 9 -23t23 -9h192q14 0 23 9t9 23q0 19 21.5 49.5t54.5 49.5q32 18 49 28.5t46 35t44.5 48t28 60.5t12.5 81zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5 t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" d="M1024 160v160q0 14 -9 23t-23 9h-96v512q0 14 -9 23t-23 9h-320q-14 0 -23 -9t-9 -23v-160q0 -14 9 -23t23 -9h96v-320h-96q-14 0 -23 -9t-9 -23v-160q0 -14 9 -23t23 -9h448q14 0 23 9t9 23zM896 1056v160q0 14 -9 23t-23 9h-192q-14 0 -23 -9t-9 -23v-160q0 -14 9 -23 t23 -9h192q14 0 23 9t9 23zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" d="M1197 512h-109q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h109q-32 108 -112.5 188.5t-188.5 112.5v-109q0 -26 -19 -45t-45 -19h-128q-26 0 -45 19t-19 45v109q-108 -32 -188.5 -112.5t-112.5 -188.5h109q26 0 45 -19t19 -45v-128q0 -26 -19 -45t-45 -19h-109 q32 -108 112.5 -188.5t188.5 -112.5v109q0 26 19 45t45 19h128q26 0 45 -19t19 -45v-109q108 32 188.5 112.5t112.5 188.5zM1536 704v-128q0 -26 -19 -45t-45 -19h-143q-37 -161 -154.5 -278.5t-278.5 -154.5v-143q0 -26 -19 -45t-45 -19h-128q-26 0 -45 19t-19 45v143 q-161 37 -278.5 154.5t-154.5 278.5h-143q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h143q37 161 154.5 278.5t278.5 154.5v143q0 26 19 45t45 19h128q26 0 45 -19t19 -45v-143q161 -37 278.5 -154.5t154.5 -278.5h143q26 0 45 -19t19 -45z" /> -<glyph unicode="" d="M1097 457l-146 -146q-10 -10 -23 -10t-23 10l-137 137l-137 -137q-10 -10 -23 -10t-23 10l-146 146q-10 10 -10 23t10 23l137 137l-137 137q-10 10 -10 23t10 23l146 146q10 10 23 10t23 -10l137 -137l137 137q10 10 23 10t23 -10l146 -146q10 -10 10 -23t-10 -23 l-137 -137l137 -137q10 -10 10 -23t-10 -23zM1312 640q0 148 -73 273t-198 198t-273 73t-273 -73t-198 -198t-73 -273t73 -273t198 -198t273 -73t273 73t198 198t73 273zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5 t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" d="M1171 723l-422 -422q-19 -19 -45 -19t-45 19l-294 294q-19 19 -19 45t19 45l102 102q19 19 45 19t45 -19l147 -147l275 275q19 19 45 19t45 -19l102 -102q19 -19 19 -45t-19 -45zM1312 640q0 148 -73 273t-198 198t-273 73t-273 -73t-198 -198t-73 -273t73 -273t198 -198 t273 -73t273 73t198 198t73 273zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" d="M1312 643q0 161 -87 295l-754 -753q137 -89 297 -89q111 0 211.5 43.5t173.5 116.5t116 174.5t43 212.5zM313 344l755 754q-135 91 -300 91q-148 0 -273 -73t-198 -199t-73 -274q0 -162 89 -299zM1536 643q0 -157 -61 -300t-163.5 -246t-245 -164t-298.5 -61t-298.5 61 t-245 164t-163.5 246t-61 300t61 299.5t163.5 245.5t245 164t298.5 61t298.5 -61t245 -164t163.5 -245.5t61 -299.5z" /> -<glyph unicode="" d="M1536 640v-128q0 -53 -32.5 -90.5t-84.5 -37.5h-704l293 -294q38 -36 38 -90t-38 -90l-75 -76q-37 -37 -90 -37q-52 0 -91 37l-651 652q-37 37 -37 90q0 52 37 91l651 650q38 38 91 38q52 0 90 -38l75 -74q38 -38 38 -91t-38 -91l-293 -293h704q52 0 84.5 -37.5 t32.5 -90.5z" /> -<glyph unicode="" d="M1472 576q0 -54 -37 -91l-651 -651q-39 -37 -91 -37q-51 0 -90 37l-75 75q-38 38 -38 91t38 91l293 293h-704q-52 0 -84.5 37.5t-32.5 90.5v128q0 53 32.5 90.5t84.5 37.5h704l-293 294q-38 36 -38 90t38 90l75 75q38 38 90 38q53 0 91 -38l651 -651q37 -35 37 -90z" /> -<glyph unicode="" horiz-adv-x="1664" d="M1611 565q0 -51 -37 -90l-75 -75q-38 -38 -91 -38q-54 0 -90 38l-294 293v-704q0 -52 -37.5 -84.5t-90.5 -32.5h-128q-53 0 -90.5 32.5t-37.5 84.5v704l-294 -293q-36 -38 -90 -38t-90 38l-75 75q-38 38 -38 90q0 53 38 91l651 651q35 37 90 37q54 0 91 -37l651 -651 q37 -39 37 -91z" /> -<glyph unicode="" horiz-adv-x="1664" d="M1611 704q0 -53 -37 -90l-651 -652q-39 -37 -91 -37q-53 0 -90 37l-651 652q-38 36 -38 90q0 53 38 91l74 75q39 37 91 37q53 0 90 -37l294 -294v704q0 52 38 90t90 38h128q52 0 90 -38t38 -90v-704l294 294q37 37 90 37q52 0 91 -37l75 -75q37 -39 37 -91z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1792 896q0 -26 -19 -45l-512 -512q-19 -19 -45 -19t-45 19t-19 45v256h-224q-98 0 -175.5 -6t-154 -21.5t-133 -42.5t-105.5 -69.5t-80 -101t-48.5 -138.5t-17.5 -181q0 -55 5 -123q0 -6 2.5 -23.5t2.5 -26.5q0 -15 -8.5 -25t-23.5 -10q-16 0 -28 17q-7 9 -13 22 t-13.5 30t-10.5 24q-127 285 -127 451q0 199 53 333q162 403 875 403h224v256q0 26 19 45t45 19t45 -19l512 -512q19 -19 19 -45z" /> -<glyph unicode="" d="M755 480q0 -13 -10 -23l-332 -332l144 -144q19 -19 19 -45t-19 -45t-45 -19h-448q-26 0 -45 19t-19 45v448q0 26 19 45t45 19t45 -19l144 -144l332 332q10 10 23 10t23 -10l114 -114q10 -10 10 -23zM1536 1344v-448q0 -26 -19 -45t-45 -19t-45 19l-144 144l-332 -332 q-10 -10 -23 -10t-23 10l-114 114q-10 10 -10 23t10 23l332 332l-144 144q-19 19 -19 45t19 45t45 19h448q26 0 45 -19t19 -45z" /> -<glyph unicode="" d="M768 576v-448q0 -26 -19 -45t-45 -19t-45 19l-144 144l-332 -332q-10 -10 -23 -10t-23 10l-114 114q-10 10 -10 23t10 23l332 332l-144 144q-19 19 -19 45t19 45t45 19h448q26 0 45 -19t19 -45zM1523 1248q0 -13 -10 -23l-332 -332l144 -144q19 -19 19 -45t-19 -45 t-45 -19h-448q-26 0 -45 19t-19 45v448q0 26 19 45t45 19t45 -19l144 -144l332 332q10 10 23 10t23 -10l114 -114q10 -10 10 -23z" /> -<glyph unicode="" horiz-adv-x="1408" d="M1408 800v-192q0 -40 -28 -68t-68 -28h-416v-416q0 -40 -28 -68t-68 -28h-192q-40 0 -68 28t-28 68v416h-416q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h416v416q0 40 28 68t68 28h192q40 0 68 -28t28 -68v-416h416q40 0 68 -28t28 -68z" /> -<glyph unicode="" horiz-adv-x="1408" d="M1408 800v-192q0 -40 -28 -68t-68 -28h-1216q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h1216q40 0 68 -28t28 -68z" /> -<glyph unicode="" horiz-adv-x="1664" d="M1482 486q46 -26 59.5 -77.5t-12.5 -97.5l-64 -110q-26 -46 -77.5 -59.5t-97.5 12.5l-266 153v-307q0 -52 -38 -90t-90 -38h-128q-52 0 -90 38t-38 90v307l-266 -153q-46 -26 -97.5 -12.5t-77.5 59.5l-64 110q-26 46 -12.5 97.5t59.5 77.5l266 154l-266 154 q-46 26 -59.5 77.5t12.5 97.5l64 110q26 46 77.5 59.5t97.5 -12.5l266 -153v307q0 52 38 90t90 38h128q52 0 90 -38t38 -90v-307l266 153q46 26 97.5 12.5t77.5 -59.5l64 -110q26 -46 12.5 -97.5t-59.5 -77.5l-266 -154z" /> -<glyph unicode="" d="M768 1408q209 0 385.5 -103t279.5 -279.5t103 -385.5t-103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103zM896 161v190q0 14 -9 23.5t-22 9.5h-192q-13 0 -23 -10t-10 -23v-190q0 -13 10 -23t23 -10h192 q13 0 22 9.5t9 23.5zM894 505l18 621q0 12 -10 18q-10 8 -24 8h-220q-14 0 -24 -8q-10 -6 -10 -18l17 -621q0 -10 10 -17.5t24 -7.5h185q14 0 23.5 7.5t10.5 17.5z" /> -<glyph unicode="" d="M928 180v56v468v192h-320v-192v-468v-56q0 -25 18 -38.5t46 -13.5h192q28 0 46 13.5t18 38.5zM472 1024h195l-126 161q-26 31 -69 31q-40 0 -68 -28t-28 -68t28 -68t68 -28zM1160 1120q0 40 -28 68t-68 28q-43 0 -69 -31l-125 -161h194q40 0 68 28t28 68zM1536 864v-320 q0 -14 -9 -23t-23 -9h-96v-416q0 -40 -28 -68t-68 -28h-1088q-40 0 -68 28t-28 68v416h-96q-14 0 -23 9t-9 23v320q0 14 9 23t23 9h440q-93 0 -158.5 65.5t-65.5 158.5t65.5 158.5t158.5 65.5q107 0 168 -77l128 -165l128 165q61 77 168 77q93 0 158.5 -65.5t65.5 -158.5 t-65.5 -158.5t-158.5 -65.5h440q14 0 23 -9t9 -23z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1280 832q0 26 -19 45t-45 19q-172 0 -318 -49.5t-259.5 -134t-235.5 -219.5q-19 -21 -19 -45q0 -26 19 -45t45 -19q24 0 45 19q27 24 74 71t67 66q137 124 268.5 176t313.5 52q26 0 45 19t19 45zM1792 1030q0 -95 -20 -193q-46 -224 -184.5 -383t-357.5 -268 q-214 -108 -438 -108q-148 0 -286 47q-15 5 -88 42t-96 37q-16 0 -39.5 -32t-45 -70t-52.5 -70t-60 -32q-30 0 -51 11t-31 24t-27 42q-2 4 -6 11t-5.5 10t-3 9.5t-1.5 13.5q0 35 31 73.5t68 65.5t68 56t31 48q0 4 -14 38t-16 44q-9 51 -9 104q0 115 43.5 220t119 184.5 t170.5 139t204 95.5q55 18 145 25.5t179.5 9t178.5 6t163.5 24t113.5 56.5l29.5 29.5t29.5 28t27 20t36.5 16t43.5 4.5q39 0 70.5 -46t47.5 -112t24 -124t8 -96z" /> -<glyph unicode="" horiz-adv-x="1408" d="M1408 -160v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-1344q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h1344q13 0 22.5 -9.5t9.5 -22.5zM1152 896q0 -78 -24.5 -144t-64 -112.5t-87.5 -88t-96 -77.5t-87.5 -72t-64 -81.5t-24.5 -96.5q0 -96 67 -224l-4 1l1 -1 q-90 41 -160 83t-138.5 100t-113.5 122.5t-72.5 150.5t-27.5 184q0 78 24.5 144t64 112.5t87.5 88t96 77.5t87.5 72t64 81.5t24.5 96.5q0 94 -66 224l3 -1l-1 1q90 -41 160 -83t138.5 -100t113.5 -122.5t72.5 -150.5t27.5 -184z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1664 576q-152 236 -381 353q61 -104 61 -225q0 -185 -131.5 -316.5t-316.5 -131.5t-316.5 131.5t-131.5 316.5q0 121 61 225q-229 -117 -381 -353q133 -205 333.5 -326.5t434.5 -121.5t434.5 121.5t333.5 326.5zM944 960q0 20 -14 34t-34 14q-125 0 -214.5 -89.5 t-89.5 -214.5q0 -20 14 -34t34 -14t34 14t14 34q0 86 61 147t147 61q20 0 34 14t14 34zM1792 576q0 -34 -20 -69q-140 -230 -376.5 -368.5t-499.5 -138.5t-499.5 139t-376.5 368q-20 35 -20 69t20 69q140 229 376.5 368t499.5 139t499.5 -139t376.5 -368q20 -35 20 -69z" /> -<glyph unicode="" horiz-adv-x="1792" d="M555 201l78 141q-87 63 -136 159t-49 203q0 121 61 225q-229 -117 -381 -353q167 -258 427 -375zM944 960q0 20 -14 34t-34 14q-125 0 -214.5 -89.5t-89.5 -214.5q0 -20 14 -34t34 -14t34 14t14 34q0 86 61 147t147 61q20 0 34 14t14 34zM1307 1151q0 -7 -1 -9 q-105 -188 -315 -566t-316 -567l-49 -89q-10 -16 -28 -16q-12 0 -134 70q-16 10 -16 28q0 12 44 87q-143 65 -263.5 173t-208.5 245q-20 31 -20 69t20 69q153 235 380 371t496 136q89 0 180 -17l54 97q10 16 28 16q5 0 18 -6t31 -15.5t33 -18.5t31.5 -18.5t19.5 -11.5 q16 -10 16 -27zM1344 704q0 -139 -79 -253.5t-209 -164.5l280 502q8 -45 8 -84zM1792 576q0 -35 -20 -69q-39 -64 -109 -145q-150 -172 -347.5 -267t-419.5 -95l74 132q212 18 392.5 137t301.5 307q-115 179 -282 294l63 112q95 -64 182.5 -153t144.5 -184q20 -34 20 -69z " /> -<glyph unicode="" horiz-adv-x="1792" d="M1024 161v190q0 14 -9.5 23.5t-22.5 9.5h-192q-13 0 -22.5 -9.5t-9.5 -23.5v-190q0 -14 9.5 -23.5t22.5 -9.5h192q13 0 22.5 9.5t9.5 23.5zM1022 535l18 459q0 12 -10 19q-13 11 -24 11h-220q-11 0 -24 -11q-10 -7 -10 -21l17 -457q0 -10 10 -16.5t24 -6.5h185 q14 0 23.5 6.5t10.5 16.5zM1008 1469l768 -1408q35 -63 -2 -126q-17 -29 -46.5 -46t-63.5 -17h-1536q-34 0 -63.5 17t-46.5 46q-37 63 -2 126l768 1408q17 31 47 49t65 18t65 -18t47 -49z" /> -<glyph unicode="" horiz-adv-x="1408" d="M1376 1376q44 -52 12 -148t-108 -172l-161 -161l160 -696q5 -19 -12 -33l-128 -96q-7 -6 -19 -6q-4 0 -7 1q-15 3 -21 16l-279 508l-259 -259l53 -194q5 -17 -8 -31l-96 -96q-9 -9 -23 -9h-2q-15 2 -24 13l-189 252l-252 189q-11 7 -13 23q-1 13 9 25l96 97q9 9 23 9 q6 0 8 -1l194 -53l259 259l-508 279q-14 8 -17 24q-2 16 9 27l128 128q14 13 30 8l665 -159l160 160q76 76 172 108t148 -12z" /> -<glyph unicode="" horiz-adv-x="1664" d="M128 -128h288v288h-288v-288zM480 -128h320v288h-320v-288zM128 224h288v320h-288v-320zM480 224h320v320h-320v-320zM128 608h288v288h-288v-288zM864 -128h320v288h-320v-288zM480 608h320v288h-320v-288zM1248 -128h288v288h-288v-288zM864 224h320v320h-320v-320z M512 1088v288q0 13 -9.5 22.5t-22.5 9.5h-64q-13 0 -22.5 -9.5t-9.5 -22.5v-288q0 -13 9.5 -22.5t22.5 -9.5h64q13 0 22.5 9.5t9.5 22.5zM1248 224h288v320h-288v-320zM864 608h320v288h-320v-288zM1248 608h288v288h-288v-288zM1280 1088v288q0 13 -9.5 22.5t-22.5 9.5h-64 q-13 0 -22.5 -9.5t-9.5 -22.5v-288q0 -13 9.5 -22.5t22.5 -9.5h64q13 0 22.5 9.5t9.5 22.5zM1664 1152v-1280q0 -52 -38 -90t-90 -38h-1408q-52 0 -90 38t-38 90v1280q0 52 38 90t90 38h128v96q0 66 47 113t113 47h64q66 0 113 -47t47 -113v-96h384v96q0 66 47 113t113 47 h64q66 0 113 -47t47 -113v-96h128q52 0 90 -38t38 -90z" /> -<glyph unicode="" horiz-adv-x="1792" d="M666 1055q-60 -92 -137 -273q-22 45 -37 72.5t-40.5 63.5t-51 56.5t-63 35t-81.5 14.5h-224q-14 0 -23 9t-9 23v192q0 14 9 23t23 9h224q250 0 410 -225zM1792 256q0 -14 -9 -23l-320 -320q-9 -9 -23 -9q-13 0 -22.5 9.5t-9.5 22.5v192q-32 0 -85 -0.5t-81 -1t-73 1 t-71 5t-64 10.5t-63 18.5t-58 28.5t-59 40t-55 53.5t-56 69.5q59 93 136 273q22 -45 37 -72.5t40.5 -63.5t51 -56.5t63 -35t81.5 -14.5h256v192q0 14 9 23t23 9q12 0 24 -10l319 -319q9 -9 9 -23zM1792 1152q0 -14 -9 -23l-320 -320q-9 -9 -23 -9q-13 0 -22.5 9.5t-9.5 22.5 v192h-256q-48 0 -87 -15t-69 -45t-51 -61.5t-45 -77.5q-32 -62 -78 -171q-29 -66 -49.5 -111t-54 -105t-64 -100t-74 -83t-90 -68.5t-106.5 -42t-128 -16.5h-224q-14 0 -23 9t-9 23v192q0 14 9 23t23 9h224q48 0 87 15t69 45t51 61.5t45 77.5q32 62 78 171q29 66 49.5 111 t54 105t64 100t74 83t90 68.5t106.5 42t128 16.5h256v192q0 14 9 23t23 9q12 0 24 -10l319 -319q9 -9 9 -23z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1792 640q0 -174 -120 -321.5t-326 -233t-450 -85.5q-70 0 -145 8q-198 -175 -460 -242q-49 -14 -114 -22q-17 -2 -30.5 9t-17.5 29v1q-3 4 -0.5 12t2 10t4.5 9.5l6 9t7 8.5t8 9q7 8 31 34.5t34.5 38t31 39.5t32.5 51t27 59t26 76q-157 89 -247.5 220t-90.5 281 q0 130 71 248.5t191 204.5t286 136.5t348 50.5q244 0 450 -85.5t326 -233t120 -321.5z" /> -<glyph unicode="" d="M1536 704v-128q0 -201 -98.5 -362t-274 -251.5t-395.5 -90.5t-395.5 90.5t-274 251.5t-98.5 362v128q0 26 19 45t45 19h384q26 0 45 -19t19 -45v-128q0 -52 23.5 -90t53.5 -57t71 -30t64 -13t44 -2t44 2t64 13t71 30t53.5 57t23.5 90v128q0 26 19 45t45 19h384 q26 0 45 -19t19 -45zM512 1344v-384q0 -26 -19 -45t-45 -19h-384q-26 0 -45 19t-19 45v384q0 26 19 45t45 19h384q26 0 45 -19t19 -45zM1536 1344v-384q0 -26 -19 -45t-45 -19h-384q-26 0 -45 19t-19 45v384q0 26 19 45t45 19h384q26 0 45 -19t19 -45z" /> -<glyph unicode="" horiz-adv-x="1664" d="M1611 320q0 -53 -37 -90l-75 -75q-38 -38 -91 -38q-54 0 -90 38l-486 485l-486 -485q-36 -38 -90 -38t-90 38l-75 75q-38 36 -38 90q0 53 38 91l651 651q37 37 90 37q52 0 91 -37l650 -651q38 -38 38 -91z" /> -<glyph unicode="" horiz-adv-x="1664" d="M1611 832q0 -53 -37 -90l-651 -651q-38 -38 -91 -38q-54 0 -90 38l-651 651q-38 36 -38 90q0 53 38 91l74 75q39 37 91 37q53 0 90 -37l486 -486l486 486q37 37 90 37q52 0 91 -37l75 -75q37 -39 37 -91z" /> -<glyph unicode="" horiz-adv-x="1920" d="M1280 32q0 -13 -9.5 -22.5t-22.5 -9.5h-960q-8 0 -13.5 2t-9 7t-5.5 8t-3 11.5t-1 11.5v13v11v160v416h-192q-26 0 -45 19t-19 45q0 24 15 41l320 384q19 22 49 22t49 -22l320 -384q15 -17 15 -41q0 -26 -19 -45t-45 -19h-192v-384h576q16 0 25 -11l160 -192q7 -11 7 -21 zM1920 448q0 -24 -15 -41l-320 -384q-20 -23 -49 -23t-49 23l-320 384q-15 17 -15 41q0 26 19 45t45 19h192v384h-576q-16 0 -25 12l-160 192q-7 9 -7 20q0 13 9.5 22.5t22.5 9.5h960q8 0 13.5 -2t9 -7t5.5 -8t3 -11.5t1 -11.5v-13v-11v-160v-416h192q26 0 45 -19t19 -45z " /> -<glyph unicode="" horiz-adv-x="1664" d="M640 0q0 -53 -37.5 -90.5t-90.5 -37.5t-90.5 37.5t-37.5 90.5t37.5 90.5t90.5 37.5t90.5 -37.5t37.5 -90.5zM1536 0q0 -53 -37.5 -90.5t-90.5 -37.5t-90.5 37.5t-37.5 90.5t37.5 90.5t90.5 37.5t90.5 -37.5t37.5 -90.5zM1664 1088v-512q0 -24 -16 -42.5t-41 -21.5 l-1044 -122q1 -7 4.5 -21.5t6 -26.5t2.5 -22q0 -16 -24 -64h920q26 0 45 -19t19 -45t-19 -45t-45 -19h-1024q-26 0 -45 19t-19 45q0 14 11 39.5t29.5 59.5t20.5 38l-177 823h-204q-26 0 -45 19t-19 45t19 45t45 19h256q16 0 28.5 -6.5t20 -15.5t13 -24.5t7.5 -26.5 t5.5 -29.5t4.5 -25.5h1201q26 0 45 -19t19 -45z" /> -<glyph unicode="" horiz-adv-x="1664" d="M1664 928v-704q0 -92 -66 -158t-158 -66h-1216q-92 0 -158 66t-66 158v960q0 92 66 158t158 66h320q92 0 158 -66t66 -158v-32h672q92 0 158 -66t66 -158z" /> -<glyph unicode="" horiz-adv-x="1920" d="M1879 584q0 -31 -31 -66l-336 -396q-43 -51 -120.5 -86.5t-143.5 -35.5h-1088q-34 0 -60.5 13t-26.5 43q0 31 31 66l336 396q43 51 120.5 86.5t143.5 35.5h1088q34 0 60.5 -13t26.5 -43zM1536 928v-160h-832q-94 0 -197 -47.5t-164 -119.5l-337 -396l-5 -6q0 4 -0.5 12.5 t-0.5 12.5v960q0 92 66 158t158 66h320q92 0 158 -66t66 -158v-32h544q92 0 158 -66t66 -158z" /> -<glyph unicode="" horiz-adv-x="768" d="M704 1216q0 -26 -19 -45t-45 -19h-128v-1024h128q26 0 45 -19t19 -45t-19 -45l-256 -256q-19 -19 -45 -19t-45 19l-256 256q-19 19 -19 45t19 45t45 19h128v1024h-128q-26 0 -45 19t-19 45t19 45l256 256q19 19 45 19t45 -19l256 -256q19 -19 19 -45z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1792 640q0 -26 -19 -45l-256 -256q-19 -19 -45 -19t-45 19t-19 45v128h-1024v-128q0 -26 -19 -45t-45 -19t-45 19l-256 256q-19 19 -19 45t19 45l256 256q19 19 45 19t45 -19t19 -45v-128h1024v128q0 26 19 45t45 19t45 -19l256 -256q19 -19 19 -45z" /> -<glyph unicode="" horiz-adv-x="1920" d="M512 512v-384h-256v384h256zM896 1024v-896h-256v896h256zM1280 768v-640h-256v640h256zM1664 1152v-1024h-256v1024h256zM1792 32v1216q0 13 -9.5 22.5t-22.5 9.5h-1600q-13 0 -22.5 -9.5t-9.5 -22.5v-1216q0 -13 9.5 -22.5t22.5 -9.5h1600q13 0 22.5 9.5t9.5 22.5z M1920 1248v-1216q0 -66 -47 -113t-113 -47h-1600q-66 0 -113 47t-47 113v1216q0 66 47 113t113 47h1600q66 0 113 -47t47 -113z" /> -<glyph unicode="" d="M1280 926q-56 -25 -121 -34q68 40 93 117q-65 -38 -134 -51q-61 66 -153 66q-87 0 -148.5 -61.5t-61.5 -148.5q0 -29 5 -48q-129 7 -242 65t-192 155q-29 -50 -29 -106q0 -114 91 -175q-47 1 -100 26v-2q0 -75 50 -133.5t123 -72.5q-29 -8 -51 -8q-13 0 -39 4 q21 -63 74.5 -104t121.5 -42q-116 -90 -261 -90q-26 0 -50 3q148 -94 322 -94q112 0 210 35.5t168 95t120.5 137t75 162t24.5 168.5q0 18 -1 27q63 45 105 109zM1536 1120v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5 t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> -<glyph unicode="" d="M1307 618l23 219h-198v109q0 49 15.5 68.5t71.5 19.5h110v219h-175q-152 0 -218 -72t-66 -213v-131h-131v-219h131v-635h262v635h175zM1536 1120v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960 q119 0 203.5 -84.5t84.5 -203.5z" /> -<glyph unicode="" horiz-adv-x="1792" d="M928 704q0 14 -9 23t-23 9q-66 0 -113 -47t-47 -113q0 -14 9 -23t23 -9t23 9t9 23q0 40 28 68t68 28q14 0 23 9t9 23zM1152 574q0 -106 -75 -181t-181 -75t-181 75t-75 181t75 181t181 75t181 -75t75 -181zM128 0h1536v128h-1536v-128zM1280 574q0 159 -112.5 271.5 t-271.5 112.5t-271.5 -112.5t-112.5 -271.5t112.5 -271.5t271.5 -112.5t271.5 112.5t112.5 271.5zM256 1216h384v128h-384v-128zM128 1024h1536v118v138h-828l-64 -128h-644v-128zM1792 1280v-1280q0 -53 -37.5 -90.5t-90.5 -37.5h-1536q-53 0 -90.5 37.5t-37.5 90.5v1280 q0 53 37.5 90.5t90.5 37.5h1536q53 0 90.5 -37.5t37.5 -90.5z" /> -<glyph unicode="" horiz-adv-x="1792" d="M832 1024q0 80 -56 136t-136 56t-136 -56t-56 -136q0 -42 19 -83q-41 19 -83 19q-80 0 -136 -56t-56 -136t56 -136t136 -56t136 56t56 136q0 42 -19 83q41 -19 83 -19q80 0 136 56t56 136zM1683 320q0 -17 -49 -66t-66 -49q-9 0 -28.5 16t-36.5 33t-38.5 40t-24.5 26 l-96 -96l220 -220q28 -28 28 -68q0 -42 -39 -81t-81 -39q-40 0 -68 28l-671 671q-176 -131 -365 -131q-163 0 -265.5 102.5t-102.5 265.5q0 160 95 313t248 248t313 95q163 0 265.5 -102.5t102.5 -265.5q0 -189 -131 -365l355 -355l96 96q-3 3 -26 24.5t-40 38.5t-33 36.5 t-16 28.5q0 17 49 66t66 49q13 0 23 -10q6 -6 46 -44.5t82 -79.5t86.5 -86t73 -78t28.5 -41z" /> -<glyph unicode="" horiz-adv-x="1920" d="M896 640q0 106 -75 181t-181 75t-181 -75t-75 -181t75 -181t181 -75t181 75t75 181zM1664 128q0 52 -38 90t-90 38t-90 -38t-38 -90q0 -53 37.5 -90.5t90.5 -37.5t90.5 37.5t37.5 90.5zM1664 1152q0 52 -38 90t-90 38t-90 -38t-38 -90q0 -53 37.5 -90.5t90.5 -37.5 t90.5 37.5t37.5 90.5zM1280 731v-185q0 -10 -7 -19.5t-16 -10.5l-155 -24q-11 -35 -32 -76q34 -48 90 -115q7 -10 7 -20q0 -12 -7 -19q-23 -30 -82.5 -89.5t-78.5 -59.5q-11 0 -21 7l-115 90q-37 -19 -77 -31q-11 -108 -23 -155q-7 -24 -30 -24h-186q-11 0 -20 7.5t-10 17.5 l-23 153q-34 10 -75 31l-118 -89q-7 -7 -20 -7q-11 0 -21 8q-144 133 -144 160q0 9 7 19q10 14 41 53t47 61q-23 44 -35 82l-152 24q-10 1 -17 9.5t-7 19.5v185q0 10 7 19.5t16 10.5l155 24q11 35 32 76q-34 48 -90 115q-7 11 -7 20q0 12 7 20q22 30 82 89t79 59q11 0 21 -7 l115 -90q34 18 77 32q11 108 23 154q7 24 30 24h186q11 0 20 -7.5t10 -17.5l23 -153q34 -10 75 -31l118 89q8 7 20 7q11 0 21 -8q144 -133 144 -160q0 -9 -7 -19q-12 -16 -42 -54t-45 -60q23 -48 34 -82l152 -23q10 -2 17 -10.5t7 -19.5zM1920 198v-140q0 -16 -149 -31 q-12 -27 -30 -52q51 -113 51 -138q0 -4 -4 -7q-122 -71 -124 -71q-8 0 -46 47t-52 68q-20 -2 -30 -2t-30 2q-14 -21 -52 -68t-46 -47q-2 0 -124 71q-4 3 -4 7q0 25 51 138q-18 25 -30 52q-149 15 -149 31v140q0 16 149 31q13 29 30 52q-51 113 -51 138q0 4 4 7q4 2 35 20 t59 34t30 16q8 0 46 -46.5t52 -67.5q20 2 30 2t30 -2q51 71 92 112l6 2q4 0 124 -70q4 -3 4 -7q0 -25 -51 -138q17 -23 30 -52q149 -15 149 -31zM1920 1222v-140q0 -16 -149 -31q-12 -27 -30 -52q51 -113 51 -138q0 -4 -4 -7q-122 -71 -124 -71q-8 0 -46 47t-52 68 q-20 -2 -30 -2t-30 2q-14 -21 -52 -68t-46 -47q-2 0 -124 71q-4 3 -4 7q0 25 51 138q-18 25 -30 52q-149 15 -149 31v140q0 16 149 31q13 29 30 52q-51 113 -51 138q0 4 4 7q4 2 35 20t59 34t30 16q8 0 46 -46.5t52 -67.5q20 2 30 2t30 -2q51 71 92 112l6 2q4 0 124 -70 q4 -3 4 -7q0 -25 -51 -138q17 -23 30 -52q149 -15 149 -31z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1408 768q0 -139 -94 -257t-256.5 -186.5t-353.5 -68.5q-86 0 -176 16q-124 -88 -278 -128q-36 -9 -86 -16h-3q-11 0 -20.5 8t-11.5 21q-1 3 -1 6.5t0.5 6.5t2 6l2.5 5t3.5 5.5t4 5t4.5 5t4 4.5q5 6 23 25t26 29.5t22.5 29t25 38.5t20.5 44q-124 72 -195 177t-71 224 q0 139 94 257t256.5 186.5t353.5 68.5t353.5 -68.5t256.5 -186.5t94 -257zM1792 512q0 -120 -71 -224.5t-195 -176.5q10 -24 20.5 -44t25 -38.5t22.5 -29t26 -29.5t23 -25q1 -1 4 -4.5t4.5 -5t4 -5t3.5 -5.5l2.5 -5t2 -6t0.5 -6.5t-1 -6.5q-3 -14 -13 -22t-22 -7 q-50 7 -86 16q-154 40 -278 128q-90 -16 -176 -16q-271 0 -472 132q58 -4 88 -4q161 0 309 45t264 129q125 92 192 212t67 254q0 77 -23 152q129 -71 204 -178t75 -230z" /> -<glyph unicode="" d="M256 192q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1408 768q0 51 -39 89.5t-89 38.5h-352q0 58 48 159.5t48 160.5q0 98 -32 145t-128 47q-26 -26 -38 -85t-30.5 -125.5t-59.5 -109.5q-22 -23 -77 -91q-4 -5 -23 -30t-31.5 -41t-34.5 -42.5 t-40 -44t-38.5 -35.5t-40 -27t-35.5 -9h-32v-640h32q13 0 31.5 -3t33 -6.5t38 -11t35 -11.5t35.5 -12.5t29 -10.5q211 -73 342 -73h121q192 0 192 167q0 26 -5 56q30 16 47.5 52.5t17.5 73.5t-18 69q53 50 53 119q0 25 -10 55.5t-25 47.5q32 1 53.5 47t21.5 81zM1536 769 q0 -89 -49 -163q9 -33 9 -69q0 -77 -38 -144q3 -21 3 -43q0 -101 -60 -178q1 -139 -85 -219.5t-227 -80.5h-36h-93q-96 0 -189.5 22.5t-216.5 65.5q-116 40 -138 40h-288q-53 0 -90.5 37.5t-37.5 90.5v640q0 53 37.5 90.5t90.5 37.5h274q36 24 137 155q58 75 107 128 q24 25 35.5 85.5t30.5 126.5t62 108q39 37 90 37q84 0 151 -32.5t102 -101.5t35 -186q0 -93 -48 -192h176q104 0 180 -76t76 -179z" /> -<glyph unicode="" d="M256 1088q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1408 512q0 35 -21.5 81t-53.5 47q15 17 25 47.5t10 55.5q0 69 -53 119q18 32 18 69t-17.5 73.5t-47.5 52.5q5 30 5 56q0 85 -49 126t-136 41h-128q-131 0 -342 -73q-5 -2 -29 -10.5 t-35.5 -12.5t-35 -11.5t-38 -11t-33 -6.5t-31.5 -3h-32v-640h32q16 0 35.5 -9t40 -27t38.5 -35.5t40 -44t34.5 -42.5t31.5 -41t23 -30q55 -68 77 -91q41 -43 59.5 -109.5t30.5 -125.5t38 -85q96 0 128 47t32 145q0 59 -48 160.5t-48 159.5h352q50 0 89 38.5t39 89.5z M1536 511q0 -103 -76 -179t-180 -76h-176q48 -99 48 -192q0 -118 -35 -186q-35 -69 -102 -101.5t-151 -32.5q-51 0 -90 37q-34 33 -54 82t-25.5 90.5t-17.5 84.5t-31 64q-48 50 -107 127q-101 131 -137 155h-274q-53 0 -90.5 37.5t-37.5 90.5v640q0 53 37.5 90.5t90.5 37.5 h288q22 0 138 40q128 44 223 66t200 22h112q140 0 226.5 -79t85.5 -216v-5q60 -77 60 -178q0 -22 -3 -43q38 -67 38 -144q0 -36 -9 -69q49 -74 49 -163z" /> -<glyph unicode="" horiz-adv-x="896" d="M832 1504v-1339l-449 -236q-22 -12 -40 -12q-21 0 -31.5 14.5t-10.5 35.5q0 6 2 20l86 500l-364 354q-25 27 -25 48q0 37 56 46l502 73l225 455q19 41 49 41z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1664 940q0 81 -21.5 143t-55 98.5t-81.5 59.5t-94 31t-98 8t-112 -25.5t-110.5 -64t-86.5 -72t-60 -61.5q-18 -22 -49 -22t-49 22q-24 28 -60 61.5t-86.5 72t-110.5 64t-112 25.5t-98 -8t-94 -31t-81.5 -59.5t-55 -98.5t-21.5 -143q0 -168 187 -355l581 -560l580 559 q188 188 188 356zM1792 940q0 -221 -229 -450l-623 -600q-18 -18 -44 -18t-44 18l-624 602q-10 8 -27.5 26t-55.5 65.5t-68 97.5t-53.5 121t-23.5 138q0 220 127 344t351 124q62 0 126.5 -21.5t120 -58t95.5 -68.5t76 -68q36 36 76 68t95.5 68.5t120 58t126.5 21.5 q224 0 351 -124t127 -344z" /> -<glyph unicode="" horiz-adv-x="1664" d="M640 96q0 -4 1 -20t0.5 -26.5t-3 -23.5t-10 -19.5t-20.5 -6.5h-320q-119 0 -203.5 84.5t-84.5 203.5v704q0 119 84.5 203.5t203.5 84.5h320q13 0 22.5 -9.5t9.5 -22.5q0 -4 1 -20t0.5 -26.5t-3 -23.5t-10 -19.5t-20.5 -6.5h-320q-66 0 -113 -47t-47 -113v-704 q0 -66 47 -113t113 -47h288h11h13t11.5 -1t11.5 -3t8 -5.5t7 -9t2 -13.5zM1568 640q0 -26 -19 -45l-544 -544q-19 -19 -45 -19t-45 19t-19 45v288h-448q-26 0 -45 19t-19 45v384q0 26 19 45t45 19h448v288q0 26 19 45t45 19t45 -19l544 -544q19 -19 19 -45z" /> -<glyph unicode="" d="M237 122h231v694h-231v-694zM483 1030q-1 52 -36 86t-93 34t-94.5 -34t-36.5 -86q0 -51 35.5 -85.5t92.5 -34.5h1q59 0 95 34.5t36 85.5zM1068 122h231v398q0 154 -73 233t-193 79q-136 0 -209 -117h2v101h-231q3 -66 0 -694h231v388q0 38 7 56q15 35 45 59.5t74 24.5 q116 0 116 -157v-371zM1536 1120v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> -<glyph unicode="" horiz-adv-x="1152" d="M480 672v448q0 14 -9 23t-23 9t-23 -9t-9 -23v-448q0 -14 9 -23t23 -9t23 9t9 23zM1152 320q0 -26 -19 -45t-45 -19h-429l-51 -483q-2 -12 -10.5 -20.5t-20.5 -8.5h-1q-27 0 -32 27l-76 485h-404q-26 0 -45 19t-19 45q0 123 78.5 221.5t177.5 98.5v512q-52 0 -90 38 t-38 90t38 90t90 38h640q52 0 90 -38t38 -90t-38 -90t-90 -38v-512q99 0 177.5 -98.5t78.5 -221.5z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1408 608v-320q0 -119 -84.5 -203.5t-203.5 -84.5h-832q-119 0 -203.5 84.5t-84.5 203.5v832q0 119 84.5 203.5t203.5 84.5h704q14 0 23 -9t9 -23v-64q0 -14 -9 -23t-23 -9h-704q-66 0 -113 -47t-47 -113v-832q0 -66 47 -113t113 -47h832q66 0 113 47t47 113v320 q0 14 9 23t23 9h64q14 0 23 -9t9 -23zM1792 1472v-512q0 -26 -19 -45t-45 -19t-45 19l-176 176l-652 -652q-10 -10 -23 -10t-23 10l-114 114q-10 10 -10 23t10 23l652 652l-176 176q-19 19 -19 45t19 45t45 19h512q26 0 45 -19t19 -45z" /> -<glyph unicode="" d="M1184 640q0 -26 -19 -45l-544 -544q-19 -19 -45 -19t-45 19t-19 45v288h-448q-26 0 -45 19t-19 45v384q0 26 19 45t45 19h448v288q0 26 19 45t45 19t45 -19l544 -544q19 -19 19 -45zM1536 992v-704q0 -119 -84.5 -203.5t-203.5 -84.5h-320q-13 0 -22.5 9.5t-9.5 22.5 q0 4 -1 20t-0.5 26.5t3 23.5t10 19.5t20.5 6.5h320q66 0 113 47t47 113v704q0 66 -47 113t-113 47h-288h-11h-13t-11.5 1t-11.5 3t-8 5.5t-7 9t-2 13.5q0 4 -1 20t-0.5 26.5t3 23.5t10 19.5t20.5 6.5h320q119 0 203.5 -84.5t84.5 -203.5z" /> -<glyph unicode="" horiz-adv-x="1664" d="M458 653q-74 162 -74 371h-256v-96q0 -78 94.5 -162t235.5 -113zM1536 928v96h-256q0 -209 -74 -371q141 29 235.5 113t94.5 162zM1664 1056v-128q0 -71 -41.5 -143t-112 -130t-173 -97.5t-215.5 -44.5q-42 -54 -95 -95q-38 -34 -52.5 -72.5t-14.5 -89.5q0 -54 30.5 -91 t97.5 -37q75 0 133.5 -45.5t58.5 -114.5v-64q0 -14 -9 -23t-23 -9h-832q-14 0 -23 9t-9 23v64q0 69 58.5 114.5t133.5 45.5q67 0 97.5 37t30.5 91q0 51 -14.5 89.5t-52.5 72.5q-53 41 -95 95q-113 5 -215.5 44.5t-173 97.5t-112 130t-41.5 143v128q0 40 28 68t68 28h288v96 q0 66 47 113t113 47h576q66 0 113 -47t47 -113v-96h288q40 0 68 -28t28 -68z" /> -<glyph unicode="" d="M394 184q-8 -9 -20 3q-13 11 -4 19q8 9 20 -3q12 -11 4 -19zM352 245q9 -12 0 -19q-8 -6 -17 7t0 18q9 7 17 -6zM291 305q-5 -7 -13 -2q-10 5 -7 12q3 5 13 2q10 -5 7 -12zM322 271q-6 -7 -16 3q-9 11 -2 16q6 6 16 -3q9 -11 2 -16zM451 159q-4 -12 -19 -6q-17 4 -13 15 t19 7q16 -5 13 -16zM514 154q0 -11 -16 -11q-17 -2 -17 11q0 11 16 11q17 2 17 -11zM572 164q2 -10 -14 -14t-18 8t14 15q16 2 18 -9zM1536 1120v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-224q-16 0 -24.5 1t-19.5 5t-16 14.5t-5 27.5v239q0 97 -52 142q57 6 102.5 18t94 39 t81 66.5t53 105t20.5 150.5q0 121 -79 206q37 91 -8 204q-28 9 -81 -11t-92 -44l-38 -24q-93 26 -192 26t-192 -26q-16 11 -42.5 27t-83.5 38.5t-86 13.5q-44 -113 -7 -204q-79 -85 -79 -206q0 -85 20.5 -150t52.5 -105t80.5 -67t94 -39t102.5 -18q-40 -36 -49 -103 q-21 -10 -45 -15t-57 -5t-65.5 21.5t-55.5 62.5q-19 32 -48.5 52t-49.5 24l-20 3q-21 0 -29 -4.5t-5 -11.5t9 -14t13 -12l7 -5q22 -10 43.5 -38t31.5 -51l10 -23q13 -38 44 -61.5t67 -30t69.5 -7t55.5 3.5l23 4q0 -38 0.5 -103t0.5 -68q0 -22 -11 -33.5t-22 -13t-33 -1.5 h-224q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> -<glyph unicode="" horiz-adv-x="1664" d="M1280 64q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1536 64q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1664 288v-320q0 -40 -28 -68t-68 -28h-1472q-40 0 -68 28t-28 68v320q0 40 28 68t68 28h427q21 -56 70.5 -92 t110.5 -36h256q61 0 110.5 36t70.5 92h427q40 0 68 -28t28 -68zM1339 936q-17 -40 -59 -40h-256v-448q0 -26 -19 -45t-45 -19h-256q-26 0 -45 19t-19 45v448h-256q-42 0 -59 40q-17 39 14 69l448 448q18 19 45 19t45 -19l448 -448q31 -30 14 -69z" /> -<glyph unicode="" d="M1407 710q0 44 -7 113.5t-18 96.5q-12 30 -17 44t-9 36.5t-4 48.5q0 23 5 68.5t5 67.5q0 37 -10 55q-4 1 -13 1q-19 0 -58 -4.5t-59 -4.5q-60 0 -176 24t-175 24q-43 0 -94.5 -11.5t-85 -23.5t-89.5 -34q-137 -54 -202 -103q-96 -73 -159.5 -189.5t-88 -236t-24.5 -248.5 q0 -40 12.5 -120t12.5 -121q0 -23 -11 -66.5t-11 -65.5t12 -36.5t34 -14.5q24 0 72.5 11t73.5 11q57 0 169.5 -15.5t169.5 -15.5q181 0 284 36q129 45 235.5 152.5t166 245.5t59.5 275zM1535 712q0 -165 -70 -327.5t-196 -288t-281 -180.5q-124 -44 -326 -44 q-57 0 -170 14.5t-169 14.5q-24 0 -72.5 -14.5t-73.5 -14.5q-73 0 -123.5 55.5t-50.5 128.5q0 24 11 68t11 67q0 40 -12.5 120.5t-12.5 121.5q0 111 18 217.5t54.5 209.5t100.5 194t150 156q78 59 232 120q194 78 316 78q60 0 175.5 -24t173.5 -24q19 0 57 5t58 5 q81 0 118 -50.5t37 -134.5q0 -23 -5 -68t-5 -68q0 -10 1 -18.5t3 -17t4 -13.5t6.5 -16t6.5 -17q16 -40 25 -118.5t9 -136.5z" /> -<glyph unicode="" horiz-adv-x="1408" d="M1408 296q0 -27 -10 -70.5t-21 -68.5q-21 -50 -122 -106q-94 -51 -186 -51q-27 0 -52.5 3.5t-57.5 12.5t-47.5 14.5t-55.5 20.5t-49 18q-98 35 -175 83q-128 79 -264.5 215.5t-215.5 264.5q-48 77 -83 175q-3 9 -18 49t-20.5 55.5t-14.5 47.5t-12.5 57.5t-3.5 52.5 q0 92 51 186q56 101 106 122q25 11 68.5 21t70.5 10q14 0 21 -3q18 -6 53 -76q11 -19 30 -54t35 -63.5t31 -53.5q3 -4 17.5 -25t21.5 -35.5t7 -28.5q0 -20 -28.5 -50t-62 -55t-62 -53t-28.5 -46q0 -9 5 -22.5t8.5 -20.5t14 -24t11.5 -19q76 -137 174 -235t235 -174 q2 -1 19 -11.5t24 -14t20.5 -8.5t22.5 -5q18 0 46 28.5t53 62t55 62t50 28.5q14 0 28.5 -7t35.5 -21.5t25 -17.5q25 -15 53.5 -31t63.5 -35t54 -30q70 -35 76 -53q3 -7 3 -21z" /> -<glyph unicode="" horiz-adv-x="1408" d="M1120 1280h-832q-66 0 -113 -47t-47 -113v-832q0 -66 47 -113t113 -47h832q66 0 113 47t47 113v832q0 66 -47 113t-113 47zM1408 1120v-832q0 -119 -84.5 -203.5t-203.5 -84.5h-832q-119 0 -203.5 84.5t-84.5 203.5v832q0 119 84.5 203.5t203.5 84.5h832 q119 0 203.5 -84.5t84.5 -203.5z" /> -<glyph unicode="" horiz-adv-x="1280" d="M1152 1280h-1024v-1242l423 406l89 85l89 -85l423 -406v1242zM1164 1408q23 0 44 -9q33 -13 52.5 -41t19.5 -62v-1289q0 -34 -19.5 -62t-52.5 -41q-19 -8 -44 -8q-48 0 -83 32l-441 424l-441 -424q-36 -33 -83 -33q-23 0 -44 9q-33 13 -52.5 41t-19.5 62v1289 q0 34 19.5 62t52.5 41q21 9 44 9h1048z" /> -<glyph unicode="" d="M1280 343q0 11 -2 16q-3 8 -38.5 29.5t-88.5 49.5l-53 29q-5 3 -19 13t-25 15t-21 5q-18 0 -47 -32.5t-57 -65.5t-44 -33q-7 0 -16.5 3.5t-15.5 6.5t-17 9.5t-14 8.5q-99 55 -170.5 126.5t-126.5 170.5q-2 3 -8.5 14t-9.5 17t-6.5 15.5t-3.5 16.5q0 13 20.5 33.5t45 38.5 t45 39.5t20.5 36.5q0 10 -5 21t-15 25t-13 19q-3 6 -15 28.5t-25 45.5t-26.5 47.5t-25 40.5t-16.5 18t-16 2q-48 0 -101 -22q-46 -21 -80 -94.5t-34 -130.5q0 -16 2.5 -34t5 -30.5t9 -33t10 -29.5t12.5 -33t11 -30q60 -164 216.5 -320.5t320.5 -216.5q6 -2 30 -11t33 -12.5 t29.5 -10t33 -9t30.5 -5t34 -2.5q57 0 130.5 34t94.5 80q22 53 22 101zM1536 1120v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> -<glyph unicode="" horiz-adv-x="1664" d="M1620 1128q-67 -98 -162 -167q1 -14 1 -42q0 -130 -38 -259.5t-115.5 -248.5t-184.5 -210.5t-258 -146t-323 -54.5q-271 0 -496 145q35 -4 78 -4q225 0 401 138q-105 2 -188 64.5t-114 159.5q33 -5 61 -5q43 0 85 11q-112 23 -185.5 111.5t-73.5 205.5v4q68 -38 146 -41 q-66 44 -105 115t-39 154q0 88 44 163q121 -149 294.5 -238.5t371.5 -99.5q-8 38 -8 74q0 134 94.5 228.5t228.5 94.5q140 0 236 -102q109 21 205 78q-37 -115 -142 -178q93 10 186 50z" /> -<glyph unicode="" horiz-adv-x="768" d="M511 980h257l-30 -284h-227v-824h-341v824h-170v284h170v171q0 182 86 275.5t283 93.5h227v-284h-142q-39 0 -62.5 -6.5t-34 -23.5t-13.5 -34.5t-3 -49.5v-142z" /> -<glyph unicode="" d="M1536 640q0 -251 -146.5 -451.5t-378.5 -277.5q-27 -5 -39.5 7t-12.5 30v211q0 97 -52 142q57 6 102.5 18t94 39t81 66.5t53 105t20.5 150.5q0 121 -79 206q37 91 -8 204q-28 9 -81 -11t-92 -44l-38 -24q-93 26 -192 26t-192 -26q-16 11 -42.5 27t-83.5 38.5t-86 13.5 q-44 -113 -7 -204q-79 -85 -79 -206q0 -85 20.5 -150t52.5 -105t80.5 -67t94 -39t102.5 -18q-40 -36 -49 -103q-21 -10 -45 -15t-57 -5t-65.5 21.5t-55.5 62.5q-19 32 -48.5 52t-49.5 24l-20 3q-21 0 -29 -4.5t-5 -11.5t9 -14t13 -12l7 -5q22 -10 43.5 -38t31.5 -51l10 -23 q13 -38 44 -61.5t67 -30t69.5 -7t55.5 3.5l23 4q0 -38 0.5 -89t0.5 -54q0 -18 -13 -30t-40 -7q-232 77 -378.5 277.5t-146.5 451.5q0 209 103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" horiz-adv-x="1664" d="M1664 960v-256q0 -26 -19 -45t-45 -19h-64q-26 0 -45 19t-19 45v256q0 106 -75 181t-181 75t-181 -75t-75 -181v-192h96q40 0 68 -28t28 -68v-576q0 -40 -28 -68t-68 -28h-960q-40 0 -68 28t-28 68v576q0 40 28 68t68 28h672v192q0 185 131.5 316.5t316.5 131.5 t316.5 -131.5t131.5 -316.5z" /> -<glyph unicode="" horiz-adv-x="1920" d="M1760 1408q66 0 113 -47t47 -113v-1216q0 -66 -47 -113t-113 -47h-1600q-66 0 -113 47t-47 113v1216q0 66 47 113t113 47h1600zM160 1280q-13 0 -22.5 -9.5t-9.5 -22.5v-224h1664v224q0 13 -9.5 22.5t-22.5 9.5h-1600zM1760 0q13 0 22.5 9.5t9.5 22.5v608h-1664v-608 q0 -13 9.5 -22.5t22.5 -9.5h1600zM256 128v128h256v-128h-256zM640 128v128h384v-128h-384z" /> -<glyph unicode="" horiz-adv-x="1408" d="M384 192q0 -80 -56 -136t-136 -56t-136 56t-56 136t56 136t136 56t136 -56t56 -136zM896 69q2 -28 -17 -48q-18 -21 -47 -21h-135q-25 0 -43 16.5t-20 41.5q-22 229 -184.5 391.5t-391.5 184.5q-25 2 -41.5 20t-16.5 43v135q0 29 21 47q17 17 43 17h5q160 -13 306 -80.5 t259 -181.5q114 -113 181.5 -259t80.5 -306zM1408 67q2 -27 -18 -47q-18 -20 -46 -20h-143q-26 0 -44.5 17.5t-19.5 42.5q-12 215 -101 408.5t-231.5 336t-336 231.5t-408.5 102q-25 1 -42.5 19.5t-17.5 43.5v143q0 28 20 46q18 18 44 18h3q262 -13 501.5 -120t425.5 -294 q187 -186 294 -425.5t120 -501.5z" /> -<glyph unicode="" d="M1040 320q0 -33 -23.5 -56.5t-56.5 -23.5t-56.5 23.5t-23.5 56.5t23.5 56.5t56.5 23.5t56.5 -23.5t23.5 -56.5zM1296 320q0 -33 -23.5 -56.5t-56.5 -23.5t-56.5 23.5t-23.5 56.5t23.5 56.5t56.5 23.5t56.5 -23.5t23.5 -56.5zM1408 160v320q0 13 -9.5 22.5t-22.5 9.5 h-1216q-13 0 -22.5 -9.5t-9.5 -22.5v-320q0 -13 9.5 -22.5t22.5 -9.5h1216q13 0 22.5 9.5t9.5 22.5zM178 640h1180l-157 482q-4 13 -16 21.5t-26 8.5h-782q-14 0 -26 -8.5t-16 -21.5zM1536 480v-320q0 -66 -47 -113t-113 -47h-1216q-66 0 -113 47t-47 113v320q0 25 16 75 l197 606q17 53 63 86t101 33h782q55 0 101 -33t63 -86l197 -606q16 -50 16 -75z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1664 896q53 0 90.5 -37.5t37.5 -90.5t-37.5 -90.5t-90.5 -37.5v-384q0 -52 -38 -90t-90 -38q-417 347 -812 380q-58 -19 -91 -66t-31 -100.5t40 -92.5q-20 -33 -23 -65.5t6 -58t33.5 -55t48 -50t61.5 -50.5q-29 -58 -111.5 -83t-168.5 -11.5t-132 55.5q-7 23 -29.5 87.5 t-32 94.5t-23 89t-15 101t3.5 98.5t22 110.5h-122q-66 0 -113 47t-47 113v192q0 66 47 113t113 47h480q435 0 896 384q52 0 90 -38t38 -90v-384zM1536 292v954q-394 -302 -768 -343v-270q377 -42 768 -341z" /> -<glyph unicode="" horiz-adv-x="1664" d="M848 -160q0 16 -16 16q-59 0 -101.5 42.5t-42.5 101.5q0 16 -16 16t-16 -16q0 -73 51.5 -124.5t124.5 -51.5q16 0 16 16zM183 128h1298q-164 181 -246.5 411.5t-82.5 484.5q0 256 -320 256t-320 -256q0 -254 -82.5 -484.5t-246.5 -411.5zM1664 128q0 -52 -38 -90t-90 -38 h-448q0 -106 -75 -181t-181 -75t-181 75t-75 181h-448q-52 0 -90 38t-38 90q190 161 287 397.5t97 498.5q0 165 96 262t264 117q-8 18 -8 37q0 40 28 68t68 28t68 -28t28 -68q0 -19 -8 -37q168 -20 264 -117t96 -262q0 -262 97 -498.5t287 -397.5z" /> -<glyph unicode="" d="M1376 640l138 -135q30 -28 20 -70q-12 -41 -52 -51l-188 -48l53 -186q12 -41 -19 -70q-29 -31 -70 -19l-186 53l-48 -188q-10 -40 -51 -52q-12 -2 -19 -2q-31 0 -51 22l-135 138l-135 -138q-28 -30 -70 -20q-41 11 -51 52l-48 188l-186 -53q-41 -12 -70 19q-31 29 -19 70 l53 186l-188 48q-40 10 -52 51q-10 42 20 70l138 135l-138 135q-30 28 -20 70q12 41 52 51l188 48l-53 186q-12 41 19 70q29 31 70 19l186 -53l48 188q10 41 51 51q41 12 70 -19l135 -139l135 139q29 30 70 19q41 -10 51 -51l48 -188l186 53q41 12 70 -19q31 -29 19 -70 l-53 -186l188 -48q40 -10 52 -51q10 -42 -20 -70z" /> -<glyph unicode="" horiz-adv-x="1792" d="M256 192q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1664 768q0 51 -39 89.5t-89 38.5h-576q0 20 15 48.5t33 55t33 68t15 84.5q0 67 -44.5 97.5t-115.5 30.5q-24 0 -90 -139q-24 -44 -37 -65q-40 -64 -112 -145q-71 -81 -101 -106 q-69 -57 -140 -57h-32v-640h32q72 0 167 -32t193.5 -64t179.5 -32q189 0 189 167q0 26 -5 56q30 16 47.5 52.5t17.5 73.5t-18 69q53 50 53 119q0 25 -10 55.5t-25 47.5h331q52 0 90 38t38 90zM1792 769q0 -105 -75.5 -181t-180.5 -76h-169q-4 -62 -37 -119q3 -21 3 -43 q0 -101 -60 -178q1 -139 -85 -219.5t-227 -80.5q-133 0 -322 69q-164 59 -223 59h-288q-53 0 -90.5 37.5t-37.5 90.5v640q0 53 37.5 90.5t90.5 37.5h288q10 0 21.5 4.5t23.5 14t22.5 18t24 22.5t20.5 21.5t19 21.5t14 17q65 74 100 129q13 21 33 62t37 72t40.5 63t55 49.5 t69.5 17.5q125 0 206.5 -67t81.5 -189q0 -68 -22 -128h374q104 0 180 -76t76 -179z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1376 128h32v640h-32q-35 0 -67.5 12t-62.5 37t-50 46t-49 54q-2 3 -3.5 4.5t-4 4.5t-4.5 5q-72 81 -112 145q-14 22 -38 68q-1 3 -10.5 22.5t-18.5 36t-20 35.5t-21.5 30.5t-18.5 11.5q-71 0 -115.5 -30.5t-44.5 -97.5q0 -43 15 -84.5t33 -68t33 -55t15 -48.5h-576 q-50 0 -89 -38.5t-39 -89.5q0 -52 38 -90t90 -38h331q-15 -17 -25 -47.5t-10 -55.5q0 -69 53 -119q-18 -32 -18 -69t17.5 -73.5t47.5 -52.5q-4 -24 -4 -56q0 -85 48.5 -126t135.5 -41q84 0 183 32t194 64t167 32zM1664 192q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45 t45 -19t45 19t19 45zM1792 768v-640q0 -53 -37.5 -90.5t-90.5 -37.5h-288q-59 0 -223 -59q-190 -69 -317 -69q-142 0 -230 77.5t-87 217.5l1 5q-61 76 -61 178q0 22 3 43q-33 57 -37 119h-169q-105 0 -180.5 76t-75.5 181q0 103 76 179t180 76h374q-22 60 -22 128 q0 122 81.5 189t206.5 67q38 0 69.5 -17.5t55 -49.5t40.5 -63t37 -72t33 -62q35 -55 100 -129q2 -3 14 -17t19 -21.5t20.5 -21.5t24 -22.5t22.5 -18t23.5 -14t21.5 -4.5h288q53 0 90.5 -37.5t37.5 -90.5z" /> -<glyph unicode="" d="M1280 -64q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1408 700q0 189 -167 189q-26 0 -56 -5q-16 30 -52.5 47.5t-73.5 17.5t-69 -18q-50 53 -119 53q-25 0 -55.5 -10t-47.5 -25v331q0 52 -38 90t-90 38q-51 0 -89.5 -39t-38.5 -89v-576 q-20 0 -48.5 15t-55 33t-68 33t-84.5 15q-67 0 -97.5 -44.5t-30.5 -115.5q0 -24 139 -90q44 -24 65 -37q64 -40 145 -112q81 -71 106 -101q57 -69 57 -140v-32h640v32q0 72 32 167t64 193.5t32 179.5zM1536 705q0 -133 -69 -322q-59 -164 -59 -223v-288q0 -53 -37.5 -90.5 t-90.5 -37.5h-640q-53 0 -90.5 37.5t-37.5 90.5v288q0 10 -4.5 21.5t-14 23.5t-18 22.5t-22.5 24t-21.5 20.5t-21.5 19t-17 14q-74 65 -129 100q-21 13 -62 33t-72 37t-63 40.5t-49.5 55t-17.5 69.5q0 125 67 206.5t189 81.5q68 0 128 -22v374q0 104 76 180t179 76 q105 0 181 -75.5t76 -180.5v-169q62 -4 119 -37q21 3 43 3q101 0 178 -60q139 1 219.5 -85t80.5 -227z" /> -<glyph unicode="" d="M1408 576q0 84 -32 183t-64 194t-32 167v32h-640v-32q0 -35 -12 -67.5t-37 -62.5t-46 -50t-54 -49q-9 -8 -14 -12q-81 -72 -145 -112q-22 -14 -68 -38q-3 -1 -22.5 -10.5t-36 -18.5t-35.5 -20t-30.5 -21.5t-11.5 -18.5q0 -71 30.5 -115.5t97.5 -44.5q43 0 84.5 15t68 33 t55 33t48.5 15v-576q0 -50 38.5 -89t89.5 -39q52 0 90 38t38 90v331q46 -35 103 -35q69 0 119 53q32 -18 69 -18t73.5 17.5t52.5 47.5q24 -4 56 -4q85 0 126 48.5t41 135.5zM1280 1344q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1536 580 q0 -142 -77.5 -230t-217.5 -87l-5 1q-76 -61 -178 -61q-22 0 -43 3q-54 -30 -119 -37v-169q0 -105 -76 -180.5t-181 -75.5q-103 0 -179 76t-76 180v374q-54 -22 -128 -22q-121 0 -188.5 81.5t-67.5 206.5q0 38 17.5 69.5t49.5 55t63 40.5t72 37t62 33q55 35 129 100 q3 2 17 14t21.5 19t21.5 20.5t22.5 24t18 22.5t14 23.5t4.5 21.5v288q0 53 37.5 90.5t90.5 37.5h640q53 0 90.5 -37.5t37.5 -90.5v-288q0 -59 59 -223q69 -190 69 -317z" /> -<glyph unicode="" d="M1280 576v128q0 26 -19 45t-45 19h-502l189 189q19 19 19 45t-19 45l-91 91q-18 18 -45 18t-45 -18l-362 -362l-91 -91q-18 -18 -18 -45t18 -45l91 -91l362 -362q18 -18 45 -18t45 18l91 91q18 18 18 45t-18 45l-189 189h502q26 0 45 19t19 45zM1536 640 q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" d="M1285 640q0 27 -18 45l-91 91l-362 362q-18 18 -45 18t-45 -18l-91 -91q-18 -18 -18 -45t18 -45l189 -189h-502q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45t45 -19h502l-189 -189q-19 -19 -19 -45t19 -45l91 -91q18 -18 45 -18t45 18l362 362l91 91q18 18 18 45zM1536 640 q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" d="M1284 641q0 27 -18 45l-362 362l-91 91q-18 18 -45 18t-45 -18l-91 -91l-362 -362q-18 -18 -18 -45t18 -45l91 -91q18 -18 45 -18t45 18l189 189v-502q0 -26 19 -45t45 -19h128q26 0 45 19t19 45v502l189 -189q19 -19 45 -19t45 19l91 91q18 18 18 45zM1536 640 q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" d="M1284 639q0 27 -18 45l-91 91q-18 18 -45 18t-45 -18l-189 -189v502q0 26 -19 45t-45 19h-128q-26 0 -45 -19t-19 -45v-502l-189 189q-19 19 -45 19t-45 -19l-91 -91q-18 -18 -18 -45t18 -45l362 -362l91 -91q18 -18 45 -18t45 18l91 91l362 362q18 18 18 45zM1536 640 q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" d="M768 1408q209 0 385.5 -103t279.5 -279.5t103 -385.5t-103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103zM1042 887q-2 -1 -9.5 -9.5t-13.5 -9.5q2 0 4.5 5t5 11t3.5 7q6 7 22 15q14 6 52 12q34 8 51 -11 q-2 2 9.5 13t14.5 12q3 2 15 4.5t15 7.5l2 22q-12 -1 -17.5 7t-6.5 21q0 -2 -6 -8q0 7 -4.5 8t-11.5 -1t-9 -1q-10 3 -15 7.5t-8 16.5t-4 15q-2 5 -9.5 10.5t-9.5 10.5q-1 2 -2.5 5.5t-3 6.5t-4 5.5t-5.5 2.5t-7 -5t-7.5 -10t-4.5 -5q-3 2 -6 1.5t-4.5 -1t-4.5 -3t-5 -3.5 q-3 -2 -8.5 -3t-8.5 -2q15 5 -1 11q-10 4 -16 3q9 4 7.5 12t-8.5 14h5q-1 4 -8.5 8.5t-17.5 8.5t-13 6q-8 5 -34 9.5t-33 0.5q-5 -6 -4.5 -10.5t4 -14t3.5 -12.5q1 -6 -5.5 -13t-6.5 -12q0 -7 14 -15.5t10 -21.5q-3 -8 -16 -16t-16 -12q-5 -8 -1.5 -18.5t10.5 -16.5 q2 -2 1.5 -4t-3.5 -4.5t-5.5 -4t-6.5 -3.5l-3 -2q-11 -5 -20.5 6t-13.5 26q-7 25 -16 30q-23 8 -29 -1q-5 13 -41 26q-25 9 -58 4q6 1 0 15q-7 15 -19 12q3 6 4 17.5t1 13.5q3 13 12 23q1 1 7 8.5t9.5 13.5t0.5 6q35 -4 50 11q5 5 11.5 17t10.5 17q9 6 14 5.5t14.5 -5.5 t14.5 -5q14 -1 15.5 11t-7.5 20q12 -1 3 17q-5 7 -8 9q-12 4 -27 -5q-8 -4 2 -8q-1 1 -9.5 -10.5t-16.5 -17.5t-16 5q-1 1 -5.5 13.5t-9.5 13.5q-8 0 -16 -15q3 8 -11 15t-24 8q19 12 -8 27q-7 4 -20.5 5t-19.5 -4q-5 -7 -5.5 -11.5t5 -8t10.5 -5.5t11.5 -4t8.5 -3 q14 -10 8 -14q-2 -1 -8.5 -3.5t-11.5 -4.5t-6 -4q-3 -4 0 -14t-2 -14q-5 5 -9 17.5t-7 16.5q7 -9 -25 -6l-10 1q-4 0 -16 -2t-20.5 -1t-13.5 8q-4 8 0 20q1 4 4 2q-4 3 -11 9.5t-10 8.5q-46 -15 -94 -41q6 -1 12 1q5 2 13 6.5t10 5.5q34 14 42 7l5 5q14 -16 20 -25 q-7 4 -30 1q-20 -6 -22 -12q7 -12 5 -18q-4 3 -11.5 10t-14.5 11t-15 5q-16 0 -22 -1q-146 -80 -235 -222q7 -7 12 -8q4 -1 5 -9t2.5 -11t11.5 3q9 -8 3 -19q1 1 44 -27q19 -17 21 -21q3 -11 -10 -18q-1 2 -9 9t-9 4q-3 -5 0.5 -18.5t10.5 -12.5q-7 0 -9.5 -16t-2.5 -35.5 t-1 -23.5l2 -1q-3 -12 5.5 -34.5t21.5 -19.5q-13 -3 20 -43q6 -8 8 -9q3 -2 12 -7.5t15 -10t10 -10.5q4 -5 10 -22.5t14 -23.5q-2 -6 9.5 -20t10.5 -23q-1 0 -2.5 -1t-2.5 -1q3 -7 15.5 -14t15.5 -13q1 -3 2 -10t3 -11t8 -2q2 20 -24 62q-15 25 -17 29q-3 5 -5.5 15.5 t-4.5 14.5q2 0 6 -1.5t8.5 -3.5t7.5 -4t2 -3q-3 -7 2 -17.5t12 -18.5t17 -19t12 -13q6 -6 14 -19.5t0 -13.5q9 0 20 -10t17 -20q5 -8 8 -26t5 -24q2 -7 8.5 -13.5t12.5 -9.5l16 -8t13 -7q5 -2 18.5 -10.5t21.5 -11.5q10 -4 16 -4t14.5 2.5t13.5 3.5q15 2 29 -15t21 -21 q36 -19 55 -11q-2 -1 0.5 -7.5t8 -15.5t9 -14.5t5.5 -8.5q5 -6 18 -15t18 -15q6 4 7 9q-3 -8 7 -20t18 -10q14 3 14 32q-31 -15 -49 18q0 1 -2.5 5.5t-4 8.5t-2.5 8.5t0 7.5t5 3q9 0 10 3.5t-2 12.5t-4 13q-1 8 -11 20t-12 15q-5 -9 -16 -8t-16 9q0 -1 -1.5 -5.5t-1.5 -6.5 q-13 0 -15 1q1 3 2.5 17.5t3.5 22.5q1 4 5.5 12t7.5 14.5t4 12.5t-4.5 9.5t-17.5 2.5q-19 -1 -26 -20q-1 -3 -3 -10.5t-5 -11.5t-9 -7q-7 -3 -24 -2t-24 5q-13 8 -22.5 29t-9.5 37q0 10 2.5 26.5t3 25t-5.5 24.5q3 2 9 9.5t10 10.5q2 1 4.5 1.5t4.5 0t4 1.5t3 6q-1 1 -4 3 q-3 3 -4 3q7 -3 28.5 1.5t27.5 -1.5q15 -11 22 2q0 1 -2.5 9.5t-0.5 13.5q5 -27 29 -9q3 -3 15.5 -5t17.5 -5q3 -2 7 -5.5t5.5 -4.5t5 0.5t8.5 6.5q10 -14 12 -24q11 -40 19 -44q7 -3 11 -2t4.5 9.5t0 14t-1.5 12.5l-1 8v18l-1 8q-15 3 -18.5 12t1.5 18.5t15 18.5q1 1 8 3.5 t15.5 6.5t12.5 8q21 19 15 35q7 0 11 9q-1 0 -5 3t-7.5 5t-4.5 2q9 5 2 16q5 3 7.5 11t7.5 10q9 -12 21 -2q7 8 1 16q5 7 20.5 10.5t18.5 9.5q7 -2 8 2t1 12t3 12q4 5 15 9t13 5l17 11q3 4 0 4q18 -2 31 11q10 11 -6 20q3 6 -3 9.5t-15 5.5q3 1 11.5 0.5t10.5 1.5 q15 10 -7 16q-17 5 -43 -12zM879 10q206 36 351 189q-3 3 -12.5 4.5t-12.5 3.5q-18 7 -24 8q1 7 -2.5 13t-8 9t-12.5 8t-11 7q-2 2 -7 6t-7 5.5t-7.5 4.5t-8.5 2t-10 -1l-3 -1q-3 -1 -5.5 -2.5t-5.5 -3t-4 -3t0 -2.5q-21 17 -36 22q-5 1 -11 5.5t-10.5 7t-10 1.5t-11.5 -7 q-5 -5 -6 -15t-2 -13q-7 5 0 17.5t2 18.5q-3 6 -10.5 4.5t-12 -4.5t-11.5 -8.5t-9 -6.5t-8.5 -5.5t-8.5 -7.5q-3 -4 -6 -12t-5 -11q-2 4 -11.5 6.5t-9.5 5.5q2 -10 4 -35t5 -38q7 -31 -12 -48q-27 -25 -29 -40q-4 -22 12 -26q0 -7 -8 -20.5t-7 -21.5q0 -6 2 -16z" /> -<glyph unicode="" horiz-adv-x="1664" d="M384 64q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1028 484l-682 -682q-37 -37 -90 -37q-52 0 -91 37l-106 108q-38 36 -38 90q0 53 38 91l681 681q39 -98 114.5 -173.5t173.5 -114.5zM1662 919q0 -39 -23 -106q-47 -134 -164.5 -217.5 t-258.5 -83.5q-185 0 -316.5 131.5t-131.5 316.5t131.5 316.5t316.5 131.5q58 0 121.5 -16.5t107.5 -46.5q16 -11 16 -28t-16 -28l-293 -169v-224l193 -107q5 3 79 48.5t135.5 81t70.5 35.5q15 0 23.5 -10t8.5 -25z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1024 128h640v128h-640v-128zM640 640h1024v128h-1024v-128zM1280 1152h384v128h-384v-128zM1792 320v-256q0 -26 -19 -45t-45 -19h-1664q-26 0 -45 19t-19 45v256q0 26 19 45t45 19h1664q26 0 45 -19t19 -45zM1792 832v-256q0 -26 -19 -45t-45 -19h-1664q-26 0 -45 19 t-19 45v256q0 26 19 45t45 19h1664q26 0 45 -19t19 -45zM1792 1344v-256q0 -26 -19 -45t-45 -19h-1664q-26 0 -45 19t-19 45v256q0 26 19 45t45 19h1664q26 0 45 -19t19 -45z" /> -<glyph unicode="" horiz-adv-x="1408" d="M1403 1241q17 -41 -14 -70l-493 -493v-742q0 -42 -39 -59q-13 -5 -25 -5q-27 0 -45 19l-256 256q-19 19 -19 45v486l-493 493q-31 29 -14 70q17 39 59 39h1280q42 0 59 -39z" /> -<glyph unicode="" horiz-adv-x="1792" d="M640 1280h512v128h-512v-128zM1792 640v-480q0 -66 -47 -113t-113 -47h-1472q-66 0 -113 47t-47 113v480h672v-160q0 -26 19 -45t45 -19h320q26 0 45 19t19 45v160h672zM1024 640v-128h-256v128h256zM1792 1120v-384h-1792v384q0 66 47 113t113 47h352v160q0 40 28 68 t68 28h576q40 0 68 -28t28 -68v-160h352q66 0 113 -47t47 -113z" /> -<glyph unicode="" d="M1283 995l-355 -355l355 -355l144 144q29 31 70 14q39 -17 39 -59v-448q0 -26 -19 -45t-45 -19h-448q-42 0 -59 40q-17 39 14 69l144 144l-355 355l-355 -355l144 -144q31 -30 14 -69q-17 -40 -59 -40h-448q-26 0 -45 19t-19 45v448q0 42 40 59q39 17 69 -14l144 -144 l355 355l-355 355l-144 -144q-19 -19 -45 -19q-12 0 -24 5q-40 17 -40 59v448q0 26 19 45t45 19h448q42 0 59 -40q17 -39 -14 -69l-144 -144l355 -355l355 355l-144 144q-31 30 -14 69q17 40 59 40h448q26 0 45 -19t19 -45v-448q0 -42 -39 -59q-13 -5 -25 -5q-26 0 -45 19z " /> -<glyph unicode="" horiz-adv-x="1920" d="M593 640q-162 -5 -265 -128h-134q-82 0 -138 40.5t-56 118.5q0 353 124 353q6 0 43.5 -21t97.5 -42.5t119 -21.5q67 0 133 23q-5 -37 -5 -66q0 -139 81 -256zM1664 3q0 -120 -73 -189.5t-194 -69.5h-874q-121 0 -194 69.5t-73 189.5q0 53 3.5 103.5t14 109t26.5 108.5 t43 97.5t62 81t85.5 53.5t111.5 20q10 0 43 -21.5t73 -48t107 -48t135 -21.5t135 21.5t107 48t73 48t43 21.5q61 0 111.5 -20t85.5 -53.5t62 -81t43 -97.5t26.5 -108.5t14 -109t3.5 -103.5zM640 1280q0 -106 -75 -181t-181 -75t-181 75t-75 181t75 181t181 75t181 -75 t75 -181zM1344 896q0 -159 -112.5 -271.5t-271.5 -112.5t-271.5 112.5t-112.5 271.5t112.5 271.5t271.5 112.5t271.5 -112.5t112.5 -271.5zM1920 671q0 -78 -56 -118.5t-138 -40.5h-134q-103 123 -265 128q81 117 81 256q0 29 -5 66q66 -23 133 -23q59 0 119 21.5t97.5 42.5 t43.5 21q124 0 124 -353zM1792 1280q0 -106 -75 -181t-181 -75t-181 75t-75 181t75 181t181 75t181 -75t75 -181z" /> -<glyph unicode="" horiz-adv-x="1664" d="M1456 320q0 40 -28 68l-208 208q-28 28 -68 28q-42 0 -72 -32q3 -3 19 -18.5t21.5 -21.5t15 -19t13 -25.5t3.5 -27.5q0 -40 -28 -68t-68 -28q-15 0 -27.5 3.5t-25.5 13t-19 15t-21.5 21.5t-18.5 19q-33 -31 -33 -73q0 -40 28 -68l206 -207q27 -27 68 -27q40 0 68 26 l147 146q28 28 28 67zM753 1025q0 40 -28 68l-206 207q-28 28 -68 28q-39 0 -68 -27l-147 -146q-28 -28 -28 -67q0 -40 28 -68l208 -208q27 -27 68 -27q42 0 72 31q-3 3 -19 18.5t-21.5 21.5t-15 19t-13 25.5t-3.5 27.5q0 40 28 68t68 28q15 0 27.5 -3.5t25.5 -13t19 -15 t21.5 -21.5t18.5 -19q33 31 33 73zM1648 320q0 -120 -85 -203l-147 -146q-83 -83 -203 -83q-121 0 -204 85l-206 207q-83 83 -83 203q0 123 88 209l-88 88q-86 -88 -208 -88q-120 0 -204 84l-208 208q-84 84 -84 204t85 203l147 146q83 83 203 83q121 0 204 -85l206 -207 q83 -83 83 -203q0 -123 -88 -209l88 -88q86 88 208 88q120 0 204 -84l208 -208q84 -84 84 -204z" /> -<glyph unicode="" horiz-adv-x="1920" d="M1920 384q0 -159 -112.5 -271.5t-271.5 -112.5h-1088q-185 0 -316.5 131.5t-131.5 316.5q0 132 71 241.5t187 163.5q-2 28 -2 43q0 212 150 362t362 150q158 0 286.5 -88t187.5 -230q70 62 166 62q106 0 181 -75t75 -181q0 -75 -41 -138q129 -30 213 -134.5t84 -239.5z " /> -<glyph unicode="" horiz-adv-x="1664" d="M1527 88q56 -89 21.5 -152.5t-140.5 -63.5h-1152q-106 0 -140.5 63.5t21.5 152.5l503 793v399h-64q-26 0 -45 19t-19 45t19 45t45 19h512q26 0 45 -19t19 -45t-19 -45t-45 -19h-64v-399zM748 813l-272 -429h712l-272 429l-20 31v37v399h-128v-399v-37z" /> -<glyph unicode="" horiz-adv-x="1792" d="M960 640q26 0 45 -19t19 -45t-19 -45t-45 -19t-45 19t-19 45t19 45t45 19zM1260 576l507 -398q28 -20 25 -56q-5 -35 -35 -51l-128 -64q-13 -7 -29 -7q-17 0 -31 8l-690 387l-110 -66q-8 -4 -12 -5q14 -49 10 -97q-7 -77 -56 -147.5t-132 -123.5q-132 -84 -277 -84 q-136 0 -222 78q-90 84 -79 207q7 76 56 147t131 124q132 84 278 84q83 0 151 -31q9 13 22 22l122 73l-122 73q-13 9 -22 22q-68 -31 -151 -31q-146 0 -278 84q-82 53 -131 124t-56 147q-5 59 15.5 113t63.5 93q85 79 222 79q145 0 277 -84q83 -52 132 -123t56 -148 q4 -48 -10 -97q4 -1 12 -5l110 -66l690 387q14 8 31 8q16 0 29 -7l128 -64q30 -16 35 -51q3 -36 -25 -56zM579 836q46 42 21 108t-106 117q-92 59 -192 59q-74 0 -113 -36q-46 -42 -21 -108t106 -117q92 -59 192 -59q74 0 113 36zM494 91q81 51 106 117t-21 108 q-39 36 -113 36q-100 0 -192 -59q-81 -51 -106 -117t21 -108q39 -36 113 -36q100 0 192 59zM672 704l96 -58v11q0 36 33 56l14 8l-79 47l-26 -26q-3 -3 -10 -11t-12 -12q-2 -2 -4 -3.5t-3 -2.5zM896 480l96 -32l736 576l-128 64l-768 -431v-113l-160 -96l9 -8q2 -2 7 -6 q4 -4 11 -12t11 -12l26 -26zM1600 64l128 64l-520 408l-177 -138q-2 -3 -13 -7z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1696 1152q40 0 68 -28t28 -68v-1216q0 -40 -28 -68t-68 -28h-960q-40 0 -68 28t-28 68v288h-544q-40 0 -68 28t-28 68v672q0 40 20 88t48 76l408 408q28 28 76 48t88 20h416q40 0 68 -28t28 -68v-328q68 40 128 40h416zM1152 939l-299 -299h299v299zM512 1323l-299 -299 h299v299zM708 676l316 316v416h-384v-416q0 -40 -28 -68t-68 -28h-416v-640h512v256q0 40 20 88t48 76zM1664 -128v1152h-384v-416q0 -40 -28 -68t-68 -28h-416v-640h896z" /> -<glyph unicode="" horiz-adv-x="1408" d="M1404 151q0 -117 -79 -196t-196 -79q-135 0 -235 100l-777 776q-113 115 -113 271q0 159 110 270t269 111q158 0 273 -113l605 -606q10 -10 10 -22q0 -16 -30.5 -46.5t-46.5 -30.5q-13 0 -23 10l-606 607q-79 77 -181 77q-106 0 -179 -75t-73 -181q0 -105 76 -181 l776 -777q63 -63 145 -63q64 0 106 42t42 106q0 82 -63 145l-581 581q-26 24 -60 24q-29 0 -48 -19t-19 -48q0 -32 25 -59l410 -410q10 -10 10 -22q0 -16 -31 -47t-47 -31q-12 0 -22 10l-410 410q-63 61 -63 149q0 82 57 139t139 57q88 0 149 -63l581 -581q100 -98 100 -235 z" /> -<glyph unicode="" d="M384 0h768v384h-768v-384zM1280 0h128v896q0 14 -10 38.5t-20 34.5l-281 281q-10 10 -34 20t-39 10v-416q0 -40 -28 -68t-68 -28h-576q-40 0 -68 28t-28 68v416h-128v-1280h128v416q0 40 28 68t68 28h832q40 0 68 -28t28 -68v-416zM896 928v320q0 13 -9.5 22.5t-22.5 9.5 h-192q-13 0 -22.5 -9.5t-9.5 -22.5v-320q0 -13 9.5 -22.5t22.5 -9.5h192q13 0 22.5 9.5t9.5 22.5zM1536 896v-928q0 -40 -28 -68t-68 -28h-1344q-40 0 -68 28t-28 68v1344q0 40 28 68t68 28h928q40 0 88 -20t76 -48l280 -280q28 -28 48 -76t20 -88z" /> -<glyph unicode="" d="M1536 1120v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> -<glyph unicode="" d="M1536 192v-128q0 -26 -19 -45t-45 -19h-1408q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1408q26 0 45 -19t19 -45zM1536 704v-128q0 -26 -19 -45t-45 -19h-1408q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1408q26 0 45 -19t19 -45zM1536 1216v-128q0 -26 -19 -45 t-45 -19h-1408q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1408q26 0 45 -19t19 -45z" /> -<glyph unicode="" horiz-adv-x="1792" d="M384 128q0 -80 -56 -136t-136 -56t-136 56t-56 136t56 136t136 56t136 -56t56 -136zM384 640q0 -80 -56 -136t-136 -56t-136 56t-56 136t56 136t136 56t136 -56t56 -136zM1792 224v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1216q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5 t22.5 9.5h1216q13 0 22.5 -9.5t9.5 -22.5zM384 1152q0 -80 -56 -136t-136 -56t-136 56t-56 136t56 136t136 56t136 -56t56 -136zM1792 736v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1216q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1216q13 0 22.5 -9.5t9.5 -22.5z M1792 1248v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1216q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1216q13 0 22.5 -9.5t9.5 -22.5z" /> -<glyph unicode="" horiz-adv-x="1792" d="M381 -84q0 -80 -54.5 -126t-135.5 -46q-106 0 -172 66l57 88q49 -45 106 -45q29 0 50.5 14.5t21.5 42.5q0 64 -105 56l-26 56q8 10 32.5 43.5t42.5 54t37 38.5v1q-16 0 -48.5 -1t-48.5 -1v-53h-106v152h333v-88l-95 -115q51 -12 81 -49t30 -88zM383 543v-159h-362 q-6 36 -6 54q0 51 23.5 93t56.5 68t66 47.5t56.5 43.5t23.5 45q0 25 -14.5 38.5t-39.5 13.5q-46 0 -81 -58l-85 59q24 51 71.5 79.5t105.5 28.5q73 0 123 -41.5t50 -112.5q0 -50 -34 -91.5t-75 -64.5t-75.5 -50.5t-35.5 -52.5h127v60h105zM1792 224v-192q0 -13 -9.5 -22.5 t-22.5 -9.5h-1216q-13 0 -22.5 9.5t-9.5 22.5v192q0 14 9 23t23 9h1216q13 0 22.5 -9.5t9.5 -22.5zM384 1123v-99h-335v99h107q0 41 0.5 122t0.5 121v12h-2q-8 -17 -50 -54l-71 76l136 127h106v-404h108zM1792 736v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1216q-13 0 -22.5 9.5 t-9.5 22.5v192q0 14 9 23t23 9h1216q13 0 22.5 -9.5t9.5 -22.5zM1792 1248v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1216q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1216q13 0 22.5 -9.5t9.5 -22.5z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1760 640q14 0 23 -9t9 -23v-64q0 -14 -9 -23t-23 -9h-1728q-14 0 -23 9t-9 23v64q0 14 9 23t23 9h1728zM483 704q-28 35 -51 80q-48 97 -48 188q0 181 134 309q133 127 393 127q50 0 167 -19q66 -12 177 -48q10 -38 21 -118q14 -123 14 -183q0 -18 -5 -45l-12 -3l-84 6 l-14 2q-50 149 -103 205q-88 91 -210 91q-114 0 -182 -59q-67 -58 -67 -146q0 -73 66 -140t279 -129q69 -20 173 -66q58 -28 95 -52h-743zM990 448h411q7 -39 7 -92q0 -111 -41 -212q-23 -55 -71 -104q-37 -35 -109 -81q-80 -48 -153 -66q-80 -21 -203 -21q-114 0 -195 23 l-140 40q-57 16 -72 28q-8 8 -8 22v13q0 108 -2 156q-1 30 0 68l2 37v44l102 2q15 -34 30 -71t22.5 -56t12.5 -27q35 -57 80 -94q43 -36 105 -57q59 -22 132 -22q64 0 139 27q77 26 122 86q47 61 47 129q0 84 -81 157q-34 29 -137 71z" /> -<glyph unicode="" d="M48 1313q-37 2 -45 4l-3 88q13 1 40 1q60 0 112 -4q132 -7 166 -7q86 0 168 3q116 4 146 5q56 0 86 2l-1 -14l2 -64v-9q-60 -9 -124 -9q-60 0 -79 -25q-13 -14 -13 -132q0 -13 0.5 -32.5t0.5 -25.5l1 -229l14 -280q6 -124 51 -202q35 -59 96 -92q88 -47 177 -47 q104 0 191 28q56 18 99 51q48 36 65 64q36 56 53 114q21 73 21 229q0 79 -3.5 128t-11 122.5t-13.5 159.5l-4 59q-5 67 -24 88q-34 35 -77 34l-100 -2l-14 3l2 86h84l205 -10q76 -3 196 10l18 -2q6 -38 6 -51q0 -7 -4 -31q-45 -12 -84 -13q-73 -11 -79 -17q-15 -15 -15 -41 q0 -7 1.5 -27t1.5 -31q8 -19 22 -396q6 -195 -15 -304q-15 -76 -41 -122q-38 -65 -112 -123q-75 -57 -182 -89q-109 -33 -255 -33q-167 0 -284 46q-119 47 -179 122q-61 76 -83 195q-16 80 -16 237v333q0 188 -17 213q-25 36 -147 39zM1536 -96v64q0 14 -9 23t-23 9h-1472 q-14 0 -23 -9t-9 -23v-64q0 -14 9 -23t23 -9h1472q14 0 23 9t9 23z" /> -<glyph unicode="" horiz-adv-x="1664" d="M512 160v192q0 14 -9 23t-23 9h-320q-14 0 -23 -9t-9 -23v-192q0 -14 9 -23t23 -9h320q14 0 23 9t9 23zM512 544v192q0 14 -9 23t-23 9h-320q-14 0 -23 -9t-9 -23v-192q0 -14 9 -23t23 -9h320q14 0 23 9t9 23zM1024 160v192q0 14 -9 23t-23 9h-320q-14 0 -23 -9t-9 -23 v-192q0 -14 9 -23t23 -9h320q14 0 23 9t9 23zM512 928v192q0 14 -9 23t-23 9h-320q-14 0 -23 -9t-9 -23v-192q0 -14 9 -23t23 -9h320q14 0 23 9t9 23zM1024 544v192q0 14 -9 23t-23 9h-320q-14 0 -23 -9t-9 -23v-192q0 -14 9 -23t23 -9h320q14 0 23 9t9 23zM1536 160v192 q0 14 -9 23t-23 9h-320q-14 0 -23 -9t-9 -23v-192q0 -14 9 -23t23 -9h320q14 0 23 9t9 23zM1024 928v192q0 14 -9 23t-23 9h-320q-14 0 -23 -9t-9 -23v-192q0 -14 9 -23t23 -9h320q14 0 23 9t9 23zM1536 544v192q0 14 -9 23t-23 9h-320q-14 0 -23 -9t-9 -23v-192 q0 -14 9 -23t23 -9h320q14 0 23 9t9 23zM1536 928v192q0 14 -9 23t-23 9h-320q-14 0 -23 -9t-9 -23v-192q0 -14 9 -23t23 -9h320q14 0 23 9t9 23zM1664 1248v-1088q0 -66 -47 -113t-113 -47h-1344q-66 0 -113 47t-47 113v1088q0 66 47 113t113 47h1344q66 0 113 -47t47 -113 z" /> -<glyph unicode="" horiz-adv-x="1664" d="M1190 955l293 293l-107 107l-293 -293zM1637 1248q0 -27 -18 -45l-1286 -1286q-18 -18 -45 -18t-45 18l-198 198q-18 18 -18 45t18 45l1286 1286q18 18 45 18t45 -18l198 -198q18 -18 18 -45zM286 1438l98 -30l-98 -30l-30 -98l-30 98l-98 30l98 30l30 98zM636 1276 l196 -60l-196 -60l-60 -196l-60 196l-196 60l196 60l60 196zM1566 798l98 -30l-98 -30l-30 -98l-30 98l-98 30l98 30l30 98zM926 1438l98 -30l-98 -30l-30 -98l-30 98l-98 30l98 30l30 98z" /> -<glyph unicode="" horiz-adv-x="1792" d="M640 128q0 52 -38 90t-90 38t-90 -38t-38 -90t38 -90t90 -38t90 38t38 90zM256 640h384v256h-158q-13 0 -22 -9l-195 -195q-9 -9 -9 -22v-30zM1536 128q0 52 -38 90t-90 38t-90 -38t-38 -90t38 -90t90 -38t90 38t38 90zM1792 1216v-1024q0 -15 -4 -26.5t-13.5 -18.5 t-16.5 -11.5t-23.5 -6t-22.5 -2t-25.5 0t-22.5 0.5q0 -106 -75 -181t-181 -75t-181 75t-75 181h-384q0 -106 -75 -181t-181 -75t-181 75t-75 181h-64q-3 0 -22.5 -0.5t-25.5 0t-22.5 2t-23.5 6t-16.5 11.5t-13.5 18.5t-4 26.5q0 26 19 45t45 19v320q0 8 -0.5 35t0 38 t2.5 34.5t6.5 37t14 30.5t22.5 30l198 198q19 19 50.5 32t58.5 13h160v192q0 26 19 45t45 19h1024q26 0 45 -19t19 -45z" /> -<glyph unicode="" d="M1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103q-111 0 -218 32q59 93 78 164q9 34 54 211q20 -39 73 -67.5t114 -28.5q121 0 216 68.5t147 188.5t52 270q0 114 -59.5 214t-172.5 163t-255 63q-105 0 -196 -29t-154.5 -77t-109 -110.5t-67 -129.5t-21.5 -134 q0 -104 40 -183t117 -111q30 -12 38 20q2 7 8 31t8 30q6 23 -11 43q-51 61 -51 151q0 151 104.5 259.5t273.5 108.5q151 0 235.5 -82t84.5 -213q0 -170 -68.5 -289t-175.5 -119q-61 0 -98 43.5t-23 104.5q8 35 26.5 93.5t30 103t11.5 75.5q0 50 -27 83t-77 33 q-62 0 -105 -57t-43 -142q0 -73 25 -122l-99 -418q-17 -70 -13 -177q-206 91 -333 281t-127 423q0 209 103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" d="M1248 1408q119 0 203.5 -84.5t84.5 -203.5v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-725q85 122 108 210q9 34 53 209q21 -39 73.5 -67t112.5 -28q181 0 295.5 147.5t114.5 373.5q0 84 -35 162.5t-96.5 139t-152.5 97t-197 36.5q-104 0 -194.5 -28.5t-153 -76.5 t-107.5 -109.5t-66.5 -128t-21.5 -132.5q0 -102 39.5 -180t116.5 -110q13 -5 23.5 0t14.5 19q10 44 15 61q6 23 -11 42q-50 62 -50 150q0 150 103.5 256.5t270.5 106.5q149 0 232.5 -81t83.5 -210q0 -168 -67.5 -286t-173.5 -118q-60 0 -97 43.5t-23 103.5q8 34 26.5 92.5 t29.5 102t11 74.5q0 49 -26.5 81.5t-75.5 32.5q-61 0 -103.5 -56.5t-42.5 -139.5q0 -72 24 -121l-98 -414q-24 -100 -7 -254h-183q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960z" /> -<glyph unicode="" d="M678 -57q0 -38 -10 -71h-380q-95 0 -171.5 56.5t-103.5 147.5q24 45 69 77.5t100 49.5t107 24t107 7q32 0 49 -2q6 -4 30.5 -21t33 -23t31 -23t32 -25.5t27.5 -25.5t26.5 -29.5t21 -30.5t17.5 -34.5t9.5 -36t4.5 -40.5zM385 294q-234 -7 -385 -85v433q103 -118 273 -118 q32 0 70 5q-21 -61 -21 -86q0 -67 63 -149zM558 805q0 -100 -43.5 -160.5t-140.5 -60.5q-51 0 -97 26t-78 67.5t-56 93.5t-35.5 104t-11.5 99q0 96 51.5 165t144.5 69q66 0 119 -41t84 -104t47 -130t16 -128zM1536 896v-736q0 -119 -84.5 -203.5t-203.5 -84.5h-468 q39 73 39 157q0 66 -22 122.5t-55.5 93t-72 71t-72 59.5t-55.5 54.5t-22 59.5q0 36 23 68t56 61.5t65.5 64.5t55.5 93t23 131t-26.5 145.5t-75.5 118.5q-6 6 -14 11t-12.5 7.5t-10 9.5t-10.5 17h135l135 64h-437q-138 0 -244.5 -38.5t-182.5 -133.5q0 126 81 213t207 87h960 q119 0 203.5 -84.5t84.5 -203.5v-96h-256v256h-128v-256h-256v-128h256v-256h128v256h256z" /> -<glyph unicode="" horiz-adv-x="1664" d="M876 71q0 21 -4.5 40.5t-9.5 36t-17.5 34.5t-21 30.5t-26.5 29.5t-27.5 25.5t-32 25.5t-31 23t-33 23t-30.5 21q-17 2 -50 2q-54 0 -106 -7t-108 -25t-98 -46t-69 -75t-27 -107q0 -68 35.5 -121.5t93 -84t120.5 -45.5t127 -15q59 0 112.5 12.5t100.5 39t74.5 73.5 t27.5 110zM756 933q0 60 -16.5 127.5t-47 130.5t-84 104t-119.5 41q-93 0 -144 -69t-51 -165q0 -47 11.5 -99t35.5 -104t56 -93.5t78 -67.5t97 -26q97 0 140.5 60.5t43.5 160.5zM625 1408h437l-135 -79h-135q71 -45 110 -126t39 -169q0 -74 -23 -131.5t-56 -92.5t-66 -64.5 t-56 -61t-23 -67.5q0 -26 16.5 -51t43 -48t58.5 -48t64 -55.5t58.5 -66t43 -85t16.5 -106.5q0 -160 -140 -282q-152 -131 -420 -131q-59 0 -119.5 10t-122 33.5t-108.5 58t-77 89t-30 121.5q0 61 37 135q32 64 96 110.5t145 71t155 36t150 13.5q-64 83 -64 149q0 12 2 23.5 t5 19.5t8 21.5t7 21.5q-40 -5 -70 -5q-149 0 -255.5 98t-106.5 246q0 140 95 250.5t234 141.5q94 20 187 20zM1664 1152v-128h-256v-256h-128v256h-256v128h256v256h128v-256h256z" /> -<glyph unicode="" horiz-adv-x="1920" d="M768 384h384v96h-128v448h-114l-148 -137l77 -80q42 37 55 57h2v-288h-128v-96zM1280 640q0 -70 -21 -142t-59.5 -134t-101.5 -101t-138 -39t-138 39t-101.5 101t-59.5 134t-21 142t21 142t59.5 134t101.5 101t138 39t138 -39t101.5 -101t59.5 -134t21 -142zM1792 384 v512q-106 0 -181 75t-75 181h-1152q0 -106 -75 -181t-181 -75v-512q106 0 181 -75t75 -181h1152q0 106 75 181t181 75zM1920 1216v-1152q0 -26 -19 -45t-45 -19h-1792q-26 0 -45 19t-19 45v1152q0 26 19 45t45 19h1792q26 0 45 -19t19 -45z" /> -<glyph unicode="" horiz-adv-x="1024" d="M1024 832q0 -26 -19 -45l-448 -448q-19 -19 -45 -19t-45 19l-448 448q-19 19 -19 45t19 45t45 19h896q26 0 45 -19t19 -45z" /> -<glyph unicode="" horiz-adv-x="1024" d="M1024 320q0 -26 -19 -45t-45 -19h-896q-26 0 -45 19t-19 45t19 45l448 448q19 19 45 19t45 -19l448 -448q19 -19 19 -45z" /> -<glyph unicode="" horiz-adv-x="640" d="M640 1088v-896q0 -26 -19 -45t-45 -19t-45 19l-448 448q-19 19 -19 45t19 45l448 448q19 19 45 19t45 -19t19 -45z" /> -<glyph unicode="" horiz-adv-x="640" d="M576 640q0 -26 -19 -45l-448 -448q-19 -19 -45 -19t-45 19t-19 45v896q0 26 19 45t45 19t45 -19l448 -448q19 -19 19 -45z" /> -<glyph unicode="" horiz-adv-x="1664" d="M160 0h608v1152h-640v-1120q0 -13 9.5 -22.5t22.5 -9.5zM1536 32v1120h-640v-1152h608q13 0 22.5 9.5t9.5 22.5zM1664 1248v-1216q0 -66 -47 -113t-113 -47h-1344q-66 0 -113 47t-47 113v1216q0 66 47 113t113 47h1344q66 0 113 -47t47 -113z" /> -<glyph unicode="" horiz-adv-x="1024" d="M1024 448q0 -26 -19 -45l-448 -448q-19 -19 -45 -19t-45 19l-448 448q-19 19 -19 45t19 45t45 19h896q26 0 45 -19t19 -45zM1024 832q0 -26 -19 -45t-45 -19h-896q-26 0 -45 19t-19 45t19 45l448 448q19 19 45 19t45 -19l448 -448q19 -19 19 -45z" /> -<glyph unicode="" horiz-adv-x="1024" d="M1024 448q0 -26 -19 -45l-448 -448q-19 -19 -45 -19t-45 19l-448 448q-19 19 -19 45t19 45t45 19h896q26 0 45 -19t19 -45z" /> -<glyph unicode="" horiz-adv-x="1024" d="M1024 832q0 -26 -19 -45t-45 -19h-896q-26 0 -45 19t-19 45t19 45l448 448q19 19 45 19t45 -19l448 -448q19 -19 19 -45z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1792 826v-794q0 -66 -47 -113t-113 -47h-1472q-66 0 -113 47t-47 113v794q44 -49 101 -87q362 -246 497 -345q57 -42 92.5 -65.5t94.5 -48t110 -24.5h1h1q51 0 110 24.5t94.5 48t92.5 65.5q170 123 498 345q57 39 100 87zM1792 1120q0 -79 -49 -151t-122 -123 q-376 -261 -468 -325q-10 -7 -42.5 -30.5t-54 -38t-52 -32.5t-57.5 -27t-50 -9h-1h-1q-23 0 -50 9t-57.5 27t-52 32.5t-54 38t-42.5 30.5q-91 64 -262 182.5t-205 142.5q-62 42 -117 115.5t-55 136.5q0 78 41.5 130t118.5 52h1472q65 0 112.5 -47t47.5 -113z" /> -<glyph unicode="" d="M349 911v-991h-330v991h330zM370 1217q1 -73 -50.5 -122t-135.5 -49h-2q-82 0 -132 49t-50 122q0 74 51.5 122.5t134.5 48.5t133 -48.5t51 -122.5zM1536 488v-568h-329v530q0 105 -40.5 164.5t-126.5 59.5q-63 0 -105.5 -34.5t-63.5 -85.5q-11 -30 -11 -81v-553h-329 q2 399 2 647t-1 296l-1 48h329v-144h-2q20 32 41 56t56.5 52t87 43.5t114.5 15.5q171 0 275 -113.5t104 -332.5z" /> -<glyph unicode="" d="M1536 640q0 -156 -61 -298t-164 -245t-245 -164t-298 -61q-172 0 -327 72.5t-264 204.5q-7 10 -6.5 22.5t8.5 20.5l137 138q10 9 25 9q16 -2 23 -12q73 -95 179 -147t225 -52q104 0 198.5 40.5t163.5 109.5t109.5 163.5t40.5 198.5t-40.5 198.5t-109.5 163.5 t-163.5 109.5t-198.5 40.5q-98 0 -188 -35.5t-160 -101.5l137 -138q31 -30 14 -69q-17 -40 -59 -40h-448q-26 0 -45 19t-19 45v448q0 42 40 59q39 17 69 -14l130 -129q107 101 244.5 156.5t284.5 55.5q156 0 298 -61t245 -164t164 -245t61 -298z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1771 0q0 -53 -37 -90l-107 -108q-39 -37 -91 -37q-53 0 -90 37l-363 364q-38 36 -38 90q0 53 43 96l-256 256l-126 -126q-14 -14 -34 -14t-34 14q2 -2 12.5 -12t12.5 -13t10 -11.5t10 -13.5t6 -13.5t5.5 -16.5t1.5 -18q0 -38 -28 -68q-3 -3 -16.5 -18t-19 -20.5 t-18.5 -16.5t-22 -15.5t-22 -9t-26 -4.5q-40 0 -68 28l-408 408q-28 28 -28 68q0 13 4.5 26t9 22t15.5 22t16.5 18.5t20.5 19t18 16.5q30 28 68 28q10 0 18 -1.5t16.5 -5.5t13.5 -6t13.5 -10t11.5 -10t13 -12.5t12 -12.5q-14 14 -14 34t14 34l348 348q14 14 34 14t34 -14 q-2 2 -12.5 12t-12.5 13t-10 11.5t-10 13.5t-6 13.5t-5.5 16.5t-1.5 18q0 38 28 68q3 3 16.5 18t19 20.5t18.5 16.5t22 15.5t22 9t26 4.5q40 0 68 -28l408 -408q28 -28 28 -68q0 -13 -4.5 -26t-9 -22t-15.5 -22t-16.5 -18.5t-20.5 -19t-18 -16.5q-30 -28 -68 -28 q-10 0 -18 1.5t-16.5 5.5t-13.5 6t-13.5 10t-11.5 10t-13 12.5t-12 12.5q14 -14 14 -34t-14 -34l-126 -126l256 -256q43 43 96 43q52 0 91 -37l363 -363q37 -39 37 -91z" /> -<glyph unicode="" horiz-adv-x="1792" d="M384 384q0 53 -37.5 90.5t-90.5 37.5t-90.5 -37.5t-37.5 -90.5t37.5 -90.5t90.5 -37.5t90.5 37.5t37.5 90.5zM576 832q0 53 -37.5 90.5t-90.5 37.5t-90.5 -37.5t-37.5 -90.5t37.5 -90.5t90.5 -37.5t90.5 37.5t37.5 90.5zM1004 351l101 382q6 26 -7.5 48.5t-38.5 29.5 t-48 -6.5t-30 -39.5l-101 -382q-60 -5 -107 -43.5t-63 -98.5q-20 -77 20 -146t117 -89t146 20t89 117q16 60 -6 117t-72 91zM1664 384q0 53 -37.5 90.5t-90.5 37.5t-90.5 -37.5t-37.5 -90.5t37.5 -90.5t90.5 -37.5t90.5 37.5t37.5 90.5zM1024 1024q0 53 -37.5 90.5 t-90.5 37.5t-90.5 -37.5t-37.5 -90.5t37.5 -90.5t90.5 -37.5t90.5 37.5t37.5 90.5zM1472 832q0 53 -37.5 90.5t-90.5 37.5t-90.5 -37.5t-37.5 -90.5t37.5 -90.5t90.5 -37.5t90.5 37.5t37.5 90.5zM1792 384q0 -261 -141 -483q-19 -29 -54 -29h-1402q-35 0 -54 29 q-141 221 -141 483q0 182 71 348t191 286t286 191t348 71t348 -71t286 -191t191 -286t71 -348z" /> -<glyph unicode="" horiz-adv-x="1792" d="M896 1152q-204 0 -381.5 -69.5t-282 -187.5t-104.5 -255q0 -112 71.5 -213.5t201.5 -175.5l87 -50l-27 -96q-24 -91 -70 -172q152 63 275 171l43 38l57 -6q69 -8 130 -8q204 0 381.5 69.5t282 187.5t104.5 255t-104.5 255t-282 187.5t-381.5 69.5zM1792 640 q0 -174 -120 -321.5t-326 -233t-450 -85.5q-70 0 -145 8q-198 -175 -460 -242q-49 -14 -114 -22h-5q-15 0 -27 10.5t-16 27.5v1q-3 4 -0.5 12t2 10t4.5 9.5l6 9t7 8.5t8 9q7 8 31 34.5t34.5 38t31 39.5t32.5 51t27 59t26 76q-157 89 -247.5 220t-90.5 281q0 174 120 321.5 t326 233t450 85.5t450 -85.5t326 -233t120 -321.5z" /> -<glyph unicode="" horiz-adv-x="1792" d="M704 1152q-153 0 -286 -52t-211.5 -141t-78.5 -191q0 -82 53 -158t149 -132l97 -56l-35 -84q34 20 62 39l44 31l53 -10q78 -14 153 -14q153 0 286 52t211.5 141t78.5 191t-78.5 191t-211.5 141t-286 52zM704 1280q191 0 353.5 -68.5t256.5 -186.5t94 -257t-94 -257 t-256.5 -186.5t-353.5 -68.5q-86 0 -176 16q-124 -88 -278 -128q-36 -9 -86 -16h-3q-11 0 -20.5 8t-11.5 21q-1 3 -1 6.5t0.5 6.5t2 6l2.5 5t3.5 5.5t4 5t4.5 5t4 4.5q5 6 23 25t26 29.5t22.5 29t25 38.5t20.5 44q-124 72 -195 177t-71 224q0 139 94 257t256.5 186.5 t353.5 68.5zM1526 111q10 -24 20.5 -44t25 -38.5t22.5 -29t26 -29.5t23 -25q1 -1 4 -4.5t4.5 -5t4 -5t3.5 -5.5l2.5 -5t2 -6t0.5 -6.5t-1 -6.5q-3 -14 -13 -22t-22 -7q-50 7 -86 16q-154 40 -278 128q-90 -16 -176 -16q-271 0 -472 132q58 -4 88 -4q161 0 309 45t264 129 q125 92 192 212t67 254q0 77 -23 152q129 -71 204 -178t75 -230q0 -120 -71 -224.5t-195 -176.5z" /> -<glyph unicode="" horiz-adv-x="896" d="M885 970q18 -20 7 -44l-540 -1157q-13 -25 -42 -25q-4 0 -14 2q-17 5 -25.5 19t-4.5 30l197 808l-406 -101q-4 -1 -12 -1q-18 0 -31 11q-18 15 -13 39l201 825q4 14 16 23t28 9h328q19 0 32 -12.5t13 -29.5q0 -8 -5 -18l-171 -463l396 98q8 2 12 2q19 0 34 -15z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1792 288v-320q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v320q0 40 28 68t68 28h96v192h-512v-192h96q40 0 68 -28t28 -68v-320q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v320q0 40 28 68t68 28h96v192h-512v-192h96q40 0 68 -28t28 -68v-320 q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v320q0 40 28 68t68 28h96v192q0 52 38 90t90 38h512v192h-96q-40 0 -68 28t-28 68v320q0 40 28 68t68 28h320q40 0 68 -28t28 -68v-320q0 -40 -28 -68t-68 -28h-96v-192h512q52 0 90 -38t38 -90v-192h96q40 0 68 -28t28 -68 z" /> -<glyph unicode="" horiz-adv-x="1664" d="M896 708v-580q0 -104 -76 -180t-180 -76t-180 76t-76 180q0 26 19 45t45 19t45 -19t19 -45q0 -50 39 -89t89 -39t89 39t39 89v580q33 11 64 11t64 -11zM1664 681q0 -13 -9.5 -22.5t-22.5 -9.5q-11 0 -23 10q-49 46 -93 69t-102 23q-68 0 -128 -37t-103 -97 q-7 -10 -17.5 -28t-14.5 -24q-11 -17 -28 -17q-18 0 -29 17q-4 6 -14.5 24t-17.5 28q-43 60 -102.5 97t-127.5 37t-127.5 -37t-102.5 -97q-7 -10 -17.5 -28t-14.5 -24q-11 -17 -29 -17q-17 0 -28 17q-4 6 -14.5 24t-17.5 28q-43 60 -103 97t-128 37q-58 0 -102 -23t-93 -69 q-12 -10 -23 -10q-13 0 -22.5 9.5t-9.5 22.5q0 5 1 7q45 183 172.5 319.5t298 204.5t360.5 68q140 0 274.5 -40t246.5 -113.5t194.5 -187t115.5 -251.5q1 -2 1 -7zM896 1408v-98q-42 2 -64 2t-64 -2v98q0 26 19 45t45 19t45 -19t19 -45z" /> -<glyph unicode="" horiz-adv-x="1792" d="M768 -128h896v640h-416q-40 0 -68 28t-28 68v416h-384v-1152zM1024 1312v64q0 13 -9.5 22.5t-22.5 9.5h-704q-13 0 -22.5 -9.5t-9.5 -22.5v-64q0 -13 9.5 -22.5t22.5 -9.5h704q13 0 22.5 9.5t9.5 22.5zM1280 640h299l-299 299v-299zM1792 512v-672q0 -40 -28 -68t-68 -28 h-960q-40 0 -68 28t-28 68v160h-544q-40 0 -68 28t-28 68v1344q0 40 28 68t68 28h1088q40 0 68 -28t28 -68v-328q21 -13 36 -28l408 -408q28 -28 48 -76t20 -88z" /> -<glyph unicode="" horiz-adv-x="1024" d="M736 960q0 -13 -9.5 -22.5t-22.5 -9.5t-22.5 9.5t-9.5 22.5q0 46 -54 71t-106 25q-13 0 -22.5 9.5t-9.5 22.5t9.5 22.5t22.5 9.5q50 0 99.5 -16t87 -54t37.5 -90zM896 960q0 72 -34.5 134t-90 101.5t-123 62t-136.5 22.5t-136.5 -22.5t-123 -62t-90 -101.5t-34.5 -134 q0 -101 68 -180q10 -11 30.5 -33t30.5 -33q128 -153 141 -298h228q13 145 141 298q10 11 30.5 33t30.5 33q68 79 68 180zM1024 960q0 -155 -103 -268q-45 -49 -74.5 -87t-59.5 -95.5t-34 -107.5q47 -28 47 -82q0 -37 -25 -64q25 -27 25 -64q0 -52 -45 -81q13 -23 13 -47 q0 -46 -31.5 -71t-77.5 -25q-20 -44 -60 -70t-87 -26t-87 26t-60 70q-46 0 -77.5 25t-31.5 71q0 24 13 47q-45 29 -45 81q0 37 25 64q-25 27 -25 64q0 54 47 82q-4 50 -34 107.5t-59.5 95.5t-74.5 87q-103 113 -103 268q0 99 44.5 184.5t117 142t164 89t186.5 32.5 t186.5 -32.5t164 -89t117 -142t44.5 -184.5z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1792 352v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1376v-192q0 -13 -9.5 -22.5t-22.5 -9.5q-12 0 -24 10l-319 320q-9 9 -9 22q0 14 9 23l320 320q9 9 23 9q13 0 22.5 -9.5t9.5 -22.5v-192h1376q13 0 22.5 -9.5t9.5 -22.5zM1792 896q0 -14 -9 -23l-320 -320q-9 -9 -23 -9 q-13 0 -22.5 9.5t-9.5 22.5v192h-1376q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1376v192q0 14 9 23t23 9q12 0 24 -10l319 -319q9 -9 9 -23z" /> -<glyph unicode="" horiz-adv-x="1920" d="M1280 608q0 14 -9 23t-23 9h-224v352q0 13 -9.5 22.5t-22.5 9.5h-192q-13 0 -22.5 -9.5t-9.5 -22.5v-352h-224q-13 0 -22.5 -9.5t-9.5 -22.5q0 -14 9 -23l352 -352q9 -9 23 -9t23 9l351 351q10 12 10 24zM1920 384q0 -159 -112.5 -271.5t-271.5 -112.5h-1088 q-185 0 -316.5 131.5t-131.5 316.5q0 130 70 240t188 165q-2 30 -2 43q0 212 150 362t362 150q156 0 285.5 -87t188.5 -231q71 62 166 62q106 0 181 -75t75 -181q0 -76 -41 -138q130 -31 213.5 -135.5t83.5 -238.5z" /> -<glyph unicode="" horiz-adv-x="1920" d="M1280 672q0 14 -9 23l-352 352q-9 9 -23 9t-23 -9l-351 -351q-10 -12 -10 -24q0 -14 9 -23t23 -9h224v-352q0 -13 9.5 -22.5t22.5 -9.5h192q13 0 22.5 9.5t9.5 22.5v352h224q13 0 22.5 9.5t9.5 22.5zM1920 384q0 -159 -112.5 -271.5t-271.5 -112.5h-1088 q-185 0 -316.5 131.5t-131.5 316.5q0 130 70 240t188 165q-2 30 -2 43q0 212 150 362t362 150q156 0 285.5 -87t188.5 -231q71 62 166 62q106 0 181 -75t75 -181q0 -76 -41 -138q130 -31 213.5 -135.5t83.5 -238.5z" /> -<glyph unicode="" horiz-adv-x="1408" d="M384 192q0 -26 -19 -45t-45 -19t-45 19t-19 45t19 45t45 19t45 -19t19 -45zM1408 131q0 -121 -73 -190t-194 -69h-874q-121 0 -194 69t-73 190q0 68 5.5 131t24 138t47.5 132.5t81 103t120 60.5q-22 -52 -22 -120v-203q-58 -20 -93 -70t-35 -111q0 -80 56 -136t136 -56 t136 56t56 136q0 61 -35.5 111t-92.5 70v203q0 62 25 93q132 -104 295 -104t295 104q25 -31 25 -93v-64q-106 0 -181 -75t-75 -181v-89q-32 -29 -32 -71q0 -40 28 -68t68 -28t68 28t28 68q0 42 -32 71v89q0 52 38 90t90 38t90 -38t38 -90v-89q-32 -29 -32 -71q0 -40 28 -68 t68 -28t68 28t28 68q0 42 -32 71v89q0 68 -34.5 127.5t-93.5 93.5q0 10 0.5 42.5t0 48t-2.5 41.5t-7 47t-13 40q68 -15 120 -60.5t81 -103t47.5 -132.5t24 -138t5.5 -131zM1088 1024q0 -159 -112.5 -271.5t-271.5 -112.5t-271.5 112.5t-112.5 271.5t112.5 271.5t271.5 112.5 t271.5 -112.5t112.5 -271.5z" /> -<glyph unicode="" horiz-adv-x="1408" d="M1280 832q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1408 832q0 -62 -35.5 -111t-92.5 -70v-395q0 -159 -131.5 -271.5t-316.5 -112.5t-316.5 112.5t-131.5 271.5v132q-164 20 -274 128t-110 252v512q0 26 19 45t45 19q6 0 16 -2q17 30 47 48 t65 18q53 0 90.5 -37.5t37.5 -90.5t-37.5 -90.5t-90.5 -37.5q-33 0 -64 18v-402q0 -106 94 -181t226 -75t226 75t94 181v402q-31 -18 -64 -18q-53 0 -90.5 37.5t-37.5 90.5t37.5 90.5t90.5 37.5q35 0 65 -18t47 -48q10 2 16 2q26 0 45 -19t19 -45v-512q0 -144 -110 -252 t-274 -128v-132q0 -106 94 -181t226 -75t226 75t94 181v395q-57 21 -92.5 70t-35.5 111q0 80 56 136t136 56t136 -56t56 -136z" /> -<glyph unicode="" horiz-adv-x="1792" d="M640 1152h512v128h-512v-128zM288 1152v-1280h-64q-92 0 -158 66t-66 158v832q0 92 66 158t158 66h64zM1408 1152v-1280h-1024v1280h128v160q0 40 28 68t68 28h576q40 0 68 -28t28 -68v-160h128zM1792 928v-832q0 -92 -66 -158t-158 -66h-64v1280h64q92 0 158 -66 t66 -158z" /> -<glyph unicode="" horiz-adv-x="1664" d="M848 -160q0 16 -16 16q-59 0 -101.5 42.5t-42.5 101.5q0 16 -16 16t-16 -16q0 -73 51.5 -124.5t124.5 -51.5q16 0 16 16zM1664 128q0 -52 -38 -90t-90 -38h-448q0 -106 -75 -181t-181 -75t-181 75t-75 181h-448q-52 0 -90 38t-38 90q190 161 287 397.5t97 498.5 q0 165 96 262t264 117q-8 18 -8 37q0 40 28 68t68 28t68 -28t28 -68q0 -19 -8 -37q168 -20 264 -117t96 -262q0 -262 97 -498.5t287 -397.5z" /> -<glyph unicode="" horiz-adv-x="1920" d="M1664 896q0 80 -56 136t-136 56h-64v-384h64q80 0 136 56t56 136zM0 128h1792q0 -106 -75 -181t-181 -75h-1280q-106 0 -181 75t-75 181zM1856 896q0 -159 -112.5 -271.5t-271.5 -112.5h-64v-32q0 -92 -66 -158t-158 -66h-704q-92 0 -158 66t-66 158v736q0 26 19 45 t45 19h1152q159 0 271.5 -112.5t112.5 -271.5z" /> -<glyph unicode="" horiz-adv-x="1408" d="M640 1472v-640q0 -61 -35.5 -111t-92.5 -70v-779q0 -52 -38 -90t-90 -38h-128q-52 0 -90 38t-38 90v779q-57 20 -92.5 70t-35.5 111v640q0 26 19 45t45 19t45 -19t19 -45v-416q0 -26 19 -45t45 -19t45 19t19 45v416q0 26 19 45t45 19t45 -19t19 -45v-416q0 -26 19 -45 t45 -19t45 19t19 45v416q0 26 19 45t45 19t45 -19t19 -45zM1408 1472v-1600q0 -52 -38 -90t-90 -38h-128q-52 0 -90 38t-38 90v512h-224q-13 0 -22.5 9.5t-9.5 22.5v800q0 132 94 226t226 94h256q26 0 45 -19t19 -45z" /> -<glyph unicode="" horiz-adv-x="1280" d="M1024 352v-64q0 -14 -9 -23t-23 -9h-704q-14 0 -23 9t-9 23v64q0 14 9 23t23 9h704q14 0 23 -9t9 -23zM1024 608v-64q0 -14 -9 -23t-23 -9h-704q-14 0 -23 9t-9 23v64q0 14 9 23t23 9h704q14 0 23 -9t9 -23zM128 0h1024v768h-416q-40 0 -68 28t-28 68v416h-512v-1280z M768 896h376q-10 29 -22 41l-313 313q-12 12 -41 22v-376zM1280 864v-896q0 -40 -28 -68t-68 -28h-1088q-40 0 -68 28t-28 68v1344q0 40 28 68t68 28h640q40 0 88 -20t76 -48l312 -312q28 -28 48 -76t20 -88z" /> -<glyph unicode="" horiz-adv-x="1408" d="M384 224v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM384 480v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5z M640 480v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM384 736v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5z M1152 224v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM896 480v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5z M640 736v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM384 992v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5z M1152 480v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM896 736v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5z M640 992v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM384 1248v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5z M1152 736v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM896 992v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5z M640 1248v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM1152 992v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5z M896 1248v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM1152 1248v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5z M896 -128h384v1536h-1152v-1536h384v224q0 13 9.5 22.5t22.5 9.5h320q13 0 22.5 -9.5t9.5 -22.5v-224zM1408 1472v-1664q0 -26 -19 -45t-45 -19h-1280q-26 0 -45 19t-19 45v1664q0 26 19 45t45 19h1280q26 0 45 -19t19 -45z" /> -<glyph unicode="" horiz-adv-x="1408" d="M384 224v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM384 480v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5z M640 480v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM384 736v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5z M1152 224v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM896 480v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5z M640 736v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM1152 480v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5z M896 736v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM1152 736v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5z M896 -128h384v1152h-256v-32q0 -40 -28 -68t-68 -28h-448q-40 0 -68 28t-28 68v32h-256v-1152h384v224q0 13 9.5 22.5t22.5 9.5h320q13 0 22.5 -9.5t9.5 -22.5v-224zM896 1056v320q0 13 -9.5 22.5t-22.5 9.5h-64q-13 0 -22.5 -9.5t-9.5 -22.5v-96h-128v96q0 13 -9.5 22.5 t-22.5 9.5h-64q-13 0 -22.5 -9.5t-9.5 -22.5v-320q0 -13 9.5 -22.5t22.5 -9.5h64q13 0 22.5 9.5t9.5 22.5v96h128v-96q0 -13 9.5 -22.5t22.5 -9.5h64q13 0 22.5 9.5t9.5 22.5zM1408 1088v-1280q0 -26 -19 -45t-45 -19h-1280q-26 0 -45 19t-19 45v1280q0 26 19 45t45 19h320 v288q0 40 28 68t68 28h448q40 0 68 -28t28 -68v-288h320q26 0 45 -19t19 -45z" /> -<glyph unicode="" horiz-adv-x="1920" d="M640 128q0 53 -37.5 90.5t-90.5 37.5t-90.5 -37.5t-37.5 -90.5t37.5 -90.5t90.5 -37.5t90.5 37.5t37.5 90.5zM256 640h384v256h-158q-14 -2 -22 -9l-195 -195q-7 -12 -9 -22v-30zM1536 128q0 53 -37.5 90.5t-90.5 37.5t-90.5 -37.5t-37.5 -90.5t37.5 -90.5t90.5 -37.5 t90.5 37.5t37.5 90.5zM1664 800v192q0 14 -9 23t-23 9h-224v224q0 14 -9 23t-23 9h-192q-14 0 -23 -9t-9 -23v-224h-224q-14 0 -23 -9t-9 -23v-192q0 -14 9 -23t23 -9h224v-224q0 -14 9 -23t23 -9h192q14 0 23 9t9 23v224h224q14 0 23 9t9 23zM1920 1344v-1152 q0 -26 -19 -45t-45 -19h-192q0 -106 -75 -181t-181 -75t-181 75t-75 181h-384q0 -106 -75 -181t-181 -75t-181 75t-75 181h-128q-26 0 -45 19t-19 45t19 45t45 19v416q0 26 13 58t32 51l198 198q19 19 51 32t58 13h160v320q0 26 19 45t45 19h1152q26 0 45 -19t19 -45z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1280 416v192q0 14 -9 23t-23 9h-224v224q0 14 -9 23t-23 9h-192q-14 0 -23 -9t-9 -23v-224h-224q-14 0 -23 -9t-9 -23v-192q0 -14 9 -23t23 -9h224v-224q0 -14 9 -23t23 -9h192q14 0 23 9t9 23v224h224q14 0 23 9t9 23zM640 1152h512v128h-512v-128zM256 1152v-1280h-32 q-92 0 -158 66t-66 158v832q0 92 66 158t158 66h32zM1440 1152v-1280h-1088v1280h160v160q0 40 28 68t68 28h576q40 0 68 -28t28 -68v-160h160zM1792 928v-832q0 -92 -66 -158t-158 -66h-32v1280h32q92 0 158 -66t66 -158z" /> -<glyph unicode="" horiz-adv-x="1920" d="M1920 576q-1 -32 -288 -96l-352 -32l-224 -64h-64l-293 -352h69q26 0 45 -4.5t19 -11.5t-19 -11.5t-45 -4.5h-96h-160h-64v32h64v416h-160l-192 -224h-96l-32 32v192h32v32h128v8l-192 24v128l192 24v8h-128v32h-32v192l32 32h96l192 -224h160v416h-64v32h64h160h96 q26 0 45 -4.5t19 -11.5t-19 -11.5t-45 -4.5h-69l293 -352h64l224 -64l352 -32q261 -58 287 -93z" /> -<glyph unicode="" horiz-adv-x="1664" d="M640 640v384h-256v-256q0 -53 37.5 -90.5t90.5 -37.5h128zM1664 192v-192h-1152v192l128 192h-128q-159 0 -271.5 112.5t-112.5 271.5v320l-64 64l32 128h480l32 128h960l32 -192l-64 -32v-800z" /> -<glyph unicode="" d="M1280 192v896q0 26 -19 45t-45 19h-128q-26 0 -45 -19t-19 -45v-320h-512v320q0 26 -19 45t-45 19h-128q-26 0 -45 -19t-19 -45v-896q0 -26 19 -45t45 -19h128q26 0 45 19t19 45v320h512v-320q0 -26 19 -45t45 -19h128q26 0 45 19t19 45zM1536 1120v-960 q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> -<glyph unicode="" d="M1280 576v128q0 26 -19 45t-45 19h-320v320q0 26 -19 45t-45 19h-128q-26 0 -45 -19t-19 -45v-320h-320q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45t45 -19h320v-320q0 -26 19 -45t45 -19h128q26 0 45 19t19 45v320h320q26 0 45 19t19 45zM1536 1120v-960 q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> -<glyph unicode="" horiz-adv-x="1024" d="M627 160q0 -13 -10 -23l-50 -50q-10 -10 -23 -10t-23 10l-466 466q-10 10 -10 23t10 23l466 466q10 10 23 10t23 -10l50 -50q10 -10 10 -23t-10 -23l-393 -393l393 -393q10 -10 10 -23zM1011 160q0 -13 -10 -23l-50 -50q-10 -10 -23 -10t-23 10l-466 466q-10 10 -10 23 t10 23l466 466q10 10 23 10t23 -10l50 -50q10 -10 10 -23t-10 -23l-393 -393l393 -393q10 -10 10 -23z" /> -<glyph unicode="" horiz-adv-x="1024" d="M595 576q0 -13 -10 -23l-466 -466q-10 -10 -23 -10t-23 10l-50 50q-10 10 -10 23t10 23l393 393l-393 393q-10 10 -10 23t10 23l50 50q10 10 23 10t23 -10l466 -466q10 -10 10 -23zM979 576q0 -13 -10 -23l-466 -466q-10 -10 -23 -10t-23 10l-50 50q-10 10 -10 23t10 23 l393 393l-393 393q-10 10 -10 23t10 23l50 50q10 10 23 10t23 -10l466 -466q10 -10 10 -23z" /> -<glyph unicode="" horiz-adv-x="1152" d="M1075 224q0 -13 -10 -23l-50 -50q-10 -10 -23 -10t-23 10l-393 393l-393 -393q-10 -10 -23 -10t-23 10l-50 50q-10 10 -10 23t10 23l466 466q10 10 23 10t23 -10l466 -466q10 -10 10 -23zM1075 608q0 -13 -10 -23l-50 -50q-10 -10 -23 -10t-23 10l-393 393l-393 -393 q-10 -10 -23 -10t-23 10l-50 50q-10 10 -10 23t10 23l466 466q10 10 23 10t23 -10l466 -466q10 -10 10 -23z" /> -<glyph unicode="" horiz-adv-x="1152" d="M1075 672q0 -13 -10 -23l-466 -466q-10 -10 -23 -10t-23 10l-466 466q-10 10 -10 23t10 23l50 50q10 10 23 10t23 -10l393 -393l393 393q10 10 23 10t23 -10l50 -50q10 -10 10 -23zM1075 1056q0 -13 -10 -23l-466 -466q-10 -10 -23 -10t-23 10l-466 466q-10 10 -10 23 t10 23l50 50q10 10 23 10t23 -10l393 -393l393 393q10 10 23 10t23 -10l50 -50q10 -10 10 -23z" /> -<glyph unicode="" horiz-adv-x="640" d="M627 992q0 -13 -10 -23l-393 -393l393 -393q10 -10 10 -23t-10 -23l-50 -50q-10 -10 -23 -10t-23 10l-466 466q-10 10 -10 23t10 23l466 466q10 10 23 10t23 -10l50 -50q10 -10 10 -23z" /> -<glyph unicode="" horiz-adv-x="640" d="M595 576q0 -13 -10 -23l-466 -466q-10 -10 -23 -10t-23 10l-50 50q-10 10 -10 23t10 23l393 393l-393 393q-10 10 -10 23t10 23l50 50q10 10 23 10t23 -10l466 -466q10 -10 10 -23z" /> -<glyph unicode="" horiz-adv-x="1152" d="M1075 352q0 -13 -10 -23l-50 -50q-10 -10 -23 -10t-23 10l-393 393l-393 -393q-10 -10 -23 -10t-23 10l-50 50q-10 10 -10 23t10 23l466 466q10 10 23 10t23 -10l466 -466q10 -10 10 -23z" /> -<glyph unicode="" horiz-adv-x="1152" d="M1075 800q0 -13 -10 -23l-466 -466q-10 -10 -23 -10t-23 10l-466 466q-10 10 -10 23t10 23l50 50q10 10 23 10t23 -10l393 -393l393 393q10 10 23 10t23 -10l50 -50q10 -10 10 -23z" /> -<glyph unicode="" horiz-adv-x="1920" d="M1792 544v832q0 13 -9.5 22.5t-22.5 9.5h-1600q-13 0 -22.5 -9.5t-9.5 -22.5v-832q0 -13 9.5 -22.5t22.5 -9.5h1600q13 0 22.5 9.5t9.5 22.5zM1920 1376v-1088q0 -66 -47 -113t-113 -47h-544q0 -37 16 -77.5t32 -71t16 -43.5q0 -26 -19 -45t-45 -19h-512q-26 0 -45 19 t-19 45q0 14 16 44t32 70t16 78h-544q-66 0 -113 47t-47 113v1088q0 66 47 113t113 47h1600q66 0 113 -47t47 -113z" /> -<glyph unicode="" horiz-adv-x="1920" d="M416 256q-66 0 -113 47t-47 113v704q0 66 47 113t113 47h1088q66 0 113 -47t47 -113v-704q0 -66 -47 -113t-113 -47h-1088zM384 1120v-704q0 -13 9.5 -22.5t22.5 -9.5h1088q13 0 22.5 9.5t9.5 22.5v704q0 13 -9.5 22.5t-22.5 9.5h-1088q-13 0 -22.5 -9.5t-9.5 -22.5z M1760 192h160v-96q0 -40 -47 -68t-113 -28h-1600q-66 0 -113 28t-47 68v96h160h1600zM1040 96q16 0 16 16t-16 16h-160q-16 0 -16 -16t16 -16h160z" /> -<glyph unicode="" horiz-adv-x="1152" d="M640 128q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1024 288v960q0 13 -9.5 22.5t-22.5 9.5h-832q-13 0 -22.5 -9.5t-9.5 -22.5v-960q0 -13 9.5 -22.5t22.5 -9.5h832q13 0 22.5 9.5t9.5 22.5zM1152 1248v-1088q0 -66 -47 -113t-113 -47h-832 q-66 0 -113 47t-47 113v1088q0 66 47 113t113 47h832q66 0 113 -47t47 -113z" /> -<glyph unicode="" horiz-adv-x="768" d="M464 128q0 33 -23.5 56.5t-56.5 23.5t-56.5 -23.5t-23.5 -56.5t23.5 -56.5t56.5 -23.5t56.5 23.5t23.5 56.5zM672 288v704q0 13 -9.5 22.5t-22.5 9.5h-512q-13 0 -22.5 -9.5t-9.5 -22.5v-704q0 -13 9.5 -22.5t22.5 -9.5h512q13 0 22.5 9.5t9.5 22.5zM480 1136 q0 16 -16 16h-160q-16 0 -16 -16t16 -16h160q16 0 16 16zM768 1152v-1024q0 -52 -38 -90t-90 -38h-512q-52 0 -90 38t-38 90v1024q0 52 38 90t90 38h512q52 0 90 -38t38 -90z" /> -<glyph unicode="" d="M768 1184q-148 0 -273 -73t-198 -198t-73 -273t73 -273t198 -198t273 -73t273 73t198 198t73 273t-73 273t-198 198t-273 73zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103 t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" horiz-adv-x="1664" d="M768 576v-384q0 -80 -56 -136t-136 -56h-384q-80 0 -136 56t-56 136v704q0 104 40.5 198.5t109.5 163.5t163.5 109.5t198.5 40.5h64q26 0 45 -19t19 -45v-128q0 -26 -19 -45t-45 -19h-64q-106 0 -181 -75t-75 -181v-32q0 -40 28 -68t68 -28h224q80 0 136 -56t56 -136z M1664 576v-384q0 -80 -56 -136t-136 -56h-384q-80 0 -136 56t-56 136v704q0 104 40.5 198.5t109.5 163.5t163.5 109.5t198.5 40.5h64q26 0 45 -19t19 -45v-128q0 -26 -19 -45t-45 -19h-64q-106 0 -181 -75t-75 -181v-32q0 -40 28 -68t68 -28h224q80 0 136 -56t56 -136z" /> -<glyph unicode="" horiz-adv-x="1664" d="M768 1216v-704q0 -104 -40.5 -198.5t-109.5 -163.5t-163.5 -109.5t-198.5 -40.5h-64q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h64q106 0 181 75t75 181v32q0 40 -28 68t-68 28h-224q-80 0 -136 56t-56 136v384q0 80 56 136t136 56h384q80 0 136 -56t56 -136zM1664 1216 v-704q0 -104 -40.5 -198.5t-109.5 -163.5t-163.5 -109.5t-198.5 -40.5h-64q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h64q106 0 181 75t75 181v32q0 40 -28 68t-68 28h-224q-80 0 -136 56t-56 136v384q0 80 56 136t136 56h384q80 0 136 -56t56 -136z" /> -<glyph unicode="" horiz-adv-x="1568" d="M496 192q0 -60 -42.5 -102t-101.5 -42q-60 0 -102 42t-42 102t42 102t102 42q59 0 101.5 -42t42.5 -102zM928 0q0 -53 -37.5 -90.5t-90.5 -37.5t-90.5 37.5t-37.5 90.5t37.5 90.5t90.5 37.5t90.5 -37.5t37.5 -90.5zM320 640q0 -66 -47 -113t-113 -47t-113 47t-47 113 t47 113t113 47t113 -47t47 -113zM1360 192q0 -46 -33 -79t-79 -33t-79 33t-33 79t33 79t79 33t79 -33t33 -79zM528 1088q0 -73 -51.5 -124.5t-124.5 -51.5t-124.5 51.5t-51.5 124.5t51.5 124.5t124.5 51.5t124.5 -51.5t51.5 -124.5zM992 1280q0 -80 -56 -136t-136 -56 t-136 56t-56 136t56 136t136 56t136 -56t56 -136zM1536 640q0 -40 -28 -68t-68 -28t-68 28t-28 68t28 68t68 28t68 -28t28 -68zM1328 1088q0 -33 -23.5 -56.5t-56.5 -23.5t-56.5 23.5t-23.5 56.5t23.5 56.5t56.5 23.5t56.5 -23.5t23.5 -56.5z" /> -<glyph unicode="" d="M1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1792 416q0 -166 -127 -451q-3 -7 -10.5 -24t-13.5 -30t-13 -22q-12 -17 -28 -17q-15 0 -23.5 10t-8.5 25q0 9 2.5 26.5t2.5 23.5q5 68 5 123q0 101 -17.5 181t-48.5 138.5t-80 101t-105.5 69.5t-133 42.5t-154 21.5t-175.5 6h-224v-256q0 -26 -19 -45t-45 -19t-45 19 l-512 512q-19 19 -19 45t19 45l512 512q19 19 45 19t45 -19t19 -45v-256h224q713 0 875 -403q53 -134 53 -333z" /> -<glyph unicode="" horiz-adv-x="1664" d="M640 320q0 -40 -12.5 -82t-43 -76t-72.5 -34t-72.5 34t-43 76t-12.5 82t12.5 82t43 76t72.5 34t72.5 -34t43 -76t12.5 -82zM1280 320q0 -40 -12.5 -82t-43 -76t-72.5 -34t-72.5 34t-43 76t-12.5 82t12.5 82t43 76t72.5 34t72.5 -34t43 -76t12.5 -82zM1440 320 q0 120 -69 204t-187 84q-41 0 -195 -21q-71 -11 -157 -11t-157 11q-152 21 -195 21q-118 0 -187 -84t-69 -204q0 -88 32 -153.5t81 -103t122 -60t140 -29.5t149 -7h168q82 0 149 7t140 29.5t122 60t81 103t32 153.5zM1664 496q0 -207 -61 -331q-38 -77 -105.5 -133t-141 -86 t-170 -47.5t-171.5 -22t-167 -4.5q-78 0 -142 3t-147.5 12.5t-152.5 30t-137 51.5t-121 81t-86 115q-62 123 -62 331q0 237 136 396q-27 82 -27 170q0 116 51 218q108 0 190 -39.5t189 -123.5q147 35 309 35q148 0 280 -32q105 82 187 121t189 39q51 -102 51 -218 q0 -87 -27 -168q136 -160 136 -398z" /> -<glyph unicode="" horiz-adv-x="1664" d="M1536 224v704q0 40 -28 68t-68 28h-704q-40 0 -68 28t-28 68v64q0 40 -28 68t-68 28h-320q-40 0 -68 -28t-28 -68v-960q0 -40 28 -68t68 -28h1216q40 0 68 28t28 68zM1664 928v-704q0 -92 -66 -158t-158 -66h-1216q-92 0 -158 66t-66 158v960q0 92 66 158t158 66h320 q92 0 158 -66t66 -158v-32h672q92 0 158 -66t66 -158z" /> -<glyph unicode="" horiz-adv-x="1920" d="M1781 605q0 35 -53 35h-1088q-40 0 -85.5 -21.5t-71.5 -52.5l-294 -363q-18 -24 -18 -40q0 -35 53 -35h1088q40 0 86 22t71 53l294 363q18 22 18 39zM640 768h768v160q0 40 -28 68t-68 28h-576q-40 0 -68 28t-28 68v64q0 40 -28 68t-68 28h-320q-40 0 -68 -28t-28 -68 v-853l256 315q44 53 116 87.5t140 34.5zM1909 605q0 -62 -46 -120l-295 -363q-43 -53 -116 -87.5t-140 -34.5h-1088q-92 0 -158 66t-66 158v960q0 92 66 158t158 66h320q92 0 158 -66t66 -158v-32h544q92 0 158 -66t66 -158v-160h192q54 0 99 -24.5t67 -70.5q15 -32 15 -68z " /> -<glyph unicode="" horiz-adv-x="1792" /> -<glyph unicode="" horiz-adv-x="1792" /> -<glyph unicode="" d="M1134 461q-37 -121 -138 -195t-228 -74t-228 74t-138 195q-8 25 4 48.5t38 31.5q25 8 48.5 -4t31.5 -38q25 -80 92.5 -129.5t151.5 -49.5t151.5 49.5t92.5 129.5q8 26 32 38t49 4t37 -31.5t4 -48.5zM640 896q0 -53 -37.5 -90.5t-90.5 -37.5t-90.5 37.5t-37.5 90.5 t37.5 90.5t90.5 37.5t90.5 -37.5t37.5 -90.5zM1152 896q0 -53 -37.5 -90.5t-90.5 -37.5t-90.5 37.5t-37.5 90.5t37.5 90.5t90.5 37.5t90.5 -37.5t37.5 -90.5zM1408 640q0 130 -51 248.5t-136.5 204t-204 136.5t-248.5 51t-248.5 -51t-204 -136.5t-136.5 -204t-51 -248.5 t51 -248.5t136.5 -204t204 -136.5t248.5 -51t248.5 51t204 136.5t136.5 204t51 248.5zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" d="M1134 307q8 -25 -4 -48.5t-37 -31.5t-49 4t-32 38q-25 80 -92.5 129.5t-151.5 49.5t-151.5 -49.5t-92.5 -129.5q-8 -26 -31.5 -38t-48.5 -4q-26 8 -38 31.5t-4 48.5q37 121 138 195t228 74t228 -74t138 -195zM640 896q0 -53 -37.5 -90.5t-90.5 -37.5t-90.5 37.5 t-37.5 90.5t37.5 90.5t90.5 37.5t90.5 -37.5t37.5 -90.5zM1152 896q0 -53 -37.5 -90.5t-90.5 -37.5t-90.5 37.5t-37.5 90.5t37.5 90.5t90.5 37.5t90.5 -37.5t37.5 -90.5zM1408 640q0 130 -51 248.5t-136.5 204t-204 136.5t-248.5 51t-248.5 -51t-204 -136.5t-136.5 -204 t-51 -248.5t51 -248.5t136.5 -204t204 -136.5t248.5 -51t248.5 51t204 136.5t136.5 204t51 248.5zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" d="M1152 448q0 -26 -19 -45t-45 -19h-640q-26 0 -45 19t-19 45t19 45t45 19h640q26 0 45 -19t19 -45zM640 896q0 -53 -37.5 -90.5t-90.5 -37.5t-90.5 37.5t-37.5 90.5t37.5 90.5t90.5 37.5t90.5 -37.5t37.5 -90.5zM1152 896q0 -53 -37.5 -90.5t-90.5 -37.5t-90.5 37.5 t-37.5 90.5t37.5 90.5t90.5 37.5t90.5 -37.5t37.5 -90.5zM1408 640q0 130 -51 248.5t-136.5 204t-204 136.5t-248.5 51t-248.5 -51t-204 -136.5t-136.5 -204t-51 -248.5t51 -248.5t136.5 -204t204 -136.5t248.5 -51t248.5 51t204 136.5t136.5 204t51 248.5zM1536 640 q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" horiz-adv-x="1920" d="M832 448v128q0 14 -9 23t-23 9h-192v192q0 14 -9 23t-23 9h-128q-14 0 -23 -9t-9 -23v-192h-192q-14 0 -23 -9t-9 -23v-128q0 -14 9 -23t23 -9h192v-192q0 -14 9 -23t23 -9h128q14 0 23 9t9 23v192h192q14 0 23 9t9 23zM1408 384q0 53 -37.5 90.5t-90.5 37.5t-90.5 -37.5 t-37.5 -90.5t37.5 -90.5t90.5 -37.5t90.5 37.5t37.5 90.5zM1664 640q0 53 -37.5 90.5t-90.5 37.5t-90.5 -37.5t-37.5 -90.5t37.5 -90.5t90.5 -37.5t90.5 37.5t37.5 90.5zM1920 512q0 -212 -150 -362t-362 -150q-192 0 -338 128h-220q-146 -128 -338 -128q-212 0 -362 150 t-150 362t150 362t362 150h896q212 0 362 -150t150 -362z" /> -<glyph unicode="" horiz-adv-x="1920" d="M384 368v-96q0 -16 -16 -16h-96q-16 0 -16 16v96q0 16 16 16h96q16 0 16 -16zM512 624v-96q0 -16 -16 -16h-224q-16 0 -16 16v96q0 16 16 16h224q16 0 16 -16zM384 880v-96q0 -16 -16 -16h-96q-16 0 -16 16v96q0 16 16 16h96q16 0 16 -16zM1408 368v-96q0 -16 -16 -16 h-864q-16 0 -16 16v96q0 16 16 16h864q16 0 16 -16zM768 624v-96q0 -16 -16 -16h-96q-16 0 -16 16v96q0 16 16 16h96q16 0 16 -16zM640 880v-96q0 -16 -16 -16h-96q-16 0 -16 16v96q0 16 16 16h96q16 0 16 -16zM1024 624v-96q0 -16 -16 -16h-96q-16 0 -16 16v96q0 16 16 16 h96q16 0 16 -16zM896 880v-96q0 -16 -16 -16h-96q-16 0 -16 16v96q0 16 16 16h96q16 0 16 -16zM1280 624v-96q0 -16 -16 -16h-96q-16 0 -16 16v96q0 16 16 16h96q16 0 16 -16zM1664 368v-96q0 -16 -16 -16h-96q-16 0 -16 16v96q0 16 16 16h96q16 0 16 -16zM1152 880v-96 q0 -16 -16 -16h-96q-16 0 -16 16v96q0 16 16 16h96q16 0 16 -16zM1408 880v-96q0 -16 -16 -16h-96q-16 0 -16 16v96q0 16 16 16h96q16 0 16 -16zM1664 880v-352q0 -16 -16 -16h-224q-16 0 -16 16v96q0 16 16 16h112v240q0 16 16 16h96q16 0 16 -16zM1792 128v896h-1664v-896 h1664zM1920 1024v-896q0 -53 -37.5 -90.5t-90.5 -37.5h-1664q-53 0 -90.5 37.5t-37.5 90.5v896q0 53 37.5 90.5t90.5 37.5h1664q53 0 90.5 -37.5t37.5 -90.5z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1664 491v616q-169 -91 -306 -91q-82 0 -145 32q-100 49 -184 76.5t-178 27.5q-173 0 -403 -127v-599q245 113 433 113q55 0 103.5 -7.5t98 -26t77 -31t82.5 -39.5l28 -14q44 -22 101 -22q120 0 293 92zM320 1280q0 -35 -17.5 -64t-46.5 -46v-1266q0 -14 -9 -23t-23 -9 h-64q-14 0 -23 9t-9 23v1266q-29 17 -46.5 46t-17.5 64q0 53 37.5 90.5t90.5 37.5t90.5 -37.5t37.5 -90.5zM1792 1216v-763q0 -39 -35 -57q-10 -5 -17 -9q-218 -116 -369 -116q-88 0 -158 35l-28 14q-64 33 -99 48t-91 29t-114 14q-102 0 -235.5 -44t-228.5 -102 q-15 -9 -33 -9q-16 0 -32 8q-32 19 -32 56v742q0 35 31 55q35 21 78.5 42.5t114 52t152.5 49.5t155 19q112 0 209 -31t209 -86q38 -19 89 -19q122 0 310 112q22 12 31 17q31 16 62 -2q31 -20 31 -55z" /> -<glyph unicode="" horiz-adv-x="1792" d="M832 536v192q-181 -16 -384 -117v-185q205 96 384 110zM832 954v197q-172 -8 -384 -126v-189q215 111 384 118zM1664 491v184q-235 -116 -384 -71v224q-20 6 -39 15q-5 3 -33 17t-34.5 17t-31.5 15t-34.5 15.5t-32.5 13t-36 12.5t-35 8.5t-39.5 7.5t-39.5 4t-44 2 q-23 0 -49 -3v-222h19q102 0 192.5 -29t197.5 -82q19 -9 39 -15v-188q42 -17 91 -17q120 0 293 92zM1664 918v189q-169 -91 -306 -91q-45 0 -78 8v-196q148 -42 384 90zM320 1280q0 -35 -17.5 -64t-46.5 -46v-1266q0 -14 -9 -23t-23 -9h-64q-14 0 -23 9t-9 23v1266 q-29 17 -46.5 46t-17.5 64q0 53 37.5 90.5t90.5 37.5t90.5 -37.5t37.5 -90.5zM1792 1216v-763q0 -39 -35 -57q-10 -5 -17 -9q-218 -116 -369 -116q-88 0 -158 35l-28 14q-64 33 -99 48t-91 29t-114 14q-102 0 -235.5 -44t-228.5 -102q-15 -9 -33 -9q-16 0 -32 8 q-32 19 -32 56v742q0 35 31 55q35 21 78.5 42.5t114 52t152.5 49.5t155 19q112 0 209 -31t209 -86q38 -19 89 -19q122 0 310 112q22 12 31 17q31 16 62 -2q31 -20 31 -55z" /> -<glyph unicode="" horiz-adv-x="1664" d="M585 553l-466 -466q-10 -10 -23 -10t-23 10l-50 50q-10 10 -10 23t10 23l393 393l-393 393q-10 10 -10 23t10 23l50 50q10 10 23 10t23 -10l466 -466q10 -10 10 -23t-10 -23zM1664 96v-64q0 -14 -9 -23t-23 -9h-960q-14 0 -23 9t-9 23v64q0 14 9 23t23 9h960q14 0 23 -9 t9 -23z" /> -<glyph unicode="" horiz-adv-x="1920" d="M617 137l-50 -50q-10 -10 -23 -10t-23 10l-466 466q-10 10 -10 23t10 23l466 466q10 10 23 10t23 -10l50 -50q10 -10 10 -23t-10 -23l-393 -393l393 -393q10 -10 10 -23t-10 -23zM1208 1204l-373 -1291q-4 -13 -15.5 -19.5t-23.5 -2.5l-62 17q-13 4 -19.5 15.5t-2.5 24.5 l373 1291q4 13 15.5 19.5t23.5 2.5l62 -17q13 -4 19.5 -15.5t2.5 -24.5zM1865 553l-466 -466q-10 -10 -23 -10t-23 10l-50 50q-10 10 -10 23t10 23l393 393l-393 393q-10 10 -10 23t10 23l50 50q10 10 23 10t23 -10l466 -466q10 -10 10 -23t-10 -23z" /> -<glyph unicode="" horiz-adv-x="1792" d="M640 454v-70q0 -42 -39 -59q-13 -5 -25 -5q-27 0 -45 19l-512 512q-19 19 -19 45t19 45l512 512q29 31 70 14q39 -17 39 -59v-69l-397 -398q-19 -19 -19 -45t19 -45zM1792 416q0 -58 -17 -133.5t-38.5 -138t-48 -125t-40.5 -90.5l-20 -40q-8 -17 -28 -17q-6 0 -9 1 q-25 8 -23 34q43 400 -106 565q-64 71 -170.5 110.5t-267.5 52.5v-251q0 -42 -39 -59q-13 -5 -25 -5q-27 0 -45 19l-512 512q-19 19 -19 45t19 45l512 512q29 31 70 14q39 -17 39 -59v-262q411 -28 599 -221q169 -173 169 -509z" /> -<glyph unicode="" horiz-adv-x="1664" d="M1186 579l257 250l-356 52l-66 10l-30 60l-159 322v-963l59 -31l318 -168l-60 355l-12 66zM1638 841l-363 -354l86 -500q5 -33 -6 -51.5t-34 -18.5q-17 0 -40 12l-449 236l-449 -236q-23 -12 -40 -12q-23 0 -34 18.5t-6 51.5l86 500l-364 354q-32 32 -23 59.5t54 34.5 l502 73l225 455q20 41 49 41q28 0 49 -41l225 -455l502 -73q45 -7 54 -34.5t-24 -59.5z" /> -<glyph unicode="" horiz-adv-x="1408" d="M1401 1187l-640 -1280q-17 -35 -57 -35q-5 0 -15 2q-22 5 -35.5 22.5t-13.5 39.5v576h-576q-22 0 -39.5 13.5t-22.5 35.5t4 42t29 30l1280 640q13 7 29 7q27 0 45 -19q15 -14 18.5 -34.5t-6.5 -39.5z" /> -<glyph unicode="" horiz-adv-x="1664" d="M557 256h595v595zM512 301l595 595h-595v-595zM1664 224v-192q0 -14 -9 -23t-23 -9h-224v-224q0 -14 -9 -23t-23 -9h-192q-14 0 -23 9t-9 23v224h-864q-14 0 -23 9t-9 23v864h-224q-14 0 -23 9t-9 23v192q0 14 9 23t23 9h224v224q0 14 9 23t23 9h192q14 0 23 -9t9 -23 v-224h851l246 247q10 9 23 9t23 -9q9 -10 9 -23t-9 -23l-247 -246v-851h224q14 0 23 -9t9 -23z" /> -<glyph unicode="" horiz-adv-x="1024" d="M288 64q0 40 -28 68t-68 28t-68 -28t-28 -68t28 -68t68 -28t68 28t28 68zM288 1216q0 40 -28 68t-68 28t-68 -28t-28 -68t28 -68t68 -28t68 28t28 68zM928 1088q0 40 -28 68t-68 28t-68 -28t-28 -68t28 -68t68 -28t68 28t28 68zM1024 1088q0 -52 -26 -96.5t-70 -69.5 q-2 -287 -226 -414q-68 -38 -203 -81q-128 -40 -169.5 -71t-41.5 -100v-26q44 -25 70 -69.5t26 -96.5q0 -80 -56 -136t-136 -56t-136 56t-56 136q0 52 26 96.5t70 69.5v820q-44 25 -70 69.5t-26 96.5q0 80 56 136t136 56t136 -56t56 -136q0 -52 -26 -96.5t-70 -69.5v-497 q54 26 154 57q55 17 87.5 29.5t70.5 31t59 39.5t40.5 51t28 69.5t8.5 91.5q-44 25 -70 69.5t-26 96.5q0 80 56 136t136 56t136 -56t56 -136z" /> -<glyph unicode="" horiz-adv-x="1664" d="M439 265l-256 -256q-10 -9 -23 -9q-12 0 -23 9q-9 10 -9 23t9 23l256 256q10 9 23 9t23 -9q9 -10 9 -23t-9 -23zM608 224v-320q0 -14 -9 -23t-23 -9t-23 9t-9 23v320q0 14 9 23t23 9t23 -9t9 -23zM384 448q0 -14 -9 -23t-23 -9h-320q-14 0 -23 9t-9 23t9 23t23 9h320 q14 0 23 -9t9 -23zM1648 320q0 -120 -85 -203l-147 -146q-83 -83 -203 -83q-121 0 -204 85l-334 335q-21 21 -42 56l239 18l273 -274q27 -27 68 -27.5t68 26.5l147 146q28 28 28 67q0 40 -28 68l-274 275l18 239q35 -21 56 -42l336 -336q84 -86 84 -204zM1031 1044l-239 -18 l-273 274q-28 28 -68 28q-39 0 -68 -27l-147 -146q-28 -28 -28 -67q0 -40 28 -68l274 -274l-18 -240q-35 21 -56 42l-336 336q-84 86 -84 204q0 120 85 203l147 146q83 83 203 83q121 0 204 -85l334 -335q21 -21 42 -56zM1664 960q0 -14 -9 -23t-23 -9h-320q-14 0 -23 9 t-9 23t9 23t23 9h320q14 0 23 -9t9 -23zM1120 1504v-320q0 -14 -9 -23t-23 -9t-23 9t-9 23v320q0 14 9 23t23 9t23 -9t9 -23zM1527 1353l-256 -256q-11 -9 -23 -9t-23 9q-9 10 -9 23t9 23l256 256q10 9 23 9t23 -9q9 -10 9 -23t-9 -23z" /> -<glyph unicode="" horiz-adv-x="1024" d="M704 280v-240q0 -16 -12 -28t-28 -12h-240q-16 0 -28 12t-12 28v240q0 16 12 28t28 12h240q16 0 28 -12t12 -28zM1020 880q0 -54 -15.5 -101t-35 -76.5t-55 -59.5t-57.5 -43.5t-61 -35.5q-41 -23 -68.5 -65t-27.5 -67q0 -17 -12 -32.5t-28 -15.5h-240q-15 0 -25.5 18.5 t-10.5 37.5v45q0 83 65 156.5t143 108.5q59 27 84 56t25 76q0 42 -46.5 74t-107.5 32q-65 0 -108 -29q-35 -25 -107 -115q-13 -16 -31 -16q-12 0 -25 8l-164 125q-13 10 -15.5 25t5.5 28q160 266 464 266q80 0 161 -31t146 -83t106 -127.5t41 -158.5z" /> -<glyph unicode="" horiz-adv-x="640" d="M640 192v-128q0 -26 -19 -45t-45 -19h-512q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h64v384h-64q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h384q26 0 45 -19t19 -45v-576h64q26 0 45 -19t19 -45zM512 1344v-192q0 -26 -19 -45t-45 -19h-256q-26 0 -45 19t-19 45v192 q0 26 19 45t45 19h256q26 0 45 -19t19 -45z" /> -<glyph unicode="" horiz-adv-x="640" d="M512 288v-224q0 -26 -19 -45t-45 -19h-256q-26 0 -45 19t-19 45v224q0 26 19 45t45 19h256q26 0 45 -19t19 -45zM542 1344l-28 -768q-1 -26 -20.5 -45t-45.5 -19h-256q-26 0 -45.5 19t-20.5 45l-28 768q-1 26 17.5 45t44.5 19h320q26 0 44.5 -19t17.5 -45z" /> -<glyph unicode="" d="M897 167v-167h-248l-159 252l-24 42q-8 9 -11 21h-3l-9 -21q-10 -20 -25 -44l-155 -250h-258v167h128l197 291l-185 272h-137v168h276l139 -228q2 -4 23 -42q8 -9 11 -21h3q3 9 11 21l25 42l140 228h257v-168h-125l-184 -267l204 -296h109zM1534 846v-206h-514l-3 27 q-4 28 -4 46q0 64 26 117t65 86.5t84 65t84 54.5t65 54t26 64q0 38 -29.5 62.5t-70.5 24.5q-51 0 -97 -39q-14 -11 -36 -38l-105 92q26 37 63 66q83 65 188 65q110 0 178 -59.5t68 -158.5q0 -56 -24.5 -103t-62 -76.5t-81.5 -58.5t-82 -50.5t-65.5 -51.5t-30.5 -63h232v80 h126z" /> -<glyph unicode="" d="M897 167v-167h-248l-159 252l-24 42q-8 9 -11 21h-3l-9 -21q-10 -20 -25 -44l-155 -250h-258v167h128l197 291l-185 272h-137v168h276l139 -228q2 -4 23 -42q8 -9 11 -21h3q3 9 11 21l25 42l140 228h257v-168h-125l-184 -267l204 -296h109zM1536 -50v-206h-514l-4 27 q-3 45 -3 46q0 64 26 117t65 86.5t84 65t84 54.5t65 54t26 64q0 38 -29.5 62.5t-70.5 24.5q-51 0 -97 -39q-14 -11 -36 -38l-105 92q26 37 63 66q80 65 188 65q110 0 178 -59.5t68 -158.5q0 -66 -34.5 -118.5t-84 -86t-99.5 -62.5t-87 -63t-41 -73h232v80h126z" /> -<glyph unicode="" horiz-adv-x="1920" d="M896 128l336 384h-768l-336 -384h768zM1909 1205q15 -34 9.5 -71.5t-30.5 -65.5l-896 -1024q-38 -44 -96 -44h-768q-38 0 -69.5 20.5t-47.5 54.5q-15 34 -9.5 71.5t30.5 65.5l896 1024q38 44 96 44h768q38 0 69.5 -20.5t47.5 -54.5z" /> -<glyph unicode="" horiz-adv-x="1664" d="M1664 438q0 -81 -44.5 -135t-123.5 -54q-41 0 -77.5 17.5t-59 38t-56.5 38t-71 17.5q-110 0 -110 -124q0 -39 16 -115t15 -115v-5q-22 0 -33 -1q-34 -3 -97.5 -11.5t-115.5 -13.5t-98 -5q-61 0 -103 26.5t-42 83.5q0 37 17.5 71t38 56.5t38 59t17.5 77.5q0 79 -54 123.5 t-135 44.5q-84 0 -143 -45.5t-59 -127.5q0 -43 15 -83t33.5 -64.5t33.5 -53t15 -50.5q0 -45 -46 -89q-37 -35 -117 -35q-95 0 -245 24q-9 2 -27.5 4t-27.5 4l-13 2q-1 0 -3 1q-2 0 -2 1v1024q2 -1 17.5 -3.5t34 -5t21.5 -3.5q150 -24 245 -24q80 0 117 35q46 44 46 89 q0 22 -15 50.5t-33.5 53t-33.5 64.5t-15 83q0 82 59 127.5t144 45.5q80 0 134 -44.5t54 -123.5q0 -41 -17.5 -77.5t-38 -59t-38 -56.5t-17.5 -71q0 -57 42 -83.5t103 -26.5q64 0 180 15t163 17v-2q-1 -2 -3.5 -17.5t-5 -34t-3.5 -21.5q-24 -150 -24 -245q0 -80 35 -117 q44 -46 89 -46q22 0 50.5 15t53 33.5t64.5 33.5t83 15q82 0 127.5 -59t45.5 -143z" /> -<glyph unicode="" horiz-adv-x="1152" d="M1152 832v-128q0 -221 -147.5 -384.5t-364.5 -187.5v-132h256q26 0 45 -19t19 -45t-19 -45t-45 -19h-640q-26 0 -45 19t-19 45t19 45t45 19h256v132q-217 24 -364.5 187.5t-147.5 384.5v128q0 26 19 45t45 19t45 -19t19 -45v-128q0 -185 131.5 -316.5t316.5 -131.5 t316.5 131.5t131.5 316.5v128q0 26 19 45t45 19t45 -19t19 -45zM896 1216v-512q0 -132 -94 -226t-226 -94t-226 94t-94 226v512q0 132 94 226t226 94t226 -94t94 -226z" /> -<glyph unicode="" horiz-adv-x="1408" d="M271 591l-101 -101q-42 103 -42 214v128q0 26 19 45t45 19t45 -19t19 -45v-128q0 -53 15 -113zM1385 1193l-361 -361v-128q0 -132 -94 -226t-226 -94q-55 0 -109 19l-96 -96q97 -51 205 -51q185 0 316.5 131.5t131.5 316.5v128q0 26 19 45t45 19t45 -19t19 -45v-128 q0 -221 -147.5 -384.5t-364.5 -187.5v-132h256q26 0 45 -19t19 -45t-19 -45t-45 -19h-640q-26 0 -45 19t-19 45t19 45t45 19h256v132q-125 13 -235 81l-254 -254q-10 -10 -23 -10t-23 10l-82 82q-10 10 -10 23t10 23l1234 1234q10 10 23 10t23 -10l82 -82q10 -10 10 -23 t-10 -23zM1005 1325l-621 -621v512q0 132 94 226t226 94q102 0 184.5 -59t116.5 -152z" /> -<glyph unicode="" horiz-adv-x="1280" d="M1088 576v640h-448v-1137q119 63 213 137q235 184 235 360zM1280 1344v-768q0 -86 -33.5 -170.5t-83 -150t-118 -127.5t-126.5 -103t-121 -77.5t-89.5 -49.5t-42.5 -20q-12 -6 -26 -6t-26 6q-16 7 -42.5 20t-89.5 49.5t-121 77.5t-126.5 103t-118 127.5t-83 150 t-33.5 170.5v768q0 26 19 45t45 19h1152q26 0 45 -19t19 -45z" /> -<glyph unicode="" horiz-adv-x="1664" d="M128 -128h1408v1024h-1408v-1024zM512 1088v288q0 14 -9 23t-23 9h-64q-14 0 -23 -9t-9 -23v-288q0 -14 9 -23t23 -9h64q14 0 23 9t9 23zM1280 1088v288q0 14 -9 23t-23 9h-64q-14 0 -23 -9t-9 -23v-288q0 -14 9 -23t23 -9h64q14 0 23 9t9 23zM1664 1152v-1280 q0 -52 -38 -90t-90 -38h-1408q-52 0 -90 38t-38 90v1280q0 52 38 90t90 38h128v96q0 66 47 113t113 47h64q66 0 113 -47t47 -113v-96h384v96q0 66 47 113t113 47h64q66 0 113 -47t47 -113v-96h128q52 0 90 -38t38 -90z" /> -<glyph unicode="" horiz-adv-x="1408" d="M512 1344q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1408 1376v-320q0 -16 -12 -25q-8 -7 -20 -7q-4 0 -7 1l-448 96q-11 2 -18 11t-7 20h-256v-102q111 -23 183.5 -111t72.5 -203v-800q0 -26 -19 -45t-45 -19h-512q-26 0 -45 19t-19 45v800 q0 106 62.5 190.5t161.5 114.5v111h-32q-59 0 -115 -23.5t-91.5 -53t-66 -66.5t-40.5 -53.5t-14 -24.5q-17 -35 -57 -35q-16 0 -29 7q-23 12 -31.5 37t3.5 49q5 10 14.5 26t37.5 53.5t60.5 70t85 67t108.5 52.5q-25 42 -25 86q0 66 47 113t113 47t113 -47t47 -113 q0 -33 -14 -64h302q0 11 7 20t18 11l448 96q3 1 7 1q12 0 20 -7q12 -9 12 -25z" /> -<glyph unicode="" horiz-adv-x="1664" d="M1440 1088q0 40 -28 68t-68 28t-68 -28t-28 -68t28 -68t68 -28t68 28t28 68zM1664 1376q0 -249 -75.5 -430.5t-253.5 -360.5q-81 -80 -195 -176l-20 -379q-2 -16 -16 -26l-384 -224q-7 -4 -16 -4q-12 0 -23 9l-64 64q-13 14 -8 32l85 276l-281 281l-276 -85q-3 -1 -9 -1 q-14 0 -23 9l-64 64q-17 19 -5 39l224 384q10 14 26 16l379 20q96 114 176 195q188 187 358 258t431 71q14 0 24 -9.5t10 -22.5z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1745 763l-164 -763h-334l178 832q13 56 -15 88q-27 33 -83 33h-169l-204 -953h-334l204 953h-286l-204 -953h-334l204 953l-153 327h1276q101 0 189.5 -40.5t147.5 -113.5q60 -73 81 -168.5t0 -194.5z" /> -<glyph unicode="" d="M909 141l102 102q19 19 19 45t-19 45l-307 307l307 307q19 19 19 45t-19 45l-102 102q-19 19 -45 19t-45 -19l-454 -454q-19 -19 -19 -45t19 -45l454 -454q19 -19 45 -19t45 19zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5 t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" d="M717 141l454 454q19 19 19 45t-19 45l-454 454q-19 19 -45 19t-45 -19l-102 -102q-19 -19 -19 -45t19 -45l307 -307l-307 -307q-19 -19 -19 -45t19 -45l102 -102q19 -19 45 -19t45 19zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5 t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" d="M1165 397l102 102q19 19 19 45t-19 45l-454 454q-19 19 -45 19t-45 -19l-454 -454q-19 -19 -19 -45t19 -45l102 -102q19 -19 45 -19t45 19l307 307l307 -307q19 -19 45 -19t45 19zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5 t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" d="M813 237l454 454q19 19 19 45t-19 45l-102 102q-19 19 -45 19t-45 -19l-307 -307l-307 307q-19 19 -45 19t-45 -19l-102 -102q-19 -19 -19 -45t19 -45l454 -454q19 -19 45 -19t45 19zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5 t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" horiz-adv-x="1408" d="M1130 939l16 175h-884l47 -534h612l-22 -228l-197 -53l-196 53l-13 140h-175l22 -278l362 -100h4v1l359 99l50 544h-644l-15 181h674zM0 1408h1408l-128 -1438l-578 -162l-574 162z" /> -<glyph unicode="" horiz-adv-x="1792" d="M275 1408h1505l-266 -1333l-804 -267l-698 267l71 356h297l-29 -147l422 -161l486 161l68 339h-1208l58 297h1209l38 191h-1208z" /> -<glyph unicode="" horiz-adv-x="1792" d="M960 1280q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1792 352v-352q0 -22 -20 -30q-8 -2 -12 -2q-13 0 -23 9l-93 93q-119 -143 -318.5 -226.5t-429.5 -83.5t-429.5 83.5t-318.5 226.5l-93 -93q-9 -9 -23 -9q-4 0 -12 2q-20 8 -20 30v352 q0 14 9 23t23 9h352q22 0 30 -20q8 -19 -7 -35l-100 -100q67 -91 189.5 -153.5t271.5 -82.5v647h-192q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h192v163q-58 34 -93 92.5t-35 128.5q0 106 75 181t181 75t181 -75t75 -181q0 -70 -35 -128.5t-93 -92.5v-163h192q26 0 45 -19 t19 -45v-128q0 -26 -19 -45t-45 -19h-192v-647q149 20 271.5 82.5t189.5 153.5l-100 100q-15 16 -7 35q8 20 30 20h352q14 0 23 -9t9 -23z" /> -<glyph unicode="" horiz-adv-x="1152" d="M1056 768q40 0 68 -28t28 -68v-576q0 -40 -28 -68t-68 -28h-960q-40 0 -68 28t-28 68v576q0 40 28 68t68 28h32v320q0 185 131.5 316.5t316.5 131.5t316.5 -131.5t131.5 -316.5q0 -26 -19 -45t-45 -19h-64q-26 0 -45 19t-19 45q0 106 -75 181t-181 75t-181 -75t-75 -181 v-320h736z" /> -<glyph unicode="" d="M1024 640q0 -106 -75 -181t-181 -75t-181 75t-75 181t75 181t181 75t181 -75t75 -181zM1152 640q0 159 -112.5 271.5t-271.5 112.5t-271.5 -112.5t-112.5 -271.5t112.5 -271.5t271.5 -112.5t271.5 112.5t112.5 271.5zM1280 640q0 -212 -150 -362t-362 -150t-362 150 t-150 362t150 362t362 150t362 -150t150 -362zM1408 640q0 130 -51 248.5t-136.5 204t-204 136.5t-248.5 51t-248.5 -51t-204 -136.5t-136.5 -204t-51 -248.5t51 -248.5t136.5 -204t204 -136.5t248.5 -51t248.5 51t204 136.5t136.5 204t51 248.5zM1536 640 q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" horiz-adv-x="1408" d="M384 800v-192q0 -40 -28 -68t-68 -28h-192q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h192q40 0 68 -28t28 -68zM896 800v-192q0 -40 -28 -68t-68 -28h-192q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h192q40 0 68 -28t28 -68zM1408 800v-192q0 -40 -28 -68t-68 -28h-192 q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h192q40 0 68 -28t28 -68z" /> -<glyph unicode="" horiz-adv-x="384" d="M384 288v-192q0 -40 -28 -68t-68 -28h-192q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h192q40 0 68 -28t28 -68zM384 800v-192q0 -40 -28 -68t-68 -28h-192q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h192q40 0 68 -28t28 -68zM384 1312v-192q0 -40 -28 -68t-68 -28h-192 q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h192q40 0 68 -28t28 -68z" /> -<glyph unicode="" d="M512 256q0 53 -37.5 90.5t-90.5 37.5t-90.5 -37.5t-37.5 -90.5t37.5 -90.5t90.5 -37.5t90.5 37.5t37.5 90.5zM863 162q-13 232 -177 396t-396 177q-14 1 -24 -9t-10 -23v-128q0 -13 8.5 -22t21.5 -10q154 -11 264 -121t121 -264q1 -13 10 -21.5t22 -8.5h128q13 0 23 10 t9 24zM1247 161q-5 154 -56 297.5t-139.5 260t-205 205t-260 139.5t-297.5 56q-14 1 -23 -9q-10 -10 -10 -23v-128q0 -13 9 -22t22 -10q204 -7 378 -111.5t278.5 -278.5t111.5 -378q1 -13 10 -22t22 -9h128q13 0 23 10q11 9 9 23zM1536 1120v-960q0 -119 -84.5 -203.5 t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> -<glyph unicode="" d="M768 1408q209 0 385.5 -103t279.5 -279.5t103 -385.5t-103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103zM1152 585q32 18 32 55t-32 55l-544 320q-31 19 -64 1q-32 -19 -32 -56v-640q0 -37 32 -56 q16 -8 32 -8q17 0 32 9z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1024 1084l316 -316l-572 -572l-316 316zM813 105l618 618q19 19 19 45t-19 45l-362 362q-18 18 -45 18t-45 -18l-618 -618q-19 -19 -19 -45t19 -45l362 -362q18 -18 45 -18t45 18zM1702 742l-907 -908q-37 -37 -90.5 -37t-90.5 37l-126 126q56 56 56 136t-56 136 t-136 56t-136 -56l-125 126q-37 37 -37 90.5t37 90.5l907 906q37 37 90.5 37t90.5 -37l125 -125q-56 -56 -56 -136t56 -136t136 -56t136 56l126 -125q37 -37 37 -90.5t-37 -90.5z" /> -<glyph unicode="" d="M1280 576v128q0 26 -19 45t-45 19h-896q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45t45 -19h896q26 0 45 19t19 45zM1536 1120v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5 t84.5 -203.5z" /> -<glyph unicode="" horiz-adv-x="1408" d="M1152 736v-64q0 -14 -9 -23t-23 -9h-832q-14 0 -23 9t-9 23v64q0 14 9 23t23 9h832q14 0 23 -9t9 -23zM1280 288v832q0 66 -47 113t-113 47h-832q-66 0 -113 -47t-47 -113v-832q0 -66 47 -113t113 -47h832q66 0 113 47t47 113zM1408 1120v-832q0 -119 -84.5 -203.5 t-203.5 -84.5h-832q-119 0 -203.5 84.5t-84.5 203.5v832q0 119 84.5 203.5t203.5 84.5h832q119 0 203.5 -84.5t84.5 -203.5z" /> -<glyph unicode="" horiz-adv-x="1024" d="M1018 933q-18 -37 -58 -37h-192v-864q0 -14 -9 -23t-23 -9h-704q-21 0 -29 18q-8 20 4 35l160 192q9 11 25 11h320v640h-192q-40 0 -58 37q-17 37 9 68l320 384q18 22 49 22t49 -22l320 -384q27 -32 9 -68z" /> -<glyph unicode="" horiz-adv-x="1024" d="M32 1280h704q13 0 22.5 -9.5t9.5 -23.5v-863h192q40 0 58 -37t-9 -69l-320 -384q-18 -22 -49 -22t-49 22l-320 384q-26 31 -9 69q18 37 58 37h192v640h-320q-14 0 -25 11l-160 192q-13 14 -4 34q9 19 29 19z" /> -<glyph unicode="" d="M685 237l614 614q19 19 19 45t-19 45l-102 102q-19 19 -45 19t-45 -19l-467 -467l-211 211q-19 19 -45 19t-45 -19l-102 -102q-19 -19 -19 -45t19 -45l358 -358q19 -19 45 -19t45 19zM1536 1120v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5 t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> -<glyph unicode="" d="M404 428l152 -152l-52 -52h-56v96h-96v56zM818 818q14 -13 -3 -30l-291 -291q-17 -17 -30 -3q-14 13 3 30l291 291q17 17 30 3zM544 128l544 544l-288 288l-544 -544v-288h288zM1152 736l92 92q28 28 28 68t-28 68l-152 152q-28 28 -68 28t-68 -28l-92 -92zM1536 1120 v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> -<glyph unicode="" d="M1280 608v480q0 26 -19 45t-45 19h-480q-42 0 -59 -39q-17 -41 14 -70l144 -144l-534 -534q-19 -19 -19 -45t19 -45l102 -102q19 -19 45 -19t45 19l534 534l144 -144q18 -19 45 -19q12 0 25 5q39 17 39 59zM1536 1120v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960 q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> -<glyph unicode="" d="M1005 435l352 352q19 19 19 45t-19 45l-352 352q-30 31 -69 14q-40 -17 -40 -59v-160q-119 0 -216 -19.5t-162.5 -51t-114 -79t-76.5 -95.5t-44.5 -109t-21.5 -111.5t-5 -110.5q0 -181 167 -404q10 -12 25 -12q7 0 13 3q22 9 19 33q-44 354 62 473q46 52 130 75.5 t224 23.5v-160q0 -42 40 -59q12 -5 24 -5q26 0 45 19zM1536 1120v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> -<glyph unicode="" d="M640 448l256 128l-256 128v-256zM1024 1039v-542l-512 -256v542zM1312 640q0 148 -73 273t-198 198t-273 73t-273 -73t-198 -198t-73 -273t73 -273t198 -198t273 -73t273 73t198 198t73 273zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103 t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" d="M1145 861q18 -35 -5 -66l-320 -448q-19 -27 -52 -27t-52 27l-320 448q-23 31 -5 66q17 35 57 35h640q40 0 57 -35zM1280 160v960q0 13 -9.5 22.5t-22.5 9.5h-960q-13 0 -22.5 -9.5t-9.5 -22.5v-960q0 -13 9.5 -22.5t22.5 -9.5h960q13 0 22.5 9.5t9.5 22.5zM1536 1120 v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> -<glyph unicode="" d="M1145 419q-17 -35 -57 -35h-640q-40 0 -57 35q-18 35 5 66l320 448q19 27 52 27t52 -27l320 -448q23 -31 5 -66zM1280 160v960q0 13 -9.5 22.5t-22.5 9.5h-960q-13 0 -22.5 -9.5t-9.5 -22.5v-960q0 -13 9.5 -22.5t22.5 -9.5h960q13 0 22.5 9.5t9.5 22.5zM1536 1120v-960 q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> -<glyph unicode="" d="M1088 640q0 -33 -27 -52l-448 -320q-31 -23 -66 -5q-35 17 -35 57v640q0 40 35 57q35 18 66 -5l448 -320q27 -19 27 -52zM1280 160v960q0 14 -9 23t-23 9h-960q-14 0 -23 -9t-9 -23v-960q0 -14 9 -23t23 -9h960q14 0 23 9t9 23zM1536 1120v-960q0 -119 -84.5 -203.5 t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> -<glyph unicode="" horiz-adv-x="1024" d="M976 229l35 -159q3 -12 -3 -22.5t-17 -14.5l-5 -1q-4 -2 -10.5 -3.5t-16 -4.5t-21.5 -5.5t-25.5 -5t-30 -5t-33.5 -4.5t-36.5 -3t-38.5 -1q-234 0 -409 130.5t-238 351.5h-95q-13 0 -22.5 9.5t-9.5 22.5v113q0 13 9.5 22.5t22.5 9.5h66q-2 57 1 105h-67q-14 0 -23 9 t-9 23v114q0 14 9 23t23 9h98q67 210 243.5 338t400.5 128q102 0 194 -23q11 -3 20 -15q6 -11 3 -24l-43 -159q-3 -13 -14 -19.5t-24 -2.5l-4 1q-4 1 -11.5 2.5l-17.5 3.5t-22.5 3.5t-26 3t-29 2.5t-29.5 1q-126 0 -226 -64t-150 -176h468q16 0 25 -12q10 -12 7 -26 l-24 -114q-5 -26 -32 -26h-488q-3 -37 0 -105h459q15 0 25 -12q9 -12 6 -27l-24 -112q-2 -11 -11 -18.5t-20 -7.5h-387q48 -117 149.5 -185.5t228.5 -68.5q18 0 36 1.5t33.5 3.5t29.5 4.5t24.5 5t18.5 4.5l12 3l5 2q13 5 26 -2q12 -7 15 -21z" /> -<glyph unicode="" horiz-adv-x="1024" d="M1020 399v-367q0 -14 -9 -23t-23 -9h-956q-14 0 -23 9t-9 23v150q0 13 9.5 22.5t22.5 9.5h97v383h-95q-14 0 -23 9.5t-9 22.5v131q0 14 9 23t23 9h95v223q0 171 123.5 282t314.5 111q185 0 335 -125q9 -8 10 -20.5t-7 -22.5l-103 -127q-9 -11 -22 -12q-13 -2 -23 7 q-5 5 -26 19t-69 32t-93 18q-85 0 -137 -47t-52 -123v-215h305q13 0 22.5 -9t9.5 -23v-131q0 -13 -9.5 -22.5t-22.5 -9.5h-305v-379h414v181q0 13 9 22.5t23 9.5h162q14 0 23 -9.5t9 -22.5z" /> -<glyph unicode="" horiz-adv-x="1024" d="M978 351q0 -153 -99.5 -263.5t-258.5 -136.5v-175q0 -14 -9 -23t-23 -9h-135q-13 0 -22.5 9.5t-9.5 22.5v175q-66 9 -127.5 31t-101.5 44.5t-74 48t-46.5 37.5t-17.5 18q-17 21 -2 41l103 135q7 10 23 12q15 2 24 -9l2 -2q113 -99 243 -125q37 -8 74 -8q81 0 142.5 43 t61.5 122q0 28 -15 53t-33.5 42t-58.5 37.5t-66 32t-80 32.5q-39 16 -61.5 25t-61.5 26.5t-62.5 31t-56.5 35.5t-53.5 42.5t-43.5 49t-35.5 58t-21 66.5t-8.5 78q0 138 98 242t255 134v180q0 13 9.5 22.5t22.5 9.5h135q14 0 23 -9t9 -23v-176q57 -6 110.5 -23t87 -33.5 t63.5 -37.5t39 -29t15 -14q17 -18 5 -38l-81 -146q-8 -15 -23 -16q-14 -3 -27 7q-3 3 -14.5 12t-39 26.5t-58.5 32t-74.5 26t-85.5 11.5q-95 0 -155 -43t-60 -111q0 -26 8.5 -48t29.5 -41.5t39.5 -33t56 -31t60.5 -27t70 -27.5q53 -20 81 -31.5t76 -35t75.5 -42.5t62 -50 t53 -63.5t31.5 -76.5t13 -94z" /> -<glyph unicode="" horiz-adv-x="898" d="M898 1066v-102q0 -14 -9 -23t-23 -9h-168q-23 -144 -129 -234t-276 -110q167 -178 459 -536q14 -16 4 -34q-8 -18 -29 -18h-195q-16 0 -25 12q-306 367 -498 571q-9 9 -9 22v127q0 13 9.5 22.5t22.5 9.5h112q132 0 212.5 43t102.5 125h-427q-14 0 -23 9t-9 23v102 q0 14 9 23t23 9h413q-57 113 -268 113h-145q-13 0 -22.5 9.5t-9.5 22.5v133q0 14 9 23t23 9h832q14 0 23 -9t9 -23v-102q0 -14 -9 -23t-23 -9h-233q47 -61 64 -144h171q14 0 23 -9t9 -23z" /> -<glyph unicode="" horiz-adv-x="1027" d="M603 0h-172q-13 0 -22.5 9t-9.5 23v330h-288q-13 0 -22.5 9t-9.5 23v103q0 13 9.5 22.5t22.5 9.5h288v85h-288q-13 0 -22.5 9t-9.5 23v104q0 13 9.5 22.5t22.5 9.5h214l-321 578q-8 16 0 32q10 16 28 16h194q19 0 29 -18l215 -425q19 -38 56 -125q10 24 30.5 68t27.5 61 l191 420q8 19 29 19h191q17 0 27 -16q9 -14 1 -31l-313 -579h215q13 0 22.5 -9.5t9.5 -22.5v-104q0 -14 -9.5 -23t-22.5 -9h-290v-85h290q13 0 22.5 -9.5t9.5 -22.5v-103q0 -14 -9.5 -23t-22.5 -9h-290v-330q0 -13 -9.5 -22.5t-22.5 -9.5z" /> -<glyph unicode="" horiz-adv-x="1280" d="M1043 971q0 100 -65 162t-171 62h-320v-448h320q106 0 171 62t65 162zM1280 971q0 -193 -126.5 -315t-326.5 -122h-340v-118h505q14 0 23 -9t9 -23v-128q0 -14 -9 -23t-23 -9h-505v-192q0 -14 -9.5 -23t-22.5 -9h-167q-14 0 -23 9t-9 23v192h-224q-14 0 -23 9t-9 23v128 q0 14 9 23t23 9h224v118h-224q-14 0 -23 9t-9 23v149q0 13 9 22.5t23 9.5h224v629q0 14 9 23t23 9h539q200 0 326.5 -122t126.5 -315z" /> -<glyph unicode="" horiz-adv-x="1792" d="M514 341l81 299h-159l75 -300q1 -1 1 -3t1 -3q0 1 0.5 3.5t0.5 3.5zM630 768l35 128h-292l32 -128h225zM822 768h139l-35 128h-70zM1271 340l78 300h-162l81 -299q0 -1 0.5 -3.5t1.5 -3.5q0 1 0.5 3t0.5 3zM1382 768l33 128h-297l34 -128h230zM1792 736v-64q0 -14 -9 -23 t-23 -9h-213l-164 -616q-7 -24 -31 -24h-159q-24 0 -31 24l-166 616h-209l-167 -616q-7 -24 -31 -24h-159q-11 0 -19.5 7t-10.5 17l-160 616h-208q-14 0 -23 9t-9 23v64q0 14 9 23t23 9h175l-33 128h-142q-14 0 -23 9t-9 23v64q0 14 9 23t23 9h109l-89 344q-5 15 5 28 q10 12 26 12h137q26 0 31 -24l90 -360h359l97 360q7 24 31 24h126q24 0 31 -24l98 -360h365l93 360q5 24 31 24h137q16 0 26 -12q10 -13 5 -28l-91 -344h111q14 0 23 -9t9 -23v-64q0 -14 -9 -23t-23 -9h-145l-34 -128h179q14 0 23 -9t9 -23z" /> -<glyph unicode="" horiz-adv-x="1280" d="M1167 896q18 -182 -131 -258q117 -28 175 -103t45 -214q-7 -71 -32.5 -125t-64.5 -89t-97 -58.5t-121.5 -34.5t-145.5 -15v-255h-154v251q-80 0 -122 1v-252h-154v255q-18 0 -54 0.5t-55 0.5h-200l31 183h111q50 0 58 51v402h16q-6 1 -16 1v287q-13 68 -89 68h-111v164 l212 -1q64 0 97 1v252h154v-247q82 2 122 2v245h154v-252q79 -7 140 -22.5t113 -45t82.5 -78t36.5 -114.5zM952 351q0 36 -15 64t-37 46t-57.5 30.5t-65.5 18.5t-74 9t-69 3t-64.5 -1t-47.5 -1v-338q8 0 37 -0.5t48 -0.5t53 1.5t58.5 4t57 8.5t55.5 14t47.5 21t39.5 30 t24.5 40t9.5 51zM881 827q0 33 -12.5 58.5t-30.5 42t-48 28t-55 16.5t-61.5 8t-58 2.5t-54 -1t-39.5 -0.5v-307q5 0 34.5 -0.5t46.5 0t50 2t55 5.5t51.5 11t48.5 18.5t37 27t27 38.5t9 51z" /> -<glyph unicode="" horiz-adv-x="1280" d="M1280 768v-800q0 -40 -28 -68t-68 -28h-1088q-40 0 -68 28t-28 68v1344q0 40 28 68t68 28h544v-544q0 -40 28 -68t68 -28h544zM1277 896h-509v509q82 -15 132 -65l312 -312q50 -50 65 -132z" /> -<glyph unicode="" horiz-adv-x="1280" d="M1024 160v64q0 14 -9 23t-23 9h-704q-14 0 -23 -9t-9 -23v-64q0 -14 9 -23t23 -9h704q14 0 23 9t9 23zM1024 416v64q0 14 -9 23t-23 9h-704q-14 0 -23 -9t-9 -23v-64q0 -14 9 -23t23 -9h704q14 0 23 9t9 23zM1280 768v-800q0 -40 -28 -68t-68 -28h-1088q-40 0 -68 28 t-28 68v1344q0 40 28 68t68 28h544v-544q0 -40 28 -68t68 -28h544zM1277 896h-509v509q82 -15 132 -65l312 -312q50 -50 65 -132z" /> -<glyph unicode="" horiz-adv-x="1664" d="M1191 1128h177l-72 218l-12 47q-2 16 -2 20h-4l-3 -20q0 -1 -3.5 -18t-7.5 -29zM736 96q0 -12 -10 -24l-319 -319q-10 -9 -23 -9q-12 0 -23 9l-320 320q-15 16 -7 35q8 20 30 20h192v1376q0 14 9 23t23 9h192q14 0 23 -9t9 -23v-1376h192q14 0 23 -9t9 -23zM1572 -23 v-233h-584v90l369 529q12 18 21 27l11 9v3q-2 0 -6.5 -0.5t-7.5 -0.5q-12 -3 -30 -3h-232v-115h-120v229h567v-89l-369 -530q-6 -8 -21 -26l-11 -11v-2l14 2q9 2 30 2h248v119h121zM1661 874v-106h-288v106h75l-47 144h-243l-47 -144h75v-106h-287v106h70l230 662h162 l230 -662h70z" /> -<glyph unicode="" horiz-adv-x="1664" d="M1191 104h177l-72 218l-12 47q-2 16 -2 20h-4l-3 -20q0 -1 -3.5 -18t-7.5 -29zM736 96q0 -12 -10 -24l-319 -319q-10 -9 -23 -9q-12 0 -23 9l-320 320q-15 16 -7 35q8 20 30 20h192v1376q0 14 9 23t23 9h192q14 0 23 -9t9 -23v-1376h192q14 0 23 -9t9 -23zM1661 -150 v-106h-288v106h75l-47 144h-243l-47 -144h75v-106h-287v106h70l230 662h162l230 -662h70zM1572 1001v-233h-584v90l369 529q12 18 21 27l11 9v3q-2 0 -6.5 -0.5t-7.5 -0.5q-12 -3 -30 -3h-232v-115h-120v229h567v-89l-369 -530q-6 -8 -21 -26l-11 -10v-3l14 3q9 1 30 1h248 v119h121z" /> -<glyph unicode="" horiz-adv-x="1792" d="M736 96q0 -12 -10 -24l-319 -319q-10 -9 -23 -9q-12 0 -23 9l-320 320q-15 16 -7 35q8 20 30 20h192v1376q0 14 9 23t23 9h192q14 0 23 -9t9 -23v-1376h192q14 0 23 -9t9 -23zM1792 -32v-192q0 -14 -9 -23t-23 -9h-832q-14 0 -23 9t-9 23v192q0 14 9 23t23 9h832 q14 0 23 -9t9 -23zM1600 480v-192q0 -14 -9 -23t-23 -9h-640q-14 0 -23 9t-9 23v192q0 14 9 23t23 9h640q14 0 23 -9t9 -23zM1408 992v-192q0 -14 -9 -23t-23 -9h-448q-14 0 -23 9t-9 23v192q0 14 9 23t23 9h448q14 0 23 -9t9 -23zM1216 1504v-192q0 -14 -9 -23t-23 -9h-256 q-14 0 -23 9t-9 23v192q0 14 9 23t23 9h256q14 0 23 -9t9 -23z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1216 -32v-192q0 -14 -9 -23t-23 -9h-256q-14 0 -23 9t-9 23v192q0 14 9 23t23 9h256q14 0 23 -9t9 -23zM736 96q0 -12 -10 -24l-319 -319q-10 -9 -23 -9q-12 0 -23 9l-320 320q-15 16 -7 35q8 20 30 20h192v1376q0 14 9 23t23 9h192q14 0 23 -9t9 -23v-1376h192 q14 0 23 -9t9 -23zM1408 480v-192q0 -14 -9 -23t-23 -9h-448q-14 0 -23 9t-9 23v192q0 14 9 23t23 9h448q14 0 23 -9t9 -23zM1600 992v-192q0 -14 -9 -23t-23 -9h-640q-14 0 -23 9t-9 23v192q0 14 9 23t23 9h640q14 0 23 -9t9 -23zM1792 1504v-192q0 -14 -9 -23t-23 -9h-832 q-14 0 -23 9t-9 23v192q0 14 9 23t23 9h832q14 0 23 -9t9 -23z" /> -<glyph unicode="" d="M1346 223q0 63 -44 116t-103 53q-52 0 -83 -37t-31 -94t36.5 -95t104.5 -38q50 0 85 27t35 68zM736 96q0 -12 -10 -24l-319 -319q-10 -9 -23 -9q-12 0 -23 9l-320 320q-15 16 -7 35q8 20 30 20h192v1376q0 14 9 23t23 9h192q14 0 23 -9t9 -23v-1376h192q14 0 23 -9t9 -23 zM1486 165q0 -62 -13 -121.5t-41 -114t-68 -95.5t-98.5 -65.5t-127.5 -24.5q-62 0 -108 16q-24 8 -42 15l39 113q15 -7 31 -11q37 -13 75 -13q84 0 134.5 58.5t66.5 145.5h-2q-21 -23 -61.5 -37t-84.5 -14q-106 0 -173 71.5t-67 172.5q0 105 72 178t181 73q123 0 205 -94.5 t82 -252.5zM1456 882v-114h-469v114h167v432q0 7 0.5 19t0.5 17v16h-2l-7 -12q-8 -13 -26 -31l-62 -58l-82 86l192 185h123v-654h165z" /> -<glyph unicode="" d="M1346 1247q0 63 -44 116t-103 53q-52 0 -83 -37t-31 -94t36.5 -95t104.5 -38q50 0 85 27t35 68zM736 96q0 -12 -10 -24l-319 -319q-10 -9 -23 -9q-12 0 -23 9l-320 320q-15 16 -7 35q8 20 30 20h192v1376q0 14 9 23t23 9h192q14 0 23 -9t9 -23v-1376h192q14 0 23 -9 t9 -23zM1456 -142v-114h-469v114h167v432q0 7 0.5 19t0.5 17v16h-2l-7 -12q-8 -13 -26 -31l-62 -58l-82 86l192 185h123v-654h165zM1486 1189q0 -62 -13 -121.5t-41 -114t-68 -95.5t-98.5 -65.5t-127.5 -24.5q-62 0 -108 16q-24 8 -42 15l39 113q15 -7 31 -11q37 -13 75 -13 q84 0 134.5 58.5t66.5 145.5h-2q-21 -23 -61.5 -37t-84.5 -14q-106 0 -173 71.5t-67 172.5q0 105 72 178t181 73q123 0 205 -94.5t82 -252.5z" /> -<glyph unicode="" horiz-adv-x="1664" d="M256 192q0 26 -19 45t-45 19q-27 0 -45.5 -19t-18.5 -45q0 -27 18.5 -45.5t45.5 -18.5q26 0 45 18.5t19 45.5zM416 704v-640q0 -26 -19 -45t-45 -19h-288q-26 0 -45 19t-19 45v640q0 26 19 45t45 19h288q26 0 45 -19t19 -45zM1600 704q0 -86 -55 -149q15 -44 15 -76 q3 -76 -43 -137q17 -56 0 -117q-15 -57 -54 -94q9 -112 -49 -181q-64 -76 -197 -78h-36h-76h-17q-66 0 -144 15.5t-121.5 29t-120.5 39.5q-123 43 -158 44q-26 1 -45 19.5t-19 44.5v641q0 25 18 43.5t43 20.5q24 2 76 59t101 121q68 87 101 120q18 18 31 48t17.5 48.5 t13.5 60.5q7 39 12.5 61t19.5 52t34 50q19 19 45 19q46 0 82.5 -10.5t60 -26t40 -40.5t24 -45t12 -50t5 -45t0.5 -39q0 -38 -9.5 -76t-19 -60t-27.5 -56q-3 -6 -10 -18t-11 -22t-8 -24h277q78 0 135 -57t57 -135z" /> -<glyph unicode="" horiz-adv-x="1664" d="M256 960q0 -26 -19 -45t-45 -19q-27 0 -45.5 19t-18.5 45q0 27 18.5 45.5t45.5 18.5q26 0 45 -18.5t19 -45.5zM416 448v640q0 26 -19 45t-45 19h-288q-26 0 -45 -19t-19 -45v-640q0 -26 19 -45t45 -19h288q26 0 45 19t19 45zM1545 597q55 -61 55 -149q-1 -78 -57.5 -135 t-134.5 -57h-277q4 -14 8 -24t11 -22t10 -18q18 -37 27 -57t19 -58.5t10 -76.5q0 -24 -0.5 -39t-5 -45t-12 -50t-24 -45t-40 -40.5t-60 -26t-82.5 -10.5q-26 0 -45 19q-20 20 -34 50t-19.5 52t-12.5 61q-9 42 -13.5 60.5t-17.5 48.5t-31 48q-33 33 -101 120q-49 64 -101 121 t-76 59q-25 2 -43 20.5t-18 43.5v641q0 26 19 44.5t45 19.5q35 1 158 44q77 26 120.5 39.5t121.5 29t144 15.5h17h76h36q133 -2 197 -78q58 -69 49 -181q39 -37 54 -94q17 -61 0 -117q46 -61 43 -137q0 -32 -15 -76z" /> -<glyph unicode="" d="M919 233v157q0 50 -29 50q-17 0 -33 -16v-224q16 -16 33 -16q29 0 29 49zM1103 355h66v34q0 51 -33 51t-33 -51v-34zM532 621v-70h-80v-423h-74v423h-78v70h232zM733 495v-367h-67v40q-39 -45 -76 -45q-33 0 -42 28q-6 16 -6 54v290h66v-270q0 -24 1 -26q1 -15 15 -15 q20 0 42 31v280h67zM985 384v-146q0 -52 -7 -73q-12 -42 -53 -42q-35 0 -68 41v-36h-67v493h67v-161q32 40 68 40q41 0 53 -42q7 -21 7 -74zM1236 255v-9q0 -29 -2 -43q-3 -22 -15 -40q-27 -40 -80 -40q-52 0 -81 38q-21 27 -21 86v129q0 59 20 86q29 38 80 38t78 -38 q21 -28 21 -86v-76h-133v-65q0 -51 34 -51q24 0 30 26q0 1 0.5 7t0.5 16.5v21.5h68zM785 1079v-156q0 -51 -32 -51t-32 51v156q0 52 32 52t32 -52zM1318 366q0 177 -19 260q-10 44 -43 73.5t-76 34.5q-136 15 -412 15q-275 0 -411 -15q-44 -5 -76.5 -34.5t-42.5 -73.5 q-20 -87 -20 -260q0 -176 20 -260q10 -43 42.5 -73t75.5 -35q137 -15 412 -15t412 15q43 5 75.5 35t42.5 73q20 84 20 260zM563 1017l90 296h-75l-51 -195l-53 195h-78l24 -69t23 -69q35 -103 46 -158v-201h74v201zM852 936v130q0 58 -21 87q-29 38 -78 38q-51 0 -78 -38 q-21 -29 -21 -87v-130q0 -58 21 -87q27 -38 78 -38q49 0 78 38q21 27 21 87zM1033 816h67v370h-67v-283q-22 -31 -42 -31q-15 0 -16 16q-1 2 -1 26v272h-67v-293q0 -37 6 -55q11 -27 43 -27q36 0 77 45v-40zM1536 1120v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960 q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> -<glyph unicode="" d="M971 292v-211q0 -67 -39 -67q-23 0 -45 22v301q22 22 45 22q39 0 39 -67zM1309 291v-46h-90v46q0 68 45 68t45 -68zM343 509h107v94h-312v-94h105v-569h100v569zM631 -60h89v494h-89v-378q-30 -42 -57 -42q-18 0 -21 21q-1 3 -1 35v364h-89v-391q0 -49 8 -73 q12 -37 58 -37q48 0 102 61v-54zM1060 88v197q0 73 -9 99q-17 56 -71 56q-50 0 -93 -54v217h-89v-663h89v48q45 -55 93 -55q54 0 71 55q9 27 9 100zM1398 98v13h-91q0 -51 -2 -61q-7 -36 -40 -36q-46 0 -46 69v87h179v103q0 79 -27 116q-39 51 -106 51q-68 0 -107 -51 q-28 -37 -28 -116v-173q0 -79 29 -116q39 -51 108 -51q72 0 108 53q18 27 21 54q2 9 2 58zM790 1011v210q0 69 -43 69t-43 -69v-210q0 -70 43 -70t43 70zM1509 260q0 -234 -26 -350q-14 -59 -58 -99t-102 -46q-184 -21 -555 -21t-555 21q-58 6 -102.5 46t-57.5 99 q-26 112 -26 350q0 234 26 350q14 59 58 99t103 47q183 20 554 20t555 -20q58 -7 102.5 -47t57.5 -99q26 -112 26 -350zM511 1536h102l-121 -399v-271h-100v271q-14 74 -61 212q-37 103 -65 187h106l71 -263zM881 1203v-175q0 -81 -28 -118q-37 -51 -106 -51q-67 0 -105 51 q-28 38 -28 118v175q0 80 28 117q38 51 105 51q69 0 106 -51q28 -37 28 -117zM1216 1365v-499h-91v55q-53 -62 -103 -62q-46 0 -59 37q-8 24 -8 75v394h91v-367q0 -33 1 -35q3 -22 21 -22q27 0 57 43v381h91z" /> -<glyph unicode="" horiz-adv-x="1408" d="M597 869q-10 -18 -257 -456q-27 -46 -65 -46h-239q-21 0 -31 17t0 36l253 448q1 0 0 1l-161 279q-12 22 -1 37q9 15 32 15h239q40 0 66 -45zM1403 1511q11 -16 0 -37l-528 -934v-1l336 -615q11 -20 1 -37q-10 -15 -32 -15h-239q-42 0 -66 45l-339 622q18 32 531 942 q25 45 64 45h241q22 0 31 -15z" /> -<glyph unicode="" d="M685 771q0 1 -126 222q-21 34 -52 34h-184q-18 0 -26 -11q-7 -12 1 -29l125 -216v-1l-196 -346q-9 -14 0 -28q8 -13 24 -13h185q31 0 50 36zM1309 1268q-7 12 -24 12h-187q-30 0 -49 -35l-411 -729q1 -2 262 -481q20 -35 52 -35h184q18 0 25 12q8 13 -1 28l-260 476v1 l409 723q8 16 0 28zM1536 1120v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1280 640q0 37 -30 54l-512 320q-31 20 -65 2q-33 -18 -33 -56v-640q0 -38 33 -56q16 -8 31 -8q20 0 34 10l512 320q30 17 30 54zM1792 640q0 -96 -1 -150t-8.5 -136.5t-22.5 -147.5q-16 -73 -69 -123t-124 -58q-222 -25 -671 -25t-671 25q-71 8 -124.5 58t-69.5 123 q-14 65 -21.5 147.5t-8.5 136.5t-1 150t1 150t8.5 136.5t22.5 147.5q16 73 69 123t124 58q222 25 671 25t671 -25q71 -8 124.5 -58t69.5 -123q14 -65 21.5 -147.5t8.5 -136.5t1 -150z" /> -<glyph unicode="" horiz-adv-x="1792" d="M402 829l494 -305l-342 -285l-490 319zM1388 274v-108l-490 -293v-1l-1 1l-1 -1v1l-489 293v108l147 -96l342 284v2l1 -1l1 1v-2l343 -284zM554 1418l342 -285l-494 -304l-338 270zM1390 829l338 -271l-489 -319l-343 285zM1239 1418l489 -319l-338 -270l-494 304z" /> -<glyph unicode="" horiz-adv-x="1408" d="M928 135v-151l-707 -1v151zM1169 481v-701l-1 -35v-1h-1132l-35 1h-1v736h121v-618h928v618h120zM241 393l704 -65l-13 -150l-705 65zM309 709l683 -183l-39 -146l-683 183zM472 1058l609 -360l-77 -130l-609 360zM832 1389l398 -585l-124 -85l-399 584zM1285 1536 l121 -697l-149 -26l-121 697z" /> -<glyph unicode="" d="M1362 110v648h-135q20 -63 20 -131q0 -126 -64 -232.5t-174 -168.5t-240 -62q-197 0 -337 135.5t-140 327.5q0 68 20 131h-141v-648q0 -26 17.5 -43.5t43.5 -17.5h1069q25 0 43 17.5t18 43.5zM1078 643q0 124 -90.5 211.5t-218.5 87.5q-127 0 -217.5 -87.5t-90.5 -211.5 t90.5 -211.5t217.5 -87.5q128 0 218.5 87.5t90.5 211.5zM1362 1003v165q0 28 -20 48.5t-49 20.5h-174q-29 0 -49 -20.5t-20 -48.5v-165q0 -29 20 -49t49 -20h174q29 0 49 20t20 49zM1536 1211v-1142q0 -81 -58 -139t-139 -58h-1142q-81 0 -139 58t-58 139v1142q0 81 58 139 t139 58h1142q81 0 139 -58t58 -139z" /> -<glyph unicode="" d="M1248 1408q119 0 203.5 -84.5t84.5 -203.5v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960zM698 640q0 88 -62 150t-150 62t-150 -62t-62 -150t62 -150t150 -62t150 62t62 150zM1262 640q0 88 -62 150 t-150 62t-150 -62t-62 -150t62 -150t150 -62t150 62t62 150z" /> -<glyph unicode="" d="M768 914l201 -306h-402zM1133 384h94l-459 691l-459 -691h94l104 160h522zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" horiz-adv-x="1408" d="M815 677q8 -63 -50.5 -101t-111.5 -6q-39 17 -53.5 58t-0.5 82t52 58q36 18 72.5 12t64 -35.5t27.5 -67.5zM926 698q-14 107 -113 164t-197 13q-63 -28 -100.5 -88.5t-34.5 -129.5q4 -91 77.5 -155t165.5 -56q91 8 152 84t50 168zM1165 1240q-20 27 -56 44.5t-58 22 t-71 12.5q-291 47 -566 -2q-43 -7 -66 -12t-55 -22t-50 -43q30 -28 76 -45.5t73.5 -22t87.5 -11.5q228 -29 448 -1q63 8 89.5 12t72.5 21.5t75 46.5zM1222 205q-8 -26 -15.5 -76.5t-14 -84t-28.5 -70t-58 -56.5q-86 -48 -189.5 -71.5t-202 -22t-201.5 18.5q-46 8 -81.5 18 t-76.5 27t-73 43.5t-52 61.5q-25 96 -57 292l6 16l18 9q223 -148 506.5 -148t507.5 148q21 -6 24 -23t-5 -45t-8 -37zM1403 1166q-26 -167 -111 -655q-5 -30 -27 -56t-43.5 -40t-54.5 -31q-252 -126 -610 -88q-248 27 -394 139q-15 12 -25.5 26.5t-17 35t-9 34t-6 39.5 t-5.5 35q-9 50 -26.5 150t-28 161.5t-23.5 147.5t-22 158q3 26 17.5 48.5t31.5 37.5t45 30t46 22.5t48 18.5q125 46 313 64q379 37 676 -50q155 -46 215 -122q16 -20 16.5 -51t-5.5 -54z" /> -<glyph unicode="" d="M848 666q0 43 -41 66t-77 1q-43 -20 -42.5 -72.5t43.5 -70.5q39 -23 81 4t36 72zM928 682q8 -66 -36 -121t-110 -61t-119 40t-56 113q-2 49 25.5 93t72.5 64q70 31 141.5 -10t81.5 -118zM1100 1073q-20 -21 -53.5 -34t-53 -16t-63.5 -8q-155 -20 -324 0q-44 6 -63 9.5 t-52.5 16t-54.5 32.5q13 19 36 31t40 15.5t47 8.5q198 35 408 1q33 -5 51 -8.5t43 -16t39 -31.5zM1142 327q0 7 5.5 26.5t3 32t-17.5 16.5q-161 -106 -365 -106t-366 106l-12 -6l-5 -12q26 -154 41 -210q47 -81 204 -108q249 -46 428 53q34 19 49 51.5t22.5 85.5t12.5 71z M1272 1020q9 53 -8 75q-43 55 -155 88q-216 63 -487 36q-132 -12 -226 -46q-38 -15 -59.5 -25t-47 -34t-29.5 -54q8 -68 19 -138t29 -171t24 -137q1 -5 5 -31t7 -36t12 -27t22 -28q105 -80 284 -100q259 -28 440 63q24 13 39.5 23t31 29t19.5 40q48 267 80 473zM1536 1120 v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> -<glyph unicode="" horiz-adv-x="1024" d="M390 1408h219v-388h364v-241h-364v-394q0 -136 14 -172q13 -37 52 -60q50 -31 117 -31q117 0 232 76v-242q-102 -48 -178 -65q-77 -19 -173 -19q-105 0 -186 27q-78 25 -138 75q-58 51 -79 105q-22 54 -22 161v539h-170v217q91 30 155 84q64 55 103 132q39 78 54 196z " /> -<glyph unicode="" d="M1123 127v181q-88 -56 -174 -56q-51 0 -88 23q-29 17 -39 45q-11 30 -11 129v295h274v181h-274v291h-164q-11 -90 -40 -147t-78 -99q-48 -40 -116 -63v-163h127v-404q0 -78 17 -121q17 -42 59 -78q43 -37 104 -57q62 -20 140 -20q67 0 129 14q57 13 134 49zM1536 1120 v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> -<glyph unicode="" horiz-adv-x="768" d="M765 237q8 -19 -5 -35l-350 -384q-10 -10 -23 -10q-14 0 -24 10l-355 384q-13 16 -5 35q9 19 29 19h224v1248q0 14 9 23t23 9h192q14 0 23 -9t9 -23v-1248h224q21 0 29 -19z" /> -<glyph unicode="" horiz-adv-x="768" d="M765 1043q-9 -19 -29 -19h-224v-1248q0 -14 -9 -23t-23 -9h-192q-14 0 -23 9t-9 23v1248h-224q-21 0 -29 19t5 35l350 384q10 10 23 10q14 0 24 -10l355 -384q13 -16 5 -35z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1792 736v-192q0 -14 -9 -23t-23 -9h-1248v-224q0 -21 -19 -29t-35 5l-384 350q-10 10 -10 23q0 14 10 24l384 354q16 14 35 6q19 -9 19 -29v-224h1248q14 0 23 -9t9 -23z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1728 643q0 -14 -10 -24l-384 -354q-16 -14 -35 -6q-19 9 -19 29v224h-1248q-14 0 -23 9t-9 23v192q0 14 9 23t23 9h1248v224q0 21 19 29t35 -5l384 -350q10 -10 10 -23z" /> -<glyph unicode="" horiz-adv-x="1408" d="M1393 321q-39 -125 -123 -250q-129 -196 -257 -196q-49 0 -140 32q-86 32 -151 32q-61 0 -142 -33q-81 -34 -132 -34q-152 0 -301 259q-147 261 -147 503q0 228 113 374q112 144 284 144q72 0 177 -30q104 -30 138 -30q45 0 143 34q102 34 173 34q119 0 213 -65 q52 -36 104 -100q-79 -67 -114 -118q-65 -94 -65 -207q0 -124 69 -223t158 -126zM1017 1494q0 -61 -29 -136q-30 -75 -93 -138q-54 -54 -108 -72q-37 -11 -104 -17q3 149 78 257q74 107 250 148q1 -3 2.5 -11t2.5 -11q0 -4 0.5 -10t0.5 -10z" /> -<glyph unicode="" horiz-adv-x="1664" d="M682 530v-651l-682 94v557h682zM682 1273v-659h-682v565zM1664 530v-786l-907 125v661h907zM1664 1408v-794h-907v669z" /> -<glyph unicode="" horiz-adv-x="1408" d="M493 1053q16 0 27.5 11.5t11.5 27.5t-11.5 27.5t-27.5 11.5t-27 -11.5t-11 -27.5t11 -27.5t27 -11.5zM915 1053q16 0 27 11.5t11 27.5t-11 27.5t-27 11.5t-27.5 -11.5t-11.5 -27.5t11.5 -27.5t27.5 -11.5zM103 869q42 0 72 -30t30 -72v-430q0 -43 -29.5 -73t-72.5 -30 t-73 30t-30 73v430q0 42 30 72t73 30zM1163 850v-666q0 -46 -32 -78t-77 -32h-75v-227q0 -43 -30 -73t-73 -30t-73 30t-30 73v227h-138v-227q0 -43 -30 -73t-73 -30q-42 0 -72 30t-30 73l-1 227h-74q-46 0 -78 32t-32 78v666h918zM931 1255q107 -55 171 -153.5t64 -215.5 h-925q0 117 64 215.5t172 153.5l-71 131q-7 13 5 20q13 6 20 -6l72 -132q95 42 201 42t201 -42l72 132q7 12 20 6q12 -7 5 -20zM1408 767v-430q0 -43 -30 -73t-73 -30q-42 0 -72 30t-30 73v430q0 43 30 72.5t72 29.5q43 0 73 -29.5t30 -72.5z" /> -<glyph unicode="" d="M663 1125q-11 -1 -15.5 -10.5t-8.5 -9.5q-5 -1 -5 5q0 12 19 15h10zM750 1111q-4 -1 -11.5 6.5t-17.5 4.5q24 11 32 -2q3 -6 -3 -9zM399 684q-4 1 -6 -3t-4.5 -12.5t-5.5 -13.5t-10 -13q-7 -10 -1 -12q4 -1 12.5 7t12.5 18q1 3 2 7t2 6t1.5 4.5t0.5 4v3t-1 2.5t-3 2z M1254 325q0 18 -55 42q4 15 7.5 27.5t5 26t3 21.5t0.5 22.5t-1 19.5t-3.5 22t-4 20.5t-5 25t-5.5 26.5q-10 48 -47 103t-72 75q24 -20 57 -83q87 -162 54 -278q-11 -40 -50 -42q-31 -4 -38.5 18.5t-8 83.5t-11.5 107q-9 39 -19.5 69t-19.5 45.5t-15.5 24.5t-13 15t-7.5 7 q-14 62 -31 103t-29.5 56t-23.5 33t-15 40q-4 21 6 53.5t4.5 49.5t-44.5 25q-15 3 -44.5 18t-35.5 16q-8 1 -11 26t8 51t36 27q37 3 51 -30t4 -58q-11 -19 -2 -26.5t30 -0.5q13 4 13 36v37q-5 30 -13.5 50t-21 30.5t-23.5 15t-27 7.5q-107 -8 -89 -134q0 -15 -1 -15 q-9 9 -29.5 10.5t-33 -0.5t-15.5 5q1 57 -16 90t-45 34q-27 1 -41.5 -27.5t-16.5 -59.5q-1 -15 3.5 -37t13 -37.5t15.5 -13.5q10 3 16 14q4 9 -7 8q-7 0 -15.5 14.5t-9.5 33.5q-1 22 9 37t34 14q17 0 27 -21t9.5 -39t-1.5 -22q-22 -15 -31 -29q-8 -12 -27.5 -23.5 t-20.5 -12.5q-13 -14 -15.5 -27t7.5 -18q14 -8 25 -19.5t16 -19t18.5 -13t35.5 -6.5q47 -2 102 15q2 1 23 7t34.5 10.5t29.5 13t21 17.5q9 14 20 8q5 -3 6.5 -8.5t-3 -12t-16.5 -9.5q-20 -6 -56.5 -21.5t-45.5 -19.5q-44 -19 -70 -23q-25 -5 -79 2q-10 2 -9 -2t17 -19 q25 -23 67 -22q17 1 36 7t36 14t33.5 17.5t30 17t24.5 12t17.5 2.5t8.5 -11q0 -2 -1 -4.5t-4 -5t-6 -4.5t-8.5 -5t-9 -4.5t-10 -5t-9.5 -4.5q-28 -14 -67.5 -44t-66.5 -43t-49 -1q-21 11 -63 73q-22 31 -25 22q-1 -3 -1 -10q0 -25 -15 -56.5t-29.5 -55.5t-21 -58t11.5 -63 q-23 -6 -62.5 -90t-47.5 -141q-2 -18 -1.5 -69t-5.5 -59q-8 -24 -29 -3q-32 31 -36 94q-2 28 4 56q4 19 -1 18l-4 -5q-36 -65 10 -166q5 -12 25 -28t24 -20q20 -23 104 -90.5t93 -76.5q16 -15 17.5 -38t-14 -43t-45.5 -23q8 -15 29 -44.5t28 -54t7 -70.5q46 24 7 92 q-4 8 -10.5 16t-9.5 12t-2 6q3 5 13 9.5t20 -2.5q46 -52 166 -36q133 15 177 87q23 38 34 30q12 -6 10 -52q-1 -25 -23 -92q-9 -23 -6 -37.5t24 -15.5q3 19 14.5 77t13.5 90q2 21 -6.5 73.5t-7.5 97t23 70.5q15 18 51 18q1 37 34.5 53t72.5 10.5t60 -22.5zM626 1152 q3 17 -2.5 30t-11.5 15q-9 2 -9 -7q2 -5 5 -6q10 0 7 -15q-3 -20 8 -20q3 0 3 3zM1045 955q-2 8 -6.5 11.5t-13 5t-14.5 5.5q-5 3 -9.5 8t-7 8t-5.5 6.5t-4 4t-4 -1.5q-14 -16 7 -43.5t39 -31.5q9 -1 14.5 8t3.5 20zM867 1168q0 11 -5 19.5t-11 12.5t-9 3q-14 -1 -7 -7l4 -2 q14 -4 18 -31q0 -3 8 2zM921 1401q0 2 -2.5 5t-9 7t-9.5 6q-15 15 -24 15q-9 -1 -11.5 -7.5t-1 -13t-0.5 -12.5q-1 -4 -6 -10.5t-6 -9t3 -8.5q4 -3 8 0t11 9t15 9q1 1 9 1t15 2t9 7zM1486 60q20 -12 31 -24.5t12 -24t-2.5 -22.5t-15.5 -22t-23.5 -19.5t-30 -18.5 t-31.5 -16.5t-32 -15.5t-27 -13q-38 -19 -85.5 -56t-75.5 -64q-17 -16 -68 -19.5t-89 14.5q-18 9 -29.5 23.5t-16.5 25.5t-22 19.5t-47 9.5q-44 1 -130 1q-19 0 -57 -1.5t-58 -2.5q-44 -1 -79.5 -15t-53.5 -30t-43.5 -28.5t-53.5 -11.5q-29 1 -111 31t-146 43q-19 4 -51 9.5 t-50 9t-39.5 9.5t-33.5 14.5t-17 19.5q-10 23 7 66.5t18 54.5q1 16 -4 40t-10 42.5t-4.5 36.5t10.5 27q14 12 57 14t60 12q30 18 42 35t12 51q21 -73 -32 -106q-32 -20 -83 -15q-34 3 -43 -10q-13 -15 5 -57q2 -6 8 -18t8.5 -18t4.5 -17t1 -22q0 -15 -17 -49t-14 -48 q3 -17 37 -26q20 -6 84.5 -18.5t99.5 -20.5q24 -6 74 -22t82.5 -23t55.5 -4q43 6 64.5 28t23 48t-7.5 58.5t-19 52t-20 36.5q-121 190 -169 242q-68 74 -113 40q-11 -9 -15 15q-3 16 -2 38q1 29 10 52t24 47t22 42q8 21 26.5 72t29.5 78t30 61t39 54q110 143 124 195 q-12 112 -16 310q-2 90 24 151.5t106 104.5q39 21 104 21q53 1 106 -13.5t89 -41.5q57 -42 91.5 -121.5t29.5 -147.5q-5 -95 30 -214q34 -113 133 -218q55 -59 99.5 -163t59.5 -191q8 -49 5 -84.5t-12 -55.5t-20 -22q-10 -2 -23.5 -19t-27 -35.5t-40.5 -33.5t-61 -14 q-18 1 -31.5 5t-22.5 13.5t-13.5 15.5t-11.5 20.5t-9 19.5q-22 37 -41 30t-28 -49t7 -97q20 -70 1 -195q-10 -65 18 -100.5t73 -33t85 35.5q59 49 89.5 66.5t103.5 42.5q53 18 77 36.5t18.5 34.5t-25 28.5t-51.5 23.5q-33 11 -49.5 48t-15 72.5t15.5 47.5q1 -31 8 -56.5 t14.5 -40.5t20.5 -28.5t21 -19t21.5 -13t16.5 -9.5z" /> -<glyph unicode="" d="M1024 36q-42 241 -140 498h-2l-2 -1q-16 -6 -43 -16.5t-101 -49t-137 -82t-131 -114.5t-103 -148l-15 11q184 -150 418 -150q132 0 256 52zM839 643q-21 49 -53 111q-311 -93 -673 -93q-1 -7 -1 -21q0 -124 44 -236.5t124 -201.5q50 89 123.5 166.5t142.5 124.5t130.5 81 t99.5 48l37 13q4 1 13 3.5t13 4.5zM732 855q-120 213 -244 378q-138 -65 -234 -186t-128 -272q302 0 606 80zM1416 536q-210 60 -409 29q87 -239 128 -469q111 75 185 189.5t96 250.5zM611 1277q-1 0 -2 -1q1 1 2 1zM1201 1132q-185 164 -433 164q-76 0 -155 -19 q131 -170 246 -382q69 26 130 60.5t96.5 61.5t65.5 57t37.5 40.5zM1424 647q-3 232 -149 410l-1 -1q-9 -12 -19 -24.5t-43.5 -44.5t-71 -60.5t-100 -65t-131.5 -64.5q25 -53 44 -95q2 -6 6.5 -17.5t7.5 -16.5q36 5 74.5 7t73.5 2t69 -1.5t64 -4t56.5 -5.5t48 -6.5t36.5 -6 t25 -4.5zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" d="M1173 473q0 50 -19.5 91.5t-48.5 68.5t-73 49t-82.5 34t-87.5 23l-104 24q-30 7 -44 10.5t-35 11.5t-30 16t-16.5 21t-7.5 30q0 77 144 77q43 0 77 -12t54 -28.5t38 -33.5t40 -29t48 -12q47 0 75.5 32t28.5 77q0 55 -56 99.5t-142 67.5t-182 23q-68 0 -132 -15.5 t-119.5 -47t-89 -87t-33.5 -128.5q0 -61 19 -106.5t56 -75.5t80 -48.5t103 -32.5l146 -36q90 -22 112 -36q32 -20 32 -60q0 -39 -40 -64.5t-105 -25.5q-51 0 -91.5 16t-65 38.5t-45.5 45t-46 38.5t-54 16q-50 0 -75.5 -30t-25.5 -75q0 -92 122 -157.5t291 -65.5 q73 0 140 18.5t122.5 53.5t88.5 93.5t33 131.5zM1536 256q0 -159 -112.5 -271.5t-271.5 -112.5q-130 0 -234 80q-77 -16 -150 -16q-143 0 -273.5 55.5t-225 150t-150 225t-55.5 273.5q0 73 16 150q-80 104 -80 234q0 159 112.5 271.5t271.5 112.5q130 0 234 -80 q77 16 150 16q143 0 273.5 -55.5t225 -150t150 -225t55.5 -273.5q0 -73 -16 -150q80 -104 80 -234z" /> -<glyph unicode="" horiz-adv-x="1664" d="M1483 512l-587 -587q-52 -53 -127.5 -53t-128.5 53l-587 587q-53 53 -53 128t53 128l587 587q53 53 128 53t128 -53l265 -265l-398 -399l-188 188q-42 42 -99 42q-59 0 -100 -41l-120 -121q-42 -40 -42 -99q0 -58 42 -100l406 -408q30 -28 67 -37l6 -4h28q60 0 99 41 l619 619l2 -3q53 -53 53 -128t-53 -128zM1406 1138l120 -120q14 -15 14 -36t-14 -36l-730 -730q-17 -15 -37 -15v0q-4 0 -6 1q-18 2 -30 14l-407 408q-14 15 -14 36t14 35l121 120q13 15 35 15t36 -15l252 -252l574 575q15 15 36 15t36 -15z" /> -<glyph unicode="" d="M704 192v1024q0 14 -9 23t-23 9h-480q-14 0 -23 -9t-9 -23v-1024q0 -14 9 -23t23 -9h480q14 0 23 9t9 23zM1376 576v640q0 14 -9 23t-23 9h-480q-14 0 -23 -9t-9 -23v-640q0 -14 9 -23t23 -9h480q14 0 23 9t9 23zM1536 1344v-1408q0 -26 -19 -45t-45 -19h-1408 q-26 0 -45 19t-19 45v1408q0 26 19 45t45 19h1408q26 0 45 -19t19 -45z" /> -<glyph unicode="" horiz-adv-x="1280" d="M1280 480q0 -40 -28 -68t-68 -28q-51 0 -80 43l-227 341h-45v-132l247 -411q9 -15 9 -33q0 -26 -19 -45t-45 -19h-192v-272q0 -46 -33 -79t-79 -33h-160q-46 0 -79 33t-33 79v272h-192q-26 0 -45 19t-19 45q0 18 9 33l247 411v132h-45l-227 -341q-29 -43 -80 -43 q-40 0 -68 28t-28 68q0 29 16 53l256 384q73 107 176 107h384q103 0 176 -107l256 -384q16 -24 16 -53zM864 1280q0 -93 -65.5 -158.5t-158.5 -65.5t-158.5 65.5t-65.5 158.5t65.5 158.5t158.5 65.5t158.5 -65.5t65.5 -158.5z" /> -<glyph unicode="" horiz-adv-x="1024" d="M1024 832v-416q0 -40 -28 -68t-68 -28t-68 28t-28 68v352h-64v-912q0 -46 -33 -79t-79 -33t-79 33t-33 79v464h-64v-464q0 -46 -33 -79t-79 -33t-79 33t-33 79v912h-64v-352q0 -40 -28 -68t-68 -28t-68 28t-28 68v416q0 80 56 136t136 56h640q80 0 136 -56t56 -136z M736 1280q0 -93 -65.5 -158.5t-158.5 -65.5t-158.5 65.5t-65.5 158.5t65.5 158.5t158.5 65.5t158.5 -65.5t65.5 -158.5z" /> -<glyph unicode="" d="M773 234l350 473q16 22 24.5 59t-6 85t-61.5 79q-40 26 -83 25.5t-73.5 -17.5t-54.5 -45q-36 -40 -96 -40q-59 0 -95 40q-24 28 -54.5 45t-73.5 17.5t-84 -25.5q-46 -31 -60.5 -79t-6 -85t24.5 -59zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103 t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1472 640q0 117 -45.5 223.5t-123 184t-184 123t-223.5 45.5t-223.5 -45.5t-184 -123t-123 -184t-45.5 -223.5t45.5 -223.5t123 -184t184 -123t223.5 -45.5t223.5 45.5t184 123t123 184t45.5 223.5zM1748 363q-4 -15 -20 -20l-292 -96v-306q0 -16 -13 -26q-15 -10 -29 -4 l-292 94l-180 -248q-10 -13 -26 -13t-26 13l-180 248l-292 -94q-14 -6 -29 4q-13 10 -13 26v306l-292 96q-16 5 -20 20q-5 17 4 29l180 248l-180 248q-9 13 -4 29q4 15 20 20l292 96v306q0 16 13 26q15 10 29 4l292 -94l180 248q9 12 26 12t26 -12l180 -248l292 94 q14 6 29 -4q13 -10 13 -26v-306l292 -96q16 -5 20 -20q5 -16 -4 -29l-180 -248l180 -248q9 -12 4 -29z" /> -<glyph unicode="" d="M1262 233q-54 -9 -110 -9q-182 0 -337 90t-245 245t-90 337q0 192 104 357q-201 -60 -328.5 -229t-127.5 -384q0 -130 51 -248.5t136.5 -204t204 -136.5t248.5 -51q144 0 273.5 61.5t220.5 171.5zM1465 318q-94 -203 -283.5 -324.5t-413.5 -121.5q-156 0 -298 61 t-245 164t-164 245t-61 298q0 153 57.5 292.5t156 241.5t235.5 164.5t290 68.5q44 2 61 -39q18 -41 -15 -72q-86 -78 -131.5 -181.5t-45.5 -218.5q0 -148 73 -273t198 -198t273 -73q118 0 228 51q41 18 72 -13q14 -14 17.5 -34t-4.5 -38z" /> -<glyph unicode="" horiz-adv-x="1792" d="M1088 704q0 26 -19 45t-45 19h-256q-26 0 -45 -19t-19 -45t19 -45t45 -19h256q26 0 45 19t19 45zM1664 896v-960q0 -26 -19 -45t-45 -19h-1408q-26 0 -45 19t-19 45v960q0 26 19 45t45 19h1408q26 0 45 -19t19 -45zM1728 1344v-256q0 -26 -19 -45t-45 -19h-1536 q-26 0 -45 19t-19 45v256q0 26 19 45t45 19h1536q26 0 45 -19t19 -45z" /> -<glyph unicode="" horiz-adv-x="1664" d="M1632 576q0 -26 -19 -45t-45 -19h-224q0 -171 -67 -290l208 -209q19 -19 19 -45t-19 -45q-18 -19 -45 -19t-45 19l-198 197q-5 -5 -15 -13t-42 -28.5t-65 -36.5t-82 -29t-97 -13v896h-128v-896q-51 0 -101.5 13.5t-87 33t-66 39t-43.5 32.5l-15 14l-183 -207 q-20 -21 -48 -21q-24 0 -43 16q-19 18 -20.5 44.5t15.5 46.5l202 227q-58 114 -58 274h-224q-26 0 -45 19t-19 45t19 45t45 19h224v294l-173 173q-19 19 -19 45t19 45t45 19t45 -19l173 -173h844l173 173q19 19 45 19t45 -19t19 -45t-19 -45l-173 -173v-294h224q26 0 45 -19 t19 -45zM1152 1152h-640q0 133 93.5 226.5t226.5 93.5t226.5 -93.5t93.5 -226.5z" /> -<glyph unicode="" horiz-adv-x="1920" d="M1917 1016q23 -64 -150 -294q-24 -32 -65 -85q-78 -100 -90 -131q-17 -41 14 -81q17 -21 81 -82h1l1 -1l1 -1l2 -2q141 -131 191 -221q3 -5 6.5 -12.5t7 -26.5t-0.5 -34t-25 -27.5t-59 -12.5l-256 -4q-24 -5 -56 5t-52 22l-20 12q-30 21 -70 64t-68.5 77.5t-61 58 t-56.5 15.5q-3 -1 -8 -3.5t-17 -14.5t-21.5 -29.5t-17 -52t-6.5 -77.5q0 -15 -3.5 -27.5t-7.5 -18.5l-4 -5q-18 -19 -53 -22h-115q-71 -4 -146 16.5t-131.5 53t-103 66t-70.5 57.5l-25 24q-10 10 -27.5 30t-71.5 91t-106 151t-122.5 211t-130.5 272q-6 16 -6 27t3 16l4 6 q15 19 57 19l274 2q12 -2 23 -6.5t16 -8.5l5 -3q16 -11 24 -32q20 -50 46 -103.5t41 -81.5l16 -29q29 -60 56 -104t48.5 -68.5t41.5 -38.5t34 -14t27 5q2 1 5 5t12 22t13.5 47t9.5 81t0 125q-2 40 -9 73t-14 46l-6 12q-25 34 -85 43q-13 2 5 24q17 19 38 30q53 26 239 24 q82 -1 135 -13q20 -5 33.5 -13.5t20.5 -24t10.5 -32t3.5 -45.5t-1 -55t-2.5 -70.5t-1.5 -82.5q0 -11 -1 -42t-0.5 -48t3.5 -40.5t11.5 -39t22.5 -24.5q8 -2 17 -4t26 11t38 34.5t52 67t68 107.5q60 104 107 225q4 10 10 17.5t11 10.5l4 3l5 2.5t13 3t20 0.5l288 2 q39 5 64 -2.5t31 -16.5z" /> -<glyph unicode="" horiz-adv-x="1792" d="M675 252q21 34 11 69t-45 50q-34 14 -73 1t-60 -46q-22 -34 -13 -68.5t43 -50.5t74.5 -2.5t62.5 47.5zM769 373q8 13 3.5 26.5t-17.5 18.5q-14 5 -28.5 -0.5t-21.5 -18.5q-17 -31 13 -45q14 -5 29 0.5t22 18.5zM943 266q-45 -102 -158 -150t-224 -12 q-107 34 -147.5 126.5t6.5 187.5q47 93 151.5 139t210.5 19q111 -29 158.5 -119.5t2.5 -190.5zM1255 426q-9 96 -89 170t-208.5 109t-274.5 21q-223 -23 -369.5 -141.5t-132.5 -264.5q9 -96 89 -170t208.5 -109t274.5 -21q223 23 369.5 141.5t132.5 264.5zM1563 422 q0 -68 -37 -139.5t-109 -137t-168.5 -117.5t-226 -83t-270.5 -31t-275 33.5t-240.5 93t-171.5 151t-65 199.5q0 115 69.5 245t197.5 258q169 169 341.5 236t246.5 -7q65 -64 20 -209q-4 -14 -1 -20t10 -7t14.5 0.5t13.5 3.5l6 2q139 59 246 59t153 -61q45 -63 0 -178 q-2 -13 -4.5 -20t4.5 -12.5t12 -7.5t17 -6q57 -18 103 -47t80 -81.5t34 -116.5zM1489 1046q42 -47 54.5 -108.5t-6.5 -117.5q-8 -23 -29.5 -34t-44.5 -4q-23 8 -34 29.5t-4 44.5q20 63 -24 111t-107 35q-24 -5 -45 8t-25 37q-5 24 8 44.5t37 25.5q60 13 119 -5.5t101 -65.5z M1670 1209q87 -96 112.5 -222.5t-13.5 -241.5q-9 -27 -34 -40t-52 -4t-40 34t-5 52q28 82 10 172t-80 158q-62 69 -148 95.5t-173 8.5q-28 -6 -52 9.5t-30 43.5t9.5 51.5t43.5 29.5q123 26 244 -11.5t208 -134.5z" /> -<glyph unicode="" d="M1133 -34q-171 -94 -368 -94q-196 0 -367 94q138 87 235.5 211t131.5 268q35 -144 132.5 -268t235.5 -211zM638 1394v-485q0 -252 -126.5 -459.5t-330.5 -306.5q-181 215 -181 495q0 187 83.5 349.5t229.5 269.5t325 137zM1536 638q0 -280 -181 -495 q-204 99 -330.5 306.5t-126.5 459.5v485q179 -30 325 -137t229.5 -269.5t83.5 -349.5z" /> -<glyph unicode="" horiz-adv-x="1408" d="M1402 433q-32 -80 -76 -138t-91 -88.5t-99 -46.5t-101.5 -14.5t-96.5 8.5t-86.5 22t-69.5 27.5t-46 22.5l-17 10q-113 -228 -289.5 -359.5t-384.5 -132.5q-19 0 -32 13t-13 32t13 31.5t32 12.5q173 1 322.5 107.5t251.5 294.5q-36 -14 -72 -23t-83 -13t-91 2.5t-93 28.5 t-92 59t-84.5 100t-74.5 146q114 47 214 57t167.5 -7.5t124.5 -56.5t88.5 -77t56.5 -82q53 131 79 291q-7 -1 -18 -2.5t-46.5 -2.5t-69.5 0.5t-81.5 10t-88.5 23t-84 42.5t-75 65t-54.5 94.5t-28.5 127.5q70 28 133.5 36.5t112.5 -1t92 -30t73.5 -50t56 -61t42 -63t27.5 -56 t16 -39.5l4 -16q12 122 12 195q-8 6 -21.5 16t-49 44.5t-63.5 71.5t-54 93t-33 112.5t12 127t70 138.5q73 -25 127.5 -61.5t84.5 -76.5t48 -85t20.5 -89t-0.5 -85.5t-13 -76.5t-19 -62t-17 -42l-7 -15q1 -5 1 -50.5t-1 -71.5q3 7 10 18.5t30.5 43t50.5 58t71 55.5t91.5 44.5 t112 14.5t132.5 -24q-2 -78 -21.5 -141.5t-50 -104.5t-69.5 -71.5t-81.5 -45.5t-84.5 -24t-80 -9.5t-67.5 1t-46.5 4.5l-17 3q-23 -147 -73 -283q6 7 18 18.5t49.5 41t77.5 52.5t99.5 42t117.5 20t129 -23.5t137 -77.5z" /> -<glyph unicode="" horiz-adv-x="1280" d="M1259 283v-66q0 -85 -57.5 -144.5t-138.5 -59.5h-57l-260 -269v269h-529q-81 0 -138.5 59.5t-57.5 144.5v66h1238zM1259 609v-255h-1238v255h1238zM1259 937v-255h-1238v255h1238zM1259 1077v-67h-1238v67q0 84 57.5 143.5t138.5 59.5h846q81 0 138.5 -59.5t57.5 -143.5z " /> -<glyph unicode="" d="M1152 640q0 -14 -9 -23l-320 -320q-9 -9 -23 -9q-13 0 -22.5 9.5t-9.5 22.5v192h-352q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h352v192q0 14 9 23t23 9q12 0 24 -10l319 -319q9 -9 9 -23zM1312 640q0 148 -73 273t-198 198t-273 73t-273 -73t-198 -198 t-73 -273t73 -273t198 -198t273 -73t273 73t198 198t73 273zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" d="M1152 736v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-352v-192q0 -14 -9 -23t-23 -9q-12 0 -24 10l-319 319q-9 9 -9 23t9 23l320 320q9 9 23 9q13 0 22.5 -9.5t9.5 -22.5v-192h352q13 0 22.5 -9.5t9.5 -22.5zM1312 640q0 148 -73 273t-198 198t-273 73t-273 -73t-198 -198 t-73 -273t73 -273t198 -198t273 -73t273 73t198 198t73 273zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" d="M1024 960v-640q0 -26 -19 -45t-45 -19q-20 0 -37 12l-448 320q-27 19 -27 52t27 52l448 320q17 12 37 12q26 0 45 -19t19 -45zM1280 160v960q0 13 -9.5 22.5t-22.5 9.5h-960q-13 0 -22.5 -9.5t-9.5 -22.5v-960q0 -13 9.5 -22.5t22.5 -9.5h960q13 0 22.5 9.5t9.5 22.5z M1536 1120v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> -<glyph unicode="" d="M1024 640q0 -106 -75 -181t-181 -75t-181 75t-75 181t75 181t181 75t181 -75t75 -181zM768 1184q-148 0 -273 -73t-198 -198t-73 -273t73 -273t198 -198t273 -73t273 73t198 198t73 273t-73 273t-198 198t-273 73zM1536 640q0 -209 -103 -385.5t-279.5 -279.5 t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" /> -<glyph unicode="" horiz-adv-x="1664" d="M1023 349l102 -204q-58 -179 -210 -290t-339 -111q-156 0 -288.5 77.5t-210 210t-77.5 288.5q0 181 104.5 330t274.5 211l17 -131q-122 -54 -195 -165.5t-73 -244.5q0 -185 131.5 -316.5t316.5 -131.5q126 0 232.5 65t165 175.5t49.5 236.5zM1571 249l58 -114l-256 -128 q-13 -7 -29 -7q-40 0 -57 35l-239 477h-472q-24 0 -42.5 16.5t-21.5 40.5l-96 779q-2 16 6 42q14 51 57 82.5t97 31.5q66 0 113 -47t47 -113q0 -69 -52 -117.5t-120 -41.5l37 -289h423v-128h-407l16 -128h455q40 0 57 -35l228 -455z" /> -<glyph unicode="" d="M1254 899q16 85 -21 132q-52 65 -187 45q-17 -3 -41 -12.5t-57.5 -30.5t-64.5 -48.5t-59.5 -70t-44.5 -91.5q80 7 113.5 -16t26.5 -99q-5 -52 -52 -143q-43 -78 -71 -99q-44 -32 -87 14q-23 24 -37.5 64.5t-19 73t-10 84t-8.5 71.5q-23 129 -34 164q-12 37 -35.5 69 t-50.5 40q-57 16 -127 -25q-54 -32 -136.5 -106t-122.5 -102v-7q16 -8 25.5 -26t21.5 -20q21 -3 54.5 8.5t58 10.5t41.5 -30q11 -18 18.5 -38.5t15 -48t12.5 -40.5q17 -46 53 -187q36 -146 57 -197q42 -99 103 -125q43 -12 85 -1.5t76 31.5q131 77 250 237 q104 139 172.5 292.5t82.5 226.5zM1536 1120v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" /> -<glyph unicode="" horiz-adv-x="1152" d="M1152 704q0 -191 -94.5 -353t-256.5 -256.5t-353 -94.5h-160q-14 0 -23 9t-9 23v611l-215 -66q-3 -1 -9 -1q-10 0 -19 6q-13 10 -13 26v128q0 23 23 31l233 71v93l-215 -66q-3 -1 -9 -1q-10 0 -19 6q-13 10 -13 26v128q0 23 23 31l233 71v250q0 14 9 23t23 9h160 q14 0 23 -9t9 -23v-181l375 116q15 5 28 -5t13 -26v-128q0 -23 -23 -31l-393 -121v-93l375 116q15 5 28 -5t13 -26v-128q0 -23 -23 -31l-393 -121v-487q188 13 318 151t130 328q0 14 9 23t23 9h160q14 0 23 -9t9 -23z" /> -<glyph unicode="" horiz-adv-x="1408" d="M1152 736v-64q0 -14 -9 -23t-23 -9h-352v-352q0 -14 -9 -23t-23 -9h-64q-14 0 -23 9t-9 23v352h-352q-14 0 -23 9t-9 23v64q0 14 9 23t23 9h352v352q0 14 9 23t23 9h64q14 0 23 -9t9 -23v-352h352q14 0 23 -9t9 -23zM1280 288v832q0 66 -47 113t-113 47h-832 q-66 0 -113 -47t-47 -113v-832q0 -66 47 -113t113 -47h832q66 0 113 47t47 113zM1408 1120v-832q0 -119 -84.5 -203.5t-203.5 -84.5h-832q-119 0 -203.5 84.5t-84.5 203.5v832q0 119 84.5 203.5t203.5 84.5h832q119 0 203.5 -84.5t84.5 -203.5z" /> -<glyph unicode="" horiz-adv-x="1792" /> -<glyph unicode="" horiz-adv-x="1792" /> -<glyph unicode="" horiz-adv-x="1792" /> -<glyph unicode="" horiz-adv-x="1792" /> -<glyph unicode="" horiz-adv-x="1792" /> -<glyph unicode="" horiz-adv-x="1792" /> -<glyph unicode="" horiz-adv-x="1792" /> -<glyph unicode="" horiz-adv-x="1792" /> -<glyph unicode="" horiz-adv-x="1792" /> -</font> -</defs></svg>
\ No newline at end of file diff --git a/user_guide_src/source/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.ttf b/user_guide_src/source/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.ttf Binary files differdeleted file mode 100644 index e89738de5..000000000 --- a/user_guide_src/source/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.ttf +++ /dev/null diff --git a/user_guide_src/source/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.woff b/user_guide_src/source/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.woff Binary files differdeleted file mode 100644 index 8c1748aab..000000000 --- a/user_guide_src/source/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.woff +++ /dev/null diff --git a/user_guide_src/source/_themes/sphinx_rtd_theme/static/images/ci-icon.ico b/user_guide_src/source/_themes/sphinx_rtd_theme/static/images/ci-icon.ico Binary files differdeleted file mode 100644 index c4246f8bf..000000000 --- a/user_guide_src/source/_themes/sphinx_rtd_theme/static/images/ci-icon.ico +++ /dev/null diff --git a/user_guide_src/source/_themes/sphinx_rtd_theme/static/js/oldtheme.js b/user_guide_src/source/_themes/sphinx_rtd_theme/static/js/oldtheme.js deleted file mode 100644 index 60520cc3a..000000000 --- a/user_guide_src/source/_themes/sphinx_rtd_theme/static/js/oldtheme.js +++ /dev/null @@ -1,47 +0,0 @@ -$( document ).ready(function() { - // Shift nav in mobile when clicking the menu. - $(document).on('click', "[data-toggle='wy-nav-top']", function() { - $("[data-toggle='wy-nav-shift']").toggleClass("shift"); - $("[data-toggle='rst-versions']").toggleClass("shift"); - }); - // Close menu when you click a link. - $(document).on('click', ".wy-menu-vertical .current ul li a", function() { - $("[data-toggle='wy-nav-shift']").removeClass("shift"); - $("[data-toggle='rst-versions']").toggleClass("shift"); - }); - $(document).on('click', "[data-toggle='rst-current-version']", function() { - $("[data-toggle='rst-versions']").toggleClass("shift-up"); - }); - // Make tables responsive - $("table.docutils:not(.field-list)").wrap("<div class='wy-table-responsive'></div>"); -}); - -window.SphinxRtdTheme = (function (jquery) { - var stickyNav = (function () { - var navBar, - win, - stickyNavCssClass = 'stickynav', - applyStickNav = function () { - if (navBar.height() <= win.height()) { - navBar.addClass(stickyNavCssClass); - } else { - navBar.removeClass(stickyNavCssClass); - } - }, - enable = function () { - applyStickNav(); - win.on('resize', applyStickNav); - }, - init = function () { - navBar = jquery('nav.wy-nav-side:first'); - win = jquery(window); - }; - jquery(init); - return { - enable : enable - }; - }()); - return { - StickyNav : stickyNav - }; -}($)); diff --git a/user_guide_src/source/_themes/sphinx_rtd_theme/static/js/theme.js b/user_guide_src/source/_themes/sphinx_rtd_theme/static/js/theme.js deleted file mode 100644 index 081d77bdf..000000000 --- a/user_guide_src/source/_themes/sphinx_rtd_theme/static/js/theme.js +++ /dev/null @@ -1,131 +0,0 @@ -$(document).ready(function () { - // Shift nav in mobile when clicking the menu. - $(document).on('click', "[data-toggle='wy-nav-top']", function () { - $("[data-toggle='wy-nav-shift']").toggleClass("shift"); - $("[data-toggle='rst-versions']").toggleClass("shift"); - }); - // Close menu when you click a link. - $(document).on('click', ".wy-menu-vertical .current ul li a", function () { - $("[data-toggle='wy-nav-shift']").removeClass("shift"); - $("[data-toggle='rst-versions']").toggleClass("shift"); - }); - $(document).on('click', "[data-toggle='rst-current-version']", function () { - $("[data-toggle='rst-versions']").toggleClass("shift-up"); - }); - // Make tables responsive - $("table.docutils:not(.field-list)").wrap("<div class='wy-table-responsive'></div>"); - // --- - // START DOC MODIFICATION BY RUFNEX - // v1.0 04.02.2015 - // Add ToogleButton to get FullWidth-View by Johannes Gamperl codeigniter.de - - $('#openToc').click(function () { - $('#nav').slideToggle(); - }); - $('#closeMe').toggle( - function () - { - setCookie('ciNav', 'yes', 365); - $('#nav2').show(); - $('#topMenu').remove(); - $('body').css({background: 'none'}); - $('.wy-nav-content-wrap').css({background: 'none', 'margin-left': 0}); - $('.wy-breadcrumbs').append('<div style="float:right;"><div style="float:left;" id="topMenu">' + $('.wy-form').parent().html() + '</div></div>'); - $('.wy-nav-side').toggle(); - }, - function () - { - setCookie('ciNav', 'no', 365); - $('#topMenu').remove(); - $('#nav').hide(); - $('#nav2').hide(); - $('body').css({background: '#edf0f2;'}); - $('.wy-nav-content-wrap').css({background: 'none repeat scroll 0 0 #fcfcfc;', 'margin-left': '300px'}); - $('.wy-nav-side').show(); - } - ); - if (getCookie('ciNav') == 'yes') - { - $('#closeMe').trigger('click'); - //$('#nav').slideToggle(); - } - // END MODIFICATION --- - -}); - -// Rufnex Cookie functions -function setCookie(cname, cvalue, exdays) { - // expire the old cookie if existed to avoid multiple cookies with the same name - if (getCookie(cname)) { - document.cookie = cname + "=;expires=Thu, 01 Jan 1970 00:00:00 GMT"; - } - var d = new Date(); - d.setTime(d.getTime() + (exdays * 24 * 60 * 60 * 1000)); - var expires = "expires=" + d.toGMTString(); - document.cookie = cname + "=" + cvalue + "; " + expires + "; path=/"; -} -function getCookie(cname) { - var name = cname + "="; - var ca = document.cookie.split(';'); - for (var i = 0; i < ca.length; i++) { - var c = ca[i]; - while (c.charAt(0) == ' ') - c = c.substring(1); - if (c.indexOf(name) == 0) { - return c.substring(name.length, c.length); - } - } - return ''; -} -// End - -// resize window -$(window).on('resize', function(){ - // show side nav on small screens when pulldown is enabled - if (getCookie('ciNav') == 'yes' && $(window).width() <= 768) { // 768px is the tablet size defined by the theme - $('.wy-nav-side').show(); - } - // changing css with jquery seems to override the default css media query - // change margin - else if (getCookie('ciNav') == 'no' && $(window).width() <= 768) { - $('.wy-nav-content-wrap').css({'margin-left': 0}); - } - // hide side nav on large screens when pulldown is enabled - else if (getCookie('ciNav') == 'yes' && $(window).width() > 768) { - $('.wy-nav-side').hide(); - } - // change margin - else if (getCookie('ciNav') == 'no' && $(window).width() > 768) { - $('.wy-nav-content-wrap').css({'margin-left': '300px'}); - } -}); - -window.SphinxRtdTheme = (function (jquery) { - var stickyNav = (function () { - var navBar, - win, - stickyNavCssClass = 'stickynav', - applyStickNav = function () { - if (navBar.height() <= win.height()) { - navBar.addClass(stickyNavCssClass); - } else { - navBar.removeClass(stickyNavCssClass); - } - }, - enable = function () { - applyStickNav(); - win.on('resize', applyStickNav); - }, - init = function () { - navBar = jquery('nav.wy-nav-side:first'); - win = jquery(window); - }; - jquery(init); - return { - enable: enable - }; - }()); - return { - StickyNav: stickyNav - }; -}($)); diff --git a/user_guide_src/source/_themes/sphinx_rtd_theme/theme.conf b/user_guide_src/source/_themes/sphinx_rtd_theme/theme.conf deleted file mode 100644 index 5814ac963..000000000 --- a/user_guide_src/source/_themes/sphinx_rtd_theme/theme.conf +++ /dev/null @@ -1,8 +0,0 @@ -[theme] -inherit = basic -stylesheet = css/citheme.css - -[options] -typekit_id = hiw1hhg -analytics_id = -sticky_navigation = False diff --git a/user_guide_src/source/_themes/sphinx_rtd_theme/versions.html b/user_guide_src/source/_themes/sphinx_rtd_theme/versions.html deleted file mode 100644 index 8b3eb79d2..000000000 --- a/user_guide_src/source/_themes/sphinx_rtd_theme/versions.html +++ /dev/null @@ -1,37 +0,0 @@ -{% if READTHEDOCS %} -{# Add rst-badge after rst-versions for small badge style. #} - <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> - <span class="rst-current-version" data-toggle="rst-current-version"> - <span class="fa fa-book"> Read the Docs</span> - v: {{ current_version }} - <span class="fa fa-caret-down"></span> - </span> - <div class="rst-other-versions"> - <dl> - <dt>Versions</dt> - {% for slug, url in versions %} - <dd><a href="{{ url }}">{{ slug }}</a></dd> - {% endfor %} - </dl> - <dl> - <dt>Downloads</dt> - {% for type, url in downloads %} - <dd><a href="{{ url }}">{{ type }}</a></dd> - {% endfor %} - </dl> - <dl> - <dt>On Read the Docs</dt> - <dd> - <a href="//{{ PRODUCTION_DOMAIN }}/projects/{{ slug }}/?fromdocs={{ slug }}">Project Home</a> - </dd> - <dd> - <a href="//{{ PRODUCTION_DOMAIN }}/builds/{{ slug }}/?fromdocs={{ slug }}">Builds</a> - </dd> - </dl> - <hr/> - Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>. - - </div> - </div> -{% endif %} - diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst deleted file mode 100644 index 371b49529..000000000 --- a/user_guide_src/source/changelog.rst +++ /dev/null @@ -1,3623 +0,0 @@ -########## -Change Log -########## - -Version 3.1.8 -============= - -Release Date: Mar 22, 2018 - -- **Security** - - - Updated :doc:`URL Helper <helpers/url_helper>` function :php:func:`auto_link()` to add ``rel="noopener"`` to generated links in order to prevent tab hijacking. - - Updated :doc:`Security Library <libraries/security>` method ``xss_clean()`` to also filter JavaScript tag functions. - - Fixed a bug where :doc:`Security Library <libraries/security>` method ``xss_clean()`` didn't check for parentheses around JavaScript's ``document``. - -- General Changes - - - Updated :doc:`Email Library <libraries/email>` to always negotiate between TLS 1.0, 1.1, 1.2 when possible (PHP 5.6+) for SMTP connections. - - Updated :doc:`Database Library <database/index>` method ``version()`` to exclude suffixes to the main version numbers with the 'postgre' driver. - -Bug fixes for 3.1.8 -------------------- - -- Fixed a bug where :doc:`Form Validation Library <libraries/form_validation>`, :doc:`Email Library <libraries/email>` tried to use ``INTL_IDNA_VARIANT_UTS46`` when it was undeclared. -- Fixed a bug where :doc:`Query Builder <database/query_builder>` methods ``where()``, ``having()`` treated values passed to them as arbitrary SQL. -- Fixed a bug (#5423) - :doc:`Database Library <database/index>` method ``insert_id()`` failed due to incorrect server version parsing with the 'postgre' driver. -- Fixed a bug (#5425) - :doc:`XML-RPC Library <libraries/xmlrpc>` produced an error message related to ``count()`` on PHP 7.2. -- Fixed a bug (#5434) - :doc:`Image Manipulation Library <libraries/image_lib>` attempted to ``chmod()`` while rendering images with the ``dynamic_output`` option. -- Fixed a bug (#5435) - :doc:`Database Results <database/results>` method ``field_data()`` hid info about one field if ``limit()`` was previously used with the 'oci8' driver. - -Version 3.1.7 -============= - -Release Date: Jan 13, 2018 - -- General Changes - - - Updated :doc:`Form Validation Library <libraries/form_validation>` rule ``valid_email`` to use ``INTL_IDNA_VARIANT_UTS46`` for non-ASCII domain names. - - Updated :doc:`Email Library <libraries/email>` to use ``INTL_IDNA_VARIANT_UTS46`` for non-ASCII domain names. - - Updated :doc:`Loader Library <libraries/loader>` method ``model()`` to log both ``CI_Model`` class loading and individual models' initialization. - - Updated :doc:`Pagination Library <libraries/pagination>` to preserve previously set attributes while calling ``initialize()``. - - Updated :doc:`Cache Library <libraries/caching>` to automatically add items to cache on ``increment()``, ``decrement()`` calls for missing keys. - - Deprecated usage of :doc:`CAPTCHA Helper <helpers/captcha_helper>` function :php:func:`create_captcha()` with parameters other than ``$data``. - -Bug fixes for 3.1.7 -------------------- - -- Fixed a regression (#5276) - :doc:`Database Utilities <database/utilities>` method ``backup()`` generated incorrect ``INSERT`` statements with the 'mysqli' driver. -- Fixed a regression where :doc:`Database Results <database/results>` method ``field_data()`` returned incorrect type names. -- Fixed a bug (#5278) - :doc:`URL Helper <helpers/url_helper>` function :php:func:`auto_link()` didn't detect trailing slashes in URLs. -- Fixed a regression (#5282) - :doc:`Query Builder <database/query_builder>` method ``count_all_results()`` breaks ``ORDER BY`` clauses for subsequent queries. -- Fixed a bug (#5279) - :doc:`Query Builder <database/query_builder>` didn't account for already escaped identifiers while applying database name prefixes. -- Fixed a bug (#5331) - :doc:`URL Helper <helpers/url_helper>` function :php:func:`auto_link()` converted e-mail addresses starting with 'www.' to both "url" and "email" links. -- Fixed a bug where ``$config['allow_get_array']`` defaulted to ``FALSE`` if it didn't exist in the config file. -- Fixed a bug (#5379) - :doc:`Session Library <libraries/sessions>` would incorrectly fail to obtain a lock that it already has on PHP 7 with the 'memcached' driver. - -Version 3.1.6 -============= - -Release Date: Sep 25, 2017 - -- **Security** - - - Fixed a potential object injection in :doc:`Cache Library <libraries/caching>` 'apc' driver when ``save()`` is used with ``$raw = TRUE`` (thanks to Tomas Bortoli). - -- General Changes - - - Deprecated :doc:`Cache Library Library <libraries/caching>` driver 'apc'. - - Updated the :doc:`Session Library <libraries/sessions>` 'redis', 'memcached' drivers to reduce the potential of a locking race conditions. - - -Bug fixes for 3.1.6 -------------------- - -- Fixed a bug (#5164) - :doc:`Loader Library <libraries/loader>` method ``library()`` ignored requests to load libraries previously assigned to super-object properties named differently than the library name. -- Fixed a bug (#5168) - :doc:`Query Builder <database/query_builder>` method ``count_all_results()`` produced erroneous queries on Microsoft SQL Server when ``ORDER BY`` clauses are cached. -- Fixed a bug (#5128) - :doc:`Profiler <general/profiling>` didn't wrap ``$_SESSION`` and configuration arrays in ``<pre>`` tags. -- Fixed a bug (#5183) - :doc:`Database Library <database/index>` method ``is_write_type()`` didn't return TRUE for ``MERGE`` statements. -- Fixed a bug where :doc:`Image Manipulation Library <libraries/image_lib>` didn't escape image source paths passed to NetPBM as shell arguments. -- Fixed a bug (#5236) - :doc:`Query Builder <database/query_builder>` methods ``limit()``, ``offset()`` break SQL Server 2005, 2008 queries with ``"<tablename>".*`` in the ``SELECT`` clause. -- Fixed a bug (#5243) - :doc:`Database Library <database/index>` method ``version()`` didn't work with the 'pdo/dblib' driver. -- Fixed a bug (#5246) - :doc:`Database transactions <database/transactions>` status wasn't reset unless ``trans_complete()`` was called. -- Fixed a bug (#5260) - :doc:`Database Utilities <database/utilities>` method ``backup()`` generated incorrect ``INSERT`` statements with the 'mysqli' driver. -- Fixed a bug where :doc:`Database Results <database/results>` method ``field_data()`` didn't parse field types with the 'mysqli' driver. - -Version 3.1.5 -============= - -Release Date: Jun 19, 2017 - -- **Security** - - - :doc:`Form Validation Library <libraries/form_validation>` rule ``valid_email`` could be bypassed if ``idn_to_ascii()`` is available. - -- General Changes - - - Updated :doc:`Form Helper <helpers/form_helper>` function :php:func:`form_label()` to accept HTML attributes as a string. - -Bug fixes for 3.1.5 -------------------- - -- Fixed a bug (#5070) - :doc:`Email Library <libraries/email>` didn't properly detect 7-bit encoding. -- Fixed a bug (#5084) - :doc:`XML-RPC Library <libraries/xmlrpc>` errored because of a variable name typo. -- Fixed a bug (#5108) - :doc:`Inflector Helper <helpers/inflector_helper>` function :php:func:`singular()` didn't properly handle 'quizzes'. -- Fixed a regression (#5131) - private controller methods triggered PHP errors instead of a 404 response. -- Fixed a bug (#5150) - :doc:`Database Forge <database/forge>` method ``modify_column()`` triggered an error while renaming columns with the 'oci8', 'pdo/oci' drivers. -- Fixed a bug (#5155) - :doc:`Query Builder <database/query_builder>` method ``count_all_results()`` returned incorrect result for queries using ``LIMIT``, ``OFFSET``. - -Version 3.1.4 -============= - -Release Date: Mar 20, 2017 - -- **Security** - - - Fixed a header injection vulnerability in :doc:`common function <general/common_functions>` :php:func:`set_status_header()` under Apache (thanks to Guillermo Caminer from `Flowgate <https://flowgate.net/>`_). - - Fixed byte-safety issues in :doc:`Encrypt Library <libraries/encrypt>` (DEPRECATED) when ``mbstring.func_overload`` is enabled. - - Fixed byte-safety issues in :doc:`Encryption Library <libraries/encryption>` when ``mbstring.func_overload`` is enabled. - - Fixed byte-safety issues in :doc:`compatibility functions <general/compatibility_functions>` ``password_hash()``, ``hash_pbkdf2()`` when ``mbstring.func_overload`` is enabled. - - Updated :doc:`Encrypt Library <libraries/encrypt>` (DEPRECATED) to call ``mcrypt_create_iv()`` with ``MCRYPT_DEV_URANDOM``. - -- General Changes - - - Updated the :doc:`Image Manipulation Library <libraries/image_lib>` to work-around an issue with some JPEGs when using GD. - -Bug fixes for 3.1.4 -------------------- - -- Fixed a regression (#4975) - :doc:`Loader Library <libraries/loader>` couldn't handle objects passed as view variables. -- Fixed a bug (#4977) - :doc:`Loader Library <libraries/loader>` method ``helper()`` could accept any character as a filename extension separator. -- Fixed a regression where the :doc:`Session Library <libraries/sessions>` would fail on a ``session_regenerate_id(TRUE)`` call with the 'database' driver. -- Fixed a bug (#4987) - :doc:`Query Builder <database/query_builder>` caching didn't keep track of table aliases. -- Fixed a bug where :doc:`Text Helper <helpers/text_helper>` function ``ascii_to_entities()`` wasn't byte-safe when ``mbstring.func_overload`` is enabled. -- Fixed a bug where ``CI_Log``, ``CI_Output``, ``CI_Email`` and ``CI_Zip`` didn't handle strings in a byte-safe manner when ``mbstring.func_overload`` is enabled. -- Fixed a bug where :doc:`Session Library <libraries/sessions>` didn't read session data in a byte-safe manner when ``mbstring.func_overload`` is enabled. -- Fixed a bug (#4990) - :doc:`Profiler <general/profiling>` didn't close ``<pre>`` tags it generated. -- Fixed a bug (#4990) - :doc:`Profiler <general/profiling>` didn't HTML-escape quotes for ``$_SESSION`` variables. -- Fixed a bug where :doc:`Input Library <libraries/input>` method ``set_cookie()`` didn't allow its *httponly* and *secure* parameters to be overriden to ``FALSE``. -- Fixed a bug (#5006) - :doc:`common function <general/common_functions>` :php:func:`get_mimes()` didn't load *application/config/mimes.php* if an environment specific config exists. -- Fixed a bug (#5006) - :doc:`common function <general/common_functions>` :php:func:`remove_invisible_characters()` didn't remove URL-encoded ``0x7F``. -- Fixed a bug (#4815) - :doc:`Database Library <database/index>` stripped URL-encoded sequences while escaping strings with the 'mssql' driver. -- Fixed a bug (#5044) - :doc:`HTML Helper <helpers/html_helper>` function :php:func:`img()` didn't accept ``data:`` URI schemes for the image source. -- Fixed a bug (#5050) - :doc:`Database Library <database/index>` tried to access an undefined property in a number of error handling cases. -- Fixed a bug (#5057) - :doc:`Database <database/index>` driver 'postgre' didn't actually apply extra options (such as 'connect_timeout') to its DSN. - -Version 3.1.3 -============= - -Release Date: Jan 09, 2017 - -- **Security** - - - Fixed an XSS vulnerability in :doc:`Security Library <libraries/security>` method ``xss_clean()``. - - Fixed a possible file inclusion vulnerability in :doc:`Loader Library <libraries/loader>` method ``vars()``. - - Fixed a possible remote code execution vulnerability in the :doc:`Email Library <libraries/email>` when 'mail' or 'sendmail' are used (thanks to Paul Buonopane from `NamePros <https://www.namepros.com/>`_). - - Added protection against timing side-channel attacks in :doc:`Security Library <libraries/security>` method ``csrf_verify()``. - - Added protection against BREACH attacks targeting the CSRF token field generated by :doc:`Form Helper <helpers/form_helper>` function :php:func:`form_open()`. - -- General Changes - - - Deprecated ``$config['allow_get_array']``. - - Deprecated ``$config['standardize_newlines']``. - - Deprecated :doc:`Date Helper <helpers/date_helper>` function :php:func:`nice_date()`. - -Bug fixes for 3.1.3 -------------------- - -- Fixed a bug (#4886) - :doc:`Database Library <database/index>` didn't differentiate bind markers inside double-quoted strings in queries. -- Fixed a bug (#4890) - :doc:`XML-RPC Library <libraries/xmlrpc>` didn't work on PHP 7. -- Fixed a regression (#4887) - :doc:`File Uploading Library <libraries/file_uploading>` triggered fatal errors due to numerous PHP distribution channels (XAMPP and cPanel confirmed) explicitly disabling ext/fileinfo by default. -- Fixed a bug (#4679) - :doc:`Input Library <libraries/input>` method ``ip_address()`` didn't properly resolve ``$config['proxy_ips']`` IPv6 addresses. -- Fixed a bug (#4902) - :doc:`Image Manipulation Library <libraries/image_lib>` processing via ImageMagick didn't work. -- Fixed a bug (#4905) - :doc:`Loader Library <libraries/loader>` didn't take into account possible user-provided directory paths when loading helpers. -- Fixed a bug (#4916) - :doc:`Session Library <libraries/sessions>` with ``sess_match_ip`` enabled was unusable for IPv6 clients when using the 'database' driver on MySQL 5.7.5+. -- Fixed a bug (#4917) - :doc:`Date Helper <helpers/date_helper>` function :php:func:`nice_date()` didn't handle YYYYMMDD inputs properly. -- Fixed a bug (#4923) - :doc:`Session Library <libraries/sessions>` could execute an erroneous SQL query with the 'database' driver, if the lock attempt times out. -- Fixed a bug (#4927) - :doc:`Output Library <libraries/output>` method ``get_header()`` returned the first matching header, regardless of whether it would be replaced by a second ``set_header()`` call. -- Fixed a bug (#4844) - :doc:`Email Library <libraries/email>` didn't apply ``escapeshellarg()`` to the while passing the Sendmail ``-f`` parameter through ``popen()``. -- Fixed a bug (#4928) - the bootstrap file didn't check if *config/constants.php* exists before trying to load it. -- Fixed a bug (#4937) - :doc:`Image Manipulation Library <libraries/image_lib>` method ``initialize()`` didn't translate *new_image* inputs to absolute paths. -- Fixed a bug (#4941) - :doc:`Query Builder <database/query_builder>` method ``order_by()`` didn't work with 'RANDOM' under the 'pdo/sqlite' driver. -- Fixed a regression (#4892) - :doc:`Query Builder <database/query_builder>` method ``update_batch()`` didn't properly handle identifier escaping. -- Fixed a bug (#4953) - :doc:`Database Forge <database/forge>` method ``create_table()`` didn't update an internal tables list cache if it exists but is empty. -- Fixed a bug (#4958) - :doc:`Query Builder <database/query_builder>` method ``count_all_results()`` didn't take into account cached ``ORDER BY`` clauses. -- Fixed a bug (#4804) - :doc:`Query Builder <database/query_builder>` method ``insert_batch()`` could fail if the input array pointer was modified. -- Fixed a bug (#4962) - :doc:`Database Force <database/forge>` method ``alter_table()`` would fail with the 'oci8' driver. -- Fixed a bug (#4457) - :doc:`Image Manipulation Library <libraries/image_lib>` method ``get_image_properties()`` didn't detect invalid images. -- Fixed a bug (#4765) - :doc:`Email Library <libraries/email>` didn't send the ``User-Agent`` header without a prior call to ``clear()``. - -Version 3.1.2 -============= - -Release Date: Oct 28, 2016 - -- **Security** - - - Fixed a number of new vulnerabilities in :doc:`Security Library <libraries/security>` method ``xss_clean()``. - -- General Changes - - - Allowed PHP 4-style constructors (``Matching_name::Matching_name()`` methods) to be used as routes, if there's a ``__construct()`` to override them. - -Bug fixes for 3.1.2 -------------------- - -- Fixed a regression (#4874) - :doc:`Session Library <libraries/sessions>` didn't take into account ``session.hash_bits_per_character`` when validating session IDs. -- Fixed a bug (#4871) - :doc:`Query Builder <database/query_builder>` method ``update_batch()`` didn't properly handle identifier escaping. -- Fixed a bug (#4884) - :doc:`Query Builder <database/query_builder>` didn't properly parse field names ending in 'is' when used inside WHERE and HAVING statements. -- Fixed a bug where ``CI_Log``, ``CI_Output``, ``CI_Email`` and ``CI_Zip`` didn't handle strings in a byte-safe manner when ``mbstring.func_overload`` is enabled. - -Version 3.1.1 -============= - -Release Date: Oct 22, 2016 - -- **Security** - - - Fixed a flaw in :doc:`Security Library <libraries/security>` method ``entity_decode()`` (used by ``xss_clean()``) that affects HTML 5 entities when using PHP 5.3. - -- General Changes - - - Added ``E_PARSE`` to the list of error levels detected by the shutdown handler. - - Updated :doc:`Inflector Helper <helpers/inflector_helper>` :php:func:`is_countable()` with more words. - - Updated :doc:`common function <general/common_functions>` :php:func:`set_status_header()` with new status codes from IETF RFCs - `2817 <https://tools.ietf.org/html/rfc2817>`_ (426) - and `6585 <https://tools.ietf.org/html/rfc6585>`_ (428, 429, 431, 511). - -Bug fixes for 3.1.1 -------------------- - -- Fixed a bug (#4732) - :doc:`Session Library <libraries/sessions>` triggered errors while writing data for a newly-created sessions with the 'memcached' driver. -- Fixed a regression (#4736) - :doc:`Image Manipulation Library <libraries/image_lib>` processing via ImageMagick didn't work. -- Fixed a bug (#4737) - :doc:`Query Builder <database/query_builder>` didn't add an ``OFFSET`` when ``LIMIT`` is zero or unused. -- Fixed a regression (#4739) - :doc:`Email Library <libraries/email>` doesn't properly separate attachment bodies from headers. -- Fixed a bug (#4754) - :doc:`Unit Testing Library <libraries/unit_testing>` method ``result()`` didn't translate ``res_datatype``. -- Fixed a bug (#4759) - :doc:`Form Validation <libraries/form_validation>`, :doc:`Trackback <libraries/trackback>` and :doc:`XML-RPC <libraries/xmlrpc>` libraries treated URI schemes in a case-sensitive manner. -- Fixed a bug (#4762) - :doc:`Cache Library <libraries/caching>` 'file' driver method ``get_metadata()`` checked TTL time against ``mtime`` instead of the cache item's creation time. -- Fixed a bug where :doc:`File Uploading Library <libraries/file_uploading>` generated error messages on PHP 7.1. -- Fixed a bug (#4780) - :doc:`compatibility function <general/compatibility_functions>` ``hex2bin()`` didn't reject inputs of type "resource". -- Fixed a bug (#4787) - :doc:`Form Validation Library <libraries/form_validation>` method ``valid_email()`` triggered ``E_WARNING`` when input emails have empty domain names. -- Fixed a bug (#4805) - :doc:`Database <database/index>` driver 'mysqli' didn't use the ``MYSQLI_CLIENT_SSL_DONT_VERIFY_SERVER_CERT`` flag properly. -- Fixed a bug (#4808) - :doc:`Database <database/index>` method ``is_write_type()`` only looked at the first line of a queries using ``RETURNING`` with the 'postgre', 'pdo/pgsql', 'odbc' and 'pdo/odbc' drivers. -- Fixed a bug where :doc:`Query Builder <database/query_builder>` method ``insert_batch()`` tried to execute an unsupported SQL query with the 'ibase' and 'pdo/firebird' drivers. -- Fixed a bug (#4809) - :doc:`Database <database/index>` driver 'pdo/mysql' didn't turn off ``AUTOCOMMIT`` when starting a transaction. -- Fixed a bug (#4822) - :doc:`CAPTCHA Helper <helpers/captcha_helper>` didn't clear expired PNG images. -- Fixed a bug (#4823) - :doc:`Session Library <libraries/sessions>` 'files' driver could enter an infinite loop if ``mbstring.func_overload`` is enabled. -- Fixed a bug (#4851) - :doc:`Database Forge <database/forge>` didn't quote schema names passed to its ``create_database()`` method. -- Fixed a bug (#4863) - :doc:`HTML Table Library <libraries/table>` method ``set_caption()`` was missing method chaining support. -- Fixed a bug (#4843) - :doc:`XML-RPC Library <libraries/xmlrpc>` client class didn't set a read/write socket timeout. -- Fixed a bug (#4865) - uncaught exceptions didn't set the HTTP Response status code to 500 unless ``display_errors`` was turned On. -- Fixed a bug (#4830) - :doc:`Session Library <libraries/sessions>` didn't take into account the new session INI settings in PHP 7.1. - -Version 3.1.0 -============= - -Release Date: July 26, 2016 - -- **Security** - - - Fixed an SQL injection in the 'odbc' database driver. - - Updated :php:func:`set_realpath()` :doc:`Path Helper <helpers/path_helper>` function to filter-out ``php://`` wrapper inputs. - - Officially dropped any kind of support for PHP 5.2.x and anything under 5.3.7. - -- General Changes - - - Updated :doc:`Image Manipulation Library <libraries/image_lib>` to validate *width* and *height* configuration values. - - Updated :doc:`Encryption Library <libraries/encryption>` to always prefer ``random_bytes()`` when it is available. - - Updated :doc:`Session Library <libraries/sessions>` to log 'debug' messages when using fallbacks to *session.save_path* (php.ini) or 'sess_use_database', 'sess_table_name' settings. - - Added a 'LONGTEXT' to 'STRING' alias to :doc:`Database Forge <database/forge>` for the 'cubrid', 'pdo/cubrid' drivers. - - Added 'TINYINT', 'MEDIUMINT', 'INT' and 'BIGINT' aliases to 'NUMBER' to :doc:`Database Forge <database/forge>` for the 'oci8', 'pdo/oci' drivers. - - - :php:func:`password_hash()` :doc:`compatibility function <general/compatibility_functions>` changes: - - - Changed salt-generation logic to prefer ``random_bytes()`` when it is available. - - Changed salt-generation logic to prefer direct access to */dev/urandom* over ``openssl_random_pseudo_bytes()``. - - Changed salt-generation logic to error if ``openssl_random_pseudo_bytes()`` sets its ``$crypto_strong`` flag to FALSE. - -Bug fixes for 3.1.0 -------------------- - -- Fixed a bug where :doc:`Image Manipulation Library <libraries/image_lib>` didn't escape image source paths passed to ImageMagick as shell arguments. -- Fixed a bug (#861) - :doc:`Database Forge <database/forge>` method ``create_table()`` incorrectly accepts field width constraints for MSSQL/SQLSRV integer-type columns. -- Fixed a bug (#4562) - :doc:`Cache Library <libraries/caching>` didn't check if ``Memcached::quit()`` is available before calling it. -- Fixed a bug (#4563) - :doc:`Input Library <libraries/input>` method ``request_headers()`` ignores ``$xss_clean`` parameter value after first call. -- Fixed a bug (#4605) - :doc:`Config Library <libraries/config>` method ``site_url()`` stripped trailing slashes from relative URIs passed to it. -- Fixed a bug (#4613) - :doc:`Email Library <libraries/config>` failed to send multiple emails via SMTP due to "already authenticated" errors when keep-alive is enabled. -- Fixed a bug (#4633) - :doc:`Form Validation Library <libraries/form_validation>` ignored multiple "callback" rules for empty, non-required fields. -- Fixed a bug (#4637) - :doc:`Database <database/index>` method ``error()`` returned ``FALSE`` with the 'oci8' driver if there was no error. -- Fixed a bug (#4647) - :doc:`Query Builder <database/query_builder>` method ``count_all_results()`` doesn't take into account ``GROUP BY`` clauses while deciding whether to do a subquery or not. -- Fixed a bug where :doc:`Session Library <libraries/sessions>` 'redis' driver didn't properly detect if a connection is properly closed on PHP 5.x. -- Fixed a bug (#4583) - :doc:`Email Library <libraries/email>` didn't properly handle inline attachments in HTML emails. -- Fixed a bug where :doc:`Database <database/index>` method ``db_select()`` didn't clear metadata cached for the previously used database. -- Fixed a bug (#4675) - :doc:`File Helper <helpers/file_helper>` function :php:func:`delete_files()` treated symbolic links as regular directories. -- Fixed a bug (#4674) - :doc:`Database <database/index>` driver 'dblib' triggered E_WARNING messages while connecting. -- Fixed a bug (#4678) - :doc:`Database Forge <database/forge>` tried to use unsupported ``IF NOT EXISTS`` clause when creating tables on Oracle. -- Fixed a bug (#4691) - :doc:`File Uploading Library <libraries/file_uploading>` method ``data()`` returns wrong 'raw_name' when the filename extension is also contained in the raw filename. -- Fixed a bug (#4679) - :doc:`Input Library <libraries/input>` method ``ip_address()`` errors with a matching ``$config['proxy_ips']`` IPv6 address. -- Fixed a bug (#4695) - :doc:`User Agent Library <libraries/user_agent>` didn't load the *config/user_agents.php* file when there's no ``User-Agent`` HTTP request header. -- Fixed a bug (#4713) - :doc:`Query Builder <database/query_builder>` methods ``insert_batch()``, ``update_batch()`` could return wrong affected rows count. -- Fixed a bug (#4712) - :doc:`Email Library <libraries/email>` doesn't sent ``RSET`` to SMTP servers after a failure and while using keep-alive. -- Fixed a bug (#4724) - :doc:`Common function <general/common_functions>` :php:func:`is_https()` compared the ``X-Forwarded-Proto`` HTTP header case-sensitively. -- Fixed a bug (#4725) - :doc:`Common function <general/common_functions>` :php:func:`remove_invisible_characters()` searched case-sensitively for URL-encoded characters. - -Version 3.0.6 -============= - -Release Date: March 21, 2016 - -- General Changes - - - Added a destructor to :doc:`Cache Library <libraries/caching>` 'memcached' driver to ensure that Memcache(d) connections are properly closed. - - Deprecated :doc:`Form Validation Library <libraries/form_validation>` method ``prep_for_form()``. - -Bug fixes for 3.0.6 -------------------- - -- Fixed a bug (#4516) - :doc:`Form Validation Library <libraries/form_validation>` always accepted empty array inputs. -- Fixed a bug where :doc:`Session Library <libraries/sessions>` allowed accessing ``$_SESSION`` values as class properties but ``isset()`` didn't work on them. -- Fixed a bug where :doc:`Form Validation Library <libraries/form_validation>` modified the ``$_POST`` array when the data being validated was actually provided via ``set_data()``. -- Fixed a bug (#4539) - :doc:`Migration Library <libraries/migration>` applied migrations before validating that all migrations within the requested version range are valid. -- Fixed a bug (#4539) - :doc:`Migration Library <libraries/migration>` triggered failures for migrations that are out of the requested version range. - -Version 3.0.5 -============= - -Release Date: March 11, 2016 - -- Core - - - Changed :doc:`Loader Library <libraries/loader>` to allow ``$autoload['drivers']`` assigning with custom property names. - - Changed :doc:`Loader Library <libraries/loader>` to ignore variables prefixed with '_ci_' when loading views. - -- General Changes - - - Updated the :doc:`Session Library <libraries/sessions>` to produce friendlier error messages on failures with drivers other than 'files'. - -- :doc:`Query Builder <database/query_builder>` - - - Added a ``$batch_size`` parameter to the ``insert_batch()`` method (defaults to 100). - - Added a ``$batch_size`` parameter to the ``update_batch()`` method (defaults to 100). - -Bug fixes for 3.0.5 -------------------- - -- Fixed a bug (#4391) - :doc:`Email Library <libraries/email>` method ``reply_to()`` didn't apply Q-encoding. -- Fixed a bug (#4384) - :doc:`Pagination Library <libraries/pagination>` ignored (possible) *cur_page* configuration value. -- Fixed a bug (#4395) - :doc:`Query Builder <database/query_builder>` method ``count_all_results()`` still fails if an ``ORDER BY`` condition is used. -- Fixed a bug (#4399) - :doc:`Query Builder <database/query_builder>` methods ``insert_batch()``, ``update_batch()`` produced confusing error messages when called with no data and *db_debug* is enabled. -- Fixed a bug (#4401) - :doc:`Query Builder <database/query_builder>` breaks ``WHERE`` and ``HAVING`` conditions that use ``IN()`` with strings containing a closing parenthesis. -- Fixed a regression in :doc:`Form Helper <helpers/form_helper>` functions :php:func:`set_checkbox()`, :php:func:`set_radio()` where "checked" inputs aren't recognized after a form submit. -- Fixed a bug (#4407) - :doc:`Text Helper <helpers/text_helper>` function :php:func:`word_censor()` doesn't work under PHP 7 if there's no custom replacement provided. -- Fixed a bug (#4415) - :doc:`Form Validation Library <libraries/form_validation>` rule **valid_url** didn't accept URLs with IPv6 addresses enclosed in square brackets under PHP 5 (upstream bug). -- Fixed a bug (#4427) - :doc:`CAPTCHA Helper <helpers/captcha_helper>` triggers an error if the provided character pool is too small. -- Fixed a bug (#4430) - :doc:`File Uploading Library <libraries/file_uploading>` option **file_ext_tolower** didn't work. -- Fixed a bug (#4431) - :doc:`Query Builder <database/query_builder>` method ``join()`` discarded opening parentheses. -- Fixed a bug (#4424) - :doc:`Session Library <libraries/sessions>` triggered a PHP warning when writing a newly created session with the 'redis' driver. -- Fixed a bug (#4437) - :doc:`Inflector Helper <helpers/inflector_helper>` function :php:func:`humanize()` didn't escape its ``$separator`` parameter while using it in a regular expression. -- Fixed a bug where :doc:`Session Library <libraries/sessions>` didn't properly handle its locks' statuses with the 'memcached' driver. -- Fixed a bug where :doc:`Session Library <libraries/sessions>` triggered a PHP warning when writing a newly created session with the 'memcached' driver. -- Fixed a bug (#4449) - :doc:`Query Builder <database/query_builder>` method ``join()`` breaks conditions containing ``IS NULL``, ``IS NOT NULL``. -- Fixed a bug (#4491) - :doc:`Session Library <libraries/sessions>` didn't clean-up internal variables for emulated locks with the 'redis' driver. -- Fixed a bug where :doc:`Session Library <libraries/sessions>` didn't clean-up internal variables for emulated locks with the 'memcached' driver. -- Fixed a bug where :doc:`Database <database/index>` transactions didn't work with the 'ibase' driver. -- Fixed a bug (#4475) - :doc:`Security Library <libraries/security>` method ``strip_image_tags()`` preserves only the first URL character from non-quoted *src* attributes. -- Fixed a bug where :doc:`Profiler Library <general/profiling>` didn't apply ``htmlspecialchars()`` to all displayed inputs. -- Fixed a bug (#4277) - :doc:`Cache Library <libraries/caching>` triggered fatal errors if accessing the Memcache(d) and/or Redis driver and they are not available on the system. -- Fixed a bug where :doc:`Cache Library <libraries/caching>` method ``is_supported()`` logged an error message when it returns ``FALSE`` for the APC and Wincache drivers. - -Version 3.0.4 -============= - -Release Date: January 13, 2016 - -- General Changes - - - Updated :doc:`Security Library <libraries/security>` method ``get_random_bytes()`` to use PHP 7's ``random_bytes()`` function when possible. - - Updated :doc:`Encryption Library <libraries/security>` method ``create_key()`` to use PHP 7's ``random_bytes()`` function when possible. - -- :doc:`Database <database/index>` - - - Added support for ``OFFSET-FETCH`` with Oracle 12c for the 'oci8' and 'pdo/oci' drivers. - - Added support for the new ``MYSQLI_CLIENT_SSL_DONT_VERIFY_SERVER_CERT`` constant from `PHP 5.6.16 <https://secure.php.net/ChangeLog-5.php#5.6.16>`_ for the 'mysqli' driver. - -Bug fixes for 3.0.4 -------------------- - -- Fixed a bug (#4212) - :doc:`Query Builder <database/query_builder>` method ``count_all_results()`` could fail if an ``ORDER BY`` condition is used. -- Fixed a bug where :doc:`Form Helper <helpers/form_helper>` functions :php:func:`set_checkbox()`, :php:func:`set_radio()` didn't "uncheck" inputs on a submitted form if the default state is "checked". -- Fixed a bug (#4217) - :doc:`Config Library <libraries/config>` method ``base_url()`` didn't use proper formatting for IPv6 when it falls back to ``$_SERVER['SERVER_ADDR']``. -- Fixed a bug where :doc:`CAPTCHA Helper <helpers/captcha_helper>` entered an infinite loop while generating a random string. -- Fixed a bug (#4223) - :doc:`Database <database/index>` method ``simple_query()`` blindly executes queries without checking if the connection was initialized properly. -- Fixed a bug (#4244) - :doc:`Email Library <libraries/email>` could improperly use "unsafe" US-ASCII characters during Quoted-printable encoding. -- Fixed a bug (#4245) - :doc:`Database Forge <database/forge>` couldn't properly handle ``SET`` and ``ENUM`` type fields with string values. -- Fixed a bug (#4283) - :doc:`String Helper <helpers/string_helper>` function :php:func:`alternator()` couldn't be called without arguments. -- Fixed a bug (#4306) - :doc:`Database <database/index>` method ``version()`` didn't work properly with the 'mssql' driver. -- Fixed a bug (#4039) - :doc:`Session Library <libraries/sessions>` could generate multiple (redundant) warnings in case of a read failure with the 'files' driver, due to a bug in PHP. -- Fixed a bug where :doc:`Session Library <libraries/sessions>` didn't have proper error handling on PHP 5 (due to a PHP bug). -- Fixed a bug (#4312) - :doc:`Form Validation Library <libraries/form_validation>` didn't provide error feedback for failed validation on empty requests. -- Fixed a bug where :doc:`Database <database/index>` method `version()` returned banner text instead of only the version number with the 'oci8' and 'pdo/oci' drivers. -- Fixed a bug (#4331) - :doc:`Database <database/index>` method ``error()`` didn't really work for connection errors with the 'mysqli' driver. -- Fixed a bug (#4343) - :doc:`Email Library <libraries/email>` failing with a *"More than one 'from' person"* message when using *sendmail*. -- Fixed a bug (#4350) - :doc:`Loader Library <libraries/loader>` method ``model()`` logic directly instantiated the ``CI_Model`` or ``MY_Model`` classes. -- Fixed a bug (#4337) - :doc:`Database <database/index>` method ``query()`` didn't return a result set for queries with the ``RETURNING`` statement on PostgreSQL. -- Fixed a bug (#4362) - :doc:`Session Library <libraries/sessions>` doesn't properly maintain its state after ID regeneration with the 'redis' and 'memcached' drivers on PHP 7. -- Fixed a bug (#4349) - :doc:`Database <database/index>` drivers 'mysql', 'mysqli', 'pdo/mysql' discard other ``sql_mode`` flags when "stricton" is enabled. -- Fixed a bug (#4349) - :doc:`Database <database/index>` drivers 'mysql', 'mysqli', 'pdo/mysql' don't turn off ``STRICT_TRANS_TABLES`` on MySQL 5.7+ when "stricton" is disabled. -- Fixed a bug (#4374) - :doc:`Session Library <libraries/sessions>` with the 'database' driver could be affected by userspace :doc:`Query Builder <database/query_builder>` conditions. - -Version 3.0.3 -============= - -Release Date: October 31, 2015 - -- **Security** - - - Fixed an XSS attack vector in :doc:`Security Library <libraries/security>` method ``xss_clean()``. - - Changed :doc:`Config Library <libraries/config>` method ``base_url()`` to fallback to ``$_SERVER['SERVER_ADDR']`` when ``$config['base_url']`` is empty in order to avoid *Host* header injections. - - Changed :doc:`CAPTCHA Helper <helpers/captcha_helper>` to use the operating system's PRNG when possible. - -- :doc:`Database <database/index>` - - - Optimized :doc:`Database Utility <database/utilities>` method ``csv_from_result()`` for speed with larger result sets. - - Added proper return values to :doc:`Database Transactions <database/transactions>` method ``trans_start()``. - -Bug fixes for 3.0.3 -------------------- - -- Fixed a bug (#4170) - :doc:`Database <database/index>` method ``insert_id()`` could return an identity from the wrong scope with the 'sqlsrv' driver. -- Fixed a bug (#4179) - :doc:`Session Library <libraries/sessions>` doesn't properly maintain its state after ID regeneration with the 'database' driver on PHP 7. -- Fixed a bug (#4173) - :doc:`Database Forge <database/forge>` method ``add_key()`` didn't allow creation of non-PRIMARY composite keys after the "bugfix" for #3968. -- Fixed a bug (#4171) - :doc:`Database Transactions <database/transactions>` didn't work with nesting in methods ``trans_begin()``, ``trans_commit()``, ``trans_rollback()``. -- Fixed a bug where :doc:`Database Transaction <database/transactions>` methods ``trans_begin()``, ``trans_commit()``, ``trans_rollback()`` ignored failures. -- Fixed a bug where all :doc:`Database Transaction <database/transactions>` methods returned TRUE while transactions are actually disabled. -- Fixed a bug where :doc:`common function <general/common_functions>` :php:func:`html_escape()` modified keys of its array inputs. -- Fixed a bug (#4192) - :doc:`Email Library <libraries/email>` wouldn't always have proper Quoted-printable encoding due to a bug in PHP's own ``mb_mime_encodeheader()`` function. - -Version 3.0.2 -============= - -Release Date: October 8, 2015 - -- **Security** - - - Fixed a number of XSS attack vectors in :doc:`Security Library <libraries/security>` method ``xss_clean()`` (thanks to Frans Rosén from `Detectify <https://detectify.com/>`_). - -- General Changes - - - Updated the *application/config/constants.php* file to check if constants aren't already defined before doing that. - - Changed :doc:`Loader Library <libraries/loader>` method ``model()`` to only apply ``ucfirst()`` and not ``strtolower()`` to the requested class name. - - Changed :doc:`Config Library <libraries/config>` methods ``base_url()``, ``site_url()`` to allow protocol-relative URLs by passing an empty string as the protocol. - -Bug fixes for 3.0.2 -------------------- - -- Fixed a bug (#2284) - :doc:`Database <database/index>` method ``protect_identifiers()`` breaks when :doc:`Query Builder <database/query_builder>` isn't enabled. -- Fixed a bug (#4052) - :doc:`Routing <general/routing>` with anonymous functions didn't work for routes that don't use regular expressions. -- Fixed a bug (#4056) - :doc:`Input Library <libraries/input>` method ``get_request_header()`` could not return a value unless ``request_headers()`` was called beforehand. -- Fixed a bug where the :doc:`Database Class <database/index>` entered an endless loop if it fails to connect with the 'sqlsrv' driver. -- Fixed a bug (#4065) - :doc:`Database <database/index>` method ``protect_identifiers()`` treats a traling space as an alias separator if the input doesn't contain ' AS '. -- Fixed a bug (#4066) - :doc:`Cache Library <libraries/caching>` couldn't fallback to a backup driver if the primary one is Memcache(d) or Redis. -- Fixed a bug (#4073) - :doc:`Email Library <libraries/email>` method ``send()`` could return TRUE in case of an actual failure when an SMTP command fails. -- Fixed a bug (#4086) - :doc:`Query Builder <database/query_builder>` didn't apply *dbprefix* to LIKE conditions if the pattern included spaces. -- Fixed a bug (#4091) - :doc:`Cache Library <libraries/caching>` 'file' driver could be tricked into accepting empty cache item IDs. -- Fixed a bug (#4093) - :doc:`Query Builder <database/query_builder>` modified string values containing 'AND', 'OR' while compiling WHERE conditions. -- Fixed a bug (#4096) - :doc:`Query Builder <database/query_builder>` didn't apply *dbprefix* when compiling BETWEEN conditions. -- Fixed a bug (#4105) - :doc:`Form Validation Library <libraries/form_validation>` didn't allow pipe characters inside "bracket parameters" when using a string ruleset. -- Fixed a bug (#4109) - :doc:`Routing <general/routing>` to *default_controller* didn't work when *enable_query_strings* is set to TRUE. -- Fixed a bug (#4044) - :doc:`Cache Library <libraries/caching>` 'redis' driver didn't catch ``RedisException`` that could be thrown during authentication. -- Fixed a bug (#4120) - :doc:`Database <database/index>` method ``error()`` didn't return error info when called after ``query()`` with the 'mssql' driver. -- Fixed a bug (#4116) - :doc:`Pagination Library <libraries/pagination>` set the wrong page number on the "data-ci-pagination-page" attribute in generated links. -- Fixed a bug where :doc:`Pagination Library <libraries/pagination>` added the 'rel="start"' attribute to the first displayed link even if it's not actually linking the first page. -- Fixed a bug (#4137) - :doc:`Error Handling <general/errors>` breaks for the new ``Error`` exceptions under PHP 7. -- Fixed a bug (#4126) - :doc:`Form Validation Library <libraries/form_validation>` method ``reset_validation()`` discarded validation rules from config files. - -Version 3.0.1 -============= - -Release Date: August 7, 2015 - -- Core - - - Added DoS mitigation to :php:func:`hash_pbkdf2()` :doc:`compatibility function <general/compatibility_functions>`. - -- Database - - - Added ``list_fields()`` support for SQLite ('sqlite3' and 'pdo_sqlite' drivers). - - Added SSL connection support for the 'mysqli' and 'pdo_mysql' drivers. - -- Libraries - - - :doc:`File Uploading Library <libraries/file_uploading>` changes: - - - Changed method ``set_error()`` to accept a custom log level (defaults to 'error'). - - Errors "no_file_selected", "file_partial", "stopped_by_extension", "no_file_types", "invalid_filetype", "bad_filename" are now logged at the 'debug' level. - - Errors "file_exceeds_limit", "file_exceeds_form_limit", "invalid_filesize", "invalid_dimensions" are now logged at the 'info' level. - - - Added 'is_resource' to the available expectations in :doc:`Unit Testing Library <libraries/unit_testing>`. - -- Helpers - - - Added Unicode support to :doc:`URL Helper <helpers/url_helper>` function :php:func:`url_title()`. - - Added support for passing the "extra" parameter as an array to all :doc:`Form Helper <helpers/form_helper>` functions that use it. - -- Core - - - Added support for defining a list of specific query parameters in ``$config['cache_query_string']`` for the :doc:`Output Library <libraries/output>`. - - Added class existence and inheritance checks to ``CI_Loader::model()`` in order to ease debugging in case of name collisions. - -Bug fixes for 3.0.1 -------------------- - -- Fixed a bug (#3733) - Autoloading of libraries with aliases didn't work, although it was advertised to. -- Fixed a bug (#3744) - Redis :doc:`Caching <libraries/caching>` driver didn't handle authentication failures properly. -- Fixed a bug (#3761) - :doc:`URL Helper <helpers/url_helper>` function :php:func:`anchor()` didn't work with array inputs. -- Fixed a bug (#3773) - ``db_select()`` didn't work for MySQL with the PDO :doc:`Database <database/index>` driver. -- Fixed a bug (#3771) - :doc:`Form Validation Library <libraries/form_validation>` was looking for a 'form_validation\_' prefix when trying to translate field name labels. -- Fixed a bug (#3787) - :doc:`FTP Library <libraries/ftp>` method ``delete_dir()`` failed when the target has subdirectories. -- Fixed a bug (#3801) - :doc:`Output Library <libraries/output>` method ``_display_cache()`` incorrectly looked for the last modified time of a directory instead of the cache file. -- Fixed a bug (#3816) - :doc:`Form Validation Library <libraries/form_validation>` treated empty string values as non-existing ones. -- Fixed a bug (#3823) - :doc:`Session Library <libraries/sessions>` drivers Redis and Memcached didn't properly handle locks that are blocking the request for more than 30 seconds. -- Fixed a bug (#3846) - :doc:`Image Manipulation Library <libraries/image_lib>` method `image_mirror_gd()` didn't properly initialize its variables. -- Fixed a bug (#3854) - `field_data()` didn't work properly with the Oracle (OCI8) database driver. -- Fixed a bug in the :doc:`Database Utility Class <database/utilities>` method ``csv_from_result()`` didn't work with a whitespace CSV delimiter. -- Fixed a bug (#3890) - :doc:`Input Library <libraries/input>` method ``get_request_header()`` treated header names as case-sensitive. -- Fixed a bug (#3903) - :doc:`Form Validation Library <libraries/form_validation>` ignored "unnamed" closure validation rules. -- Fixed a bug (#3904) - :doc:`Form Validation Library <libraries/form_validation>` ignored "named" callback rules when the field is empty and there's no 'required' rule. -- Fixed a bug (#3922) - :doc:`Email <libraries/email>` and :doc:`XML-RPC <libraries/xmlrpc>` libraries could enter an infinite loop due to `PHP bug #39598 <https://bugs.php.net/bug.php?id=39598>`_. -- Fixed a bug (#3913) - :doc:`Cache Library <libraries/caching>` didn't work with the direct ``$this->cache->$driver_name->method()`` syntax with Redis and Memcache(d). -- Fixed a bug (#3932) - :doc:`Query Builder <database/query_builder>` didn't properly compile WHERE and HAVING conditions for field names that end with "and", "or". -- Fixed a bug in :doc:`Query Builder <database/query_builder>` where ``delete()`` didn't properly work on multiple tables with a WHERE condition previously set via ``where()``. -- Fixed a bug (#3952) - :doc:`Database <database/index>` method ``list_fields()`` didn't work with SQLite3. -- Fixed a bug (#3955) - :doc:`Cache Library <libraries/caching>` methods ``increment()`` and ``decrement()`` ignored the 'key_prefix' setting. -- Fixed a bug (#3963) - :doc:`Unit Testing Library <libraries/unit_testing>` wrongly tried to translate filenames, line numbers and notes values in test results. -- Fixed a bug (#3965) - :doc:`File Uploading Library <libraries/file_uploading>` ignored the "encrypt_name" setting when "overwrite" is enabled. -- Fixed a bug (#3968) - :doc:`Database Forge <database/forge>` method ``add_key()`` didn't treat array inputs as composite keys unless it's a PRIMARY KEY. -- Fixed a bug (#3715) - :doc:`Pagination Library <libraries/pagination>` could generate broken link when a protocol-relative base URL is used. -- Fixed a bug (#3828) - :doc:`Output Library <libraries/output>` method ``delete_cache()`` couldn't delete index page caches. -- Fixed a bug (#3704) - :doc:`Database <database/index>` method ``stored_procedure()`` in the 'oci8' driver didn't properly bind parameters. -- Fixed a bug (#3778) - :doc:`Download Helper <helpers/download_helper>` function :php:func:`force_download()` incorrectly sent a *Pragma* response header. -- Fixed a bug (#3752) - ``$routing['directory']`` overrides were not properly handled and always resulted in a 404 "Not Found" error. -- Fixed a bug (#3279) - :doc:`Query Builder <database/query_builder>` methods ``update()`` and ``get_compiled_update()`` did double escaping on the table name if it was provided via ``from()``. -- Fixed a bug (#3991) - ``$config['rewrite_short_tags']`` never worked due to ``function_exists('eval')`` always returning FALSE. -- Fixed a bug where the :doc:`File Uploading Library <libraries/file_uploading>` library will not properly configure its maximum file size unless the input value is of type integer. -- Fixed a bug (#4000) - :doc:`Pagination Library <libraries/pagination>` didn't enable "rel" attributes by default if no attributes-related config options were used. -- Fixed a bug (#4004) - :doc:`URI Class <libraries/uri>` didn't properly parse the request URI if it contains a colon followed by a digit. -- Fixed a bug in :doc:`Query Builder <database/query_builder>` where the ``$escape`` parameter for some methods only affected field names. -- Fixed a bug (#4012) - :doc:`Query Builder <database/query_builder>` methods ``where_in()``, ``or_where_in()``, ``where_not_in()``, ``or_where_not_in()`` didn't take into account previously cached WHERE conditions when query cache is in use. -- Fixed a bug (#4015) - :doc:`Email Library <libraries/email>` method ``set_header()`` didn't support method chaining, although it was advertised. -- Fixed a bug (#4027) - :doc:`Routing <general/routing>` with HTTP verbs only worked if the route request method was declared in all-lowercase letters. -- Fixed a bug (#4026) - :doc:`Database Transactions <database/transactions>` always rollback if any previous ``query()`` call fails. -- Fixed a bug (#4023) - :doc:`String Helper <helpers/string_helper>` function ``increment_string()`` didn't escape its ``$separator`` parameter. - -Version 3.0.0 -============= - -Release Date: March 30, 2015 - -- License - - - CodeIgniter has been relicensed with the `MIT License <http://opensource.org/licenses/MIT>`_, eliminating its old proprietary licensing. - -- General Changes - - - PHP 5.1.6 is no longer supported. CodeIgniter now requires PHP 5.2.4 and recommends PHP 5.4+ or newer to be used. - - Changed filenaming convention (class file names now must be Ucfirst and everything else in lowercase). - - Changed the default database driver to 'mysqli' (the old 'mysql' driver is DEPRECATED). - - ``$_SERVER['CI_ENV']`` can now be set to control the ``ENVIRONMENT`` constant. - - Added an optional backtrace to php-error template. - - Added Android to the list of user agents. - - Added Windows 7, Windows 8, Windows 8.1, Android, Blackberry, iOS and PlayStation 3 to the list of user platforms. - - Added Fennec (Firefox for mobile) to the list of mobile user agents. - - Ability to log certain error types, not all under a threshold. - - Added support for pem, p10, p12, p7a, p7c, p7m, p7r, p7s, crt, crl, der, kdb, rsa, cer, sst, csr Certs to mimes.php. - - Added support for pgp, gpg, zsh and cdr files to mimes.php. - - Added support for 3gp, 3g2, mp4, wmv, f4v, vlc Video files to mimes.php. - - Added support for m4a, aac, m4u, xspf, au, ac3, flac, ogg, wma Audio files to mimes.php. - - Added support for kmz and kml (Google Earth) files to mimes.php. - - Added support for ics Calendar files to mimes.php. - - Added support for rar, jar and 7zip archives to mimes.php. - - Updated support for xml ('application/xml') and xsl ('application/xml', 'text/xsl') files in mimes.php. - - Updated support for doc files in mimes.php. - - Updated support for docx files in mimes.php. - - Updated support for php files in mimes.php. - - Updated support for zip files in mimes.php. - - Updated support for csv files in mimes.php. - - Added Romanian, Greek, Vietnamese and Cyrilic characters in *application/config/foreign_characters.php*. - - Changed logger to only chmod when file is first created. - - Removed previously deprecated SHA1 Library. - - Removed previously deprecated use of ``$autoload['core']`` in *application/config/autoload.php*. - 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. - - 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. - - 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. - - Path constants BASEPATH, APPPATH and VIEWPATH are now (internally) defined as absolute paths. - - Updated email validation methods to use ``filter_var()`` instead of PCRE. - - Changed environment defaults to report all errors in *development* and only fatal ones in *testing*, *production* but only display them in *development*. - - Updated *ip_address* database field lengths from 16 to 45 for supporting IPv6 address on :doc:`Trackback Library <libraries/trackback>` and :doc:`Captcha Helper <helpers/captcha_helper>`. - - Removed *cheatsheets* and *quick_reference* PDFs from the documentation. - - Added availability checks where usage of dangerous functions like ``eval()`` and ``exec()`` is required. - - Added support for changing the file extension of log files using ``$config['log_file_extension']``. - - Added support for turning newline standardization on/off via ``$config['standardize_newlines']`` and set it to FALSE by default. - - Added configuration setting ``$config['composer_autoload']`` to enable loading of a `Composer <https://getcomposer.org>`_ auto-loader. - - Removed the automatic conversion of 'programmatic characters' to HTML entities from the :doc:`URI Library <libraries/uri>`. - - Changed log messages that say a class or file was loaded to "info" level instead of "debug", so that they don't pollute log files when ``$config['log_threshold']`` is set to 2 (debug). - -- Helpers - - - :doc:`Date Helper <helpers/date_helper>` changes include: - - - Added an optional third parameter to :php:func:`timespan()` that constrains the number of time units displayed. - - Added an optional parameter to :php:func:`timezone_menu()` that allows more attributes to be added to the generated select tag. - - Added function :php:func:`date_range()` that generates a list of dates between a specified period. - - Deprecated ``standard_date()``, which now just uses the native ``date()`` with `DateTime constants <http://php.net/manual/en/class.datetime.php#datetime.constants.types>`_. - - Changed :php:func:`now()` to work with all timezone strings supported by PHP. - - Changed :php:func:`days_in_month()` to use the native ``cal_days_in_month()`` PHP function, if available. - - - :doc:`URL Helper <helpers/url_helper>` changes include: - - - Deprecated *separator* options **dash** and **underscore** for function :php:func:`url_title()` (they are only aliases for '-' and '_' respectively). - - :php:func:`url_title()` will now trim extra dashes from beginning and end. - - :php:func:`anchor_popup()` will now fill the *href* attribute with the URL and its JS code will return FALSE instead. - - Added JS window name support to the :php:func:`anchor_popup()` function. - - Added support for menubar attribute to the :php:func:`anchor_popup()`. - - Added support (auto-detection) for HTTP/1.1 response codes 303, 307 in :php:func:`redirect()`. - - Changed :php:func:`redirect()` to choose the **refresh** method only on IIS servers, instead of all servers on Windows (when **auto** is used). - - Changed :php:func:`anchor()`, :php:func:`anchor_popup()`, and :php:func:`redirect()` to support protocol-relative URLs (e.g. *//ellislab.com/codeigniter*). - - - :doc:`HTML Helper <helpers/html_helper>` changes include: - - - Added more doctypes. - - Changed application and environment config files to be loaded in a cascade-like manner. - - Changed :php:func:`doctype()` to cache and only load once the doctypes array. - - Deprecated functions ``nbs()`` and ``br()``, which are just aliases for the native ``str_repeat()`` with `` `` and ``<br />`` respectively. - - - :doc:`Inflector Helper <helpers/inflector_helper>` changes include: - - - Changed :php:func:`humanize()` to allow passing an input separator as its second parameter. - - Changed :php:func:`humanize()` and :php:func:`underscore()` to utilize `mbstring <http://php.net/mbstring>`_, if available. - - Changed :php:func:`plural()` and :php:func:`singular()` to avoid double pluralization and support more words. - - - :doc:`Download Helper <helpers/download_helper>` changes include: - - - Added an optional third parameter to :php:func:`force_download()` that enables/disables sending the actual file MIME type in the Content-Type header (disabled by default). - - Added a work-around in :php:func:`force_download()` for a bug Android <= 2.1, where the filename extension needs to be in uppercase. - - Added support for reading from an existing file path by passing NULL as the second parameter to :php:func:`force_download()` (useful for large files and/or safely transmitting binary data). - - - :doc:`Form Helper <helpers/form_helper>` changes include: - - - :php:func:`form_dropdown()` will now also take an array for unity with other form helpers. - - :php:func:`form_prep()` is now DEPRECATED and only acts as an alias for :doc:`common function <general/common_functions>` :php:func:`html_escape()`. - - :php:func:`set_value()` will now also accept a third argument, allowing to turn off HTML escaping of the value. - - - :doc:`Security Helper <helpers/security_helper>` changes include: - - - :php:func:`do_hash()` now uses PHP's native ``hash()`` function (supporting more algorithms) and is deprecated. - - :php:func:`strip_image_tags()` is now an alias for the same method in the :doc:`Security Library <libraries/security>`. - - - :doc:`Smiley Helper <helpers/smiley_helper>` changes include: - - - Deprecated the whole helper as too specific for CodeIgniter. - - Removed previously deprecated function ``js_insert_smiley()``. - - Changed application and environment config files to be loaded in a cascade-like manner. - - The smileys array is now cached and loaded only once. - - - :doc:`File Helper <helpers/file_helper>` changes include: - - - :php:func:`set_realpath()` can now also handle file paths as opposed to just directories. - - Added an optional paramater to :php:func:`delete_files()` to enable it to skip deleting files such as *.htaccess* and *index.html*. - - Deprecated function ``read_file()`` - it's just an alias for PHP's native ``file_get_contents()``. - - - :doc:`String Helper <helpers/string_helper>` changes include: - - - Deprecated function ``repeater()`` - it's just an alias for PHP's native ``str_repeat()``. - - Deprecated function ``trim_slashes()`` - it's just an alias for PHP's native ``trim()`` (with a slash as its second argument). - - Deprecated randomization type options **unique** and **encrypt** for funcion :php:func:`random_string()` (they are only aliases for **md5** and **sha1** respectively). - - - :doc:`CAPTCHA Helper <helpers/captcha_helper>` changes include: - - - Added *word_length* and *pool* options to allow customization of the generated word. - - Added *colors* configuration to allow customization for the *background*, *border*, *text* and *grid* colors. - - Added *filename* to the returned array elements. - - Updated to use `imagepng()` in case that `imagejpeg()` isn't available. - - Added **font_size** option to allow customization of font size. - - Added **img_id** option to set id attribute of captcha image. - - - :doc:`Text Helper <helpers/text_helper>` changes include: - - - Changed the default tag for use in :php:func:`highlight_phrase()` to ``<mark>`` (formerly ``<strong>``). - - Changed :php:func:`character_limiter()`, :php:func:`word_wrap()` and :php:func:`ellipsize()` to utilize `mbstring <http://php.net/mbstring>`_ or `iconv <http://php.net/iconv>`_, if available. - - - :doc:`Directory Helper <helpers/directory_helper>` :php:func:`directory_map()` will now append ``DIRECTORY_SEPARATOR`` to directory names in the returned array. - - :doc:`Array Helper <helpers/array_helper>` :php:func:`element()` and :php:func:`elements()` now return NULL instead of FALSE when the required elements don't exist. - - :doc:`Language Helper <helpers/language_helper>` :php:func:`lang()` now accepts an optional list of additional HTML attributes. - - Deprecated the :doc:`Email Helper <helpers/email_helper>` as its ``valid_email()``, ``send_email()`` functions are now only aliases for PHP native functions ``filter_var()`` and ``mail()`` respectively. - -- Database - - - DEPRECATED the 'mysql', 'sqlite', 'mssql' and 'pdo/dblib' (also known as 'pdo/mssql' or 'pdo/sybase') drivers. - - Added **dsn** configuration setting for drivers that support DSN strings (PDO, PostgreSQL, Oracle, ODBC, CUBRID). - - Added **schema** configuration setting (defaults to *public*) for drivers that might need it (currently used by PostgreSQL and ODBC). - - Added **save_queries** configuration setting to *application/config/database.php* (defaults to ``TRUE``). - - Removed **autoinit** configuration setting as it doesn't make sense to instantiate the database class but not connect to the database. - - Added subdrivers support (currently only used by PDO). - - Added an optional database name parameter to ``db_select()``. - - Removed ``protect_identifiers()`` and renamed internal method ``_protect_identifiers()`` to it instead - it was just an alias. - - Renamed internal method ``_escape_identifiers()`` to ``escape_identifiers()``. - - Updated ``escape_identifiers()`` to accept an array of fields as well as strings. - - MySQL and MySQLi drivers now require at least MySQL version 5.1. - - Added a ``$persistent`` parameter to ``db_connect()`` and changed ``db_pconnect()`` to be an alias for ``db_connect(TRUE)``. - - ``db_set_charset()`` now only requires one parameter (collation was only needed due to legacy support for MySQL versions prior to 5.1). - - ``db_select()`` will now always (if required by the driver) be called by ``db_connect()`` instead of only when initializing. - - Replaced the ``_error_message()`` and ``_error_number()`` methods with ``error()``, which returns an array containing the last database error code and message. - - Improved ``version()`` implementation so that drivers that have a native function to get the version number don't have to be defined in the core ``DB_driver`` class. - - Added capability for packages to hold *config/database.php* config files. - - Added MySQL client compression support. - - Added encrypted connections support (for *mysql*, *sqlsrv* and PDO with *sqlsrv*). - - Removed :doc:`Loader Class <libraries/loader>` from Database error tracing to better find the likely culprit. - - Added support for SQLite3 database driver. - - 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 support to binding arrays as ``IN()`` sets in ``query()``. - - - :doc:`Query Builder <database/query_builder>` changes include: - - - Renamed the Active Record class to Query Builder to remove confusion with the Active Record design pattern. - - Added the ability to insert objects with ``insert_batch()``. - - Added new methods that return the SQL string of queries without executing them: ``get_compiled_select()``, ``get_compiled_insert()``, ``get_compiled_update()``, ``get_compiled_delete()``. - - Added an optional parameter that allows to disable escaping (useful for custom fields) for methods ``join()``, ``order_by()``, ``where_in()``, ``or_where_in()``, ``where_not_in()``, ``or_where_not_in()``, ``insert()``, ``insert_batch()``. - - Added support for ``join()`` with multiple conditions. - - Added support for *USING* in ``join()``. - - Added support for *EXISTS* in ``where()``. - - Added seed values support for random ordering with ``order_by(seed, 'RANDOM')``. - - Changed ``limit()`` to ignore NULL values instead of always casting to integer. - - Changed ``offset()`` to ignore empty values instead of always casting to integer. - - Methods ``insert_batch()`` and ``update_batch()`` now return an integer representing the number of rows affected by them. - - Methods ``where()``, ``or_where()``, ``having()`` and ``or_having()`` now convert trailing ``=`` and ``<>``, ``!=`` SQL operators to ``IS NULL`` and ``IS NOT NULL`` respectively when the supplied comparison value is ``NULL``. - - Added method chaining support to ``reset_query()``, ``start_cache()``, ``stop_cache()`` and ``flush_cache()``. - - Added an optional second parameter to ``count_all_results()`` to disable resetting of QB values. - - - :doc:`Database Results <database/results>` changes include: - - - Added a constructor to the ``DB_result`` class and moved all driver-specific properties and logic out of the base ``DB_driver`` class to allow better abstraction. - - Added method ``unbuffered_row()`` for fetching a row without prefetching the whole result (consume less memory). - - Renamed former method ``_data_seek()`` to ``data_seek()`` and made it public. - - - Improved support for the MySQLi driver, including: - - - OOP style usage of the PHP extension is now used, instead of the procedural aliases. - - Server version checking is now done via ``mysqli::$server_info`` instead of running an SQL query. - - Added persistent connections support for PHP >= 5.3. - - Added support for configuring socket pipe connections. - - Added support for ``backup()`` in :doc:`Database Utilities <database/utilities>`. - - Changed methods ``trans_begin()``, ``trans_commit()`` and ``trans_rollback()`` to use the PHP API instead of sending queries. - - - Improved support of the PDO driver, including: - - - Added support for ``create_database()``, ``drop_database()`` and ``drop_table()`` in :doc:`Database Forge <database/forge>`. - - Added support for ``list_fields()`` in :doc:`Database Results <database/results>`. - - Subdrivers are now isolated from each other instead of being in one large class. - - - Improved support of the PostgreSQL driver, including: - - - ``pg_version()`` is now used to get the database version number, when possible. - - Added ``db_set_charset()`` support. - - Added support for ``optimize_table()`` in :doc:`Database Utilities <database/utilities>` (rebuilds table indexes). - - Added boolean data type support in ``escape()``. - - Added ``update_batch()`` support. - - Removed ``limit()`` and ``order_by()`` support for *UPDATE* and *DELETE* queries as PostgreSQL does not support those features. - - Added a work-around for dead persistent connections to be re-created after a database restart. - - Changed ``db_connect()`` to include the (new) **schema** value into Postgre's **search_path** session variable. - - ``pg_escape_literal()`` is now used for escaping strings, if available. - - - Improved support of the CUBRID driver, including: - - - Added DSN string support. - - Added persistent connections support. - - Improved ``list_databases()`` in :doc:`Database Utility <database/utilities>` (until now only the currently used database was returned). - - - Improved support of the MSSQL and SQLSRV drivers, including: - - - Added random ordering support. - - Added support for ``optimize_table()`` in :doc:`Database Utility <database/utilities>`. - - Added escaping with *QUOTE_IDENTIFIER* setting detection. - - Added port handling support for UNIX-based systems (MSSQL driver). - - Added *OFFSET* support for SQL Server 2005 and above. - - Added ``db_set_charset()`` support (MSSQL driver). - - Added a *scrollable* property to enable configuration of the cursor to use (SQLSRV driver). - - Added support and auto-detection for the ``SQLSRV_CURSOR_CLIENT_BUFFERED`` scrollable cursor flag (SQLSRV driver). - - Changed default behavior to not use ``SQLSRV_CURSOR_STATIC`` due to performance issues (SQLSRV driver). - - - Improved support of the Oracle (OCI8) driver, including: - - - Added DSN string support (Easy Connect and TNS). - - Added support for ``drop_table()`` in :doc:`Database Forge <database/forge>`. - - Added support for ``list_databases()`` in :doc:`Database Utilities <database/utilities>`. - - Generally improved for speed and cleaned up all of its components. - - ``num_rows()`` is now only called explicitly by the developer and no longer re-executes statements. - - - Improved support of the SQLite driver, including: - - - Added support for ``replace()`` in :doc:`Query Builder <database/query_builder>`. - - Added support for ``drop_table()`` in :doc:`Database Forge <database/forge>`. - - - :doc:`Database Forge <database/forge>` changes include: - - - Added an optional second parameter to ``drop_table()`` that allows adding the **IF EXISTS** condition, which is no longer the default. - - 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. - - - :doc:`Database Utility <database/utilities>` changes include: - - - Added support for passing a custom database object to the loader. - - Modified the class to no longer extend :doc:`Database Forge <database/forge>`, which has been a deprecated behavior for awhile. - - Overall improved support for all of the drivers. - - Added *foreign_key_checks* option to MySQL/MySQLi backup, allowing statement to disable/re-enable foreign key checks to be inserted into the backup output. - -- Libraries - - - Added a new :doc:`Encryption Library <libraries/encryption>` to replace the old, largely insecure :doc:`Encrypt Library <libraries/encrypt>`. - - - :doc:`Encrypt Library <libraries/encrypt>` changes include: - - - Deprecated the library in favor of the new :doc:`Encryption Library <libraries/encryption>`. - - Added support for hashing algorithms other than SHA1 and MD5. - - Removed previously deprecated ``sha1()`` method. - - - :doc:`Session Library <libraries/sessions>` changes include: - - - Completely re-written the library to use self-contained drivers via ``$config['sess_driver']``. - - Added 'files', 'database', 'redis' and 'memcached' drivers (using 'files' by default). - - Added ``$config['sess_save_path']`` setting to specify where the session data is stored, depending on the driver. - - Dropped support for storing session data in cookies (which renders ``$config['sess_encrypt_cookie']`` useless and is therefore also removed). - - Dropped official support for storing session data in databases other than MySQL and PostgreSQL. - - Changed table structure for the 'database' driver. - - Added a new **tempdata** feature that allows setting userdata items with expiration time (``mark_as_temp()``, ``tempdata()``, ``set_tempdata()``, ``unset_tempdata()``). - - Changed method ``keep_flashdata()`` to also accept an array of keys. - - Changed methods ``userdata()``, ``flashdata()`` to return an array of all userdata/flashdata when no parameter is passed. - - Deprecated method ``all_userdata()`` - it is now just an alias for ``userdata()`` with no parameters. - - Added method ``has_userdata()`` that verifies the existence of a userdata item. - - Added *debug* level log messages for key events in the session validation process. - - Dropped support for the *sess_match_useragent* option. - - - :doc:`File Uploading Library <libraries/file_uploading>` changes include: - - - Added method chaining support. - - Added support for using array notation in file field names. - - Added **max_filename_increment** and **file_ext_tolower** configuration settings. - - Added **min_width** and **min_height** configuration settings for images. - - Added **mod_mime_fix** configuration setting to disable suffixing multiple file extensions with an underscore. - - Added the possibility pass **allowed_types** as an array. - - Added an ``$index`` parameter to the method ``data()``. - - Added a ``$reset`` parameter to method ``initialize()``. - - Removed method ``clean_file_name()`` and its usage in favor of :doc:`Security Library <libraries/security>`'s ``sanitize_filename()``. - - Removed method ``mimes_types()``. - - Changed ``CI_Upload::_prep_filename()`` to simply replace all (but the last) dots in the filename with underscores, instead of suffixing them. - - - :doc:`Calendar Library <libraries/calendar>` changes include: - - - Added method chaining support. - - Added configuration to generate days of other months instead of blank cells. - - Added auto-configuration for *next_prev_url* if it is empty and *show_prev_next* is set to TRUE. - - Added support for templating via an array in addition to the encoded string. - - Changed method ``get_total_days()`` to be an alias for :doc:`Date Helper <helpers/date_helper>` :php:func:`days_in_month()`. - - - :doc:`Cart Library <libraries/cart>` changes include: - - - Deprecated the library as too specific for CodeIgniter. - - Added method ``remove()`` to remove a cart item, updating with quantity of 0 seemed like a hack but has remained to retain compatibility. - - Added method ``get_item()`` to enable retrieving data for a single cart item. - - Added unicode support for product names. - - Added support for disabling product name strictness via the ``$product_name_safe`` property. - - Changed ``insert()`` method to auto-increment quantity for an item when inserted twice instead of resetting it. - - Changed ``update()`` method to support updating all properties attached to an item and not to require 'qty'. - - - :doc:`Image Manipulation Library <libraries/image_lib>` changes include: - - - The ``initialize()`` method now only sets existing class properties. - - Added support for 3-length hex color values for *wm_font_color* and *wm_shadow_color* properties, as well as validation for them. - - Class properties *wm_font_color*, *wm_shadow_color* and *wm_use_drop_shadow* are now protected, to avoid breaking the ``text_watermark()`` method if they are set manually after initialization. - - If property *maintain_ratio* is set to TRUE, ``image_reproportion()`` now doesn't need both width and height to be specified. - - Property *maintain_ratio* is now taken into account when resizing images using ImageMagick library. - - Added support for maintaining transparency for PNG images when watermarking. - - Added a **file_permissions** setting. - - - :doc:`Form Validation Library <libraries/form_validation>` changes include: - - - Added method ``error_array()`` to return all error messages as an array. - - Added method ``set_data()`` to set an alternative data array to be validated instead of the default ``$_POST``. - - Added method ``reset_validation()`` which resets internal validation variables in case of multiple validation routines. - - Added support for setting error delimiters in the config file via ``$config['error_prefix']`` and ``$config['error_suffix']``. - - Internal method ``_execute()`` now considers input data to be invalid if a specified rule is not found. - - Removed method ``is_numeric()`` as it exists as a native PHP function and ``_execute()`` will find and use that (the **is_numeric** rule itself is deprecated since 1.6.1). - - Native PHP functions used as rules can now accept an additional parameter, other than the data itself. - - Updated method ``set_rules()`` to accept an array of rules as well as a string. - - Fields that have empty rules set no longer run through validation (and therefore are not considered erroneous). - - Added rule **differs** to check if the value of a field differs from the value of another field. - - Added rule **valid_url**. - - Added rule **in_list** to check if the value of a field is within a given list. - - Added support for named parameters in error messages. - - :doc:`Language <libraries/language>` line keys must now be prefixed with **form_validation_**. - - Added rule **alpha_numeric_spaces**. - - Added support for custom error messages per field rule. - - Added support for callable rules when they are passed as an array. - - Added support for non-ASCII domains in **valid_email** rule, depending on the Intl extension. - - Changed the debug message about an error message not being set to include the rule name it is about. - - - :doc:`Caching Library <libraries/caching>` changes include: - - - Added Wincache driver. - - Added Redis driver. - - Added a *key_prefix* option for cache IDs. - - Updated driver ``is_supported()`` methods to log at the "debug" level. - - Added option to store raw values instead of CI-formatted ones (APC, Memcache). - - Added atomic increment/decrement feature via ``increment()``, ``decrement()``. - - - :doc:`E-mail Library <libraries/email>` changes include: - - - Added a custom filename parameter to ``attach()`` as ``$this->email->attach($filename, $disposition, $newname)``. - - Added possibility to send attachment as buffer string in ``attach()`` as ``$this->email->attach($buffer, $disposition, $newname, $mime)``. - - Added possibility to attach remote files by passing a URL. - - Added method ``attachment_cid()`` to enable embedding inline attachments into HTML. - - Added dsn (delivery status notification) option. - - Renamed method ``_set_header()`` to ``set_header()`` and made it public to enable adding custom headers. - - Successfully sent emails will automatically clear the parameters. - - Added a *return_path* parameter to the ``from()`` method. - - Removed the second parameter (character limit) from internal method ``_prep_quoted_printable()`` as it is never used. - - Internal method ``_prep_quoted_printable()`` will now utilize the native ``quoted_printable_encode()``, ``imap_8bit()`` functions (if available) when CRLF is set to "\r\n". - - Default charset now relies on the global ``$config['charset']`` setting. - - Removed unused protected method ``_get_ip()`` (:doc:`Input Library <libraries/input>`'s ``ip_address()`` should be used anyway). - - Internal method ``_prep_q_encoding()`` now utilizes PHP's *mbstring* and *iconv* extensions (when available) and no longer has a second (``$from``) argument. - - Added an optional parameter to ``print_debugger()`` to allow specifying which parts of the message should be printed ('headers', 'subject', 'body'). - - Added SMTP keepalive option to avoid opening the connection for each ``send()`` call. Accessible as ``$smtp_keepalive``. - - Public method ``set_header()`` now filters the input by removing all "\\r" and "\\n" characters. - - Added support for non-ASCII domains in ``valid_email()``, depending on the Intl extension. - - - :doc:`Pagination Library <libraries/pagination>` changes include: - - - Deprecated usage of the "anchor_class" setting (use the new "attributes" setting instead). - - Added method chaining support to ``initialize()`` method. - - Added support for the anchor "rel" attribute. - - Added support for setting custom attributes. - - Added support for language translations of the *first_link*, *next_link*, *prev_link* and *last_link* values. - - Added support for ``$config['num_links'] = 0`` configuration. - - Added ``$config['reuse_query_string']`` to allow automatic repopulation of query string arguments, combined with normal URI segments. - - Added ``$config['use_global_url_suffix']`` to allow overriding the library 'suffix' value with that of the global ``$config['url_suffix']`` setting. - - Removed the default `` `` from a number of the configuration variables. - - - :doc:`Profiler Library <general/profiling>` changes include: - - - Database object names are now being displayed. - - The sum of all queries running times in seconds is now being displayed. - - Added support for displaying the HTTP DNT ("Do Not Track") header. - - Added support for displaying ``$_FILES``. - - - :doc:`Migration Library <libraries/migration>` changes include: - - - Added support for timestamp-based migrations (enabled by default). - - Added ``$config['migration_type']`` to allow switching between *sequential* and *timestamp* migrations. - - - :doc:`XML-RPC Library <libraries/xmlrpc>` changes include: - - - Added the ability to use a proxy. - - Added Basic HTTP authentication support. - - - :doc:`User Agent Library <libraries/user_agent>` changes include: - - - Added check to detect if robots are pretending to be mobile clients (helps with e.g. Google indexing mobile website versions). - - Added method ``parse()`` to allow parsing a custom user-agent string, different from the current visitor's. - - - :doc:`HTML Table Library <libraries/table>` changes include: - - - Added method chaining support. - - Added support for setting table class defaults in a config file. - - - :doc:`Zip Library <libraries/zip>` changes include: - - - Method ``read_file()`` can now also alter the original file path/name while adding files to an archive. - - Added support for changing the compression level. - - - :doc:`Trackback Library <libraries/trackback>` method ``receive()`` will now utilize ``iconv()`` if it is available but ``mb_convert_encoding()`` is not. - -- Core - - - :doc:`Routing <general/routing>` changes include: - - - Added support for multiple levels of controller directories. - - Added support for per-directory *default_controller* and *404_override* classes. - - Added possibility to route requests using HTTP verbs. - - Added possibility to route requests using callbacks. - - Added a new reserved route (*translate_uri_dashes*) to allow usage of dashes in the controller and method URI segments. - - Deprecated methods ``fetch_directory()``, ``fetch_class()`` and ``fetch_method()`` in favor of their respective public properties. - - Removed method ``_set_overrides()`` and moved its logic to the class constructor. - - - :doc:`URI Library <libraries/uri>` changes include: - - - Added conditional PCRE UTF-8 support to the "invalid URI characters" check and removed the ``preg_quote()`` call from it to allow more flexibility. - - Renamed method ``_filter_uri()`` to ``filter_uri()``. - - Changed method ``filter_uri()`` to accept by reference and removed its return value. - - Changed private methods to protected so that MY_URI can override them. - - Renamed internal method ``_parse_cli_args()`` to ``_parse_argv()``. - - Renamed internal method ``_detect_uri()`` to ``_parse_request_uri()``. - - Changed ``_parse_request_uri()`` to accept absolute URIs for compatibility with HTTP/1.1 as per `RFC2616 <http://www.ietf.org/rfc/rfc2616.txt>`. - - Added protected method ``_parse_query_string()`` to URI paths in the the **QUERY_STRING** value, like ``_parse_request_uri()`` does. - - Changed URI string detection logic to always default to **REQUEST_URI** unless configured otherwise or under CLI. - - Removed methods ``_remove_url_suffix()``, ``_explode_segments()`` and moved their logic into ``_set_uri_string()``. - - Removed method ``_fetch_uri_string()`` and moved its logic into the class constructor. - - Removed method ``_reindex_segments()``. - - - :doc:`Loader Library <libraries/loader>` changes include: - - - Added method chaining support. - - Added method ``get_vars()`` to the Loader to retrieve all variables loaded with ``$this->load->vars()``. - - ``_ci_autoloader()`` is now a protected method. - - Added autoloading of drivers with ``$autoload['drivers']``. - - ``$config['rewrite_short_tags']`` now has no effect when using PHP 5.4 as ``<?=`` will always be available. - - Changed method ``config()`` to return whatever ``CI_Config::load()`` returns instead of always being void. - - Added support for library and model aliasing on autoload. - - Changed method ``is_loaded()`` to ask for the (case sensitive) library name instead of its instance name. - - Removed ``$_base_classes`` property and unified all class data in ``$_ci_classes`` instead. - - Added method ``clear_vars()`` to allow clearing the cached variables for views. - - - :doc:`Input Library <libraries/input>` changes include: - - - Deprecated the ``$config['global_xss_filtering']`` setting. - - Added ``method()`` to retrieve ``$_SERVER['REQUEST_METHOD']``. - - Added support for arrays and network addresses (e.g. 192.168.1.1/24) for use with the *proxy_ips* setting. - - Added method ``input_stream()`` to aid in using **php://input** stream data such as one passed via PUT, DELETE and PATCH requests. - - Changed method ``valid_ip()`` to use PHP's native ``filter_var()`` function. - - Changed internal method ``_sanitize_globals()`` to skip enforcing reversal of *register_globals* in PHP 5.4+, where this functionality no longer exists. - - Changed methods ``get()``, ``post()``, ``get_post()``, ``cookie()``, ``server()``, ``user_agent()`` to return NULL instead of FALSE when no value is found. - - Changed default value of the ``$xss_clean`` parameter to NULL for all methods that utilize it, the default value is now determined by the ``$config['global_xss_filtering']`` setting. - - Added method ``post_get()`` and changed ``get_post()`` to search in GET data first. Both methods' names now properly match their GET/POST data search priorities. - - Changed method ``_fetch_from_array()`` to parse array notation in field name. - - Changed method ``_fetch_from_array()`` to allow retrieving multiple fields at once. - - Added an option for ``_clean_input_keys()`` to return FALSE instead of terminating the whole script. - - Deprecated the ``is_cli_request()`` method, it is now an alias for the new :php:func:`is_cli()` common function. - - Added an ``$xss_clean`` parameter to method ``user_agent()`` and removed the ``$user_agent`` property. - - Added property ``$raw_input_stream`` to access **php://input** data. - - - :doc:`Common functions <general/common_functions>` changes include: - - - Added function :php:func:`get_mimes()` to return the *application/config/mimes.php* array. - - Added support for HTTP code 303 ("See Other") in :php:func:`set_status_header()`. - - Removed redundant conditional to determine HTTP server protocol in :php:func:`set_status_header()`. - - 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 :php:func:`is_https()` to check if a secure connection is used. - - Added function :php:func:`is_cli()` to replace the ``CI_Input::is_cli_request()`` method. - - Added function :php:func:`function_usable()` to work around a bug in `Suhosin <http://www.hardened-php.net/suhosin/>`. - - Removed the third (`$php_error`) argument from function :php:func:`log_message()`. - - Changed internal function ``load_class()`` to accept a constructor parameter instead of (previously unused) class name prefix. - - Removed default parameter value of :php:func:`is_php()`. - - Added a second argument ``$double_encode`` to :php:func:`html_escape()`. - - Changed function :php:func:`config_item()` to return NULL instead of FALSE when no value is found. - - Changed function :php:func:`set_status_header()` to return immediately when run under CLI. - - - :doc:`Output Library <libraries/output>` changes include: - - - Added a second argument to method ``set_content_type()`` that allows setting the document charset as well. - - Added methods ``get_content_type()`` and ``get_header()``. - - Added method ``delete_cache()``. - - Added configuration option ``$config['cache_query_string']`` to enable taking the query string into account when caching. - - Changed caching behavior to compress the output before storing it, if ``$config['compress_output']`` is enabled. - - - :doc:`Config Library <libraries/config>` changes include: - - - Changed ``site_url()`` method to accept an array as well. - - 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: - - - Added ``$config['csrf_regeneration']``, which makes CSRF token regeneration optional. - - Added ``$config['csrf_exclude_uris']``, allowing for exclusion of URIs from the CSRF protection (regular expressions are supported). - - Added method ``strip_image_tags()``. - - Added method ``get_random_bytes()`` and switched CSRF & XSS token generation to use it. - - Modified method ``sanitize_filename()`` to read a public ``$filename_bad_chars`` property for getting the invalid characters list. - - Return status code of 403 instead of a 500 if CSRF protection is enabled but a token is missing from a request. - - - :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 overridden afterwards, if another one is found. - - - :doc:`Hooks Library <general/hooks>` changes include: - - - Added support for closure hooks (or anything that ``is_callable()`` returns TRUE for). - - Renamed method ``_call_hook()`` to ``call_hook()``. - - Class instances are now stored in order to maintain their state. - - - UTF-8 Library changes include: - - - ``UTF8_ENABLED`` now requires only one of `Multibyte String <http://php.net/mbstring>`_ or `iconv <http://php.net/iconv>`_ to be available instead of both. - - Changed method ``clean_string()`` to utilize ``mb_convert_encoding()`` if it is available. - - Renamed method ``_is_ascii()`` to ``is_ascii()`` and made it public. - - - Log Library changes include: - - - Added a ``$config['log_file_permissions']`` setting. - - Changed the library constructor to try to create the **log_path** directory if it doesn't exist. - - Added support for microseconds ("u" date format character) in ``$config['log_date_format']``. - - - Added :doc:`compatibility layers <general/compatibility_functions>` for: - - - `Multibyte String <http://php.net/mbstring>`_ (limited support). - - `Hash <http://php.net/hash>`_ (``hash_equals()``, ``hash_pbkdf2()``). - - `Password Hashing <http://php.net/password>`_. - - `Standard Functions ``array_column()``, ``array_replace()``, ``array_replace_recursive()``, ``hex2bin()``, ``quoted_printable_encode()``. - - - 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 ``_error_handler()``, so they can be logged. - - -Bug fixes for 3.0 ------------------ - -- Fixed a bug where ``unlink()`` raised an error if cache file did not exist when you try to delete it. -- Fixed a bug (#181) - a typo in the form validation language file. -- Fixed a bug (#159, #163) - :doc:`Query Builder <database/query_builder>` nested transactions didn't work properly due to ``$_trans_depth`` not being incremented. -- Fixed a bug (#737, #75) - :doc:`Pagination <libraries/pagination>` anchor class was not set properly when using initialize method. -- Fixed a bug (#419) - :doc:`URL Helper <helpers/url_helper>` :php:func:`auto_link()` didn't recognize URLs that come after a word boundary. -- Fixed a bug (#724) - :doc:`Form Validation Library <libraries/form_validation>` rule **is_unique** didn't check if a database connection exists. -- Fixed a bug (#647) - :doc:`Zip Library <libraries/zip>` internal method ``_get_mod_time()`` didn't suppress possible "stat failed" errors generated by ``filemtime()``. -- Fixed a bug (#157, #174) - :doc:`Image Manipulation Library <libraries/image_lib>` method ``clear()`` didn't completely clear properties. -- Fixed a bug where :doc:`Database Forge <database/forge>` method ``create_table()`` with PostgreSQL database could lead to fetching the whole table. -- Fixed a bug (#795) - :doc:`Form Helper <helpers/form_helper>` :php:func:`form_open()` didn't add the default form *method* and *accept-charset* when an empty array is passed to it. -- Fixed a bug (#797) - :doc:`Date Helper <helpers/date_helper>` :php:func:`timespan()` was using incorrect seconds for year and month. -- Fixed a bug in :doc:`Cart Library <libraries/cart>` method ``contents()`` where if called without a TRUE (or equal) parameter, it would fail due to a typo. -- Fixed a bug (#406) - SQLSRV DB driver not returning resource on ``db_pconnect()``. -- Fixed a bug in :doc:`Image Manipulation Library <libraries/image_lib>` method ``gd_loaded()`` where it was possible for the script execution to end or a PHP E_WARNING message to be emitted. -- Fixed a bug in the :doc:`Pagination library <libraries/pagination>` where when use_page_numbers=TRUE previous link and page 1 link did not have the same url. -- Fixed a bug (#561) - errors in :doc:`XML-RPC Library <libraries/xmlrpc>` were not properly escaped. -- Fixed a bug (#904) - :doc:`Loader Library <libraries/loader>` method ``initialize()`` caused a PHP Fatal error to be triggered if error level E_STRICT is used. -- Fixed a hosting edge case where an empty ``$_SERVER['HTTPS']`` variable would evaluate to 'on'. -- Fixed a bug (#154) - :doc:`Session Library <libraries/sessions>` method ``sess_update()`` caused the session to be destroyed on pages where multiple AJAX requests were executed at once. -- Fixed a possible bug in :doc:`Input Libary <libraries/input>` method ``is_ajax_request()`` where some clients might not send the X-Requested-With HTTP header value exactly as 'XmlHttpRequest'. -- Fixed a bug (#1039) - :doc:`Database Utilities <database/utilities>` internal method ``_backup()`` method failed for the 'mysql' driver due to a table name not being escaped. -- Fixed a bug (#1070) - ``CI_DB_driver::initialize()`` didn't set a character set if a database is not selected. -- Fixed a bug (#177) - :doc:`Form Validation Library <libraries/form_validation>` method ``set_value()`` didn't set the default value if POST data is NULL. -- Fixed a bug (#68, #414) - :Oracle's ``escape_str()`` didn't properly escape LIKE wild characters. -- Fixed a bug (#81) - ODBC's ``list_fields()`` and ``field_data()`` methods skipped the first column due to ``odbc_field_*()`` functions' index starting at 1 instead of 0. -- Fixed a bug (#129) - ODBC's ``num_rows()`` method returned -1 in some cases, due to not all subdrivers supporting the ``odbc_num_rows()`` function. -- Fixed a bug (#153) - E_NOTICE being generated by ``getimagesize()`` in the :doc:`File Uploading Library <libraries/file_uploading>`. -- Fixed a bug (#611) - SQLSRV's error handling methods used to issue warnings when there's no actual error. -- Fixed a bug (#1036) - ``is_write_type()`` method in the :doc:`Database Library <database/index>` didn't return TRUE for RENAME queries. -- Fixed a bug in PDO's ``_version()`` method where it used to return the client version as opposed to the server one. -- Fixed a bug in PDO's ``insert_id()`` method where it could've failed if it's used with Postgre versions prior to 8.1. -- Fixed a bug in CUBRID's ``affected_rows()`` method where a connection resource was passed to ``cubrid_affected_rows()`` instead of a result. -- Fixed a bug (#638) - ``db_set_charset()`` ignored its arguments and always used the configured charset instead. -- Fixed a bug (#413) - Oracle's error handling methods used to only return connection-related errors. -- Fixed a bug (#1101) - :doc:`Database Result <database/results>` method ``field_data()`` for 'mysql', 'mysqli' drivers was implemented as if it was handling a DESCRIBE result instead of the actual result set. -- Fixed a bug in Oracle's :doc:`Database Forge <database/forge>` method ``_create_table()`` where it failed with AUTO_INCREMENT as it's not supported. -- Fixed a bug (#1080) - when using the SMTP protocol, :doc:`Email Library <libraries/email>` method ``send()`` was returning TRUE even if the connection/authentication against the server failed. -- Fixed a bug (#306) - ODBC's ``insert_id()`` method was calling non-existent function ``odbc_insert_id()``, which resulted in a fatal error. -- Fixed a bug in Oracle's :doc:`Database Result <database/results>` implementation where the cursor ID passed to it was always NULL. -- Fixed a bug (#64) - Regular expression in *DB_query_builder.php* failed to handle queries containing SQL bracket delimiters in the JOIN condition. -- Fixed a bug in the :doc:`Session Library <libraries/sessions>` where a PHP E_NOTICE error was triggered by ``_unserialize()`` due to results from databases such as MSSQL and Oracle being space-padded on the right. -- Fixed a bug (#501) - :doc:`Form Validation Library <libraries/form_validation>` method ``set_rules()`` depended on ``count($_POST)`` instead of actually checking if the request method 'POST' before aborting. -- Fixed a bug (#136) - PostgreSQL and MySQL's ``escape_str()`` method didn't properly escape LIKE wild characters. -- Fixed a bug in :doc:`Loader Library <libraries/loader>` method ``library()`` where some PHP versions wouldn't execute the class constructor. -- Fixed a bug (#88) - An unexisting property was used for configuration of the Memcache cache driver. -- Fixed a bug (#14) - :doc:`Database Forge <database/forge>` method ``create_database()`` didn't utilize the configured database character set. -- Fixed a bug (#23, #1238) - :doc:`Database Caching <database/caching>` method ``delete_all()`` used to delete .htaccess and index.html files, which is a potential security risk. -- Fixed a bug in :doc:`Trackback Library <libraries/trackback>` method ``validate_url()`` where it didn't actually do anything, due to input not being passed by reference. -- Fixed a bug (#11, #183, #863) - :doc:`Form Validation Library <libraries/form_validation>` method ``_execute()`` silently continued to the next rule, if a rule method/function is not found. -- Fixed a bug (#122) - routed URI string was being reported incorrectly in sub-directories. -- Fixed a bug (#1241) - :doc:`Zip Library <libraries/zip>` method ``read_dir()`` wasn't compatible with Windows. -- Fixed a bug (#306) - ODBC driver didn't have an ``_insert_batch()`` method, which resulted in fatal error being triggered when ``insert_batch()`` is used with it. -- Fixed a bug in MSSQL and SQLSrv's ``_truncate()`` where the TABLE keyword was missing. -- Fixed a bug in PDO's ``trans_commit()`` method where it failed due to an erroneous property name. -- Fixed a bug (#798) - :doc:`Query Builder <database/query_builder>` method ``update()`` used to ignore LIKE conditions that were set with ``like()``. -- Fixed a bug in Oracle's and MSSQL's ``delete()`` methods where an erroneous SQL statement was generated when used with ``limit()``. -- Fixed a bug in SQLSRV's ``delete()`` method where ``like()`` and ``limit()`` conditions were ignored. -- Fixed a bug (#1265) - Database connections were always closed, regardless of the 'pconnect' option value. -- Fixed a bug (#128) - :doc:`Language Library <libraries/language>` did not correctly keep track of loaded language files. -- Fixed a bug (#1349) - :doc:`File Uploading Library <libraries/file_uploading>` method ``get_extension()`` returned the original filename when it didn't have an actual extension. -- Fixed a bug (#1273) - :doc:`Query Builder <database/query_builder>` method ``set_update_batch()`` generated an E_NOTICE message. -- Fixed a bug (#44, #110) - :doc:`File Uploading Library <libraries/file_uploading>` method ``clean_file_name()`` didn't clear '!' and '#' characters. -- Fixed a bug (#121) - :doc:`Database Results <database/results>` method ``row()`` returned an array when there's no actual result to be returned. -- Fixed a bug (#319) - SQLSRV's ``affected_rows()`` method failed due to a scrollable cursor being created for write-type queries. -- Fixed a bug (#356) - :doc:`Database <database/index>` driver 'postgre' didn't have an ``_update_batch()`` method, which resulted in fatal error being triggered when ``update_batch()`` is used with it. -- Fixed a bug (#784, #862) - :doc:`Database Forge <database/forge>` method ``create_table()`` failed on SQLSRV/MSSQL when used with 'IF NOT EXISTS'. -- Fixed a bug (#1419) - :doc:`Driver Library <general/creating_drivers>` had a static variable that was causing an error. -- Fixed a bug (#1411) - the :doc:`Email Library <libraries/email>` used its own short list of MIMEs instead the one from *config/mimes.php*. -- Fixed a bug where php.ini setting *magic_quotes_runtime* wasn't turned off for PHP 5.3 (where it is indeed deprecated, but not non-existent). -- Fixed a bug (#666) - :doc:`Output Library <libraries/output>` method ``set_content_type()`` didn't set the document charset. -- Fixed a bug (#784, #861) - :doc:`Database Forge <database/forge>` method ``create_table()`` used to accept constraints for MSSQL/SQLSRV integer-type columns. -- Fixed a bug (#706) - SQLSRV/MSSSQL :doc:`Database <database/index>` drivers didn't escape field names. -- Fixed a bug (#1452) - :doc:`Query Builder <database/query_builder>` method ``protect_identifiers()`` didn't properly detect identifiers with spaces in their names. -- Fixed a bug where :doc:`Query Builder <database/query_builder>` method ``protect_identifiers()`` ignored its extra arguments when the value passed to it is an array. -- Fixed a bug where :doc:`Query Builder <database/query_builder>` internal method ``_has_operator()`` didn't detect BETWEEN. -- Fixed a bug where :doc:`Query Builder <database/query_builder>` method ``join()`` failed with identifiers containing dashes. -- Fixed a bug (#1264) - :doc:`Database Forge <database/forge>` and :doc:`Database Utilities <database/utilities>` didn't update/reset the databases and tables list cache when a table or a database is created, dropped or renamed. -- Fixed a bug (#7) - :doc:`Query Builder <database/query_builder>` method ``join()`` only escaped one set of conditions. -- Fixed a bug (#1321) - ``CI_Exceptions`` couldn't find the *errors/* directory in some cases. -- Fixed a bug (#1202) - :doc:`Encrypt Library <libraries/encrypt>` ``encode_from_legacy()`` didn't set back the encrypt mode on failure. -- Fixed a bug (#145) - :doc:`Database Class <database/index>` method ``compile_binds()`` failed when the bind marker was present in a literal string within the query. -- Fixed a bug in :doc:`Query Builder <database/query_builder>` method ``protect_identifiers()`` where if passed along with the field names, operators got escaped as well. -- Fixed a bug (#10) - :doc:`URI Library <libraries/uri>` internal method ``_detect_uri()`` failed with paths containing a colon. -- Fixed a bug (#1387) - :doc:`Query Builder <database/query_builder>` method ``from()`` didn't escape table aliases. -- Fixed a bug (#520) - :doc:`Date Helper <helpers/date_helper>` function :php:func:``nice_date()`` failed when the optional second parameter is not passed. -- Fixed a bug (#318) - :doc:`Profiling Library <general/profiling>` setting *query_toggle_count* was not settable as described in the manual. -- Fixed a bug (#938) - :doc:`Config Library <libraries/config>` method ``site_url()`` added a question mark to the URL string when query strings are enabled even if it already existed. -- Fixed a bug (#999) - :doc:`Config Library <libraries/config>` method ``site_url()`` always appended ``$config['url_suffix']`` to the end of the URL string, regardless of whether a query string exists in it. -- Fixed a bug where :doc:`URL Helper <helpers/url_helper>` function :php:func:`anchor_popup()` ignored the attributes argument if it is not an array. -- Fixed a bug (#1328) - :doc:`Form Validation Library <libraries/form_validation>` didn't properly check the type of the form fields before processing them. -- Fixed a bug (#79) - :doc:`Form Validation Library <libraries/form_validation>` didn't properly validate array fields that use associative keys or have custom indexes. -- Fixed a bug (#427) - :doc:`Form Validation Library <libraries/form_validation>` method ``strip_image_tags()`` was an alias to a non-existent method. -- Fixed a bug (#1545) - :doc:`Query Builder <database/query_builder>` method ``limit()`` wasn't executed properly under Oracle. -- Fixed a bug (#1551) - :doc:`Date Helper <helpers/date_helper>` function :php:func:`standard_date()` didn't properly format *W3C* and *ATOM* standard dates. -- Fixed a bug where :doc:`Query Builder <database/query_builder>` method ``join()`` escaped literal values as if they were fields. -- Fixed a bug (#135) - PHP Error logging was impossible without the errors being displayed. -- Fixed a bug (#1613) - :doc:`Form Helper <helpers/form_helper>` functions :php:func:`form_multiselect()`, :php:func:`form_dropdown()` didn't properly handle empty array option groups. -- Fixed a bug (#1605) - :doc:`Pagination Library <libraries/pagination>` produced incorrect *previous* and *next* link values. -- Fixed a bug in SQLSRV's ``affected_rows()`` method where an erroneous function name was used. -- Fixed a bug (#1000) - Change syntax of ``$view_file`` to ``$_ci_view_file`` to prevent being overwritten by application. -- Fixed a bug (#1757) - :doc:`Directory Helper <helpers/directory_helper>` function :php:func:`directory_map()` was skipping files and directories named '0'. -- Fixed a bug (#1789) - :doc:`Database Library <database/index>` method ``escape_str()`` escaped quote characters in LIKE conditions twice under MySQL. -- Fixed a bug (#395) - :doc:`Unit Testing Library <libraries/unit_testing>` method ``result()`` didn't properly check array result columns when called from ``report()``. -- Fixed a bug (#1692) - :doc:`Database Class <database/index>` method ``display_error()`` didn't properly trace the possible error source on Windows systems. -- Fixed a bug (#1745) - :doc:`Database Class <database/index>` method ``is_write_type()`` didn't return TRUE for LOAD queries. -- Fixed a bug (#1765) - :doc:`Database Class <database/index>` didn't properly detect connection errors for the 'mysqli' driver. -- Fixed a bug (#1257) - :doc:`Query Builder <database/query_builder>` used to (unnecessarily) group FROM clause contents, which breaks certain queries and is invalid for some databases. -- Fixed a bug (#1709) - :doc:`Email <libraries/email>` headers were broken when using long email subjects and \r\n as CRLF. -- Fixed a bug where ``MB_ENABLED`` constant was only declared if ``UTF8_ENABLED`` was set to TRUE. -- Fixed a bug where the :doc:`Session Library <libraries/sessions>` accepted cookies with *last_activity* values being in the future. -- Fixed a bug (#1897) - :doc:`Email Library <libraries/email>` triggered PHP E_WARNING errors when *mail* protocol used and ``to()`` is never called. -- Fixed a bug (#1409) - :doc:`Email Library <libraries/email>` didn't properly handle multibyte characters when applying Q-encoding to headers. -- Fixed a bug where :doc:`Email Library <libraries/email>` ignored its *wordwrap* setting while handling alternative messages. -- Fixed a bug (#1476, #1909) - :doc:`Pagination Library <libraries/pagination>` didn't take into account actual routing when determining the current page. -- Fixed a bug (#1766) - :doc:`Query Builder <database/query_builder>` didn't always take into account the *dbprefix* setting. -- Fixed a bug (#779) - :doc:`URI Class <libraries/uri>` didn't always trim slashes from the *uri_string* as shown in the documentation. -- Fixed a bug (#134) - :doc:`Database Caching <database/caching>` method ``delete_cache()`` didn't work in some cases due to *cachedir* not being initialized properly. -- Fixed a bug (#191) - :doc:`Loader Library <libraries/loader>` ignored attempts for (re)loading databases to ``get_instance()->db`` even when the old database connection is dead. -- Fixed a bug (#1255) - :doc:`User Agent Library <libraries/user_agent>` method ``is_referral()`` only checked if ``$_SERVER['HTTP_REFERER']`` exists. -- Fixed a bug (#1146) - :doc:`Download Helper <helpers/download_helper>` function :php:func:`force_download()` incorrectly sent *Cache-Control* directives *pre-check* and *post-check* to Internet Explorer. -- Fixed a bug (#1811) - :doc:`URI Library <libraries/uri>` didn't properly cache segments for ``uri_to_assoc()`` and ``ruri_to_assoc()``. -- Fixed a bug (#1506) - :doc:`Form Helpers <helpers/form_helper>` set empty *name* attributes. -- Fixed a bug (#59) - :doc:`Query Builder <database/query_builder>` method ``count_all_results()`` ignored the DISTINCT clause. -- Fixed a bug (#1624) - :doc:`Form Validation Library <libraries/form_validation>` rule **matches** didn't property handle array field names. -- Fixed a bug (#1630) - :doc:`Form Helper <helpers/form_helper>` function :php:func:`set_value()` didn't escape HTML entities. -- Fixed a bug (#142) - :doc:`Form Helper <helpers/form_helper>` function :php:func:`form_dropdown()` didn't escape HTML entities in option values. -- Fixed a bug (#50) - :doc:`Session Library <libraries/sessions>` unnecessarily stripped slashed from serialized data, making it impossible to read objects in a namespace. -- Fixed a bug (#658) - :doc:`Routing <general/routing>` wildcard **:any** didn't work as advertised and matched multiple URI segments instead of all characters within a single segment. -- Fixed a bug (#1938) - :doc:`Email Library <libraries/email>` removed multiple spaces inside a pre-formatted plain text message. -- Fixed a bug (#122) - :doc:`URI Library <libraries/uri>` method ``ruri_string()`` didn't include a directory if one is used. -- Fixed a bug - :doc:`Routing Library <general/routing>` didn't properly handle *default_controller* in a subdirectory when a method is also specified. -- Fixed a bug (#953) - :doc:`post_controller_constructor hook <general/hooks>` wasn't called with a *404_override*. -- Fixed a bug (#1220) - :doc:`Profiler Library <general/profiling>` didn't display information for database objects that are instantiated inside models. -- Fixed a bug (#1978) - :doc:`Directory Helper <helpers/directory_helper>` function :php:func:`directory_map()`'s return array didn't make a distinction between directories and file indexes when a directory with a numeric name is present. -- Fixed a bug (#777) - :doc:`Loader Library <libraries/loader>` didn't look for helper extensions in added package paths. -- Fixed a bug (#18) - :doc:`APC Cache <libraries/caching>` driver didn't (un)serialize data, resulting in failure to store objects. -- Fixed a bug (#188) - :doc:`Unit Testing Library <libraries/unit_testing>` filled up logs with error messages for non-existing language keys. -- Fixed a bug (#113) - :doc:`Form Validation Library <libraries/form_validation>` didn't properly handle empty fields that were specified as an array. -- Fixed a bug (#2061) - :doc:`Routing Class <general/routing>` didn't properly sanitize directory, controller and function triggers with **enable_query_strings** set to TRUE. -- Fixed a bug - SQLSRV didn't support ``escape_like_str()`` or escaping an array of values. -- Fixed a bug - :doc:`Database Results <database/results>` method ``list_fields()`` didn't reset its field pointer for the 'mysql', 'mysqli' and 'mssql' drivers. -- Fixed a bug (#2211) - :doc:`Migration Library <libraries/migration>` extensions couldn't execute ``CI_Migration::__construct()``. -- Fixed a bug (#2255) - :doc:`Email Library <libraries/email>` didn't apply *smtp_timeout* to socket reads and writes. -- Fixed a bug (#2239) - :doc:`Email Library <libraries/email>` improperly handled the Subject when used with *bcc_batch_mode* resulting in E_WARNING messages and an empty Subject. -- Fixed a bug (#2234) - :doc:`Query Builder <database/query_builder>` didn't reset JOIN cache for write-type queries. -- Fixed a bug (#2298) - :doc:`Database Results <database/results>` method ``next_row()`` kept returning the last row, allowing for infinite loops. -- Fixed a bug (#2236, #2639) - :doc:`Form Helper <helpers/form_helper>` functions :php:func:`set_value()`, :php:func:`set_select()`, :php:func:`set_radio()`, :php:func:`set_checkbox()` didn't parse array notation for keys if the rule was not present in the :doc:`Form Validation Library <libraries/form_validation>`. -- Fixed a bug (#2353) - :doc:`Query Builder <database/query_builder>` erroneously prefixed literal strings with **dbprefix**. -- Fixed a bug (#78) - :doc:`Cart Library <libraries/cart>` didn't allow non-English letters in product names. -- Fixed a bug (#77) - :doc:`Database Class <database/index>` didn't properly handle the transaction "test mode" flag. -- Fixed a bug (#2380) - :doc:`URI Routing <general/routing>` method ``fetch_method()`` returned 'index' if the requested method name matches its controller name. -- Fixed a bug (#2388) - :doc:`Email Library <libraries/email>` used to ignore attachment errors, resulting in broken emails being sent. -- Fixed a bug (#2498) - :doc:`Form Validation Library <libraries/form_validation>` rule **valid_base64** only checked characters instead of actual validity. -- Fixed a bug (#2425) - OCI8 :doc:`database <database/index>` driver method ``stored_procedure()`` didn't log an error unless **db_debug** was set to TRUE. -- Fixed a bug (#2490) - :doc:`Database Class <database/queries>` method ``query()`` returning boolean instead of a result object for PostgreSQL-specific *INSERT INTO ... RETURNING* statements. -- Fixed a bug (#249) - :doc:`Cache Library <libraries/caching>` didn't properly handle Memcache(d) configurations with missing options. -- Fixed a bug (#180) - :php:func:`config_item()` didn't take into account run-time configuration changes. -- Fixed a bug (#2551) - :doc:`Loader Library <libraries/loader>` method ``library()`` didn't properly check if a class that is being loaded already exists. -- Fixed a bug (#2560) - :doc:`Form Helper <helpers/form_helper>` function :php:func:`form_open()` set the 'method="post"' attribute only if the passed attributes equaled an empty string. -- Fixed a bug (#2585) - :doc:`Query Builder <database/query_builder>` methods ``min()``, ``max()``, ``avg()``, ``sum()`` didn't escape field names. -- Fixed a bug (#2590) - :doc:`Common function <general/common_functions>` :php:func:`log_message()` didn't actually cache the ``CI_Log`` class instance. -- Fixed a bug (#2609) - :doc:`Common function <general/common_functions>` :php:func:`get_config()` optional argument was only effective on first function call. Also, it can now add items, in addition to updating existing items. -- Fixed a bug in the 'postgre' :doc:`database <database/index>` driver where the connection ID wasn't passed to ``pg_escape_string()``. -- Fixed a bug (#33) - Script execution was terminated when an invalid cookie key was encountered. -- Fixed a bug (#2691) - nested :doc:`database <database/index>` transactions could end in a deadlock when an error is encountered with *db_debug* set to TRUE. -- Fixed a bug (#2515) - ``_exception_handler()`` used to send the 200 "OK" HTTP status code and didn't stop script exection even on fatal errors. -- Fixed a bug - Redis :doc:`Caching <libraries/caching>` driver didn't handle connection failures properly. -- Fixed a bug (#2756) - :doc:`Database Class <database/index>` executed the MySQL-specific `SET SESSION sql_mode` query for all drivers when the 'stricton' option is set. -- Fixed a bug (#2579) - :doc:`Query Builder <database/query_builder>` "no escape" functionality didn't work properly with query cache. -- Fixed a bug (#2237) - :doc:`Parser Library <libraries/parser>` failed if the same tag pair is used more than once within a template. -- Fixed a bug (#2143) - :doc:`Form Validation Library <libraries/form_validation>` didn't check for rule groups named in a *controller/method* manner when trying to load from a config file. -- Fixed a bug (#2762) - :doc:`Hooks Class <general/hooks>` didn't properly check if the called class/function exists. -- Fixed a bug (#148) - :doc:`Input Library <libraries/input>` internal method ``_clean_input_data()`` assumed that it data is URL-encoded, stripping certain character sequences from it. -- Fixed a bug (#346) - with ``$config['global_xss_filtering']`` turned on, the ``$_GET``, ``$_POST``, ``$_COOKIE`` and ``$_SERVER`` superglobals were overwritten during initialization time, resulting in XSS filtering being either performed twice or there was no possible way to get the original data, even though options for this do exist. -- Fixed an edge case (#555) - :doc:`User Agent Library <libraries/user_agent>` reported an incorrect version Opera 10+ due to a non-standard user-agent string. -- Fixed a bug (#133) - :doc:`Text Helper <helpers/text_helper>` :php:func:`ascii_to_entities()` stripped the last character if it happens to be in the extended ASCII group. -- Fixed a bug (#2822) - ``fwrite()`` was used incorrectly throughout the whole framework, allowing incomplete writes when writing to a network stream and possibly a few other edge cases. -- Fixed a bug where :doc:`User Agent Library <libraries/user_agent>` methods ``accept_charset()`` and ``accept_lang()`` didn't properly parse HTTP headers that contain spaces. -- Fixed a bug where *default_controller* was called instad of triggering a 404 error if the current route is in a controller directory. -- Fixed a bug (#2737) - :doc:`XML-RPC Library <libraries/xmlrpc>` used objects as array keys, which triggered E_NOTICE messages. -- Fixed a bug (#2771) - :doc:`Security Library <libraries/security>` method ``xss_clean()`` didn't take into account HTML5 entities. -- Fixed a bug (#2856) - ODBC method ``affected_rows()`` passed an incorrect value to ``odbc_num_rows()``. -- Fixed a bug (#43) :doc:`Image Manipulation Library <libraries/image_lib>` method ``text_watermark()`` didn't properly determine watermark placement. -- Fixed a bug where :doc:`HTML Table Library <libraries/table>` ignored its *auto_heading* setting if headings were not already set. -- Fixed a bug (#2364) - :doc:`Pagination Library <libraries/pagination>` appended the query string (if used) multiple times when there are successive calls to ``create_links()`` with no ``initialize()`` in between them. -- 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/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. -- Fixed a bug (#3573) - :doc:`Email Library <libraries/email>` violated `RFC5321 <https://tools.ietf.org/rfc/rfc5321.txt>`_ by sending 'localhost.localdomain' as a hostname. -- Fixed a bug (#3572) - ``CI_Security::_remove_evil_attributes()`` failed for large-sized inputs due to *pcre.backtrack_limit* and didn't properly match HTML tags. - -Version 2.2.3 -============= - -Release Date: July 14, 2015 - -- Security - - - Removed a fallback to ``mysql_escape_string()`` in the 'mysql' database driver (``escape_str()`` method) when there's no active database connection. - -Version 2.2.2 -============= - -Release Date: April 15, 2015 - -- General Changes - - - Added HTTP "Host" header character validation to prevent cache poisoning attacks when *base_url* auto-detection is used. - - Added *FSCommand* and *seekSegmentTime* to the "evil attributes" list in ``CI_Security::xss_clean()``. - -Bug fixes for 2.2.2 -------------------- - -- Fixed a bug (#3665) - ``CI_Security::entity_decode()`` triggered warnings under some circumstances. - -Version 2.2.1 -============= - -Release Date: January 22, 2015 - -- General Changes - - - Improved security in ``xss_clean()``. - - Updated timezones in :doc:`Date Helper <helpers/date_helper>`. - -Bug fixes for 2.2.1 -------------------- - -- Fixed a bug (#3094) - Internal method ``CI_Input::_clean_input_data()`` breaks encrypted session cookies. -- Fixed a bug (#2268) - :doc:`Security Library <libraries/security>` method ``xss_clean()`` didn't properly match JavaScript events. -- Fixed a bug (#3309) - :doc:`Security Library <libraries/security>` method ``xss_clean()`` used an overly-invasive pattern to strip JS event handlers. -- Fixed a bug (#2771) - :doc:`Security Library <libraries/security>` method ``xss_clean()`` didn't take into account HTML5 entities. -- Fixed a bug (#73) - :doc:`Security Library <libraries/security>` method ``sanitize_filename()`` could be tricked by an XSS attack. -- Fixed a bug (#2681) - :doc:`Security Library <libraries/security>` method ``entity_decode()`` used the ``PREG_REPLACE_EVAL`` flag, which is deprecated since PHP 5.5. -- Fixed a bug (#3302) - Internal function ``get_config()`` triggered an E_NOTICE message on PHP 5.6. -- Fixed a bug (#2508) - :doc:`Config Library <libraries/config>` didn't properly detect if the current request is via HTTPS. -- Fixed a bug (#3314) - SQLSRV :doc:`Database driver <database/index>`'s method ``count_all()`` didn't escape the supplied table name. -- Fixed a bug (#3404) - MySQLi :doc:`Database driver <database/index>`'s method ``escape_str()`` had a wrong fallback to ``mysql_escape_string()`` when there was no active connection. -- Fixed a bug in the :doc:`Session Library <libraries/sessions>` where session ID regeneration occurred during AJAX requests. - -Version 2.2.0 -============= - -Release Date: June 2, 2014 - -- General Changes - - - Security: :doc:`Encrypt Library <libraries/encrypt>` method ``xor_encode()`` has been removed. The Encrypt Class now requires the Mcrypt extension to be installed. - - Security: The :doc:`Session Library <libraries/sessions>` now uses HMAC authentication instead of a simple MD5 checksum. - -Bug fixes for 2.2.0 -------------------- - -- Fixed an edge case (#2583) in the :doc:`Email Library <libraries/email>` where `Suhosin <http://www.hardened-php.net/suhosin/>` blocked messages sent via ``mail()`` due to trailing newspaces in headers. -- Fixed a bug (#696) - make ``oci_execute()`` calls inside ``num_rows()`` non-committing, since they are only there to reset which row is next in line for oci_fetch calls and thus don't need to be committed. -- Fixed a bug (#2689) - :doc:`Database Force <database/forge>` methods ``create_table()``, ``drop_table()`` and ``rename_table()`` produced broken SQL for tge 'sqlsrv' driver. -- Fixed a bug (#2427) - PDO :doc:`Database driver <database/index>` didn't properly check for query failures. -- Fixed a bug in the :doc:`Session Library <libraries/sessions>` where authentication was not performed for encrypted cookies. - -Version 2.1.4 -============= - -Release Date: July 8, 2013 - -- General Changes - - - Improved security in ``xss_clean()``. - -Bug fixes for 2.1.4 -------------------- - -- Fixed a bug (#1936) - :doc:`Migration Library <libraries/migration>` method ``latest()`` had a typo when retrieving language values. -- Fixed a bug (#2021) - :doc:`Migration Library <libraries/migration>` configuration file was mistakenly using Windows style line feeds. -- Fixed a bug (#1273) - ``E_NOTICE`` being generated by :doc:`Query Builder <database/query_builder>`'s ``set_update_batch()`` method. -- Fixed a bug (#2337) - :doc:`Email Library <libraries/email>` method ``print_debugger()`` didn't apply ``htmlspecialchars()`` to headers. - -Version 2.1.3 -============= - -Release Date: October 8, 2012 - -- Core - - - :doc:`Common function <general/common_functions>` ``is_loaded()`` now returns a reference. - -Bug fixes for 2.1.3 -------------------- - -- Fixed a bug (#1543) - File-based :doc:`Caching <libraries/caching>` method ``get_metadata()`` used a non-existent array key to look for the TTL value. -- Fixed a bug (#1314) - :doc:`Session Library <libraries/sessions>` method ``sess_destroy()`` didn't destroy the userdata array. -- Fixed a bug (#804) - :doc:`Profiler library <general/profiling>` was trying to handle objects as strings in some cases, resulting in *E_WARNING* messages being issued by ``htmlspecialchars()``. -- Fixed a bug (#1699) - :doc:`Migration Library <libraries/migration>` ignored the ``$config['migration_path']`` setting. -- Fixed a bug (#227) - :doc:`Input Library <libraries/input>` allowed unconditional spoofing of HTTP clients' IP addresses through the *HTTP_CLIENT_IP* header. -- Fixed a bug (#907) - :doc:`Input Library <libraries/input>` ignored *HTTP_X_CLUSTER_CLIENT_IP* and *HTTP_X_CLIENT_IP* headers when checking for proxies. -- Fixed a bug (#940) - ``csrf_verify()`` used to set the CSRF cookie while processing a POST request with no actual POST data, which resulted in validating a request that should be considered invalid. -- Fixed a bug (#499) - :doc:`Security Library <libraries/security>` where a CSRF cookie was created even if ``$config['csrf_protection']`` is set to FALSE. -- Fixed a bug (#1715) - :doc:`Input Library <libraries/input>` triggered ``csrf_verify()`` on CLI requests. -- Fixed a bug (#751) - :doc:`Query Builder <database/query_builder>` didn't properly handle cached field escaping overrides. -- Fixed a bug (#2004) - :doc:`Query Builder <database/query_builder>` didn't properly merge cached calls with non-cache ones. - -Version 2.1.2 -============= - -Release Date: June 29, 2012 - -- General Changes - - - Improved security in ``xss_clean()``. - -Version 2.1.1 -============= - -Release Date: June 12, 2012 - -- General Changes - - - Fixed support for docx, xlsx files in mimes.php. - -- Libraries - - - Further improved MIME type detection in the :doc:`File Uploading Library <libraries/file_uploading>`. - - Added support for IPv6 to the :doc:`Input Library <libraries/input>`. - - Added support for the IP format parameter to the :doc:`Form Validation Library <libraries/form_validation>`. - -- Helpers - - - ``url_title()`` performance and output improved. You can now use any string as the word delimiter, but 'dash' and 'underscore' are still supported. - -Bug fixes for 2.1.1 -------------------- - -- Fixed a bug (#697) - A wrong array key was used in the :doc:`File Uploading Library <libraries/file_uploading>` to check for mime-types. -- Fixed a bug - ``form_open()`` compared $action against ``site_url()`` instead of ``base_url()``. -- Fixed a bug - ``CI_Upload::_file_mime_type()`` could've failed if ``mime_content_type()`` is used for the detection and returns FALSE. -- Fixed a bug (#538) - Windows paths were ignored when using the :doc:`Image Manipulation Library <libraries/image_lib>` to create a new file. -- Fixed a bug - When database caching was enabled, $this->db->query() checked the cache before binding variables which resulted in cached queries never being found. -- Fixed a bug - CSRF cookie value was allowed to be any (non-empty) string before being written to the output, making code injection a risk. -- Fixed a bug (#726) - PDO put a 'dbname' argument in its connection string regardless of the database platform in use, which made it impossible to use SQLite. -- Fixed a bug - ``CI_DB_pdo_driver::num_rows()`` was not returning properly value with SELECT queries, cause it was relying on ``PDOStatement::rowCount()``. -- Fixed a bug (#1059) - ``CI_Image_lib::clear()`` was not correctly clearing all necessary object properties, namely width and height. - -Version 2.1.0 -============= - -Release Date: November 14, 2011 - -- General Changes - - - Callback validation rules can now accept parameters like any other - validation rule. - - Added html_escape() to :doc:`Common - functions <general/common_functions>` to escape HTML output - for preventing XSS. - -- Helpers - - - Added increment_string() to :doc:`String - Helper <helpers/string_helper>` to turn "foo" into "foo-1" - or "foo-1" into "foo-2". - - Altered form helper - made action on form_open_multipart helper - function call optional. Fixes (#65) - - url_title() will now trim extra dashes from beginning and end. - - Improved speed of :doc:`String Helper <helpers/string_helper>`'s random_string() method - -- Database - - - Added a `CUBRID <http://www.cubrid.org/>`_ driver to the :doc:`Database - Driver <database/index>`. Thanks to the CUBRID team for - supplying this patch. - - Added a PDO driver to the :doc:`Database Driver <database/index>`. - - Typecast limit and offset in the :doc:`Database - Driver <database/queries>` to integers to avoid possible - injection. - - Added additional option 'none' for the optional third argument for - $this->db->like() in the :doc:`Database - Driver <database/query_builder>`. - - Added $this->db->insert_batch() support to the OCI8 (Oracle) driver. - - Added failover if the main connections in the config should fail - -- Libraries - - - Changed ``$this->cart->insert()`` in the :doc:`Cart - Library <libraries/cart>` to return the Row ID if a single - item was inserted successfully. - - Added support to set an optional parameter in your callback rules - of validation using the :doc:`Form Validation - Library <libraries/form_validation>`. - - Added a :doc:`Migration library <libraries/migration>` to assist with applying - incremental updates to your database schema. - - Driver children can be located in any package path. - - Added max_filename_increment config setting for Upload library. - - Added ``is_unique`` to the :doc:`Form Validation library <libraries/form_validation>`. - - Added $config['use_page_numbers'] to the :doc:`Pagination library <libraries/pagination>`, which enables real page numbers in the URI. - - Added TLS and SSL Encryption for SMTP. - -- Core - - - Changed private functions in CI_URI to protected so MY_URI can - override them. - - Removed CI_CORE boolean constant from CodeIgniter.php (no longer Reactor and Core versions). - -Bug fixes for 2.1.0 -------------------- - -- Fixed #378 Robots identified as regular browsers by the User Agent - class. -- If a config class was loaded first then a library with the same name - is loaded, the config would be ignored. -- Fixed a bug (Reactor #19) where 1) the 404_override route was being - ignored in some cases, and 2) auto-loaded libraries were not - available to the 404_override controller when a controller existed - but the requested method did not. -- Fixed a bug (Reactor #89) where MySQL export would fail if the table - had hyphens or other non alphanumeric/underscore characters. -- Fixed a bug (#105) that stopped query errors from being logged unless database debugging was enabled -- Fixed a bug (#160) - Removed unneeded array copy in the file cache - driver. -- Fixed a bug (#150) - field_data() now correctly returns column - length. -- Fixed a bug (#8) - load_class() now looks for core classes in - APPPATH first, allowing them to be replaced. -- Fixed a bug (#24) - ODBC database driver called incorrect parent in __construct(). -- Fixed a bug (#85) - OCI8 (Oracle) database escape_str() function did not escape correct. -- Fixed a bug (#344) - Using schema found in :doc:`Saving Session Data to a Database <libraries/sessions>`, system would throw error "user_data does not have a default value" when deleting then creating a session. -- Fixed a bug (#112) - OCI8 (Oracle) driver didn't pass the configured database character set when connecting. -- Fixed a bug (#182) - OCI8 (Oracle) driver used to re-execute the statement whenever num_rows() is called. -- Fixed a bug (#82) - WHERE clause field names in the DB update_string() method were not escaped, resulting in failed queries in some cases. -- Fixed a bug (#89) - Fix a variable type mismatch in DB display_error() where an array is expected, but a string could be set instead. -- Fixed a bug (#467) - Suppress warnings generated from get_magic_quotes_gpc() (deprecated in PHP 5.4) -- Fixed a bug (#484) - First time _csrf_set_hash() is called, hash is never set to the cookie (in Security.php). -- Fixed a bug (#60) - Added _file_mime_type() method to the :doc:`File Uploading Library <libraries/file_uploading>` in order to fix a possible MIME-type injection. -- Fixed a bug (#537) - Support for all wav type in browser. -- Fixed a bug (#576) - Using ini_get() function to detect if apc is enabled or not. -- Fixed invalid date time format in :doc:`Date helper <helpers/date_helper>` and :doc:`XMLRPC library <libraries/xmlrpc>`. -- Fixed a bug (#200) - MySQL queries would be malformed after calling db->count_all() then db->get(). - -Version 2.0.3 -============= - -Release Date: August 20, 2011 - -- Security - - - An improvement was made to the MySQL and MySQLi drivers to prevent - exposing a potential vector for SQL injection on sites using - multi-byte character sets in the database client connection. - An incompatibility in PHP versions < 5.2.3 and MySQL < 5.0.7 with - *mysql_set_charset()* creates a situation where using multi-byte - character sets on these environments may potentially expose a SQL - injection attack vector. Latin-1, UTF-8, and other "low ASCII" - character sets are unaffected on all environments. - - If you are running or considering running a multi-byte character - set for your database connection, please pay close attention to - the server environment you are deploying on to ensure you are not - vulnerable. - -- General Changes - - - Fixed a bug where there was a misspelling within a code comment in - the index.php file. - - Added Session Class userdata to the output profiler. Additionally, - added a show/hide toggle on HTTP Headers, Session Data and Config - Variables. - - Removed internal usage of the EXT constant. - - Visual updates to the welcome_message view file and default error - templates. Thanks to `danijelb <https://bitbucket.org/danijelb>`_ - for the pull request. - - Added insert_batch() function to the PostgreSQL database driver. - Thanks to epallerols for the patch. - - Added "application/x-csv" to mimes.php. - - Fixed a bug where :doc:`Email library <libraries/email>` - attachments with a "." in the name would using invalid MIME-types. - -- Helpers - - - Added an optional third parameter to heading() which allows adding - html attributes to the rendered heading tag. - - form_open() now only adds a hidden (Cross-site Reference Forgery) - protection field when the form's action is internal and is set to - the post method. (Reactor #165) - - Re-worked plural() and singular() functions in the :doc:`Inflector - helper <helpers/inflector_helper>` to support considerably - more words. - -- Libraries - - - Altered Session to use a longer match against the user_agent - string. See upgrade notes if using database sessions. - - Added $this->db->set_dbprefix() to the :doc:`Database - Driver <database/queries>`. - - Changed $this->cart->insert() in the :doc:`Cart - Library <libraries/cart>` to return the Row ID if a single - item was inserted successfully. - - Added $this->load->get_var() to the :doc:`Loader - library <libraries/loader>` to retrieve global vars set with - $this->load->view() and $this->load->vars(). - - Changed $this->db->having() to insert quotes using escape() rather - than escape_str(). - -Bug fixes for 2.0.3 -------------------- - -- Added ENVIRONMENT to reserved constants. (Reactor #196) -- Changed server check to ensure SCRIPT_NAME is defined. (Reactor #57) -- Removed APPPATH.'third_party' from the packages autoloader to negate - needless file stats if no packages exist or if the developer does not - load any other packages by default. -- Fixed a bug (Reactor #231) where Sessions Library database table - example SQL did not contain an index on last_activity. See :doc:`Upgrade - Notes <installation/upgrade_203>`. -- Fixed a bug (Reactor #229) where the Sessions Library example SQL in - the documentation contained incorrect SQL. -- Fixed a bug (Core #340) where when passing in the second parameter to - $this->db->select(), column names in subsequent queries would not be - properly escaped. -- Fixed issue #199 - Attributes passed as string does not include a - space between it and the opening tag. -- Fixed a bug where the method $this->cart->total_items() from :doc:`Cart - Library <libraries/cart>` now returns the sum of the quantity - of all items in the cart instead of your total count. -- Fixed a bug where not setting 'null' when adding fields in db_forge - for mysql and mysqli drivers would default to NULL instead of NOT - NULL as the docs suggest. -- Fixed a bug where using $this->db->select_max(), - $this->db->select_min(), etc could throw notices. Thanks to w43l for - the patch. -- Replace checks for STDIN with php_sapi_name() == 'cli' which on the - whole is more reliable. This should get parameters in crontab - working. - -Version 2.0.2 -============= - -Release Date: April 7, 2011 -Hg Tag: v2.0.2 - -- General changes - - - The :doc:`Security library <./libraries/security>` was moved to - the core and is now loaded automatically. Please remove your - loading calls. - - The CI_SHA class is now deprecated. All supported versions of PHP - provide a sha1() function. - - constants.php will now be loaded from the environment folder if - available. - - Added language key error logging - - Made Environment Support optional. Comment out or delete the - constant to stop environment checks. - - Added Environment Support for Hooks. - - Added CI\_ Prefix to the :doc:`Cache driver <libraries/caching>`. - - Added :doc:`CLI usage <./general/cli>` documentation. - -- Helpers - - - Removed the previously deprecated dohash() from the :doc:`Security - helper <./helpers/security_helper>`; use do_hash() instead. - - Changed the 'plural' function so that it doesn't ruin the - captalization of your string. It also take into consideration - acronyms which are all caps. - -- Database - - - $this->db->count_all_results() will now return an integer - instead of a string. - -Bug fixes for 2.0.2 -------------------- - -- Fixed a bug (Reactor #145) where the Output Library had - parse_exec_vars set to protected. -- Fixed a bug (Reactor #80) where is_really_writable would create an - empty file when on Windows or with safe_mode enabled. -- Fixed various bugs with User Guide. -- Added is_cli_request() method to documentation for :doc:`Input - class <libraries/input>`. -- Added form_validation_lang entries for decimal, less_than and - greater_than. -- Fixed issue #153 Escape Str Bug in MSSQL driver. -- Fixed issue #172 Google Chrome 11 posts incorrectly when action is empty. - -Version 2.0.1 -============= - -Release Date: March 15, 2011 -Hg Tag: v2.0.1 - -- General changes - - - Added $config['cookie_secure'] to the config file to allow - requiring a secure (HTTPS) in order to set cookies. - - Added the constant CI_CORE to help differentiate between Core: - TRUE and Reactor: FALSE. - - Added an ENVIRONMENT constant in index.php, which affects PHP - error reporting settings, and optionally, which configuration - files are loaded (see below). Read more on the :doc:`Handling - Environments <general/environments>` page. - - Added support for - :ref:`environment-specific <config-environments>` - configuration files. - -- Libraries - - - Added decimal, less_than and greater_than rules to the :doc:`Form - validation Class <libraries/form_validation>`. - - :doc:`Input Class <libraries/input>` methods post() and get() - will now return a full array if the first argument is not - provided. - - Secure cookies can now be made with the set_cookie() helper and - :doc:`Input Class <libraries/input>` method. - - Added set_content_type() to :doc:`Output - Class <libraries/output>` to set the output Content-Type - HTTP header based on a MIME Type or a config/mimes.php array key. - - :doc:`Output Class <libraries/output>` will now support method - chaining. - -- Helpers - - - Changed the logic for form_open() in :doc:`Form - helper <helpers/form_helper>`. If no value is passed it will - submit to the current URL. - -Bug fixes for 2.0.1 -------------------- - -- CLI requests can now be run from any folder, not just when CD'ed next - to index.php. -- Fixed issue #41: Added audio/mp3 mime type to mp3. -- Fixed a bug (Core #329) where the file caching driver referenced the - incorrect cache directory. -- Fixed a bug (Reactor #69) where the SHA1 library was named - incorrectly. - -.. _2.0.0-changelog: - -Version 2.0.0 -============= - -Release Date: January 28, 2011 -Hg Tag: v2.0.0 - -- General changes - - - PHP 4 support is removed. CodeIgniter now requires PHP 5.1.6. - - Scaffolding, having been deprecated for a number of versions, has - been removed. - - Plugins have been removed, in favor of Helpers. The CAPTCHA plugin - has been converted to a Helper and - :doc:`documented <./helpers/captcha_helper>`. The JavaScript - calendar plugin was removed due to the ready availability of great - JavaScript calendars, particularly with jQuery. - - Added new special Library type: - :doc:`Drivers <./general/drivers>`. - - Added full query-string support. See the config file for details. - - Moved the application folder outside of the system folder. - - Moved system/cache and system/logs directories to the application - directory. - - Added routing overrides to the main index.php file, enabling the - normal routing to be overridden on a per "index" file basis. - - Added the ability to set config values (or override config values) - directly from data set in the main index.php file. This allows a - single application to be used with multiple front controllers, - each having its own config values. - - Added $config['directory_trigger'] to the config file so that a - controller sub-directory can be specified when running _GET - strings instead of URI segments. - - Added ability to set "Package" paths - specific paths where the - Loader and Config classes should try to look first for a requested - file. This allows distribution of sub-applications with their own - libraries, models, config files, etc. in a single "package" - directory. See the :doc:`Loader class <libraries/loader>` - documentation for more details. - - In-development code is now hosted at BitBucket . - - Removed the deprecated Validation Class. - - Added CI\_ Prefix to all core classes. - - Package paths can now be set in application/config/autoload.php. - - :doc:`Upload library <libraries/file_uploading>` file_name can - now be set without an extension, the extension will be taken from - the uploaded file instead of the given name. - - In :doc:`Database Forge <database/forge>` the name can be omitted - from $this->dbforge->modify_column()'s 2nd param if you aren't - changing the name. - - $config['base_url'] is now empty by default and will guess what - it should be. - - Enabled full Command Line Interface compatibility with - config['uri_protocol'] = 'CLI';. - -- Libraries - - - Added a :doc:`Cache driver <libraries/caching>` with APC, - memcached, and file-based support. - - Added $prefix, $suffix and $first_url properties to :doc:`Pagination - library <./libraries/pagination>`. - - Added the ability to suppress first, previous, next, last, and - page links by setting their values to FALSE in the :doc:`Pagination - library <./libraries/pagination>`. - - Added :doc:`Security library <./libraries/security>`, which now - contains the xss_clean function, filename_security function and - other security related functions. - - Added CSRF (Cross-site Reference Forgery) protection to the - :doc:`Security library <./libraries/security>`. - - Added $parse_exec_vars property to Output library. - - Added ability to enable / disable individual sections of the - :doc:`Profiler <general/profiling>` - - Added a wildcard option $config['allowed_types'] = '\*' to the - :doc:`File Uploading Class <./libraries/file_uploading>`. - - Added an 'object' config variable to the XML-RPC Server library so - that one can specify the object to look for requested methods, - instead of assuming it is in the $CI superobject. - - Added "is_object" into the list of unit tests capable of being - run. - - Table library will generate an empty cell with a blank string, or - NULL value. - - Added ability to set tag attributes for individual cells in the - Table library - - Added a parse_string() method to the :doc:`Parser - Class <libraries/parser>`. - - Added HTTP headers and Config information to the - :doc:`Profiler <general/profiling>` output. - - Added Chrome and Flock to the list of detectable browsers by - browser() in the :doc:`User Agent Class <libraries/user_agent>`. - - The :doc:`Unit Test Class <libraries/unit_testing>` now has an - optional "notes" field available to it, and allows for discrete - display of test result items using - $this->unit->set_test_items(). - - Added a $xss_clean class variable to the XMLRPC library, enabling - control over the use of the Security library's xss_clean() - method. - - Added a download() method to the :doc:`FTP - library <libraries/ftp>` - - Changed do_xss_clean() to return FALSE if the uploaded file - fails XSS checks. - - Added stripslashes() and trim()ing of double quotes from $_FILES - type value to standardize input in Upload library. - - Added a second parameter (boolean) to - $this->zip->read_dir('/path/to/directory', FALSE) to remove the - preceding trail of empty folders when creating a Zip archive. This - example would contain a zip with "directory" and all of its - contents. - - Added ability in the Image Library to handle PNG transparency for - resize operations when using the GD lib. - - Modified the Session class to prevent use if no encryption key is - set in the config file. - - Added a new config item to the Session class - sess_expire_on_close to allow sessions to auto-expire when the - browser window is closed. - - Improved performance of the Encryption library on servers where - Mcrypt is available. - - Changed the default encryption mode in the Encryption library to - CBC. - - Added an encode_from_legacy() method to provide a way to - transition encrypted data from CodeIgniter 1.x to CodeIgniter 2.x. - Please see the :doc:`upgrade - instructions <./installation/upgrade_200>` for details. - - Altered Form_Validation library to allow for method chaining on - set_rules(), set_message() and set_error_delimiters() - functions. - - Altered Email Library to allow for method chaining. - - Added request_headers(), get_request_header() and - is_ajax_request() to the input class. - - Altered :doc:`User agent library <libraries/user_agent>` so that - is_browser(), is_mobile() and is_robot() can optionally check - for a specific browser or mobile device. - - Altered :doc:`Input library <libraries/input>` so that post() and - get() will return all POST and GET items (respectively) if there - are no parameters passed in. - -- Database - - - :doc:`database configuration <./database/configuration>`. - - Added autoinit value to :doc:`database - configuration <./database/configuration>`. - - Added stricton value to :doc:`database - configuration <./database/configuration>`. - - Added database_exists() to the :doc:`Database Utilities - Class <database/utilities>`. - - Semantic change to db->version() function to allow a list of - exceptions for databases with functions to return version string - instead of specially formed SQL queries. Currently this list only - includes Oracle and SQLite. - - Fixed a bug where driver specific table identifier protection - could lead to malformed queries in the field_data() functions. - - Fixed a bug where an undefined class variable was referenced in - database drivers. - - Modified the database errors to show the filename and line number - of the problematic query. - - Removed the following deprecated functions: orwhere, orlike, - groupby, orhaving, orderby, getwhere. - - Removed deprecated _drop_database() and _create_database() - functions from the db utility drivers. - - Improved dbforge create_table() function for the Postgres driver. - -- Helpers - - - Added convert_accented_characters() function to :doc:`text - helper <./helpers/text_helper>`. - - Added accept-charset to the list of inserted attributes of - form_open() in the :doc:`Form Helper <helpers/form_helper>`. - - Deprecated the dohash() function in favour of do_hash() for - naming consistency. - - Non-backwards compatible change made to get_dir_file_info() in - the :doc:`File Helper <helpers/file_helper>`. No longer recurses - by default so as to encourage responsible use (this function can - cause server performance issues when used without caution). - - Modified the second parameter of directory_map() in the - :doc:`Directory Helper <helpers/directory_helper>` to accept an - integer to specify recursion depth. - - Modified delete_files() in the :doc:`File - Helper <helpers/file_helper>` to return FALSE on failure. - - Added an optional second parameter to byte_format() in the - :doc:`Number Helper <helpers/number_helper>` to allow for decimal - precision. - - Added alpha, and sha1 string types to random_string() in the - :doc:`String Helper <helpers/string_helper>`. - - Modified prep_url() so as to not prepend \http:// if the supplied - string already has a scheme. - - Modified get_file_info in the file helper, changing filectime() - to filemtime() for dates. - - Modified smiley_js() to add optional third parameter to return - only the javascript with no script tags. - - The img() function of the :doc:`HTML - helper <./helpers/html_helper>` will now generate an empty - string as an alt attribute if one is not provided. - - If CSRF is enabled in the application config file, form_open() - will automatically insert it as a hidden field. - - Added sanitize_filename() into the :doc:`Security - helper <./helpers/security_helper>`. - - Added ellipsize() to the :doc:`Text - Helper <./helpers/text_helper>` - - Added elements() to the :doc:`Array - Helper <./helpers/array_helper>` - -- Other Changes - - - Added an optional second parameter to show_404() to disable - logging. - - Updated loader to automatically apply the sub-class prefix as an - option when loading classes. Class names can be prefixed with the - standard "CI\_" or the same prefix as the subclass prefix, or no - prefix at all. - - Increased randomness with is_really_writable() to avoid file - collisions when hundreds or thousands of requests occur at once. - - Switched some DIR_WRITE_MODE constant uses to FILE_WRITE_MODE - where files and not directories are being operated on. - - get_mime_by_extension() is now case insensitive. - - Added "default" to the list :doc:`Reserved - Names <general/reserved_names>`. - - Added 'application/x-msdownload' for .exe files and - 'application/x-gzip-compressed' for .tgz files to - config/mimes.php. - - Updated the output library to no longer compress output or send - content-length headers if the server runs with - zlib.output_compression enabled. - - Eliminated a call to is_really_writable() on each request unless - it is really needed (Output caching) - - Documented append_output() in the :doc:`Output - Class <libraries/output>`. - - Documented a second argument in the decode() function for the - :doc:`Encrypt Class <libraries/encrypt>`. - - Documented db->close(). - - Updated the router to support a default route with any number of - segments. - - Moved _remove_invisible_characters() function from the - :doc:`Security Library <libraries/security>` to :doc:`common - functions. <general/common_functions>` - - Added audio/mpeg3 as a valid mime type for MP3. - -Bug fixes for 2.0.0 -------------------- - -- Fixed a bug where you could not change the User-Agent when sending - email. -- Fixed a bug where the Output class would send incorrect cached output - for controllers implementing their own _output() method. -- Fixed a bug where a failed query would not have a saved query - execution time causing errors in the Profiler -- Fixed a bug that was writing log entries when multiple identical - helpers and plugins were loaded. -- Fixed assorted user guide typos or examples (#10693, #8951, #7825, - #8660, #7883, #6771, #10656). -- Fixed a language key in the profiler: "profiler_no_memory_usage" - to "profiler_no_memory". -- Fixed an error in the Zip library that didn't allow downloading on - PHP 4 servers. -- Fixed a bug in the Form Validation library where fields passed as - rule parameters were not being translated (#9132) -- Modified inflector helper to properly pluralize words that end in - 'ch' or 'sh' -- Fixed a bug in xss_clean() that was not allowing hyphens in query - strings of submitted URLs. -- Fixed bugs in get_dir_file_info() and get_file_info() in the - File Helper with recursion, and file paths on Windows. -- Fixed a bug where Active Record override parameter would not let you - disable Active Record if it was enabled in your database config file. -- Fixed a bug in reduce_double_slashes() in the String Helper to - properly remove duplicate leading slashes (#7585) -- Fixed a bug in values_parsing() of the XML-RPC library which - prevented NULL variables typed as 'string' from being handled - properly. -- Fixed a bug were form_open_multipart() didn't accept string - attribute arguments (#10930). -- Fixed a bug (#10470) where get_mime_by_extension() was case - sensitive. -- Fixed a bug where some error messages for the SQLite and Oracle - drivers would not display. -- Fixed a bug where files created with the Zip Library would result in - file creation dates of 1980. -- Fixed a bug in the Session library that would result in PHP error - when attempting to store values with objects. -- Fixed a bug where extending the Controller class would result in a - fatal PHP error. -- Fixed a PHP Strict Standards Error in the index.php file. -- Fixed a bug where getimagesize() was being needlessly checked on - non-image files in is_allowed_type(). -- Fixed a bug in the Encryption library where an empty key was not - triggering an error. -- Fixed a bug in the Email library where CC and BCC recipients were not - reset when using the clear() method (#109). -- Fixed a bug in the URL Helper where prep_url() could cause a PHP - error on PHP versions < 5.1.2. -- Added a log message in core/output if the cache directory config - value was not found. -- Fixed a bug where multiple libraries could not be loaded by passing - an array to load->library() -- Fixed a bug in the html helper where too much white space was - rendered between the src and alt tags in the img() function. -- Fixed a bug in the profilers _compile_queries() function. -- Fixed a bug in the date helper where the DATE_ISO8601 variable was - returning an incorrectly formatted date string. - -Version 1.7.2 -============= - -Release Date: September 11, 2009 -Hg Tag: v1.7.2 - -- Libraries - - - Added a new :doc:`Cart Class <libraries/cart>`. - - Added the ability to pass $config['file_name'] for the :doc:`File - Uploading Class <libraries/file_uploading>` and rename the - uploaded file. - - Changed order of listed user-agents so Safari would more - accurately report itself. (#6844) - -- Database - - - Switched from using gettype() in escape() to is\_* methods, since - future PHP versions might change its output. - - Updated all database drivers to handle arrays in escape_str() - - Added escape_like_str() method for escaping strings to be used - in LIKE conditions - - Updated Active Record to utilize the new LIKE escaping mechanism. - - Added reconnect() method to DB drivers to try to keep alive / - reestablish a connection after a long idle. - - Modified MSSQL driver to use mssql_get_last_message() for error - messages. - -- Helpers - - - Added form_multiselect() to the :doc:`Form - helper <helpers/form_helper>`. - - Modified form_hidden() in the :doc:`Form - helper <helpers/form_helper>` to accept multi-dimensional - arrays. - - Modified form_prep() in the :doc:`Form - helper <helpers/form_helper>` to keep track of prepped - fields to avoid multiple prep/mutation from subsequent calls which - can occur when using Form Validation and form helper functions to - output form fields. - - Modified directory_map() in the :doc:`Directory - helper <helpers/directory_helper>` to allow the inclusion of - hidden files, and to return FALSE on failure to read directory. - - Modified the :doc:`Smiley helper <helpers/smiley_helper>` to work - with multiple fields and insert the smiley at the last known - cursor position. - -- General - - - Compatible with PHP 5.3.0. - - Modified :doc:`show_error() <general/errors>` to allow sending - of HTTP server response codes. - - Modified :doc:`show_404() <general/errors>` to send 404 status - code, removing non-CGI compatible header() statement from - error_404.php template. - - Added set_status_header() to the :doc:`Common - functions <general/common_functions>` to allow use when the - Output class is unavailable. - - Added is_php() to :doc:`Common - functions <general/common_functions>` to facilitate PHP - version comparisons. - - Added 2 CodeIgniter "cheatsheets" (thanks to DesignFellow.com for - this contribution). - -Bug fixes for 1.7.2 -------------------- - -- Fixed assorted user guide typos or examples (#6743, #7214, #7516, - #7287, #7852, #8224, #8324, #8349). -- Fixed a bug in the Form Validation library where multiple callbacks - weren't working (#6110) -- doctype helper default value was missing a "1". -- Fixed a bug in the language class when outputting an error for an - unfound file. -- Fixed a bug in the Calendar library where the shortname was output - for "May". -- Fixed a bug with ORIG_PATH_INFO that was allowing URIs of just a - slash through. -- Fixed a fatal error in the Oracle and ODBC drivers (#6752) -- Fixed a bug where xml_from_result() was checking for a nonexistent - method. -- Fixed a bug where Database Forge's add_column and modify_column - were not looping through when sent multiple fields. -- Fixed a bug where the File Helper was using '/' instead of the - DIRECTORY_SEPARATOR constant. -- Fixed a bug to prevent PHP errors when attempting to use sendmail on - servers that have manually disabled the PHP popen() function. -- Fixed a bug that would cause PHP errors in XML-RPC data if the PHP - data type did not match the specified XML-RPC type. -- Fixed a bug in the XML-RPC class with parsing dateTime.iso8601 data - types. -- Fixed a case sensitive string replacement in xss_clean() -- Fixed a bug in form_textarea() where form data was not prepped - correctly. -- Fixed a bug in form_prep() causing it to not preserve entities in - the user's original input when called back into a form element -- Fixed a bug in _protect_identifiers() where the swap prefix - ($swap_pre) was not being observed. -- Fixed a bug where the 400 status header sent with the 'disallowed URI - characters' was not compatible with CGI environments. -- Fixed a bug in the typography class where heading tags could have - paragraph tags inserted when using auto_typography(). - -Version 1.7.1 -============= - -Release Date: February 10, 2009 -Hg Tag: 1.7.1 - -- Libraries - - - Fixed an arbitrary script execution security flaw (#6068) in the - Form Validation library (thanks to hkk) - - Changed default current page indicator in the Pagination library - to use <strong> instead of <b> - - A "HTTP/1.1 400 Bad Request" header is now sent when disallowed - characters are encountered. - - Added <big>, <small>, <q>, and <tt> to the Typography parser's - inline elements. - - Added more accurate error reporting for the Email library when - using sendmail. - - Removed a strict type check from the rotate() function of the - :doc:`Image Manipulation Class <libraries/image_lib>`. - - Added enhanced error checking in file saving in the Image library - when using the GD lib. - - Added an additional newline between multipart email headers and - the MIME message text for better compatibility with a variety of - MUAs. - - Made modest improvements to efficiency and accuracy of - explode_name() in the Image lib. - -- Database - - - Added where_in to the list of expected arguments received by - delete(). - -- Helpers - - - Added the ability to have optgroups in form_dropdown() within the - :doc:`form helper <helpers/form_helper>`. - - Added a doctype() function to the :doc:`HTML - helper <helpers/html_helper>`. - - Added ability to force lowercase for url_title() in the :doc:`URL - helper <helpers/url_helper>`. - - Changed the default "type" of form_button() to "button" from - "submit" in the :doc:`form helper <helpers/form_helper>`. - - Changed redirect() in the URL helper to allow redirections to URLs - outside of the CI site. - - Updated get_cookie() to try to fetch the cookie using the global - cookie prefix if the requested cookie name doesn't exist. - -- Other Changes - - - Improved security in xss_clean() to help prevent attacks - targeting Internet Explorer. - - Added 'application/msexcel' to config/mimes.php for .xls files. - - Added 'proxy_ips' config item to whitelist reverse proxy servers - from which to trust the HTTP_X_FORWARDED_FOR header to to - determine the visitor's IP address. - - Improved accuracy of Upload::is_allowed_filetype() for images - (#6715) - -Bug fixes for 1.7.1 -------------------- - -- Database - - - Fixed a bug when doing 'random' on order_by() (#5706). - - Fixed a bug where adding a primary key through Forge could fail - (#5731). - - Fixed a bug when using DB cache on multiple databases (#5737). - - Fixed a bug where TRUNCATE was not considered a "write" query - (#6619). - - Fixed a bug where csv_from_result() was checking for a - nonexistent method. - - Fixed a bug _protect_identifiers() where it was improperly - removing all pipe symbols from items - -- Fixed assorted user guide typos or examples (#5998, #6093, #6259, - #6339, #6432, #6521). -- Fixed a bug in the MySQLi driver when no port is specified -- Fixed a bug (#5702), in which the field label was not being fetched - properly, when "matching" one field to another. -- Fixed a bug in which identifers were not being escaped properly when - reserved characters were used. -- Fixed a bug with the regular expression used to protect submitted - paragraph tags in auto typography. -- Fixed a bug where double dashes within tag attributes were being - converted to em dash entities. -- Fixed a bug where double spaces within tag attributes were being - converted to non-breaking space entities. -- Fixed some accuracy issues with curly quotes in - Typography::format_characters() -- Changed a few docblock comments to reflect actual return values. -- Fixed a bug with high ascii characters in subject and from email - headers. -- Fixed a bug in xss_clean() where whitespace following a validated - character entity would not be preserved. -- Fixed a bug where HTML comments and <pre> tags were being parsed in - Typography::auto_typography(). -- Fixed a bug with non-breaking space cleanup in - Typography::auto_typography(). -- Fixed a bug in database escaping where a compound statement (ie: - SUM()) wasn't handled correctly with database prefixes. -- Fixed a bug when an opening quote is preceded by a paragraph tag and - immediately followed by another tag. -- Fixed a bug in the Text Helper affecting some locales where - word_censor() would not work on words beginning or ending with an - accented character. -- Fixed a bug in the Text Helper character limiter where the provided - limit intersects the last word of the string. -- Fixed a bug (#6342) with plural() in the Inflection helper with words - ending in "y". -- Fixed bug (#6517) where Routed URI segments returned by - URI::rsegment() method were incorrect for the default controller. -- Fixed a bug (#6706) in the Security Helper where xss_clean() was - using a deprecated second argument. -- Fixed a bug in the URL helper url_title() function where trailing - periods were allowed at the end of a URL. -- Fixed a bug (#6669) in the Email class when CRLF's are used for the - newline character with headers when used with the "mail" protocol. -- Fixed a bug (#6500) where URI::A_filter_uri() was exit()ing an - error instead of using show_error(). -- Fixed a bug (#6592) in the File Helper where get_dir_file_info() - where recursion was not occurring properly. -- Tweaked Typography::auto_typography() for some edge-cases. - -Version 1.7 -=========== - -Release Date: October 23, 2008 -Hg Tag: 1.7.0 - -- Libraries - - - Added a new :doc:`Form Validation - Class <libraries/form_validation>`. It simplifies setting - rules and field names, supports arrays as field names, allows - groups of validation rules to be saved in a config file, and adds - some helper functions for use in view files. **Please note that - the old Validation class is now deprecated**. We will leave it in - the library folder for some time so that existing applications - that use it will not break, but you are encouraged to migrate to - the new version. - - Updated the :doc:`Sessions class <libraries/sessions>` so that - any custom data being saved gets stored to a database rather than - the session cookie (assuming you are using a database to store - session data), permitting much more data to be saved. - - Added the ability to store libraries in subdirectories within - either the main "libraries" or the local application "libraries" - folder. Please see the :doc:`Loader class <libraries/loader>` for - more info. - - Added the ability to assign library objects to your own variable - names when you use $this->load->library(). Please see the :doc:`Loader - class <libraries/loader>` for more info. - - Added controller class/method info to :doc:`Profiler - class <general/profiling>` and support for multiple database - connections. - - Improved the "auto typography" feature and moved it out of the - helper into its own :doc:`Typography - Class <libraries/typography>`. - - Improved performance and accuracy of xss_clean(), including - reduction of false positives on image/file tests. - - Improved :doc:`Parser class <./libraries/parser>` to allow - multiple calls to the parse() function. The output of each is - appended in the output. - - Added max_filename option to set a file name length limit in the - :doc:`File Upload Class <libraries/file_uploading>`. - - Added set_status_header() function to :doc:`Output - class <libraries/output>`. - - Modified :doc:`Pagination <libraries/pagination>` class to only - output the "First" link when the link for page one would not be - shown. - - Added support for mb_strlen in the :doc:`Form - Validation <libraries/form_validation>` class so that - multi-byte languages will calculate string lengths properly. - -- Database - - - Improved Active Record class to allow full path column and table - names: hostname.database.table.column. Also improved the alias - handling. - - Improved how table and column names are escaped and prefixed. It - now honors full path names when adding prefixes and escaping. - - Added Active Record caching feature to "update" and "delete" - functions. - - Added removal of non-printing control characters in escape_str() - of DB drivers that do not have native PHP escaping mechanisms - (mssql, oci8, odbc), to avoid potential SQL errors, and possible - sources of SQL injection. - - Added port support to MySQL, MySQLi, and MS SQL database drivers. - - Added driver name variable in each DB driver, based on bug report - #4436. - -- Helpers - - - Added several new "setting" functions to the :doc:`Form - helper <helpers/form_helper>` that allow POST data to be - retrieved and set into forms. These are intended to be used on - their own, or with the new :doc:`Form Validation - Class <libraries/form_validation>`. - - Added current_url() and uri_segments() to :doc:`URL - helper <helpers/url_helper>`. - - Altered auto_link() in the :doc:`URL - helper <helpers/url_helper>` so that email addresses with - "+" included will be linked. - - Added meta() function to :doc:`HTML - helper <helpers/html_helper>`. - - Improved accuracy of calculations in :doc:`Number - helper <helpers/number_helper>`. - - Removed added newlines ("\\n") from most form and html helper - functions. - - Tightened up validation in the :doc:`Date - helper <helpers/date_helper>` function human_to_unix(), - and eliminated the POSIX regex. - - Updated :doc:`Date helper <helpers/date_helper>` to match the - world's current time zones and offsets. - - Modified url_title() in the :doc:`URL - helper <helpers/url_helper>` to remove characters and digits - that are part of character entities, to allow dashes, underscores, - and periods regardless of the $separator, and to allow uppercase - characters. - - Added support for arbitrary attributes in anchor_popup() of the - :doc:`URL helper <helpers/url_helper>`. - -- Other Changes - - - Added :doc:`PHP Style Guide <./general/styleguide>` to docs. - - Added sanitization in xss_clean() for a deprecated HTML tag that - could be abused in user input in Internet Explorer. - - Added a few openxml document mime types, and an additional mobile - agent to mimes.php and user_agents.php respectively. - - Added a file lock check during caching, before trying to write to - the file. - - Modified Cookie key cleaning to unset a few troublesome key names - that can be present in certain environments, preventing CI from - halting execution. - - Changed the output of the profiler to use style attribute rather - than clear, and added the id "codeigniter_profiler" to the - container div. - -Bug fixes for 1.7.0 -------------------- - -- Fixed bug in xss_clean() that could remove some desirable tag - attributes. -- Fixed assorted user guide typos or examples (#4807, #4812, #4840, - #4862, #4864, #4899, #4930, #5006, #5071, #5158, #5229, #5254, - #5351). -- Fixed an edit from 1.6.3 that made the $robots array in - user_agents.php go poof. -- Fixed a bug in the :doc:`Email library <libraries/email>` with - quoted-printable encoding improperly encoding space and tab - characters. -- Modified XSS sanitization to no longer add semicolons after &[single - letter], such as in M&M's, B&B, etc. -- Modified XSS sanitization to no longer strip XHTML image tags of - closing slashes. -- Fixed a bug in the Session class when database sessions are used - where upon session update all userdata would be errantly written to - the session cookie. -- Fixed a bug (#4536) in backups with the MySQL driver where some - legacy code was causing certain characters to be double escaped. -- Fixed a routing bug (#4661) that occurred when the default route - pointed to a subfolder. -- Fixed the spelling of "Dhaka" in the timezone_menu() function of the - :doc:`Date helper. <helpers/date_helper>` -- Fixed the spelling of "raspberry" in config/smileys.php. -- Fixed incorrect parenthesis in form_open() function (#5135). -- Fixed a bug that was ignoring case when comparing controller methods - (#4560). -- Fixed a bug (#4615) that was not setting SMTP authorization settings - when using the initialize function. -- Fixed a bug in highlight_code() in the :doc:`Text - helper <helpers/text_helper>` that would leave a stray </span> - in certain cases. -- Fixed Oracle bug (#3306) that was preventing multiple queries in one - action. -- Fixed ODBC bug that was ignoring connection params due to its use of - a constructor. -- Fixed a DB driver bug with num_rows() that would cause an error with - the Oracle driver. -- Fixed MS SQL bug (#4915). Added brackets around database name in MS - SQL driver when selecting the database, in the event that reserved - characters are used in the name. -- Fixed a DB caching bug (4718) in which the path was incorrect when no - URI segments were present. -- Fixed Image_lib class bug #4562. A path was not defined for NetPBM. -- Fixed Image_lib class bug #4532. When cropping an image with - identical height/width settings on output, a copy is made. -- Fixed DB_driver bug (4900), in which a database error was not being - logged correctly. -- Fixed DB backup bug in which field names were not being escaped. -- Fixed a DB Active Record caching bug in which multiple calls to - cached data were not being honored. -- Fixed a bug in the Session class that was disallowing slashes in the - serialized array. -- Fixed a Form Validation bug in which the "isset" error message was - being trigged by the "required" rule. -- Fixed a spelling error in a Loader error message. -- Fixed a bug (5050) with IP validation with empty segments. -- Fixed a bug in which the parser was being greedy if multiple - identical sets of tags were encountered. - -Version 1.6.3 -============= - -Release Date: June 26, 2008 -Hg Tag: v1.6.3 - -Version 1.6.3 is a security and maintenance release and is recommended -for all users. - -- Database - - - Modified MySQL/MySQLi Forge class to give explicit names to keys - - Added ability to set multiple column non-primary keys to the - :doc:`Forge class <database/forge>` - - Added ability to set additional database config values in :doc:`DSN - connections <database/connecting>` via the query string. - -- Libraries - - - Set the mime type check in the :doc:`Upload - class <libraries/file_uploading>` to reference the global - mimes variable. - - Added support for query strings to the :doc:`Pagination - class <libraries/pagination>`, automatically detected or - explicitly declared. - - Added get_post() to the :doc:`Input class <libraries/input>`. - - Documented get() in the :doc:`Input class <libraries/input>`. - - Added the ability to automatically output language items as form - labels in the :doc:`Language class <libraries/language>`. - -- Helpers - - - Added a :doc:`Language helper <helpers/language_helper>`. - - Added a :doc:`Number helper <helpers/number_helper>`. - - :doc:`Form helper <helpers/form_helper>` refactored to allow - form_open() and form_fieldset() to accept arrays or strings as - arguments. - -- Other changes - - - Improved security in xss_clean(). - - Removed an unused Router reference in _display_cache(). - - Added ability to :doc:`use xss_clean() to test - images <libraries/input>` for XSS, useful for upload - security. - - Considerably expanded list of mobile user-agents in - config/user_agents.php. - - Charset information in the userguide has been moved above title - for internationalization purposes (#4614). - - Added "Using Associative Arrays In a Request Parameter" example to - the :doc:`XMLRPC userguide page <libraries/xmlrpc>`. - - Removed maxlength and size as automatically added attributes of - form_input() in the :doc:`form helper <helpers/form_helper>`. - - Documented the language file use of byte_format() in the :doc:`number - helper <helpers/number_helper>`. - -Bug fixes for 1.6.3 -------------------- - -- Added a language key for valid_emails in validation_lang.php. -- Amended fixes for bug (#3419) with parsing DSN database connections. -- Moved the _has_operator() function (#4535) into DB_driver from - DB_active_rec. -- Fixed a syntax error in upload_lang.php. -- Fixed a bug (#4542) with a regular expression in the Image library. -- Fixed a bug (#4561) where orhaving() wasn't properly passing values. -- Removed some unused variables from the code (#4563). -- Fixed a bug where having() was not adding an = into the statement - (#4568). -- Fixed assorted user guide typos or examples (#4574, #4706). -- Added quoted-printable headers to Email class when the multi-part - override is used. -- Fixed a double opening <p> tag in the index pages of each system - directory. - -Version 1.6.2 -============= - -Release Date: May 13, 2008 -Hg Tag: 1.6.2 - -- Active Record - - - Added the ability to prevent escaping in having() clauses. - - Added rename_table() into :doc:`DBForge <./database/forge>`. - - Fixed a bug that wasn't allowing escaping to be turned off if the - value of a query was NULL. - - DB Forge is now assigned to any models that exist after loading - (#3457). - -- Database - - - Added :doc:`Strict Mode <./database/transactions>` to database - transactions. - - Escape behaviour in where() clauses has changed; values in those - with the "FALSE" argument are no longer escaped (ie: quoted). - -- Config - - - Added 'application/vnd.ms-powerpoint' to list of mime types. - - Added 'audio/mpg' to list of mime types. - - Added new user-modifiable file constants.php containing file mode - and fopen constants. - - Added the ability to set CRLF settings via config in the - :doc:`Email <libraries/email>` class. - -- Libraries - - - Added increased security for filename handling in the Upload - library. - - Added increased security for sessions for client-side data - tampering. - - The MySQLi forge class is now in sync with MySQL forge. - - Added the ability to set CRLF settings via config in the - :doc:`Email <libraries/email>` class. - - :doc:`Unit Testing <libraries/unit_testing>` results are now - colour coded, and a change was made to the default template of - results. - - Added a valid_emails rule to the Validation class. - - The :doc:`Zip class <libraries/zip>` now exits within download(). - - The :doc:`Zip class <libraries/zip>` has undergone a substantial - re-write for speed and clarity (thanks stanleyxu for the hard work - and code contribution in bug report #3425!) - -- Helpers - - - Added a Compatibility - Helper for using some common - PHP 5 functions safely in applications that might run on PHP 4 - servers (thanks Seppo for the hard work and code contribution!) - - Added form_button() in the :doc:`Form - helper <helpers/form_helper>`. - - Changed the radio() and checkbox() functions to default to not - checked by default. - - Added the ability to include an optional HTTP Response Code in the - redirect() function of the :doc:`URL - Helper <helpers/url_helper>`. - - Modified img() in the :doc:`HTML Helper <helpers/html_helper>` to - remove an unneeded space (#4208). - - Modified anchor() in the :doc:`URL helper <helpers/url_helper>` - to no longer add a default title= attribute (#4209). - - The :doc:`Download helper <helpers/download_helper>` now exits - within force_download(). - - Added get_dir_file_info(), get_file_info(), and - get_mime_by_extension() to the :doc:`File - Helper <helpers/file_helper>`. - - Added symbolic_permissions() and octal_permissions() to the - :doc:`File helper <helpers/file_helper>`. - -- Plugins - - - Modified captcha generation to first look for the function - imagecreatetruecolor, and fallback to imagecreate if it isn't - available (#4226). - -- Other Changes - - - Added ability for :doc:`xss_clean() <libraries/input>` to accept - arrays. - - Removed closing PHP tags from all PHP files to avoid accidental - output and potential 'cannot modify headers' errors. - - Removed "scripts" from the auto-load search path. Scripts were - deprecated in Version 1.4.1 (September 21, 2006). If you still - need to use them for legacy reasons, they must now be manually - loaded in each Controller. - - Added a :doc:`Reserved Names <general/reserved_names>` page to - the userguide, and migrated reserved controller names into it. - - Added a :doc:`Common Functions <general/common_functions>` page - to the userguide for globally available functions. - - Improved security and performance of xss_clean(). - -Bugfixes for 1.6.2 ------------------- - -- Fixed a bug where SET queries were not being handled as "write" - queries. -- Fixed a bug (#3191) with ORIG_PATH_INFO URI parsing. -- Fixed a bug in DB Forge, when inserting an id field (#3456). -- Fixed a bug in the table library that could cause identically - constructed rows to be dropped (#3459). -- Fixed DB Driver and MySQLi result driver checking for resources - instead of objects (#3461). -- Fixed an AR_caching error where it wasn't tracking table aliases - (#3463). -- Fixed a bug in AR compiling, where select statements with arguments - got incorrectly escaped (#3478). -- Fixed an incorrect documentation of $this->load->language (#3520). -- Fixed bugs (#3523, #4350) in get_filenames() with recursion and - problems with Windows when $include_path is used. -- Fixed a bug (#4153) in the XML-RPC class preventing dateTime.iso8601 - from being used. -- Fixed an AR bug with or_where_not_in() (#4171). -- Fixed a bug with :doc:`xss_clean() <libraries/input>` that would - add semicolons to GET URI variable strings. -- Fixed a bug (#4206) in the Directory Helper where the directory - resource was not being closed, and minor improvements. -- Fixed a bug in the FTP library where delete_dir() was not working - recursively (#4215). -- Fixed a Validation bug when set_rules() is used with a non-array - field name and rule (#4220). -- Fixed a bug (#4223) where DB caching would not work for returned DB - objects or multiple DB connections. -- Fixed a bug in the Upload library that might output the same error - twice (#4390). -- Fixed an AR bug when joining with a table alias and table prefix - (#4400). -- Fixed a bug in the DB class testing the $params argument. -- Fixed a bug in the Table library where the integer 0 in cell data - would be displayed as a blank cell. -- Fixed a bug in link_tag() of the :doc:`URL - helper <helpers/url_helper>` where a key was passed instead of - a value. -- Fixed a bug in DB_result::row() that prevented it from returning - individual fields with MySQL NULL values. -- Fixed a bug where SMTP emails were not having dot transformation - performed on lines that begin with a dot. -- Fixed a bug in display_error() in the DB driver that was - instantiating new Language and Exception objects, and not using the - error heading. -- Fixed a bug (#4413) where a URI containing slashes only e.g. - '\http://example.com/index.php?//' would result in PHP errors -- Fixed an array to string conversion error in the Validation library - (#4425) -- Fixed bug (#4451, #4299, #4339) where failed transactions will not - rollback when debug mode is enabled. -- Fixed a bug (#4506) with overlay_watermark() in the Image library - preventing support for PNG-24s with alpha transparency -- Fixed assorted user guide typos (#3453, #4364, #4379, #4399, #4408, - #4412, #4448, #4488). - -Version 1.6.1 -============= - -Release Date: February 12, 2008 -Hg Tag: 1.6.1 - -- Active Record - - - Added :ref:`Active Record - Caching <ar-caching>`. - - Made Active Record fully database-prefix aware. - -- Database drivers - - - Added support for setting client character set and collation for - MySQLi. - -- Core Changes - - - Modified xss_clean() to be more intelligent with its handling of - URL encoded strings. - - Added $_SERVER, $_FILES, $_ENV, and $_SESSION to sanitization - of globals. - - Added a :doc:`Path Helper <./helpers/path_helper>`. - - Simplified _reindex_segments() in the URI class. - - Escaped the '-' in the default 'permitted_uri_chars' config - item, to prevent errors if developers just try to add additional - characters to the end of the default expression. - - Modified method calling to controllers to show a 404 when a - private or protected method is accessed via a URL. - - Modified framework initiated 404s to log the controller and method - for invalid requests. - -- Helpers - - - Modified get_filenames() in the File Helper to return FALSE if - the $source_dir is not readable. - -Bugfixes for 1.6.1 ------------------- - -- Deprecated is_numeric as a validation rule. Use of numeric and - integer are preferred. -- Fixed bug (#3379) in DBForge with SQLite for table creation. -- Made Active Record fully database prefix aware (#3384). -- Fixed a bug where DBForge was outputting invalid SQL in Postgres by - adding brackets around the tables in FROM. -- Changed the behaviour of Active Record's update() to make the WHERE - clause optional (#3395). -- Fixed a bug (#3396) where certain POST variables would cause a PHP - warning. -- Fixed a bug in query binding (#3402). -- Changed order of SQL keywords in the Profiler $highlight array so OR - would not be highlighted before ORDER BY. -- Fixed a bug (#3404) where the MySQLi driver was testing if - $this->conn_id was a resource instead of an object. -- Fixed a bug (#3419) connecting to a database via a DSN string. -- Fixed a bug (#3445) where the routed segment array was not re-indexed - to begin with 1 when the default controller is used. -- Fixed assorted user guide typos. - -Version 1.6.0 -============= - -Release Date: January 30, 2008 - -- DBForge - - - Added :doc:`DBForge <./database/forge>` to the database tools. - - Moved create_database() and drop_database() into - :doc:`DBForge <./database/forge>`. - - Added add_field(), add_key(), create_table(), drop_table(), - add_column(), drop_column(), modify_column() into - :doc:`DBForge <./database/forge>`. - -- Active Record - - - Added protect_identifiers() in :doc:`Active - Record <./database/query_builder>`. - - All AR queries are backticked if appropriate to the database. - - Added where_in(), or_where_in(), where_not_in(), - or_where_not_in(), not_like() and or_not_like() to :doc:`Active - Record <./database/query_builder>`. - - Added support for limit() into update() and delete() statements in - :doc:`Active Record <./database/query_builder>`. - - Added empty_table() and truncate_table() to :doc:`Active - Record <./database/query_builder>`. - - Added the ability to pass an array of tables to the delete() - statement in :doc:`Active Record <./database/query_builder>`. - - Added count_all_results() function to :doc:`Active - Record <./database/query_builder>`. - - Added select_max(), select_min(), select_avg() and - select_sum() to :doc:`Active Record <./database/query_builder>`. - - Added the ability to use aliases with joins in :doc:`Active - Record <./database/query_builder>`. - - Added a third parameter to Active Record's like() clause to - control where the wildcard goes. - - Added a third parameter to set() in :doc:`Active - Record <./database/query_builder>` that withholds escaping - data. - - Changed the behaviour of variables submitted to the where() clause - with no values to auto set "IS NULL" - -- Other Database Related - - - MySQL driver now requires MySQL 4.1+ - - Added $this->DB->save_queries variable to DB driver, enabling - queries to get saved or not. Previously they were always saved. - - Added $this->db->dbprefix() to manually add database prefixes. - - Added 'random' as an order_by() option , and removed "rand()" as - a listed option as it was MySQL only. - - Added a check for NULL fields in the MySQL database backup - utility. - - Added "constrain_by_prefix" parameter to db->list_table() - function. If set to TRUE it will limit the result to only table - names with the current prefix. - - Deprecated from Active Record; getwhere() for get_where(); - groupby() for group_by(); havingor() for having_or(); orderby() - for order_by; orwhere() for or_where(); and orlike() for - or_like(). - - Modified csv_from_result() to output CSV data more in the spirit - of basic rules of RFC 4180. - - Added 'char_set' and 'dbcollat' database configuration settings, - to explicitly set the client communication properly. - - Removed 'active_r' configuration setting and replaced with a - global $active_record setting, which is more in harmony with the - global nature of the behavior (#1834). - -- Core changes - - - Added ability to load multiple views, whose content will be - appended to the output in the order loaded. - - Added the ability to :doc:`auto-load <./general/autoloader>` - :doc:`Models <./general/models>`. - - Reorganized the URI and Routes classes for better clarity. - - Added Compat.php to allow function overrides for older versions of - PHP or PHP environments missing certain extensions / libraries - - Added memory usage, GET, URI string data, and individual query - execution time to Profiler output. - - Deprecated Scaffolding. - - Added is_really_writable() to Common.php to provide a - cross-platform reliable method of testing file/folder writability. - -- Libraries - - - Changed the load protocol of Models to allow for extension. - - Strengthened the Encryption library to help protect against man in - the middle attacks when MCRYPT_MODE_CBC mode is used. - - Added Flashdata variables, session_id regeneration and - configurable session update times to the :doc:`Session - class. <./libraries/sessions>` - - Removed 'last_visit' from the Session class. - - Added a language entry for valid_ip validation error. - - Modified prep_for_form() in the Validation class to accept - arrays, adding support for POST array validation (via callbacks - only) - - Added an "integer" rule into the Validation library. - - Added valid_base64() to the Validation library. - - Documented clear() in the :doc:`Image - Processing <./libraries/image_lib>` library. - - Changed the behaviour of custom callbacks so that they no longer - trigger the "required" rule. - - Modified Upload class $_FILES error messages to be more precise. - - Moved the safe mode and auth checks for the Email library into the - constructor. - - Modified variable names in _ci_load() method of Loader class to - avoid conflicts with view variables. - - Added a few additional mime type variations for CSV. - - Enabled the 'system' methods for the XML-RPC Server library, - except for 'system.multicall' which is still disabled. - -- Helpers & Plugins - - - Added link_tag() to the :doc:`HTML - helper. <./helpers/html_helper>` - - Added img() to the :doc:`HTML helper. <./helpers/html_helper>` - - Added ability to :doc:`"extend" Helpers <./general/helpers>`. - - Added an :doc:`email helper <./helpers/email_helper>` into core - helpers. - - Added strip_quotes() function to :doc:`string - helper <./helpers/string_helper>`. - - Added reduce_multiples() function to :doc:`string - helper <./helpers/string_helper>`. - - Added quotes_to_entities() function to :doc:`string - helper <./helpers/string_helper>`. - - Added form_fieldset(), form_fieldset_close(), form_label(), - and form_reset() function to :doc:`form - helper <./helpers/form_helper>`. - - Added support for external urls in form_open(). - - Removed support for db_backup in MySQLi due to incompatible - functions. - - Javascript Calendar plugin now uses the months and days from the - calendar language file, instead of hard-coded values, - internationalizing it. - -- Documentation Changes - - - Added Writing Documentation section - for the community to use in writing their own documentation. - - Added titles to all user manual pages. - - Added attributes into <html> of userguide for valid html. - - Added :doc:`Zip Encoding Class <libraries/zip>` - to the table of contents of the userguide. - - Moved part of the userguide menu javascript to an external file. - - Documented distinct() in :doc:`Active - Record <./database/query_builder>`. - - Documented the timezones() function in the :doc:`Date - Helper <./helpers/date_helper>`. - - Documented unset_userdata in the :doc:`Session - class <./libraries/sessions>`. - - Documented 2 config options to the :doc:`Database - configuration <./database/configuration>` page. - -Bug fixes for Version 1.6.0 ---------------------------- - -- Fixed a bug (#1813) preventing using $CI->db in the same application - with returned database objects. -- Fixed a bug (#1842) where the $this->uri->rsegments array would not - include the 'index' method if routed to the controller without an - implicit method. -- Fixed a bug (#1872) where word_limiter() was not retaining - whitespace. -- Fixed a bug (#1890) in csv_from_result() where content that - included the delimiter would break the file. -- Fixed a bug (#2542)in the clean_email() method of the Email class to - allow for non-numeric / non-sequential array keys. -- Fixed a bug (#2545) in _html_entity_decode_callback() when - 'global_xss_filtering' is enabled. -- Fixed a bug (#2668) in the :doc:`parser class <./libraries/parser>` - where numeric data was ignored. -- Fixed a bug (#2679) where the "previous" pagination link would get - drawn on the first page. -- Fixed a bug (#2702) in _object_to_array that broke some types of - inserts and updates. -- Fixed a bug (#2732) in the SQLite driver for PHP 4. -- Fixed a bug (#2754) in Pagination to scan for non-positive - num_links. -- Fixed a bug (#2762) in the :doc:`Session - library <./libraries/sessions>` where user agent matching would - fail on user agents ending with a space. -- Fixed a bug (#2784) $field_names[] vs $Ffield_names[] in postgres - and sqlite drivers. -- Fixed a bug (#2810) in the typography helper causing extraneous - paragraph tags when string contains tags. -- Fixed a bug (#2849) where arguments passed to a subfolder controller - method would be incorrectly shifted, dropping the 3rd segment value. -- Fixed a bug (#2858) which referenced a wrong variable in the Image - class. -- Fixed a bug (#2875)when loading plugin files as _plugin. and not - _pi. -- Fixed a bug (#2912) in get_filenames() in the :doc:`File - Helper <helpers/file_helper>` where the array wasn't cleared - after each call. -- Fixed a bug (#2974) in highlight_phrase() that caused an error with - slashes. -- Fixed a bug (#3003) in the Encryption Library to support modes other - than MCRYPT_MODE_ECB -- Fixed a bug (#3015) in the :doc:`User Agent - library <./libraries/user_agent>` where more than 2 languages - where not reported with languages(). -- Fixed a bug (#3017) in the :doc:`Email <./libraries/email>` library - where some timezones were calculated incorrectly. -- Fixed a bug (#3024) in which master_dim wasn't getting reset by - clear() in the Image library. -- Fixed a bug (#3156) in Text Helper highlight_code() causing PHP tags - to be handled incorrectly. -- Fixed a bug (#3166) that prevented num_rows from working in Oracle. -- Fixed a bug (#3175) preventing certain libraries from working - properly when autoloaded in PHP 4. -- Fixed a bug (#3267) in the Typography Helper where unordered list was - listed "un. -- Fixed a bug (#3268) where the Router could leave '/' as the path. -- Fixed a bug (#3279) where the Email class was sending the wrong - Content-Transfer-Encoding for some character sets. -- Fixed a bug (#3284) where the rsegment array would not be set - properly if the requested URI contained more segments than the routed - URI. -- Removed extraneous load of $CFG in _display_cache() of the Output - class (#3285). -- Removed an extraneous call to loading models (#3286). -- Fixed a bug (#3310) with sanitization of globals in the Input class - that could unset CI's global variables. -- Fixed a bug (#3314) which would cause the top level path to be - deleted in delete_files() of the File helper. -- Fixed a bug (#3328) where the smiley helper might return an undefined - variable. -- Fixed a bug (#3330) in the FTP class where a comparison wasn't - getting made. -- Removed an unused parameter from Profiler (#3332). -- Fixed a bug in database driver where num_rows property wasn't - getting updated. -- Fixed a bug in the :doc:`upload - library <./libraries/file_uploading>` when allowed_files - wasn't defined. -- Fixed a bug in word_wrap() of the Text Helper that incorrectly - referenced an object. -- Fixed a bug in Validation where valid_ip() wasn't called properly. -- Fixed a bug in Validation where individual error messages for - checkboxes wasn't supported. -- Fixed a bug in captcha calling an invalid PHP function. -- Fixed a bug in the cookie helper "set_cookie" function. It was not - honoring the config settings. -- Fixed a bug that was making validation callbacks required even when - not set as such. -- Fixed a bug in the XML-RPC library so if a type is specified, a more - intelligent decision is made as to the default type. -- Fixed an example of comma-separated emails in the email library - documentation. -- Fixed an example in the Calendar library for Showing Next/Previous - Month Links. -- Fixed a typo in the database language file. -- Fixed a typo in the image language file "suppor" to "support". -- Fixed an example for XML RPC. -- Fixed an example of accept_charset() in the :doc:`User Agent - Library <./libraries/user_agent>`. -- Fixed a typo in the docblock comments that had CodeIgniter spelled - CodeIgnitor. -- Fixed a typo in the :doc:`String Helper <./helpers/string_helper>` - (uniquid changed to uniqid). -- Fixed typos in the email Language class - (email_attachment_unredable, email_filed_smtp_login), and FTP - Class (ftp_unable_to_remame). -- Added a stripslashes() into the Upload Library. -- Fixed a series of grammatical and spelling errors in the language - files. -- Fixed assorted user guide typos. - -Version 1.5.4 -============= - -Release Date: July 12, 2007 - -- Added :doc:`custom Language files <./libraries/language>` to the - :doc:`autoload <./general/autoloader>` options. -- Added stripslashes() to the _clean_input_data() function in the - :doc:`Input class <./libraries/input>` when magic quotes is on so - that data will always be un-slashed within the framework. -- Added array to string into the :doc:`profiler <general/profiling>`. -- Added some additional mime types in application/config/mimes.php. -- Added filename_security() method to :doc:`Input - library <./libraries/input>`. -- Added some additional arguments to the :doc:`Inflection - helper <./helpers/inflector_helper>` singular() to compensate - for words ending in "s". Also added a force parameter to pluralize(). -- Added $config['charset'] to the config file. Default value is - 'UTF-8', used in some string handling functions. -- Fixed MSSQL insert_id(). -- Fixed a logic error in the DB trans_status() function. It was - incorrectly returning TRUE on failure and FALSE on success. -- Fixed a bug that was allowing multiple load attempts on extended - classes. -- Fixed a bug in the bootstrap file that was incorrectly attempting to - discern the full server path even when it was explicity set by the - user. -- Fixed a bug in the escape_str() function in the MySQL driver. -- Fixed a typo in the :doc:`Calendar library <./libraries/calendar>` -- Fixed a typo in rpcs.php library -- Fixed a bug in the :doc:`Zip library <./libraries/zip>`, providing - PC Zip file compatibility with Mac OS X -- Fixed a bug in router that was ignoring the scaffolding route for - optimization -- Fixed an IP validation bug. -- Fixed a bug in display of POST keys in the - :doc:`Profiler <./general/profiling>` output -- Fixed a bug in display of queries with characters that would be - interpreted as HTML in the :doc:`Profiler <./general/profiling>` - output -- Fixed a bug in display of Email class print debugger with characters - that would be interpreted as HTML in the debugging output -- Fixed a bug in the Content-Transfer-Encoding of HTML emails with the - quoted-printable MIME type -- Fixed a bug where one could unset certain PHP superglobals by setting - them via GET or POST data -- Fixed an undefined function error in the insert_id() function of the - PostgreSQL driver -- Fixed various doc typos. -- Documented two functions from the :doc:`String - helper <./helpers/string_helper>` that were missing from the - user guide: trim_slashes() and reduce_double_slashes(). -- Docs now validate to XHTML 1 transitional -- Updated the XSS Filtering to take into account the IE expression() - ability and improved certain deletions to prevent possible exploits -- Modified the Router so that when Query Strings are Enabled, the - controller trigger and function trigger values are sanitized for - filename include security. -- Modified the is_image() method in the Upload library to take into - account Windows IE 6/7 eccentricities when dealing with MIMEs -- Modified XSS Cleaning routine to be more performance friendly and - compatible with PHP 5.2's new PCRE backtrack and recursion limits. -- Modified the :doc:`URL Helper <./helpers/url_helper>` to type cast - the $title as a string in case a numeric value is supplied -- Modified Form Helper form_dropdown() to type cast the keys and - values of the options array as strings, allowing numeric values to be - properly set as 'selected' -- Deprecated the use if is_numeric() in various places since it allows - periods. Due to compatibility problems with ctype_digit(), making it - unreliable in some installations, the following regular expression - was used instead: preg_match("/[^0-9]/", $n) -- Deprecated: APPVER has been deprecated and replaced with CI_VERSION - for clarity. - -Version 1.5.3 -============= - -Release Date: April 15, 2007 - -- Added array to string into the profiler -- Code Igniter references updated to CodeIgniter -- pMachine references updated to EllisLab -- Fixed a bug in the repeater function of :doc:`string - helper <./helpers/string_helper>`. -- Fixed a bug in ODBC driver -- Fixed a bug in result_array() that was returning an empty array when - no result is produced. -- Fixed a bug in the redirect function of the :doc:`url - helper <./helpers/url_helper>`. -- Fixed an undefined variable in Loader -- Fixed a version bug in the Postgres driver -- Fixed a bug in the textarea function of the form helper for use with - strings -- Fixed doc typos. - -Version 1.5.2 -============= - -Release Date: February 13, 2007 - -- Added subversion information - to the :doc:`downloads <installation/downloads>` page. -- Added support for captions in the :doc:`Table - Library <./libraries/table>` -- Fixed a bug in the - :doc:`download_helper <helpers/download_helper>` that was causing - Internet Explorer to load rather than download -- Fixed a bug in the Active Record Join function that was not taking - table prefixes into consideration. -- Removed unescaped variables in error messages of Input and Router - classes -- Fixed a bug in the Loader that was causing errors on Libraries loaded - twice. A debug message is now silently made in the log. -- Fixed a bug in the :doc:`form helper <helpers/form_helper>` that - gave textarea a value attribute -- Fixed a bug in the :doc:`Image Library <libraries/image_lib>` that - was ignoring resizing the same size image -- Fixed some doc typos. - -Version 1.5.1 -============= - -Release Date: November 23, 2006 - -- Added support for submitting arrays of libraries in the - $this->load->library function. -- Added support for naming custom library files in lower or uppercase. -- Fixed a bug related to output buffering. -- Fixed a bug in the active record class that was not resetting query - data after a completed query. -- Fixed a bug that was suppressing errors in controllers. -- Fixed a problem that can cause a loop to occur when the config file - is missing. -- Fixed a bug that occurred when multiple models were loaded with the - third parameter set to TRUE. -- Fixed an oversight that was not unsetting globals properly in the - input sanitize function. -- Fixed some bugs in the Oracle DB driver. -- Fixed an incorrectly named variable in the MySQLi result driver. -- Fixed some doc typos. - -Version 1.5.0.1 -=============== - -Release Date: October 31, 2006 - -- Fixed a problem in which duplicate attempts to load helpers and - classes were not being stopped. -- Fixed a bug in the word_wrap() helper function. -- Fixed an invalid color Hex number in the Profiler class. -- Fixed a corrupted image in the user guide. - -Version 1.5.0 -============= - -Release Date: October 30, 2006 - -- Added :doc:`DB utility class <./database/utilities>`, permitting DB - backups, CVS or XML files from DB results, and various other - functions. -- Added :doc:`Database Caching Class <./database/caching>`. -- Added :doc:`transaction support <./database/transactions>` to the - database classes. -- Added :doc:`Profiler Class <./general/profiling>` which generates a - report of Benchmark execution times, queries, and POST data at the - bottom of your pages. -- Added :doc:`User Agent Library <./libraries/user_agent>` which - allows browsers, robots, and mobile devises to be identified. -- Added :doc:`HTML Table Class <./libraries/table>` , enabling tables - to be generated from arrays or database results. -- Added :doc:`Zip Encoding Library <./libraries/zip>`. -- Added :doc:`FTP Library <./libraries/ftp>`. -- Added the ability to :doc:`extend - libraries <./general/creating_libraries>` and :doc:`extend core - classes <./general/core_classes>`, in addition to being able to - replace them. -- Added support for storing :doc:`models within - sub-folders <./general/models>`. -- Added :doc:`Download Helper <./helpers/download_helper>`. -- Added :doc:`simple_query() <./database/queries>` function to the - database classes -- Added :doc:`standard_date() <./helpers/date_helper>` function to - the Date Helper. -- Added :doc:`$query->free_result() <./database/results>` to database - class. -- Added :doc:`$query->list_fields() <./database/metadata>` function to - database class -- Added :doc:`$this->db->platform() <./database/helpers>` function -- Added new :doc:`File Helper <./helpers/file_helper>`: - get_filenames() -- Added new helper: :doc:`Smiley Helper <./helpers/smiley_helper>` -- Added support for <ul> and <ol> lists in the :doc:`HTML - Helper <./helpers/html_helper>` -- Added the ability to rewrite :doc:`short - tags <./general/alternative_php>` on-the-fly, converting them - to standard PHP statements, for those servers that do not support - short tags. This allows the cleaner syntax to be used regardless of - whether it's supported by the server. -- Added the ability to :doc:`rename or relocate the "application" - folder <./general/managing_apps>`. -- Added more thorough initialization in the upload class so that all - class variables are reset. -- Added "is_numeric" to validation, which uses the native PHP - is_numeric function. -- Improved the URI handler to make it more reliable when the - $config['uri_protocol'] item is set to AUTO. -- Moved most of the functions in the Controller class into the Loader - class, allowing fewer reserved function names for controllers when - running under PHP 5. -- Updated the DB Result class to return an empty array when - $query->result() doesn't produce a result. -- Updated the input->cookie() and input->post() functions in :doc:`Input - Class <./libraries/input>` to permit arrays contained cookies - that are arrays to be run through the XSS filter. -- Documented three functions from the Validation - class that were missing from the user - guide: set_select(), set_radio(), and set_checkbox(). -- Fixed a bug in the Email class related to SMTP Helo data. -- Fixed a bug in the word wrapping helper and function in the email - class. -- Fixed a bug in the validation class. -- Fixed a bug in the typography helper that was incorrectly wrapping - block level elements in paragraph tags. -- Fixed a problem in the form_prep() function that was double encoding - entities. -- Fixed a bug that affects some versions of PHP when output buffering - is nested. -- Fixed a bug that caused CI to stop working when the PHP magic - __get() or __set() functions were used within models or - controllers. -- Fixed a pagination bug that was permitting negative values in the - URL. -- Fixed an oversight in which the Loader class was not allowed to be - extended. -- Changed _get_config() to get_config() since the function is not a - private one. -- **Deprecated "init" folder**. Initialization happens automatically - now. :doc:`Please see documentation <./general/creating_libraries>`. -- **Deprecated** $this->db->field_names() USE - $this->db->list_fields() -- **Deprecated** the $config['log_errors'] item from the config.php - file. Instead, $config['log_threshold'] can be set to "0" to turn it - off. - -Version 1.4.1 -============= - -Release Date: September 21, 2006 - -- Added a new feature that passes URI segments directly to your - function calls as parameters. See the - :doc:`Controllers <general/controllers>` page for more info. -- Added support for a function named _output(), which when used in - your controllers will received the final rendered output from the - output class. More info in the :doc:`Controllers <general/controllers>` - page. -- Added several new functions in the :doc:`URI - Class <./libraries/uri>` to let you retrieve and manipulate URI - segments that have been re-routed using the :doc:`URI - Routing <general/routing>` feature. Previously, the URI class did not - permit you to access any re-routed URI segments, but now it does. -- Added :doc:`$this->output->set_header() <./libraries/output>` - function, which allows you to set server headers. -- Updated plugins, helpers, and language classes to allow your - application folder to contain its own plugins, helpers, and language - folders. Previously they were always treated as global for your - entire installation. If your application folder contains any of these - resources they will be used *instead* the global ones. -- Added :doc:`Inflector helper <./helpers/inflector_helper>`. -- Added element() function in the :doc:`array - helper <./helpers/array_helper>`. -- Added RAND() to active record orderby() function. -- Added delete_cookie() and get_cookie() to :doc:`Cookie - helper <./helpers/cookie_helper>`, even though the input class - has a cookie fetching function. -- Added Oracle database driver (still undergoing testing so it might - have some bugs). -- Added the ability to combine pseudo-variables and php variables in - the template parser class. -- Added output compression option to the config file. -- Removed the is_numeric test from the db->escape() function. -- Fixed a MySQLi bug that was causing error messages not to contain - proper error data. -- Fixed a bug in the email class which was causing it to ignore - explicitly set alternative headers. -- Fixed a bug that was causing a PHP error when the Exceptions class - was called within the get_config() function since it was causing - problems. -- Fixed an oversight in the cookie helper in which the config file - cookie settings were not being honored. -- Fixed an oversight in the upload class. An item mentioned in the 1.4 - changelog was missing. -- Added some code to allow email attachments to be reset when sending - batches of email. -- Deprecated the application/scripts folder. It will continue to work - for legacy users, but it is recommended that you create your own - :doc:`libraries <./general/libraries>` or - :doc:`models <./general/models>` instead. It was originally added - before CI had user libraries or models, but it's not needed anymore. -- Deprecated the $autoload['core'] item from the autoload.php file. - Instead, please now use: $autoload['libraries'] -- Deprecated the following database functions: - $this->db->smart_escape_str() and $this->db->fields(). - -Version 1.4.0 -============= - -Release Date: September 17, 2006 - -- Added :doc:`Hooks <./general/hooks>` feature, enabling you to tap - into and modify the inner workings of the framework without hacking - the core files. -- Added the ability to organize controller files :doc:`into - sub-folders <general/controllers>`. Kudos to Marco for - suggesting this (and the next two) feature. -- Added regular expressions support for :doc:`routing - rules <./general/routing>`. -- Added the ability to :doc:`remap function - calls <./general/controllers>` within your controllers. -- Added the ability to :doc:`replace core system - classes <./general/core_classes>` with your own classes. -- Added support for % character in URL. -- Added the ability to supply full URLs using the - :doc:`anchor() <./helpers/url_helper>` helper function. -- Added mode parameter to :doc:`file_write() <./helpers/file_helper>` - helper. -- Added support for changing the port number in the :doc:`Postgres - driver <./database/configuration>`. -- Moved the list of "allowed URI characters" out of the Router class - and into the config file. -- Moved the MIME type array out of the Upload class and into its own - file in the application/config/ folder. -- Updated the Upload class to allow the upload field name to be set - when calling :doc:`do_upload() <./libraries/file_uploading>`. -- Updated the :doc:`Config Library <./libraries/config>` to be able to - load config files silently, and to be able to assign config files to - their own index (to avoid collisions if you use multiple config - files). -- Updated the URI Protocol code to allow more options so that URLs will - work more reliably in different environments. -- Updated the form_open() helper to allow the GET method to be used. -- Updated the MySQLi execute() function with some code to help prevent - lost connection errors. -- Updated the SQLite Driver to check for object support before - attempting to return results as objects. If unsupported it returns an - array. -- Updated the Models loader function to allow multiple loads of the - same model. -- Updated the MS SQL driver so that single quotes are escaped. -- Updated the Postgres and ODBC drivers for better compatibility. -- Removed a strtolower() call that was changing URL segments to lower - case. -- Removed some references that were interfering with PHP 4.4.1 - compatibility. -- Removed backticks from Postgres class since these are not needed. -- Renamed display() to _display() in the Output class to make it clear - that it's a private function. -- Deprecated the hash() function due to a naming conflict with a native - PHP function with the same name. Please use dohash() instead. -- Fixed an bug that was preventing the input class from unsetting GET - variables. -- Fixed a router bug that was making it too greedy when matching end - segments. -- Fixed a bug that was preventing multiple discrete database calls. -- Fixed a bug in which loading a language file was producing a "file - contains no data" message. -- Fixed a session bug caused by the XSS Filtering feature inadvertently - changing the case of certain words. -- Fixed some missing prefixes when using the database prefix feature. -- Fixed a typo in the Calendar class (cal_november). -- Fixed a bug in the form_checkbox() helper. -- Fixed a bug that was allowing the second segment of the URI to be - identical to the class name. -- Fixed an evaluation bug in the database initialization function. -- Fixed a minor bug in one of the error messages in the language class. -- Fixed a bug in the date helper timespan function. -- Fixed an undefined variable in the DB Driver class. -- Fixed a bug in which dollar signs used as binding replacement values - in the DB class would be treated as RegEx back-references. -- Fixed a bug in the set_hash() function which was preventing MD5 from - being used. -- Fixed a couple bugs in the Unit Testing class. -- Fixed an incorrectly named variable in the Validation class. -- Fixed an incorrectly named variable in the URI class. -- Fixed a bug in the config class that was preventing the base URL from - being called properly. -- Fixed a bug in the validation class that was not permitting callbacks - if the form field was empty. -- Fixed a problem that was preventing scaffolding from working properly - with MySQLi. -- Fixed some MS SQL bugs. -- Fixed some doc typos. - -Version 1.3.3 -============= - -Release Date: June 1, 2006 - -- Models do **not** connect automatically to the database as of this - version. :doc:`More info here <./general/models>`. -- Updated the Sessions class to utilize the active record class when - running session related queries. Previously the queries assumed MySQL - syntax. -- Updated alternator() function to re-initialize when called with no - arguments, allowing multiple calls. -- Fixed a bug in the active record "having" function. -- Fixed a problem in the validation class which was making checkboxes - be ignored when required. -- Fixed a bug in the word_limiter() helper function. It was cutting - off the fist word. -- Fixed a bug in the xss_clean function due to a PHP bug that affects - some versions of html_entity_decode. -- Fixed a validation bug that was preventing rules from being set twice - in one controller. -- Fixed a calendar bug that was not letting it use dynamically loaded - languages. -- Fixed a bug in the active record class when using WHERE clauses with - LIKE -- Fixed a bug in the hash() security helper. -- Fixed some typos. - -Version 1.3.2 -============= - -Release Date: April 17, 2006 - -- Changed the behavior of the validation class such that if a - "required" rule is NOT explicitly stated for a field then all other - tests get ignored. -- Fixed a bug in the Controller class that was causing it to look in - the local "init" folder instead of the main system one. -- Fixed a bug in the init_pagination file. The $config item was not - being set correctly. -- Fixed a bug in the auto typography helper that was causing - inconsistent behavior. -- Fixed a couple bugs in the Model class. -- Fixed some documentation typos and errata. - -Version 1.3.1 -============= - -Release Date: April 11, 2006 - -- Added a :doc:`Unit Testing Library <./libraries/unit_testing>`. -- Added the ability to pass objects to the **insert()** and - **update()** database functions. This feature enables you to (among - other things) use your :doc:`Model class <./general/models>` - variables to run queries with. See the Models page for details. -- Added the ability to pass objects to the :doc:`view loading - function <./general/views>`: $this->load->view('my_view', - $object); -- Added getwhere function to :doc:`Active Record - class <./database/query_builder>`. -- Added count_all function to :doc:`Active Record - class <./database/query_builder>`. -- Added language file for scaffolding and fixed a scaffolding bug that - occurs when there are no rows in the specified table. -- Added :doc:`$this->db->last_query() <./database/queries>`, which - allows you to view your last query that was run. -- Added a new mime type to the upload class for better compatibility. -- Changed how cache files are read to prevent PHP errors if the cache - file contains an XML tag, which PHP wants to interpret as a short - tag. -- Fixed a bug in a couple of the active record functions (where and - orderby). -- Fixed a bug in the image library when realpath() returns false. -- Fixed a bug in the Models that was preventing libraries from being - used within them. -- Fixed a bug in the "exact_length" function of the validation class. -- Fixed some typos in the user guide - -Version 1.3 -=========== - -Release Date: April 3, 2006 - -- Added support for :doc:`Models <general/models>`. -- Redesigned the database libraries to support additional RDBMs - (Postgres, MySQLi, etc.). -- Redesigned the :doc:`Active Record class <./database/query_builder>` - to enable more varied types of queries with simpler syntax, and - advanced features like JOINs. -- Added a feature to the database class that lets you run :doc:`custom - function calls <./database/call_function>`. -- Added support for :doc:`private functions <general/controllers>` in your - controllers. Any controller function name that starts with an - underscore will not be served by a URI request. -- Added the ability to pass your own initialization parameters to your - :doc:`custom core libraries <general/creating_libraries>` when using - $this->load->library() -- Added support for running standard :doc:`query string URLs <general/urls>`. - These can be optionally enabled in your config file. -- Added the ability to :doc:`specify a "suffix" <general/urls>`, which will be - appended to your URLs. For example, you could add .html to your URLs, - making them appear static. This feature is enabled in your config - file. -- Added a new error template for use with native PHP errors. -- Added "alternator" function in the :doc:`string - helpers <./helpers/string_helper>`. -- Removed slashing from the input class. After much debate we decided - to kill this feature. -- Change the commenting style in the scripts to the PEAR standard so - that IDEs and tools like phpDocumenter can harvest the comments. -- Added better class and function name-spacing to avoid collisions with - user developed classes. All CodeIgniter classes are now prefixed with - CI\_ and all controller methods are prefixed with _ci to avoid - controller collisions. A list of reserved function names can be - :doc:`found here <general/controllers>`. -- Redesigned how the "CI" super object is referenced, depending on - whether PHP 4 or 5 is being run, since PHP 5 allows a more graceful - way to manage objects that utilizes a bit less resources. -- Deprecated: $this->db->use_table() has been deprecated. Please read - the :doc:`Active Record <./database/query_builder>` page for - information. -- Deprecated: $this->db->smart_escape_str() has been deprecated. - Please use this instead: $this->db->escape() -- Fixed a bug in the exception handler which was preventing some PHP - errors from showing up. -- Fixed a typo in the URI class. $this->total_segment() should be - plural: $this->total_segments() -- Fixed some typos in the default calendar template -- Fixed some typos in the user guide - -Version 1.2 -=========== - -Release Date: March 21, 2006 - -- Redesigned some internal aspects of the framework to resolve scoping - problems that surfaced during the beta tests. The problem was most - notable when instantiating classes in your constructors, particularly - if those classes in turn did work in their constructors. -- Added a global function named - :doc:`get_instance() <general/ancillary_classes>` allowing the main - CodeIgniter object to be accessible throughout your own classes. -- Added new :doc:`File Helper <./helpers/file_helper>`: - delete_files() -- Added new :doc:`URL Helpers <./helpers/url_helper>`: base_url(), - index_page() -- Added the ability to create your own :doc:`core - libraries <general/creating_libraries>` and store them in your local - application directory. -- Added an overwrite option to the :doc:`Upload - class <./libraries/file_uploading>`, enabling files to be - overwritten rather than having the file name appended. -- Added Javascript Calendar plugin. -- Added search feature to user guide. Note: This is done using Google, - which at the time of this writing has not crawled all the pages of - the docs. -- Updated the parser class so that it allows tag pars within other tag - pairs. -- Fixed a bug in the DB "where" function. -- Fixed a bug that was preventing custom config files to be - auto-loaded. -- Fixed a bug in the mysql class bind feature that prevented question - marks in the replacement data. -- Fixed some bugs in the xss_clean function - -Version Beta 1.1 -================ - -Release Date: March 10, 2006 - -- Added a :doc:`Calendaring class <./libraries/calendar>`. -- Added support for running :doc:`multiple - applications <general/managing_apps>` that share a common CodeIgniter - backend. -- Moved the "uri protocol" variable from the index.php file into the - config.php file -- Fixed a problem that was preventing certain function calls from - working within constructors. -- Fixed a problem that was preventing the $this->load->library function - from working in constructors. -- Fixed a bug that occurred when the session class was loaded using the - auto-load routine. -- Fixed a bug that can happen with PHP versions that do not support the - E_STRICT constant -- Fixed a data type error in the form_radio function (form helper) -- Fixed a bug that was preventing the xss_clean function from being - called from the validation class. -- Fixed the cookie related config names, which were incorrectly - specified as $conf rather than $config -- Fixed a pagination problem in the scaffolding. -- Fixed a bug in the mysql class "where" function. -- Fixed a regex problem in some code that trimmed duplicate slashes. -- Fixed a bug in the br() function in the HTML helper -- Fixed a syntax mistake in the form_dropdown function in the Form - Helper. -- Removed the "style" attributes form the form helpers. -- Updated the documentation. Added "next/previous" links to each page - and fixed various typos. - -Version Beta 1.0 -================ - -Release Date: February 28, 2006 - -First publicly released version. diff --git a/user_guide_src/source/conf.py b/user_guide_src/source/conf.py deleted file mode 100644 index 553669996..000000000 --- a/user_guide_src/source/conf.py +++ /dev/null @@ -1,263 +0,0 @@ -# -*- coding: utf-8 -*- -# -# CodeIgniter documentation build configuration file, created by -# sphinx-quickstart on Sun Aug 28 07:24:38 2011. -# -# This file is execfile()d with the current directory set to its containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys, os - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) - -# -- General configuration ----------------------------------------------------- - -# If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.ifconfig', 'sphinxcontrib.phpdomain'] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The encoding of source files. -#source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'CodeIgniter' -copyright = u'2014 - 2018, 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 -# built documents. -# -# The short X.Y version. -version = '3.1.8' -# The full version, including alpha/beta/rc tags. -release = '3.1.8' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = [] - -# The reST default role (used for this markup: `text`) to use for all documents. -#default_role = None - -# If true, '()' will be appended to :php:func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. php:function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'trac' -highlight_language = 'ci' - -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - - -# -- Options for HTML output --------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -html_theme = 'sphinx_rtd_theme' - -# 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. -# -# Specifying a few options; just a starting point & we can play with it. -html_theme_options = { - -} - -# Add any paths that contain custom themes here, relative to this directory. -html_theme_path = ["./_themes"] - -# The name for this set of Sphinx documents. If None, it defaults to -# "<project> v<release> documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# 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 = '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, -# so a file named "default.css" will overwrite the builtin "default.css". -#html_static_path = ['_static'] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_domain_indices = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a <link> tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None - -# Output file base name for HTML help builder. -htmlhelp_basename = 'CodeIgniterdoc' - -html_copy_source = False - -# -- Options for LaTeX output -------------------------------------------------- - -# The paper size ('letter' or 'a4'). -#latex_paper_size = 'letter' - -# The font size ('10pt', '11pt' or '12pt'). -#latex_font_size = '10pt' - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). -latex_documents = [ - ('index', 'CodeIgniter.tex', u'CodeIgniter Documentation', - u'British Columbia Institute of Technology', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Additional stuff for the LaTeX preamble. -#latex_preamble = '' - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_domain_indices = True - - -# -- Options for manual page output -------------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ('index', 'codeigniter', u'CodeIgniter Documentation', - [u'British Columbia Institute of Technology'], 1) -] - - -# -- Options for Epub output --------------------------------------------------- - -# Bibliographic Dublin Core info. -epub_title = u'CodeIgniter' -epub_author = u'British Columbia Institute of Technology' -epub_publisher = u'British Columbia Institute of Technology' -epub_copyright = u'2014 - 2018, British Columbia Institute of Technology' - -# The language of the text. It defaults to the language option -# or en if the language is not set. -#epub_language = '' - -# The scheme of the identifier. Typical schemes are ISBN or URL. -#epub_scheme = '' - -# The unique identifier of the text. This can be a ISBN number -# or the project homepage. -#epub_identifier = '' - -# A unique identification for the text. -#epub_uid = '' - -# HTML files that should be inserted before the pages created by sphinx. -# The format is a list of tuples containing the path and title. -#epub_pre_files = [] - -# HTML files shat should be inserted after the pages created by sphinx. -# The format is a list of tuples containing the path and title. -#epub_post_files = [] - -# A list of files that should not be packed into the epub file. -#epub_exclude_files = [] - -# The depth of the table of contents in toc.ncx. -#epub_tocdepth = 3 - -# Allow duplicate toc entries. -#epub_tocdup = True diff --git a/user_guide_src/source/contributing/index.rst b/user_guide_src/source/contributing/index.rst deleted file mode 100644 index be776ec1f..000000000 --- a/user_guide_src/source/contributing/index.rst +++ /dev/null @@ -1,159 +0,0 @@ -########################### -Contributing to CodeIgniter -########################### - -.. toctree:: - :titlesonly: - - ../documentation/index - ../DCO - -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 <https://help.github.com/articles/using-pull-requests/>`_ -on 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: - -- There is not already an open Issue -- The issue has already been fixed (check the develop branch, or look for - closed Issues) -- Is it something really obvious that you fix it yourself? - -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 -******* - -Please note that GitHub is not for general support questions! If you are -having trouble using a feature of CodeIgniter, ask for help on our -`forums <http://forum.codeigniter.com/>`_ instead. - -If you are not sure whether you are using something correctly or if you -have found a bug, again - please ask on the forums first. - -******** -Security -******** - -Did you find a security issue in CodeIgniter? - -Please *don't* disclose it publicly, but e-mail us at security@codeigniter.com, -or report it via our page on `HackerOne <https://hackerone.com/codeigniter>`_. - -If you've found a critical vulnerability, we'd be happy to credit you in our -`ChangeLog <../changelog>`. - -**************************** -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 -********** - -Before we look into how, here are the guidelines. If your Pull Requests fail -to pass these guidelines it will be declined and you will need to re-submit -when you’ve made the changes. This might sound a bit tough, but it is required -for us to maintain quality of the code-base. - -PHP Style -========= - -All code must meet the `Style Guide -<https://codeigniter.com/userguide3/general/styleguide.html>`_, which is -essentially the `Allman indent style -<https://en.wikipedia.org/wiki/Indent_style#Allman_style>`_, underscores and -readable operators. This makes certain that all code is the same format as the -existing code and means it will be as readable as possible. - -Documentation -============= - -If you change anything that requires a change to documentation then you will -need to add it. New classes, methods, parameters, changing default values, etc -are all things that will require a change to documentation. The change-log -must also be updated for every change. Also PHPDoc blocks must be maintained. - -Compatibility -============= - -CodeIgniter recommends PHP 5.6 or newer to be used, but it should be -compatible with PHP 5.3.7 so all code supplied must stick to this -requirement. If PHP 5.4 (and above) functions or features are used then -there must be a fallback for PHP 5.3.7. - -Branching -========= - -CodeIgniter uses the `Git-Flow -<http://nvie.com/posts/a-successful-git-branching-model/>`_ branching model -which requires all pull requests to be sent to the "develop" branch. This is -where the next planned version will be developed. The "master" branch will -always contain the latest stable version and is kept clean so a "hotfix" (e.g: -an emergency security patch) can be applied to master to create a new version, -without worrying about other features holding it up. For this reason all -commits need to be made to "develop" and any sent to "master" will be closed -automatically. If you have multiple changes to submit, please place all -changes into their own branch on your fork. - -One thing at a time: A pull request should only contain one change. That does -not mean only one commit, but one change - however many commits it took. The -reason for this is that if you change X and Y but send a pull request for both -at the same time, we might really want X but disagree with Y, meaning we -cannot merge the request. Using the Git-Flow branching model you can create -new branches for both of these features and send two requests. - -Signing -======= -You must sign your work, certifying that you either wrote the work or -otherwise have the right to pass it on to an open source project. git makes -this trivial as you merely have to use `--signoff` on your commits to your -CodeIgniter fork. - -.. code-block:: bash - - git commit --signoff - -or simply - -.. code-block:: bash - - git commit -s - -This will sign your commits with the information setup in your git config, e.g. - - Signed-off-by: John Q Public <john.public@example.com> - -If you are using Tower there is a "Sign-Off" checkbox in the commit window. You -could even alias git commit to use the -s flag so you don’t have to think about -it. - -By signing your work in this manner, you certify to a "Developer's Certificate -of Origin". The current version of this certificate is in the :doc:`/DCO` file -in the root of this documentation. diff --git a/user_guide_src/source/database/caching.rst b/user_guide_src/source/database/caching.rst deleted file mode 100644 index d73120a93..000000000 --- a/user_guide_src/source/database/caching.rst +++ /dev/null @@ -1,162 +0,0 @@ -###################### -Database Caching Class -###################### - -The Database Caching Class permits you to cache your queries as text -files for reduced database load. - -.. important:: This class is initialized automatically by the database - driver when caching is enabled. Do NOT load this class manually. - -.. important:: Not all query result functions are available when you - use caching. Please read this page carefully. - -Enabling Caching -================ - -Caching is enabled in three steps: - -- Create a writable directory on your server where the cache files can - be stored. -- Set the path to your cache folder in your - application/config/database.php file. -- Enable the caching feature, either globally by setting the preference - in your application/config/database.php file, or manually as - described below. - -Once enabled, caching will happen automatically whenever a page is -loaded that contains database queries. - -How Does Caching Work? -====================== - -CodeIgniter's query caching system happens dynamically when your pages -are viewed. When caching is enabled, the first time a web page is -loaded, the query result object will be serialized and stored in a text -file on your server. The next time the page is loaded the cache file -will be used instead of accessing your database. Your database usage can -effectively be reduced to zero for any pages that have been cached. - -Only read-type (SELECT) queries can be cached, since these are the only -type of queries that produce a result. Write-type (INSERT, UPDATE, etc.) -queries, since they don't generate a result, will not be cached by the -system. - -Cache files DO NOT expire. Any queries that have been cached will remain -cached until you delete them. The caching system permits you clear -caches associated with individual pages, or you can delete the entire -collection of cache files. Typically you'll want to use the housekeeping -functions described below to delete cache files after certain events -take place, like when you've added new information to your database. - -Will Caching Improve Your Site's Performance? -============================================= - -Getting a performance gain as a result of caching depends on many -factors. If you have a highly optimized database under very little load, -you probably won't see a performance boost. If your database is under -heavy use you probably will see an improved response, assuming your -file-system is not overly taxed. Remember that caching simply changes -how your information is retrieved, shifting it from being a database -operation to a file-system one. - -In some clustered server environments, for example, caching may be -detrimental since file-system operations are so intense. On single -servers in shared environments, caching will probably be beneficial. -Unfortunately there is no single answer to the question of whether you -should cache your database. It really depends on your situation. - -How are Cache Files Stored? -=========================== - -CodeIgniter places the result of EACH query into its own cache file. -Sets of cache files are further organized into sub-folders corresponding -to your controller functions. To be precise, the sub-folders are named -identically to the first two segments of your URI (the controller class -name and function name). - -For example, let's say you have a controller called blog with a function -called comments that contains three queries. The caching system will -create a cache folder called blog+comments, into which it will write -three cache files. - -If you use dynamic queries that change based on information in your URI -(when using pagination, for example), each instance of the query will -produce its own cache file. It's possible, therefore, to end up with -many times more cache files than you have queries. - -Managing your Cache Files -========================= - -Since cache files do not expire, you'll need to build deletion routines -into your application. For example, let's say you have a blog that -allows user commenting. Whenever a new comment is submitted you'll want -to delete the cache files associated with the controller function that -serves up your comments. You'll find two delete functions described -below that help you clear data. - -Not All Database Functions Work with Caching -============================================ - -Lastly, we need to point out that the result object that is cached is a -simplified version of the full result object. For that reason, some of -the query result functions are not available for use. - -The following functions ARE NOT available when using a cached result -object: - -- num_fields() -- field_names() -- field_data() -- free_result() - -Also, the two database resources (result_id and conn_id) are not -available when caching, since result resources only pertain to run-time -operations. - -****************** -Function Reference -****************** - -$this->db->cache_on() / $this->db->cache_off() -================================================ - -Manually enables/disables caching. This can be useful if you want to -keep certain queries from being cached. Example:: - - // Turn caching on - $this->db->cache_on(); - $query = $this->db->query("SELECT * FROM mytable"); - - // Turn caching off for this one query - $this->db->cache_off(); - $query = $this->db->query("SELECT * FROM members WHERE member_id = '$current_user'"); - - // Turn caching back on - $this->db->cache_on(); - $query = $this->db->query("SELECT * FROM another_table"); - -$this->db->cache_delete() -========================== - -Deletes the cache files associated with a particular page. This is -useful if you need to clear caching after you update your database. - -The caching system saves your cache files to folders that correspond to -the URI of the page you are viewing. For example, if you are viewing a -page at example.com/index.php/blog/comments, the caching system will put -all cache files associated with it in a folder called blog+comments. To -delete those particular cache files you will use:: - - $this->db->cache_delete('blog', 'comments'); - -If you do not use any parameters the current URI will be used when -determining what should be cleared. - -$this->db->cache_delete_all() -=============================== - -Clears all existing cache files. Example:: - - $this->db->cache_delete_all(); - diff --git a/user_guide_src/source/database/call_function.rst b/user_guide_src/source/database/call_function.rst deleted file mode 100644 index 83fc870d0..000000000 --- a/user_guide_src/source/database/call_function.rst +++ /dev/null @@ -1,39 +0,0 @@ -##################### -Custom Function Calls -##################### - -$this->db->call_function(); -============================ - -This function enables you to call PHP database functions that are not -natively included in CodeIgniter, in a platform independent manner. For -example, let's say you want to call the mysql_get_client_info() -function, which is **not** natively supported by CodeIgniter. You could -do so like this:: - - $this->db->call_function('get_client_info'); - -You must supply the name of the function, **without** the mysql\_ -prefix, in the first parameter. The prefix is added automatically based -on which database driver is currently being used. This permits you to -run the same function on different database platforms. Obviously not all -function calls are identical between platforms, so there are limits to -how useful this function can be in terms of portability. - -Any parameters needed by the function you are calling will be added to -the second parameter. - -:: - - $this->db->call_function('some_function', $param1, $param2, etc..); - -Often, you will either need to supply a database connection ID or a -database result ID. The connection ID can be accessed using:: - - $this->db->conn_id; - -The result ID can be accessed from within your result object, like this:: - - $query = $this->db->query("SOME QUERY"); - - $query->result_id;
\ No newline at end of file diff --git a/user_guide_src/source/database/configuration.rst b/user_guide_src/source/database/configuration.rst deleted file mode 100644 index a9bf7dcb6..000000000 --- a/user_guide_src/source/database/configuration.rst +++ /dev/null @@ -1,207 +0,0 @@ -###################### -Database Configuration -###################### - -CodeIgniter has a config file that lets you store your database -connection values (username, password, database name, etc.). The config -file is located at application/config/database.php. You can also set -database connection values for specific -:doc:`environments <../libraries/config>` by placing **database.php** -in the respective environment config folder. - -The config settings are stored in a multi-dimensional array with this -prototype:: - - $db['default'] = array( - 'dsn' => '', - 'hostname' => 'localhost', - 'username' => 'root', - 'password' => '', - 'database' => 'database_name', - 'dbdriver' => 'mysqli', - 'dbprefix' => '', - 'pconnect' => TRUE, - 'db_debug' => TRUE, - 'cache_on' => FALSE, - 'cachedir' => '', - 'char_set' => 'utf8', - 'dbcollat' => 'utf8_general_ci', - 'swap_pre' => '', - 'encrypt' => FALSE, - 'compress' => FALSE, - 'stricton' => FALSE, - 'failover' => array() - ); - -Some database drivers (such as PDO, PostgreSQL, Oracle, ODBC) might -require a full DSN string to be provided. If that is the case, you -should use the 'dsn' configuration setting, as if you're using the -driver's underlying native PHP extension, like this:: - - // PDO - $db['default']['dsn'] = 'pgsql:host=localhost;port=5432;dbname=database_name'; - - // Oracle - $db['default']['dsn'] = '//localhost/XE'; - -.. note:: If you do not specify a DSN string for a driver that requires it, CodeIgniter - will try to build it with the rest of the provided settings. - -.. note:: If you provide a DSN string and it is missing some valid settings (e.g. the - database character set), which are present in the rest of the configuration - fields, CodeIgniter will append them. - -You can also specify failovers for the situation when the main connection cannot connect for some reason. -These failovers can be specified by setting the failover for a connection like this:: - - $db['default']['failover'] = array( - array( - 'hostname' => 'localhost1', - 'username' => '', - 'password' => '', - 'database' => '', - 'dbdriver' => 'mysqli', - 'dbprefix' => '', - 'pconnect' => TRUE, - 'db_debug' => TRUE, - 'cache_on' => FALSE, - 'cachedir' => '', - 'char_set' => 'utf8', - 'dbcollat' => 'utf8_general_ci', - 'swap_pre' => '', - 'encrypt' => FALSE, - 'compress' => FALSE, - 'stricton' => FALSE - ), - array( - 'hostname' => 'localhost2', - 'username' => '', - 'password' => '', - 'database' => '', - 'dbdriver' => 'mysqli', - 'dbprefix' => '', - 'pconnect' => TRUE, - 'db_debug' => TRUE, - 'cache_on' => FALSE, - 'cachedir' => '', - 'char_set' => 'utf8', - 'dbcollat' => 'utf8_general_ci', - 'swap_pre' => '', - 'encrypt' => FALSE, - 'compress' => FALSE, - 'stricton' => FALSE - ) - ); - -You can specify as many failovers as you like. - -The reason we use a multi-dimensional array rather than a more simple -one is to permit you to optionally store multiple sets of connection -values. If, for example, you run multiple environments (development, -production, test, etc.) under a single installation, you can set up a -connection group for each, then switch between groups as needed. For -example, to set up a "test" environment you would do this:: - - $db['test'] = array( - 'dsn' => '', - 'hostname' => 'localhost', - 'username' => 'root', - 'password' => '', - 'database' => 'database_name', - 'dbdriver' => 'mysqli', - 'dbprefix' => '', - 'pconnect' => TRUE, - 'db_debug' => TRUE, - 'cache_on' => FALSE, - 'cachedir' => '', - 'char_set' => 'utf8', - 'dbcollat' => 'utf8_general_ci', - 'swap_pre' => '', - 'compress' => FALSE, - 'encrypt' => FALSE, - 'stricton' => FALSE, - 'failover' => array() - ); - -Then, to globally tell the system to use that group you would set this -variable located in the config file:: - - $active_group = 'test'; - -.. note:: The name 'test' is arbitrary. It can be anything you want. By - default we've used the word "default" for the primary connection, - but it too can be renamed to something more relevant to your project. - -Query Builder -------------- - -The :doc:`Query Builder Class <query_builder>` is globally enabled or -disabled by setting the $query_builder variable in the database -configuration file to TRUE/FALSE (boolean). The default setting is TRUE. -If you are not using the -query builder class, setting it to FALSE will utilize fewer resources -when the database classes are initialized. - -:: - - $query_builder = TRUE; - -.. note:: that some CodeIgniter classes such as Sessions require Query - Builder to be enabled to access certain functionality. - -Explanation of Values: ----------------------- - -====================== =========================================================================================================== - Name Config Description -====================== =========================================================================================================== -**dsn** The DSN connect string (an all-in-one configuration sequence). -**hostname** The hostname of your database server. Often this is 'localhost'. -**username** The username used to connect to the database. -**password** The password used to connect to the database. -**database** The name of the database you want to connect to. -**dbdriver** The database type. ie: mysqli, postgre, odbc, etc. Must be specified in lower case. -**dbprefix** An optional table prefix which will added to the table name when running - :doc:`Query Builder <query_builder>` queries. This permits multiple CodeIgniter - installations to share one database. -**pconnect** TRUE/FALSE (boolean) - Whether to use a persistent connection. -**db_debug** TRUE/FALSE (boolean) - Whether database errors should be displayed. -**cache_on** TRUE/FALSE (boolean) - Whether database query caching is enabled, - see also :doc:`Database Caching Class <caching>`. -**cachedir** The absolute server path to your database query cache directory. -**char_set** The character set used in communicating with the database. -**dbcollat** The character collation used in communicating with the database - - .. note:: Only used in the 'mysql' and 'mysqli' drivers. - -**swap_pre** A default table prefix that should be swapped with dbprefix. This is useful for distributed - applications where you might run manually written queries, and need the prefix to still be - customizable by the end user. -**schema** The database schema, defaults to 'public'. Used by PostgreSQL and ODBC drivers. -**encrypt** Whether or not to use an encrypted connection. - - - 'mysql' (deprecated), 'sqlsrv' and 'pdo/sqlsrv' drivers accept TRUE/FALSE - - 'mysqli' and 'pdo/mysql' drivers accept an array with the following options: - - - 'ssl_key' - Path to the private key file - - 'ssl_cert' - Path to the public key certificate file - - 'ssl_ca' - Path to the certificate authority file - - 'ssl_capath' - Path to a directory containing trusted CA certificates in PEM format - - 'ssl_cipher' - List of *allowed* ciphers to be used for the encryption, separated by colons (':') - - 'ssl_verify' - TRUE/FALSE; Whether to verify the server certificate or not ('mysqli' only) - -**compress** Whether or not to use client compression (MySQL only). -**stricton** TRUE/FALSE (boolean) - Whether to force "Strict Mode" connections, good for ensuring strict SQL - while developing an application. -**port** The database port number. To use this value you have to add a line to the database config array. - :: - - $db['default']['port'] = 5432; - -====================== =========================================================================================================== - -.. note:: Depending on what database platform you are using (MySQL, PostgreSQL, - etc.) not all values will be needed. For example, when using SQLite you - will not need to supply a username or password, and the database name - will be the path to your database file. The information above assumes - you are using MySQL. diff --git a/user_guide_src/source/database/connecting.rst b/user_guide_src/source/database/connecting.rst deleted file mode 100644 index 9b8117076..000000000 --- a/user_guide_src/source/database/connecting.rst +++ /dev/null @@ -1,155 +0,0 @@ -########################### -Connecting to your Database -########################### - -There are two ways to connect to a database: - -Automatically Connecting -======================== - -The "auto connect" feature will load and instantiate the database class -with every page load. To enable "auto connecting", add the word database -to the library array, as indicated in the following file: - -application/config/autoload.php - -Manually Connecting -=================== - -If only some of your pages require database connectivity you can -manually connect to your database by adding this line of code in any -function where it is needed, or in your class constructor to make the -database available globally in that class. - -:: - - $this->load->database(); - -If the above function does **not** contain any information in the first -parameter it will connect to the group specified in your database config -file. For most people, this is the preferred method of use. - -Available Parameters --------------------- - -#. The database connection values, passed either as an array or a DSN - string. -#. TRUE/FALSE (boolean). Whether to return the connection ID (see - Connecting to Multiple Databases below). -#. TRUE/FALSE (boolean). Whether to enable the Query Builder class. Set - to TRUE by default. - -Manually Connecting to a Database ---------------------------------- - -The first parameter of this function can **optionally** be used to -specify a particular database group from your config file, or you can -even submit connection values for a database that is not specified in -your config file. Examples: - -To choose a specific group from your config file you can do this:: - - $this->load->database('group_name'); - -Where group_name is the name of the connection group from your config -file. - -To connect manually to a desired database you can pass an array of -values:: - - $config['hostname'] = 'localhost'; - $config['username'] = 'myusername'; - $config['password'] = 'mypassword'; - $config['database'] = 'mydatabase'; - $config['dbdriver'] = 'mysqli'; - $config['dbprefix'] = ''; - $config['pconnect'] = FALSE; - $config['db_debug'] = TRUE; - $config['cache_on'] = FALSE; - $config['cachedir'] = ''; - $config['char_set'] = 'utf8'; - $config['dbcollat'] = 'utf8_general_ci'; - $this->load->database($config); - -For information on each of these values please see the :doc:`configuration -page <configuration>`. - -.. note:: For the PDO driver, you should use the $config['dsn'] setting - instead of 'hostname' and 'database': - - | - | $config['dsn'] = 'mysql:host=localhost;dbname=mydatabase'; - -Or you can submit your database values as a Data Source Name. DSNs must -have this prototype:: - - $dsn = 'dbdriver://username:password@hostname/database'; - $this->load->database($dsn); - -To override default config values when connecting with a DSN string, add -the config variables as a query string. - -:: - - $dsn = 'dbdriver://username:password@hostname/database?char_set=utf8&dbcollat=utf8_general_ci&cache_on=true&cachedir=/path/to/cache'; - $this->load->database($dsn); - -Connecting to Multiple Databases -================================ - -If you need to connect to more than one database simultaneously you can -do so as follows:: - - $DB1 = $this->load->database('group_one', TRUE); - $DB2 = $this->load->database('group_two', TRUE); - -Note: Change the words "group_one" and "group_two" to the specific -group names you are connecting to (or you can pass the connection values -as indicated above). - -By setting the second parameter to TRUE (boolean) the function will -return the database object. - -.. note:: When you connect this way, you will use your object name to issue - commands rather than the syntax used throughout this guide. In other - words, rather than issuing commands with: - - | - | $this->db->query(); - | $this->db->result(); - | etc... - | - | You will instead use: - | - | $DB1->query(); - | $DB1->result(); - | etc... - -.. note:: You don't need to create separate database configurations if you - only need to use a different database on the same connection. You - can switch to a different database when you need to, like this: - - | $this->db->db_select($database2_name); - -Reconnecting / Keeping the Connection Alive -=========================================== - -If the database server's idle timeout is exceeded while you're doing -some heavy PHP lifting (processing an image, for instance), you should -consider pinging the server by using the reconnect() method before -sending further queries, which can gracefully keep the connection alive -or re-establish it. - -:: - - $this->db->reconnect(); - -Manually closing the Connection -=============================== - -While CodeIgniter intelligently takes care of closing your database -connections, you can explicitly close the connection. - -:: - - $this->db->close();
\ No newline at end of file diff --git a/user_guide_src/source/database/db_driver_reference.rst b/user_guide_src/source/database/db_driver_reference.rst deleted file mode 100644 index 1f036cd77..000000000 --- a/user_guide_src/source/database/db_driver_reference.rst +++ /dev/null @@ -1,439 +0,0 @@ -################### -DB Driver Reference -################### - -This is the platform-independent base DB implementation class. -This class will not be called directly. Rather, the adapter -class for the specific database will extend and instantiate it. - -The how-to material for this has been split over several articles. -This article is intended to be a reference for them. - -.. important:: Not all methods are supported by all database drivers, - some of them may fail (and return FALSE) if the underlying - driver does not support them. - -.. php:class:: CI_DB_driver - - .. php:method:: initialize() - - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Initialize database settings, establish a connection to - the database. - - .. php:method:: db_connect($persistent = TRUE) - - :param bool $persistent: Whether to establish a persistent connection or a regular one - :returns: Database connection resource/object or FALSE on failure - :rtype: mixed - - Establish a connection with the database. - - .. note:: The returned value depends on the underlying - driver in use. For example, a ``mysqli`` instance - will be returned with the 'mysqli' driver. - - .. php:method:: db_pconnect() - - :returns: Database connection resource/object or FALSE on failure - :rtype: mixed - - Establish a persistent connection with the database. - - .. note:: This method is just an alias for ``db_connect(TRUE)``. - - .. php:method:: reconnect() - - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Keep / reestablish the database connection if no queries - have been sent for a length of time exceeding the - server's idle timeout. - - .. php:method:: db_select([$database = '']) - - :param string $database: Database name - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Select / switch the current database. - - .. php:method:: db_set_charset($charset) - - :param string $charset: Character set name - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Set client character set. - - .. php:method:: platform() - - :returns: Platform name - :rtype: string - - The name of the platform in use (mysql, mssql, etc...). - - .. php:method:: version() - - :returns: The version of the database being used - :rtype: string - - Database version number. - - .. php:method:: query($sql[, $binds = FALSE[, $return_object = NULL]]) - - :param string $sql: The SQL statement to execute - :param array $binds: An array of binding data - :param bool $return_object: Whether to return a result object or not - :returns: TRUE for successful "write-type" queries, CI_DB_result instance (method chaining) on "query" success, FALSE on failure - :rtype: mixed - - Execute an SQL query. - - Accepts an SQL string as input and returns a result object - upon successful execution of a "read" type query. - - Returns: - - - Boolean TRUE upon successful execution of a "write type" queries - - Boolean FALSE upon failure - - ``CI_DB_result`` object for "read type" queries - - .. note: If 'db_debug' setting is set to TRUE, an error - page will be displayed instead of returning FALSE - on failures and script execution will stop. - - .. php:method:: simple_query($sql) - - :param string $sql: The SQL statement to execute - :returns: Whatever the underlying driver's "query" function returns - :rtype: mixed - - A simplified version of the ``query()`` method, appropriate - for use when you don't need to get a result object or to - just send a query to the database and not care for the result. - - .. php:method:: affected_rows() - - :returns: Number of rows affected - :rtype: int - - Returns the number of rows *changed* by the last executed query. - - Useful for checking how much rows were created, updated or deleted - during the last executed query. - - .. php:method:: trans_strict([$mode = TRUE]) - - :param bool $mode: Strict mode flag - :rtype: void - - Enable/disable transaction "strict" mode. - - When strict mode is enabled, if you are running multiple - groups of transactions and one group fails, all subsequent - groups will be rolled back. - - If strict mode is disabled, each group is treated - autonomously, meaning a failure of one group will not - affect any others. - - .. php:method:: trans_off() - - :rtype: void - - Disables transactions at run-time. - - .. php:method:: trans_start([$test_mode = FALSE]) - - :param bool $test_mode: Test mode flag - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Start a transaction. - - .. php:method:: trans_complete() - - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Complete Transaction. - - .. php:method:: trans_status() - - :returns: TRUE if the transaction succeeded, FALSE if it failed - :rtype: bool - - Lets you retrieve the transaction status flag to - determine if it has failed. - - .. php:method:: compile_binds($sql, $binds) - - :param string $sql: The SQL statement - :param array $binds: An array of binding data - :returns: The updated SQL statement - :rtype: string - - Compiles an SQL query with the bind values passed for it. - - .. php:method:: is_write_type($sql) - - :param string $sql: The SQL statement - :returns: TRUE if the SQL statement is of "write type", FALSE if not - :rtype: bool - - Determines if a query is of a "write" type (such as - INSERT, UPDATE, DELETE) or "read" type (i.e. SELECT). - - .. php:method:: elapsed_time([$decimals = 6]) - - :param int $decimals: The number of decimal places - :returns: The aggregate query elapsed time, in microseconds - :rtype: string - - Calculate the aggregate query elapsed time. - - .. php:method:: total_queries() - - :returns: The total number of queries executed - :rtype: int - - Returns the total number of queries that have been - executed so far. - - .. php:method:: last_query() - - :returns: The last query executed - :rtype: string - - Returns the last query that was executed. - - .. php:method:: escape($str) - - :param mixed $str: The value to escape, or an array of multiple ones - :returns: The escaped value(s) - :rtype: mixed - - Escapes input data based on type, including boolean and - NULLs. - - .. php:method:: escape_str($str[, $like = FALSE]) - - :param mixed $str: A string value or array of multiple ones - :param bool $like: Whether or not the string will be used in a LIKE condition - :returns: The escaped string(s) - :rtype: mixed - - Escapes string values. - - .. warning:: The returned strings do NOT include quotes - around them. - - .. php:method:: escape_like_str($str) - - :param mixed $str: A string value or array of multiple ones - :returns: The escaped string(s) - :rtype: mixed - - Escape LIKE strings. - - Similar to ``escape_str()``, but will also escape the ``%`` - and ``_`` wildcard characters, so that they don't cause - false-positives in LIKE conditions. - - .. important:: The ``escape_like_str()`` method uses '!' (exclamation mark) - to escape special characters for *LIKE* conditions. Because this - method escapes partial strings that you would wrap in quotes - yourself, it cannot automatically add the ``ESCAPE '!'`` - condition for you, and so you'll have to manually do that. - - - .. php:method:: primary($table) - - :param string $table: Table name - :returns: The primary key name, FALSE if none - :rtype: string - - Retrieves the primary key of a table. - - .. note:: If the database platform does not support primary - key detection, the first column name may be assumed - as the primary key. - - .. php:method:: count_all([$table = '']) - - :param string $table: Table name - :returns: Row count for the specified table - :rtype: int - - Returns the total number of rows in a table, or 0 if no - table was provided. - - .. php:method:: list_tables([$constrain_by_prefix = FALSE]) - - :param bool $constrain_by_prefix: TRUE to match table names by the configured dbprefix - :returns: Array of table names or FALSE on failure - :rtype: array - - Gets a list of the tables in the current database. - - .. php:method:: table_exists($table_name) - - :param string $table_name: The table name - :returns: TRUE if that table exists, FALSE if not - :rtype: bool - - Determine if a particular table exists. - - .. php:method:: list_fields($table) - - :param string $table: The table name - :returns: Array of field names or FALSE on failure - :rtype: array - - Gets a list of the field names in a table. - - .. php:method:: field_exists($field_name, $table_name) - - :param string $table_name: The table name - :param string $field_name: The field name - :returns: TRUE if that field exists in that table, FALSE if not - :rtype: bool - - Determine if a particular field exists. - - .. php:method:: field_data($table) - - :param string $table: The table name - :returns: Array of field data items or FALSE on failure - :rtype: array - - Gets a list containing field data about a table. - - .. php:method:: escape_identifiers($item) - - :param mixed $item: The item or array of items to escape - :returns: The input item(s), escaped - :rtype: mixed - - Escape SQL identifiers, such as column, table and names. - - .. php:method:: insert_string($table, $data) - - :param string $table: The target table - :param array $data: An associative array of key/value pairs - :returns: The SQL INSERT statement, as a string - :rtype: string - - Generate an INSERT statement string. - - .. php:method:: update_string($table, $data, $where) - - :param string $table: The target table - :param array $data: An associative array of key/value pairs - :param mixed $where: The WHERE statement conditions - :returns: The SQL UPDATE statement, as a string - :rtype: string - - Generate an UPDATE statement string. - - .. php:method:: call_function($function) - - :param string $function: Function name - :returns: The function result - :rtype: string - - Runs a native PHP function , using a platform agnostic - wrapper. - - .. php:method:: cache_set_path([$path = '']) - - :param string $path: Path to the cache directory - :rtype: void - - Sets the directory path to use for caching storage. - - .. php:method:: cache_on() - - :returns: TRUE if caching is on, FALSE if not - :rtype: bool - - Enable database results caching. - - .. php:method:: cache_off() - - :returns: TRUE if caching is on, FALSE if not - :rtype: bool - - Disable database results caching. - - .. php:method:: cache_delete([$segment_one = ''[, $segment_two = '']]) - - :param string $segment_one: First URI segment - :param string $segment_two: Second URI segment - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Delete the cache files associated with a particular URI. - - .. php:method:: cache_delete_all() - - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Delete all cache files. - - .. php:method:: close() - - :rtype: void - - Close the DB Connection. - - .. php:method:: display_error([$error = ''[, $swap = ''[, $native = FALSE]]]) - - :param string $error: The error message - :param string $swap: Any "swap" values - :param bool $native: Whether to localize the message - :rtype: void - - :returns: Displays the DB error screensends the application/views/errors/error_db.php template - :rtype: string - - Display an error message and stop script execution. - - The message is displayed using the - *application/views/errors/error_db.php* template. - - .. php:method:: protect_identifiers($item[, $prefix_single = FALSE[, $protect_identifiers = NULL[, $field_exists = TRUE]]]) - - :param string $item: The item to work with - :param bool $prefix_single: Whether to apply the dbprefix even if the input item is a single identifier - :param bool $protect_identifiers: Whether to quote identifiers - :param bool $field_exists: Whether the supplied item contains a field name or not - :returns: The modified item - :rtype: string - - Takes a column or table name (optionally with an alias) - and applies the configured *dbprefix* to it. - - Some logic is necessary in order to deal with - column names that include the path. - - Consider a query like this:: - - SELECT * FROM hostname.database.table.column AS c FROM hostname.database.table - - Or a query with aliasing:: - - SELECT m.member_id, m.member_name FROM members AS m - - Since the column name can include up to four segments - (host, DB, table, column) or also have an alias prefix, - we need to do a bit of work to figure this out and - insert the table prefix (if it exists) in the proper - position, and escape only the correct identifiers. - - This method is used extensively by the Query Builder class.
\ No newline at end of file diff --git a/user_guide_src/source/database/examples.rst b/user_guide_src/source/database/examples.rst deleted file mode 100644 index 5fd7fccfa..000000000 --- a/user_guide_src/source/database/examples.rst +++ /dev/null @@ -1,119 +0,0 @@ -################################## -Database Quick Start: Example Code -################################## - -The following page contains example code showing how the database class -is used. For complete details please read the individual pages -describing each function. - -Initializing the Database Class -=============================== - -The following code loads and initializes the database class based on -your :doc:`configuration <configuration>` settings:: - - $this->load->database(); - -Once loaded the class is ready to be used as described below. - -Note: If all your pages require database access you can connect -automatically. See the :doc:`connecting <connecting>` page for details. - -Standard Query With Multiple Results (Object Version) -===================================================== - -:: - - $query = $this->db->query('SELECT name, title, email FROM my_table'); - - foreach ($query->result() as $row) - { - echo $row->title; - echo $row->name; - echo $row->email; - } - - echo 'Total Results: ' . $query->num_rows(); - -The above result() function returns an array of **objects**. Example: -$row->title - -Standard Query With Multiple Results (Array Version) -==================================================== - -:: - - $query = $this->db->query('SELECT name, title, email FROM my_table'); - - foreach ($query->result_array() as $row) - { - echo $row['title']; - echo $row['name']; - echo $row['email']; - } - -The above result_array() function returns an array of standard array -indexes. Example: $row['title'] - -Standard Query With Single Result -================================= - -:: - - $query = $this->db->query('SELECT name FROM my_table LIMIT 1'); - $row = $query->row(); - echo $row->name; - -The above row() function returns an **object**. Example: $row->name - -Standard Query With Single Result (Array version) -================================================= - -:: - - $query = $this->db->query('SELECT name FROM my_table LIMIT 1'); - $row = $query->row_array(); - echo $row['name']; - -The above row_array() function returns an **array**. Example: -$row['name'] - -Standard Insert -=============== - -:: - - $sql = "INSERT INTO mytable (title, name) VALUES (".$this->db->escape($title).", ".$this->db->escape($name).")"; - $this->db->query($sql); - echo $this->db->affected_rows(); - -Query Builder Query -=================== - -The :doc:`Query Builder Pattern <query_builder>` gives you a simplified -means of retrieving data:: - - $query = $this->db->get('table_name'); - - foreach ($query->result() as $row) - { - echo $row->title; - } - -The above get() function retrieves all the results from the supplied -table. The :doc:`Query Builder <query_builder>` class contains a full -compliment of functions for working with data. - -Query Builder Insert -==================== - -:: - - $data = array( - 'title' => $title, - 'name' => $name, - 'date' => $date - ); - - $this->db->insert('mytable', $data); // Produces: INSERT INTO mytable (title, name, date) VALUES ('{$title}', '{$name}', '{$date}') - diff --git a/user_guide_src/source/database/forge.rst b/user_guide_src/source/database/forge.rst deleted file mode 100644 index 5af4f2248..000000000 --- a/user_guide_src/source/database/forge.rst +++ /dev/null @@ -1,412 +0,0 @@ -#################### -Database Forge Class -#################### - -The Database Forge Class contains methods that help you manage your -database. - -.. contents:: Table of Contents - :depth: 3 - -**************************** -Initializing the Forge Class -**************************** - -.. important:: In order to initialize the Forge class, your database - driver must already be running, since the forge class relies on it. - -Load the Forge Class as follows:: - - $this->load->dbforge() - -You can also pass another database object to the DB Forge loader, in case -the database you want to manage isn't the default one:: - - $this->myforge = $this->load->dbforge($this->other_db, TRUE); - -In the above example, we're passing a custom database object as the first -parameter and then tell it to return the dbforge object, instead of -assigning it directly to ``$this->dbforge``. - -.. note:: Both of the parameters can be used individually, just pass an empty - value as the first one if you wish to skip it. - -Once initialized you will access the methods using the ``$this->dbforge`` -object:: - - $this->dbforge->some_method(); - -******************************* -Creating and Dropping Databases -******************************* - -**$this->dbforge->create_database('db_name')** - -Permits you to create the database specified in the first parameter. -Returns TRUE/FALSE based on success or failure:: - - if ($this->dbforge->create_database('my_db')) - { - echo 'Database created!'; - } - -**$this->dbforge->drop_database('db_name')** - -Permits you to drop the database specified in the first parameter. -Returns TRUE/FALSE based on success or failure:: - - if ($this->dbforge->drop_database('my_db')) - { - echo 'Database deleted!'; - } - - -**************************** -Creating and Dropping Tables -**************************** - -There are several things you may wish to do when creating tables. Add -fields, add keys to the table, alter columns. CodeIgniter provides a -mechanism for this. - -Adding fields -============= - -Fields are created via an associative array. Within the array you must -include a 'type' key that relates to the datatype of the field. For -example, INT, VARCHAR, TEXT, etc. Many datatypes (for example VARCHAR) -also require a 'constraint' key. - -:: - - $fields = array( - 'users' => array( - 'type' => 'VARCHAR', - 'constraint' => '100', - ), - ); - // will translate to "users VARCHAR(100)" when the field is added. - - -Additionally, the following key/values can be used: - -- unsigned/true : to generate "UNSIGNED" in the field definition. -- default/value : to generate a default value in the field definition. -- null/true : to generate "NULL" in the field definition. Without this, - the field will default to "NOT NULL". -- auto_increment/true : generates an auto_increment flag on the - field. Note that the field type must be a type that supports this, - such as integer. -- unique/true : to generate a unique key for the field definition. - -:: - - $fields = array( - 'blog_id' => array( - 'type' => 'INT', - 'constraint' => 5, - 'unsigned' => TRUE, - 'auto_increment' => TRUE - ), - 'blog_title' => array( - 'type' => 'VARCHAR', - 'constraint' => '100', - 'unique' => TRUE, - ), - 'blog_author' => array( - 'type' =>'VARCHAR', - 'constraint' => '100', - 'default' => 'King of Town', - ), - 'blog_description' => array( - 'type' => 'TEXT', - 'null' => TRUE, - ), - ); - - -After the fields have been defined, they can be added using -``$this->dbforge->add_field($fields);`` followed by a call to the -``create_table()`` method. - -**$this->dbforge->add_field()** - -The add fields method will accept the above array. - - -Passing strings as fields -------------------------- - -If you know exactly how you want a field to be created, you can pass the -string into the field definitions with add_field() - -:: - - $this->dbforge->add_field("label varchar(100) NOT NULL DEFAULT 'default label'"); - - -.. note:: Passing raw strings as fields cannot be followed by ``add_key()`` calls on those fields. - -.. note:: Multiple calls to add_field() are cumulative. - -Creating an id field --------------------- - -There is a special exception for creating id fields. A field with type -id will automatically be assigned as an INT(9) auto_incrementing -Primary Key. - -:: - - $this->dbforge->add_field('id'); - // gives id INT(9) NOT NULL AUTO_INCREMENT - - -Adding Keys -=========== - -Generally speaking, you'll want your table to have Keys. This is -accomplished with $this->dbforge->add_key('field'). An optional second -parameter set to TRUE will make it a primary key. Note that add_key() -must be followed by a call to create_table(). - -Multiple column non-primary keys must be sent as an array. Sample output -below is for MySQL. - -:: - - $this->dbforge->add_key('blog_id', TRUE); - // gives PRIMARY KEY `blog_id` (`blog_id`) - - $this->dbforge->add_key('blog_id', TRUE); - $this->dbforge->add_key('site_id', TRUE); - // gives PRIMARY KEY `blog_id_site_id` (`blog_id`, `site_id`) - - $this->dbforge->add_key('blog_name'); - // gives KEY `blog_name` (`blog_name`) - - $this->dbforge->add_key(array('blog_name', 'blog_label')); - // gives KEY `blog_name_blog_label` (`blog_name`, `blog_label`) - - -Creating a table -================ - -After fields and keys have been declared, you can create a new table -with - -:: - - $this->dbforge->create_table('table_name'); - // gives CREATE TABLE table_name - - -An optional second parameter set to TRUE adds an "IF NOT EXISTS" clause -into the definition - -:: - - $this->dbforge->create_table('table_name', TRUE); - // gives CREATE TABLE IF NOT EXISTS table_name - -You could also pass optional table attributes, such as MySQL's ``ENGINE``:: - - $attributes = array('ENGINE' => 'InnoDB'); - $this->dbforge->create_table('table_name', FALSE, $attributes); - // produces: CREATE TABLE `table_name` (...) ENGINE = InnoDB DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci - -.. note:: Unless you specify the ``CHARACTER SET`` and/or ``COLLATE`` attributes, - ``create_table()`` will always add them with your configured *char_set* - and *dbcollat* values, as long as they are not empty (MySQL only). - - -Dropping a table -================ - -Execute a DROP TABLE statement and optionally add an IF EXISTS clause. - -:: - - // Produces: DROP TABLE table_name - $this->dbforge->drop_table('table_name'); - - // Produces: DROP TABLE IF EXISTS table_name - $this->dbforge->drop_table('table_name',TRUE); - - -Renaming a table -================ - -Executes a TABLE rename - -:: - - $this->dbforge->rename_table('old_table_name', 'new_table_name'); - // gives ALTER TABLE old_table_name RENAME TO new_table_name - - -**************** -Modifying Tables -**************** - -Adding a Column to a Table -========================== - -**$this->dbforge->add_column()** - -The ``add_column()`` method is used to modify an existing table. It -accepts the same field array as above, and can be used for an unlimited -number of additional fields. - -:: - - $fields = array( - 'preferences' => array('type' => 'TEXT') - ); - $this->dbforge->add_column('table_name', $fields); - // Executes: ALTER TABLE table_name ADD preferences TEXT - -If you are using MySQL or CUBIRD, then you can take advantage of their -AFTER and FIRST clauses to position the new column. - -Examples:: - - // Will place the new column after the `another_field` column: - $fields = array( - 'preferences' => array('type' => 'TEXT', 'after' => 'another_field') - ); - - // Will place the new column at the start of the table definition: - $fields = array( - 'preferences' => array('type' => 'TEXT', 'first' => TRUE) - ); - - -Dropping a Column From a Table -============================== - -**$this->dbforge->drop_column()** - -Used to remove a column from a table. - -:: - - $this->dbforge->drop_column('table_name', 'column_to_drop'); - - - -Modifying a Column in a Table -============================= - -**$this->dbforge->modify_column()** - -The usage of this method is identical to ``add_column()``, except it -alters an existing column rather than adding a new one. In order to -change the name you can add a "name" key into the field defining array. - -:: - - $fields = array( - 'old_name' => array( - 'name' => 'new_name', - 'type' => 'TEXT', - ), - ); - $this->dbforge->modify_column('table_name', $fields); - // gives ALTER TABLE table_name CHANGE old_name new_name TEXT - - -*************** -Class Reference -*************** - -.. php:class:: CI_DB_forge - - .. php:method:: add_column($table[, $field = array()[, $_after = NULL]]) - - :param string $table: Table name to add the column to - :param array $field: Column definition(s) - :param string $_after: Column for AFTER clause (deprecated) - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Adds a column to a table. Usage: See `Adding a Column to a Table`_. - - .. php:method:: add_field($field) - - :param array $field: Field definition to add - :returns: CI_DB_forge instance (method chaining) - :rtype: CI_DB_forge - - Adds a field to the set that will be used to create a table. Usage: See `Adding fields`_. - - .. php:method:: add_key($key[, $primary = FALSE]) - - :param array $key: Name of a key field - :param bool $primary: Set to TRUE if it should be a primary key or a regular one - :returns: CI_DB_forge instance (method chaining) - :rtype: CI_DB_forge - - Adds a key to the set that will be used to create a table. Usage: See `Adding Keys`_. - - .. php:method:: create_database($db_name) - - :param string $db_name: Name of the database to create - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Creates a new database. Usage: See `Creating and Dropping Databases`_. - - .. php:method:: create_table($table[, $if_not_exists = FALSE[, array $attributes = array()]]) - - :param string $table: Name of the table to create - :param string $if_not_exists: Set to TRUE to add an 'IF NOT EXISTS' clause - :param string $attributes: An associative array of table attributes - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Creates a new table. Usage: See `Creating a table`_. - - .. php:method:: drop_column($table, $column_name) - - :param string $table: Table name - :param array $column_name: The column name to drop - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Drops a column from a table. Usage: See `Dropping a Column From a Table`_. - - .. php:method:: drop_database($db_name) - - :param string $db_name: Name of the database to drop - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Drops a database. Usage: See `Creating and Dropping Databases`_. - - .. php:method:: drop_table($table_name[, $if_exists = FALSE]) - - :param string $table: Name of the table to drop - :param string $if_exists: Set to TRUE to add an 'IF EXISTS' clause - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Drops a table. Usage: See `Dropping a table`_. - - .. php:method:: modify_column($table, $field) - - :param string $table: Table name - :param array $field: Column definition(s) - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Modifies a table column. Usage: See `Modifying a Column in a Table`_. - - .. php:method:: rename_table($table_name, $new_table_name) - - :param string $table: Current of the table - :param string $new_table_name: New name of the table - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Renames a table. Usage: See `Renaming a table`_. diff --git a/user_guide_src/source/database/helpers.rst b/user_guide_src/source/database/helpers.rst deleted file mode 100644 index 2d997a9e0..000000000 --- a/user_guide_src/source/database/helpers.rst +++ /dev/null @@ -1,100 +0,0 @@ -#################### -Query Helper Methods -#################### - -Information From Executing a Query -================================== - -**$this->db->insert_id()** - -The insert ID number when performing database inserts. - -.. note:: If using the PDO driver with PostgreSQL, or using the Interbase - driver, this function requires a $name parameter, which specifies the - appropriate sequence to check for the insert id. - -**$this->db->affected_rows()** - -Displays the number of affected rows, when doing "write" type queries -(insert, update, etc.). - -.. note:: In MySQL "DELETE FROM TABLE" returns 0 affected rows. The database - class has a small hack that allows it to return the correct number of - affected rows. By default this hack is enabled but it can be turned off - in the database driver file. - -**$this->db->last_query()** - -Returns the last query that was run (the query string, not the result). -Example:: - - $str = $this->db->last_query(); - - // Produces: SELECT * FROM sometable.... - - -.. note:: Disabling the **save_queries** setting in your database - configuration will render this function useless. - -Information About Your Database -=============================== - -**$this->db->count_all()** - -Permits you to determine the number of rows in a particular table. -Submit the table name in the first parameter. Example:: - - echo $this->db->count_all('my_table'); - - // Produces an integer, like 25 - -**$this->db->platform()** - -Outputs the database platform you are running (MySQL, MS SQL, Postgres, -etc...):: - - echo $this->db->platform(); - -**$this->db->version()** - -Outputs the database version you are running:: - - echo $this->db->version(); - -Making Your Queries Easier -========================== - -**$this->db->insert_string()** - -This function simplifies the process of writing database inserts. It -returns a correctly formatted SQL insert string. Example:: - - $data = array('name' => $name, 'email' => $email, 'url' => $url); - - $str = $this->db->insert_string('table_name', $data); - -The first parameter is the table name, the second is an associative -array with the data to be inserted. The above example produces:: - - INSERT INTO table_name (name, email, url) VALUES ('Rick', 'rick@example.com', 'example.com') - -.. note:: Values are automatically escaped, producing safer queries. - -**$this->db->update_string()** - -This function simplifies the process of writing database updates. It -returns a correctly formatted SQL update string. Example:: - - $data = array('name' => $name, 'email' => $email, 'url' => $url); - - $where = "author_id = 1 AND status = 'active'"; - - $str = $this->db->update_string('table_name', $data, $where); - -The first parameter is the table name, the second is an associative -array with the data to be updated, and the third parameter is the -"where" clause. The above example produces:: - - UPDATE table_name SET name = 'Rick', email = 'rick@example.com', url = 'example.com' WHERE author_id = 1 AND status = 'active' - -.. note:: Values are automatically escaped, producing safer queries.
\ No newline at end of file diff --git a/user_guide_src/source/database/index.rst b/user_guide_src/source/database/index.rst deleted file mode 100644 index 2fb50f9be..000000000 --- a/user_guide_src/source/database/index.rst +++ /dev/null @@ -1,25 +0,0 @@ -################## -Database Reference -################## - -CodeIgniter comes with a full-featured and very fast abstracted database -class that supports both traditional structures and Query Builder -patterns. The database functions offer clear, simple syntax. - -.. toctree:: - :titlesonly: - - Quick Start: Usage Examples <examples> - Database Configuration <configuration> - Connecting to a Database <connecting> - Running Queries <queries> - Generating Query Results <results> - Query Helper Functions <helpers> - Query Builder Class <query_builder> - Transactions <transactions> - Getting MetaData <metadata> - Custom Function Calls <call_function> - Query Caching <caching> - Database Manipulation with Database Forge <forge> - Database Utilities Class <utilities> - Database Driver Reference <db_driver_reference>
\ No newline at end of file diff --git a/user_guide_src/source/database/metadata.rst b/user_guide_src/source/database/metadata.rst deleted file mode 100644 index b8be809b6..000000000 --- a/user_guide_src/source/database/metadata.rst +++ /dev/null @@ -1,130 +0,0 @@ -################# -Database Metadata -################# - -************** -Table MetaData -************** - -These functions let you fetch table information. - -List the Tables in Your Database -================================ - -**$this->db->list_tables();** - -Returns an array containing the names of all the tables in the database -you are currently connected to. Example:: - - $tables = $this->db->list_tables(); - - foreach ($tables as $table) - { - echo $table; - } - - -Determine If a Table Exists -=========================== - -**$this->db->table_exists();** - -Sometimes it's helpful to know whether a particular table exists before -running an operation on it. Returns a boolean TRUE/FALSE. Usage example:: - - if ($this->db->table_exists('table_name')) - { - // some code... - } - -.. note:: Replace *table_name* with the name of the table you are looking for. - - -************** -Field MetaData -************** - -List the Fields in a Table -========================== - -**$this->db->list_fields()** - -Returns an array containing the field names. This query can be called -two ways: - -1. You can supply the table name and call it from the $this->db-> -object:: - - $fields = $this->db->list_fields('table_name'); - - foreach ($fields as $field) - { - echo $field; - } - -2. You can gather the field names associated with any query you run by -calling the function from your query result object:: - - $query = $this->db->query('SELECT * FROM some_table'); - - foreach ($query->list_fields() as $field) - { - echo $field; - } - - -Determine If a Field is Present in a Table -========================================== - -**$this->db->field_exists()** - -Sometimes it's helpful to know whether a particular field exists before -performing an action. Returns a boolean TRUE/FALSE. Usage example:: - - if ($this->db->field_exists('field_name', 'table_name')) - { - // some code... - } - -.. note:: Replace *field_name* with the name of the column you are looking - for, and replace *table_name* with the name of the table you are - looking for. - - -Retrieve Field Metadata -======================= - -**$this->db->field_data()** - -Returns an array of objects containing field information. - -Sometimes it's helpful to gather the field names or other metadata, like -the column type, max length, etc. - -.. note:: Not all databases provide meta-data. - -Usage example:: - - $fields = $this->db->field_data('table_name'); - - foreach ($fields as $field) - { - echo $field->name; - echo $field->type; - echo $field->max_length; - echo $field->primary_key; - } - -If you have run a query already you can use the result object instead of -supplying the table name:: - - $query = $this->db->query("YOUR QUERY"); - $fields = $query->field_data(); - -The following data is available from this function if supported by your -database: - -- name - column name -- max_length - maximum length of the column -- primary_key - 1 if the column is a primary key -- type - the type of the column diff --git a/user_guide_src/source/database/queries.rst b/user_guide_src/source/database/queries.rst deleted file mode 100644 index 710ababb0..000000000 --- a/user_guide_src/source/database/queries.rst +++ /dev/null @@ -1,176 +0,0 @@ -####### -Queries -####### - -************ -Query Basics -************ - -Regular Queries -=============== - -To submit a query, use the **query** function:: - - $this->db->query('YOUR QUERY HERE'); - -The query() function returns a database result **object** when "read" -type queries are run, which you can use to :doc:`show your -results <results>`. When "write" type queries are run it simply -returns TRUE or FALSE depending on success or failure. When retrieving -data you will typically assign the query to your own variable, like -this:: - - $query = $this->db->query('YOUR QUERY HERE'); - -Simplified Queries -================== - -The **simple_query** method is a simplified version of the -$this->db->query() method. It DOES -NOT return a database result set, nor does it set the query timer, or -compile bind data, or store your query for debugging. It simply lets you -submit a query. Most users will rarely use this function. - -It returns whatever the database drivers' "execute" function returns. -That typically is TRUE/FALSE on success or failure for write type queries -such as INSERT, DELETE or UPDATE statements (which is what it really -should be used for) and a resource/object on success for queries with -fetchable results. - -:: - - if ($this->db->simple_query('YOUR QUERY')) - { - echo "Success!"; - } - else - { - echo "Query failed!"; - } - -.. note:: PostgreSQL's ``pg_exec()`` function (for example) always - returns a resource on success, even for write type queries. - So take that in mind if you're looking for a boolean value. - -*************************************** -Working with Database prefixes manually -*************************************** - -If you have configured a database prefix and would like to prepend it to -a table name for use in a native SQL query for example, then you can use -the following:: - - $this->db->dbprefix('tablename'); // outputs prefix_tablename - - -If for any reason you would like to change the prefix programatically -without needing to create a new connection, you can use this method:: - - $this->db->set_dbprefix('newprefix_'); - $this->db->dbprefix('tablename'); // outputs newprefix_tablename - - -********************** -Protecting identifiers -********************** - -In many databases it is advisable to protect table and field names - for -example with backticks in MySQL. **Query Builder queries are -automatically protected**, however if you need to manually protect an -identifier you can use:: - - $this->db->protect_identifiers('table_name'); - -.. important:: Although the Query Builder will try its best to properly - quote any field and table names that you feed it, note that it - is NOT designed to work with arbitrary user input. DO NOT feed it - with unsanitized user data. - -This function will also add a table prefix to your table, assuming you -have a prefix specified in your database config file. To enable the -prefixing set TRUE (boolean) via the second parameter:: - - $this->db->protect_identifiers('table_name', TRUE); - - -**************** -Escaping Queries -**************** - -It's a very good security practice to escape your data before submitting -it into your database. CodeIgniter has three methods that help you do -this: - -#. **$this->db->escape()** This function determines the data type so - that it can escape only string data. It also automatically adds - single quotes around the data so you don't have to: - :: - - $sql = "INSERT INTO table (title) VALUES(".$this->db->escape($title).")"; - -#. **$this->db->escape_str()** This function escapes the data passed to - it, regardless of type. Most of the time you'll use the above - function rather than this one. Use the function like this: - :: - - $sql = "INSERT INTO table (title) VALUES('".$this->db->escape_str($title)."')"; - -#. **$this->db->escape_like_str()** This method should be used when - strings are to be used in LIKE conditions so that LIKE wildcards - ('%', '\_') in the string are also properly escaped. - -:: - - $search = '20% raise'; - $sql = "SELECT id FROM table WHERE column LIKE '%" . - $this->db->escape_like_str($search)."%' ESCAPE '!'"; - -.. important:: The ``escape_like_str()`` method uses '!' (exclamation mark) - to escape special characters for *LIKE* conditions. Because this - method escapes partial strings that you would wrap in quotes - yourself, it cannot automatically add the ``ESCAPE '!'`` - condition for you, and so you'll have to manually do that. - - -************** -Query Bindings -************** - -Bindings enable you to simplify your query syntax by letting the system -put the queries together for you. Consider the following example:: - - $sql = "SELECT * FROM some_table WHERE id = ? AND status = ? AND author = ?"; - $this->db->query($sql, array(3, 'live', 'Rick')); - -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 -you. - -*************** -Handling Errors -*************** - -**$this->db->error();** - -If you need to get the last error that has occurred, the error() method -will return an array containing its code and message. Here's a quick -example:: - - if ( ! $this->db->simple_query('SELECT `example_field` FROM `example_table`')) - { - $error = $this->db->error(); // Has keys 'code' and 'message' - } - diff --git a/user_guide_src/source/database/query_builder.rst b/user_guide_src/source/database/query_builder.rst deleted file mode 100644 index 38bc7fcff..000000000 --- a/user_guide_src/source/database/query_builder.rst +++ /dev/null @@ -1,1570 +0,0 @@ -################### -Query Builder Class -################### - -CodeIgniter gives you access to a Query Builder class. This pattern -allows information to be retrieved, inserted, and updated in your -database with minimal scripting. In some cases only one or two lines -of code are necessary to perform a database action. -CodeIgniter does not require that each database table be its own class -file. It instead provides a more simplified interface. - -Beyond simplicity, a major benefit to using the Query Builder features -is that it allows you to create database independent applications, since -the query syntax is generated by each database adapter. It also allows -for safer queries, since the values are escaped automatically by the -system. - -.. note:: If you intend to write your own queries you can disable this - class in your database config file, allowing the core database library - and adapter to utilize fewer resources. - -.. contents:: - :local: - :depth: 1 - -************** -Selecting Data -************** - -The following functions allow you to build SQL **SELECT** statements. - -**$this->db->get()** - -Runs the selection query and returns the result. Can be used by itself -to retrieve all records from a table:: - - $query = $this->db->get('mytable'); // Produces: SELECT * FROM mytable - -The second and third parameters enable you to set a limit and offset -clause:: - - $query = $this->db->get('mytable', 10, 20); - - // Executes: SELECT * FROM mytable LIMIT 20, 10 - // (in MySQL. Other databases have slightly different syntax) - -You'll notice that the above function is assigned to a variable named -$query, which can be used to show the results:: - - $query = $this->db->get('mytable'); - - foreach ($query->result() as $row) - { - echo $row->title; - } - -Please visit the :doc:`result functions <results>` page for a full -discussion regarding result generation. - -**$this->db->get_compiled_select()** - -Compiles the selection query just like **$this->db->get()** but does not *run* -the query. This method simply returns the SQL query as a string. - -Example:: - - $sql = $this->db->get_compiled_select('mytable'); - echo $sql; - - // Prints string: SELECT * FROM mytable - -The second parameter enables you to set whether or not the query builder query -will be reset (by default it will be reset, just like when using `$this->db->get()`):: - - echo $this->db->limit(10,20)->get_compiled_select('mytable', FALSE); - - // Prints string: SELECT * FROM mytable LIMIT 20, 10 - // (in MySQL. Other databases have slightly different syntax) - - echo $this->db->select('title, content, date')->get_compiled_select(); - - // Prints string: SELECT title, content, date FROM mytable LIMIT 20, 10 - -The key thing to notice in the above example is that the second query did not -utilize **$this->db->from()** and did not pass a table name into the first -parameter. The reason for this outcome is because the query has not been -executed using **$this->db->get()** which resets values or reset directly -using **$this->db->reset_query()**. - -**$this->db->get_where()** - -Identical to the above function except that it permits you to add a -"where" clause in the second parameter, instead of using the db->where() -function:: - - $query = $this->db->get_where('mytable', array('id' => $id), $limit, $offset); - -Please read the about the where function below for more information. - -.. note:: get_where() was formerly known as getwhere(), which has been removed - -**$this->db->select()** - -Permits you to write the SELECT portion of your query:: - - $this->db->select('title, content, date'); - $query = $this->db->get('mytable'); - - // Executes: SELECT title, content, date FROM mytable - -.. note:: If you are selecting all (\*) from a table you do not need to - use this function. When omitted, CodeIgniter assumes that you wish - to select all fields and automatically adds 'SELECT \*'. - -``$this->db->select()`` accepts an optional second parameter. If you set it -to FALSE, CodeIgniter will not try to protect your field or table names. -This is useful if you need a compound select statement where automatic -escaping of fields may break them. - -:: - - $this->db->select('(SELECT SUM(payments.amount) FROM payments WHERE payments.invoice_id=4) AS amount_paid', FALSE); - $query = $this->db->get('mytable'); - -**$this->db->select_max()** - -Writes a ``SELECT MAX(field)`` portion for your query. You can optionally -include a second parameter to rename the resulting field. - -:: - - $this->db->select_max('age'); - $query = $this->db->get('members'); // Produces: SELECT MAX(age) as age FROM members - - $this->db->select_max('age', 'member_age'); - $query = $this->db->get('members'); // Produces: SELECT MAX(age) as member_age FROM members - - -**$this->db->select_min()** - -Writes a "SELECT MIN(field)" portion for your query. As with -select_max(), You can optionally include a second parameter to rename -the resulting field. - -:: - - $this->db->select_min('age'); - $query = $this->db->get('members'); // Produces: SELECT MIN(age) as age FROM members - - -**$this->db->select_avg()** - -Writes a "SELECT AVG(field)" portion for your query. As with -select_max(), You can optionally include a second parameter to rename -the resulting field. - -:: - - $this->db->select_avg('age'); - $query = $this->db->get('members'); // Produces: SELECT AVG(age) as age FROM members - - -**$this->db->select_sum()** - -Writes a "SELECT SUM(field)" portion for your query. As with -select_max(), You can optionally include a second parameter to rename -the resulting field. - -:: - - $this->db->select_sum('age'); - $query = $this->db->get('members'); // Produces: SELECT SUM(age) as age FROM members - -**$this->db->from()** - -Permits you to write the FROM portion of your query:: - - $this->db->select('title, content, date'); - $this->db->from('mytable'); - $query = $this->db->get(); // Produces: SELECT title, content, date FROM mytable - -.. note:: As shown earlier, the FROM portion of your query can be specified - in the $this->db->get() function, so use whichever method you prefer. - -**$this->db->join()** - -Permits you to write the JOIN portion of your query:: - - $this->db->select('*'); - $this->db->from('blogs'); - $this->db->join('comments', 'comments.id = blogs.id'); - $query = $this->db->get(); - - // Produces: - // SELECT * FROM blogs JOIN comments ON comments.id = blogs.id - -Multiple function calls can be made if you need several joins in one -query. - -If you need a specific type of JOIN you can specify it via the third -parameter of the function. Options are: left, right, outer, inner, left -outer, and right outer. - -:: - - $this->db->join('comments', 'comments.id = blogs.id', 'left'); - // Produces: LEFT JOIN comments ON comments.id = blogs.id - -************************* -Looking for Specific Data -************************* - -**$this->db->where()** - -This function enables you to set **WHERE** clauses using one of four -methods: - -.. note:: All values passed to this function are escaped automatically, - producing safer queries. - -#. **Simple key/value method:** - - :: - - $this->db->where('name', $name); // Produces: WHERE name = 'Joe' - - Notice that the equal sign is added for you. - - If you use multiple function calls they will be chained together with - AND between them: - - :: - - $this->db->where('name', $name); - $this->db->where('title', $title); - $this->db->where('status', $status); - // WHERE name = 'Joe' AND title = 'boss' AND status = 'active' - -#. **Custom key/value method:** - - You can include an operator in the first parameter in order to - control the comparison: - - :: - - $this->db->where('name !=', $name); - $this->db->where('id <', $id); // Produces: WHERE name != 'Joe' AND id < 45 - -#. **Associative array method:** - - :: - - $array = array('name' => $name, 'title' => $title, 'status' => $status); - $this->db->where($array); - // Produces: WHERE name = 'Joe' AND title = 'boss' AND status = 'active' - - You can include your own operators using this method as well: - - :: - - $array = array('name !=' => $name, 'id <' => $id, 'date >' => $date); - $this->db->where($array); - -#. **Custom string:** - You can write your own clauses manually:: - - $where = "name='Joe' AND status='boss' OR status='active'"; - $this->db->where($where); - - -``$this->db->where()`` accepts an optional third parameter. If you set it to -FALSE, CodeIgniter will not try to protect your field or table names. - -:: - - $this->db->where('MATCH (field) AGAINST ("value")', NULL, FALSE); - -**$this->db->or_where()** - -This function is identical to the one above, except that multiple -instances are joined by OR:: - - $this->db->where('name !=', $name); - $this->db->or_where('id >', $id); // Produces: WHERE name != 'Joe' OR id > 50 - -.. note:: or_where() was formerly known as orwhere(), which has been - removed. - -**$this->db->where_in()** - -Generates a WHERE field IN ('item', 'item') SQL query joined with AND if -appropriate - -:: - - $names = array('Frank', 'Todd', 'James'); - $this->db->where_in('username', $names); - // Produces: WHERE username IN ('Frank', 'Todd', 'James') - - -**$this->db->or_where_in()** - -Generates a WHERE field IN ('item', 'item') SQL query joined with OR if -appropriate - -:: - - $names = array('Frank', 'Todd', 'James'); - $this->db->or_where_in('username', $names); - // Produces: OR username IN ('Frank', 'Todd', 'James') - -**$this->db->where_not_in()** - -Generates a WHERE field NOT IN ('item', 'item') SQL query joined with -AND if appropriate - -:: - - $names = array('Frank', 'Todd', 'James'); - $this->db->where_not_in('username', $names); - // Produces: WHERE username NOT IN ('Frank', 'Todd', 'James') - - -**$this->db->or_where_not_in()** - -Generates a WHERE field NOT IN ('item', 'item') SQL query joined with OR -if appropriate - -:: - - $names = array('Frank', 'Todd', 'James'); - $this->db->or_where_not_in('username', $names); - // Produces: OR username NOT IN ('Frank', 'Todd', 'James') - -************************ -Looking for Similar Data -************************ - -**$this->db->like()** - -This method enables you to generate **LIKE** clauses, useful for doing -searches. - -.. note:: All values passed to this method are escaped automatically. - -#. **Simple key/value method:** - - :: - - $this->db->like('title', 'match'); - // Produces: WHERE `title` LIKE '%match%' ESCAPE '!' - - If you use multiple method calls they will be chained together with - AND between them:: - - $this->db->like('title', 'match'); - $this->db->like('body', 'match'); - // WHERE `title` LIKE '%match%' ESCAPE '!' AND `body` LIKE '%match% ESCAPE '!' - - If you want to control where the wildcard (%) is placed, you can use - an optional third argument. Your options are 'before', 'after' and - 'both' (which is the default). - - :: - - $this->db->like('title', 'match', 'before'); // Produces: WHERE `title` LIKE '%match' ESCAPE '!' - $this->db->like('title', 'match', 'after'); // Produces: WHERE `title` LIKE 'match%' ESCAPE '!' - $this->db->like('title', 'match', 'both'); // Produces: WHERE `title` LIKE '%match%' ESCAPE '!' - -#. **Associative array method:** - - :: - - $array = array('title' => $match, 'page1' => $match, 'page2' => $match); - $this->db->like($array); - // WHERE `title` LIKE '%match%' ESCAPE '!' AND `page1` LIKE '%match%' ESCAPE '!' AND `page2` LIKE '%match%' ESCAPE '!' - - -**$this->db->or_like()** - -This method is identical to the one above, except that multiple -instances are joined by OR:: - - $this->db->like('title', 'match'); $this->db->or_like('body', $match); - // WHERE `title` LIKE '%match%' ESCAPE '!' OR `body` LIKE '%match%' ESCAPE '!' - -.. note:: ``or_like()`` was formerly known as ``orlike()``, which has been removed. - -**$this->db->not_like()** - -This method is identical to ``like()``, except that it generates -NOT LIKE statements:: - - $this->db->not_like('title', 'match'); // WHERE `title` NOT LIKE '%match% ESCAPE '!' - -**$this->db->or_not_like()** - -This method is identical to ``not_like()``, except that multiple -instances are joined by OR:: - - $this->db->like('title', 'match'); - $this->db->or_not_like('body', 'match'); - // WHERE `title` LIKE '%match% OR `body` NOT LIKE '%match%' ESCAPE '!' - -**$this->db->group_by()** - -Permits you to write the GROUP BY portion of your query:: - - $this->db->group_by("title"); // Produces: GROUP BY title - -You can also pass an array of multiple values as well:: - - $this->db->group_by(array("title", "date")); // Produces: GROUP BY title, date - -.. note:: group_by() was formerly known as groupby(), which has been - removed. - -**$this->db->distinct()** - -Adds the "DISTINCT" keyword to a query - -:: - - $this->db->distinct(); - $this->db->get('table'); // Produces: SELECT DISTINCT * FROM table - -**$this->db->having()** - -Permits you to write the HAVING portion of your query. There are 2 -possible syntaxes, 1 argument or 2:: - - $this->db->having('user_id = 45'); // Produces: HAVING user_id = 45 - $this->db->having('user_id', 45); // Produces: HAVING user_id = 45 - -You can also pass an array of multiple values as well:: - - $this->db->having(array('title =' => 'My Title', 'id <' => $id)); - // Produces: HAVING title = 'My Title', id < 45 - - -If you are using a database that CodeIgniter escapes queries for, you -can prevent escaping content by passing an optional third argument, and -setting it to FALSE. - -:: - - $this->db->having('user_id', 45); // Produces: HAVING `user_id` = 45 in some databases such as MySQL - $this->db->having('user_id', 45, FALSE); // Produces: HAVING user_id = 45 - - -**$this->db->or_having()** - -Identical to having(), only separates multiple clauses with "OR". - -**************** -Ordering results -**************** - -**$this->db->order_by()** - -Lets you set an ORDER BY clause. - -The first parameter contains the name of the column you would like to order by. - -The second parameter lets you set the direction of the result. -Options are **ASC**, **DESC** AND **RANDOM**. - -:: - - $this->db->order_by('title', 'DESC'); - // Produces: ORDER BY `title` DESC - -You can also pass your own string in the first parameter:: - - $this->db->order_by('title DESC, name ASC'); - // Produces: ORDER BY `title` DESC, `name` ASC - -Or multiple function calls can be made if you need multiple fields. - -:: - - $this->db->order_by('title', 'DESC'); - $this->db->order_by('name', 'ASC'); - // Produces: ORDER BY `title` DESC, `name` ASC - -If you choose the **RANDOM** direction option, then the first parameters will -be ignored, unless you specify a numeric seed value. - -:: - - $this->db->order_by('title', 'RANDOM'); - // Produces: ORDER BY RAND() - - $this->db->order_by(42, 'RANDOM'); - // Produces: ORDER BY RAND(42) - -.. note:: order_by() was formerly known as orderby(), which has been - removed. - -.. note:: Random ordering is not currently supported in Oracle and - will default to ASC instead. - -**************************** -Limiting or Counting Results -**************************** - -**$this->db->limit()** - -Lets you limit the number of rows you would like returned by the query:: - - $this->db->limit(10); // Produces: LIMIT 10 - -The second parameter lets you set a result offset. - -:: - - $this->db->limit(10, 20); // Produces: LIMIT 20, 10 (in MySQL. Other databases have slightly different syntax) - -**$this->db->count_all_results()** - -Permits you to determine the number of rows in a particular Active -Record query. Queries will accept Query Builder restrictors such as -``where()``, ``or_where()``, ``like()``, ``or_like()``, etc. Example:: - - echo $this->db->count_all_results('my_table'); // Produces an integer, like 25 - $this->db->like('title', 'match'); - $this->db->from('my_table'); - echo $this->db->count_all_results(); // Produces an integer, like 17 - -However, this method also resets any field values that you may have passed -to ``select()``. If you need to keep them, you can pass ``FALSE`` as the -second parameter:: - - echo $this->db->count_all_results('my_table', FALSE); - -**$this->db->count_all()** - -Permits you to determine the number of rows in a particular table. -Submit the table name in the first parameter. Example:: - - echo $this->db->count_all('my_table'); // Produces an integer, like 25 - -************** -Query grouping -************** - -Query grouping allows you to create groups of WHERE clauses by enclosing them in parentheses. This will allow -you to create queries with complex WHERE clauses. Nested groups are supported. Example:: - - $this->db->select('*')->from('my_table') - ->group_start() - ->where('a', 'a') - ->or_group_start() - ->where('b', 'b') - ->where('c', 'c') - ->group_end() - ->group_end() - ->where('d', 'd') - ->get(); - - // Generates: - // SELECT * FROM (`my_table`) WHERE ( `a` = 'a' OR ( `b` = 'b' AND `c` = 'c' ) ) AND `d` = 'd' - -.. note:: groups need to be balanced, make sure every group_start() is matched by a group_end(). - -**$this->db->group_start()** - -Starts a new group by adding an opening parenthesis to the WHERE clause of the query. - -**$this->db->or_group_start()** - -Starts a new group by adding an opening parenthesis to the WHERE clause of the query, prefixing it with 'OR'. - -**$this->db->not_group_start()** - -Starts a new group by adding an opening parenthesis to the WHERE clause of the query, prefixing it with 'NOT'. - -**$this->db->or_not_group_start()** - -Starts a new group by adding an opening parenthesis to the WHERE clause of the query, prefixing it with 'OR NOT'. - -**$this->db->group_end()** - -Ends the current group by adding an closing parenthesis to the WHERE clause of the query. - -************** -Inserting Data -************** - -**$this->db->insert()** - -Generates an insert string based on the data you supply, and runs the -query. You can either pass an **array** or an **object** to the -function. Here is an example using an array:: - - $data = array( - 'title' => 'My title', - 'name' => 'My Name', - 'date' => 'My date' - ); - - $this->db->insert('mytable', $data); - // Produces: INSERT INTO mytable (title, name, date) VALUES ('My title', 'My name', 'My date') - -The first parameter will contain the table name, the second is an -associative array of values. - -Here is an example using an object:: - - /* - class Myclass { - public $title = 'My Title'; - public $content = 'My Content'; - public $date = 'My Date'; - } - */ - - $object = new Myclass; - $this->db->insert('mytable', $object); - // Produces: INSERT INTO mytable (title, content, date) VALUES ('My Title', 'My Content', 'My Date') - -The first parameter will contain the table name, the second is an -object. - -.. note:: All values are escaped automatically producing safer queries. - -**$this->db->get_compiled_insert()** - -Compiles the insertion query just like $this->db->insert() but does not -*run* the query. This method simply returns the SQL query as a string. - -Example:: - - $data = array( - 'title' => 'My title', - 'name' => 'My Name', - 'date' => 'My date' - ); - - $sql = $this->db->set($data)->get_compiled_insert('mytable'); - echo $sql; - - // Produces string: INSERT INTO mytable (`title`, `name`, `date`) VALUES ('My title', 'My name', 'My date') - -The second parameter enables you to set whether or not the query builder query -will be reset (by default it will be--just like $this->db->insert()):: - - echo $this->db->set('title', 'My Title')->get_compiled_insert('mytable', FALSE); - - // Produces string: INSERT INTO mytable (`title`) VALUES ('My Title') - - echo $this->db->set('content', 'My Content')->get_compiled_insert(); - - // Produces string: INSERT INTO mytable (`title`, `content`) VALUES ('My Title', 'My Content') - -The key thing to notice in the above example is that the second query did not -utilize `$this->db->from()` nor did it pass a table name into the first -parameter. The reason this worked is because the query has not been executed -using `$this->db->insert()` which resets values or reset directly using -`$this->db->reset_query()`. - -.. note:: This method doesn't work for batched inserts. - -**$this->db->insert_batch()** - -Generates an insert string based on the data you supply, and runs the -query. You can either pass an **array** or an **object** to the -function. Here is an example using an array:: - - $data = array( - array( - 'title' => 'My title', - 'name' => 'My Name', - 'date' => 'My date' - ), - array( - 'title' => 'Another title', - 'name' => 'Another Name', - 'date' => 'Another date' - ) - ); - - $this->db->insert_batch('mytable', $data); - // Produces: INSERT INTO mytable (title, name, date) VALUES ('My title', 'My name', 'My date'), ('Another title', 'Another name', 'Another date') - -The first parameter will contain the table name, the second is an -associative array of values. - -.. note:: All values are escaped automatically producing safer queries. - -************* -Updating Data -************* - -**$this->db->replace()** - -This method executes a REPLACE statement, which is basically the SQL -standard for (optional) DELETE + INSERT, using *PRIMARY* and *UNIQUE* -keys as the determining factor. -In our case, it will save you from the need to implement complex -logics with different combinations of ``select()``, ``update()``, -``delete()`` and ``insert()`` calls. - -Example:: - - $data = array( - 'title' => 'My title', - 'name' => 'My Name', - 'date' => 'My date' - ); - - $this->db->replace('table', $data); - - // Executes: REPLACE INTO mytable (title, name, date) VALUES ('My title', 'My name', 'My date') - -In the above example, if we assume that the *title* field is our primary -key, then if a row containing 'My title' as the *title* value, that row -will be deleted with our new row data replacing it. - -Usage of the ``set()`` method is also allowed and all fields are -automatically escaped, just like with ``insert()``. - -**$this->db->set()** - -This function enables you to set values for inserts or updates. - -**It can be used instead of passing a data array directly to the insert -or update functions:** - -:: - - $this->db->set('name', $name); - $this->db->insert('mytable'); // Produces: INSERT INTO mytable (`name`) VALUES ('{$name}') - -If you use multiple function called they will be assembled properly -based on whether you are doing an insert or an update:: - - $this->db->set('name', $name); - $this->db->set('title', $title); - $this->db->set('status', $status); - $this->db->insert('mytable'); - -**set()** will also accept an optional third parameter (``$escape``), that -will prevent data from being escaped if set to FALSE. To illustrate the -difference, here is ``set()`` used both with and without the escape -parameter. - -:: - - $this->db->set('field', 'field+1', FALSE); - $this->db->where('id', 2); - $this->db->update('mytable'); // gives UPDATE mytable SET field = field+1 WHERE id = 2 - - $this->db->set('field', 'field+1'); - $this->db->where('id', 2); - $this->db->update('mytable'); // gives UPDATE `mytable` SET `field` = 'field+1' WHERE `id` = 2 - -You can also pass an associative array to this function:: - - $array = array( - 'name' => $name, - 'title' => $title, - 'status' => $status - ); - - $this->db->set($array); - $this->db->insert('mytable'); - -Or an object:: - - /* - class Myclass { - public $title = 'My Title'; - public $content = 'My Content'; - public $date = 'My Date'; - } - */ - - $object = new Myclass; - $this->db->set($object); - $this->db->insert('mytable'); - -**$this->db->update()** - -Generates an update string and runs the query based on the data you -supply. You can pass an **array** or an **object** to the function. Here -is an example using an array:: - - $data = array( - 'title' => $title, - 'name' => $name, - 'date' => $date - ); - - $this->db->where('id', $id); - $this->db->update('mytable', $data); - // Produces: - // - // UPDATE mytable - // SET title = '{$title}', name = '{$name}', date = '{$date}' - // WHERE id = $id - -Or you can supply an object:: - - /* - class Myclass { - public $title = 'My Title'; - public $content = 'My Content'; - public $date = 'My Date'; - } - */ - - $object = new Myclass; - $this->db->where('id', $id); - $this->db->update('mytable', $object); - // Produces: - // - // UPDATE `mytable` - // SET `title` = '{$title}', `name` = '{$name}', `date` = '{$date}' - // WHERE id = `$id` - -.. note:: All values are escaped automatically producing safer queries. - -You'll notice the use of the $this->db->where() function, enabling you -to set the WHERE clause. You can optionally pass this information -directly into the update function as a string:: - - $this->db->update('mytable', $data, "id = 4"); - -Or as an array:: - - $this->db->update('mytable', $data, array('id' => $id)); - -You may also use the $this->db->set() function described above when -performing updates. - -**$this->db->update_batch()** - -Generates an update string based on the data you supply, and runs the query. -You can either pass an **array** or an **object** to the function. -Here is an example using an array:: - - $data = array( - array( - 'title' => 'My title' , - 'name' => 'My Name 2' , - 'date' => 'My date 2' - ), - array( - 'title' => 'Another title' , - 'name' => 'Another Name 2' , - 'date' => 'Another date 2' - ) - ); - - $this->db->update_batch('mytable', $data, 'title'); - - // Produces: - // UPDATE `mytable` SET `name` = CASE - // WHEN `title` = 'My title' THEN 'My Name 2' - // WHEN `title` = 'Another title' THEN 'Another Name 2' - // ELSE `name` END, - // `date` = CASE - // WHEN `title` = 'My title' THEN 'My date 2' - // WHEN `title` = 'Another title' THEN 'Another date 2' - // ELSE `date` END - // WHERE `title` IN ('My title','Another title') - -The first parameter will contain the table name, the second is an associative -array of values, the third parameter is the where key. - -.. note:: All values are escaped automatically producing safer queries. - -.. note:: ``affected_rows()`` won't give you proper results with this method, - due to the very nature of how it works. Instead, ``update_batch()`` - returns the number of rows affected. - -**$this->db->get_compiled_update()** - -This works exactly the same way as ``$this->db->get_compiled_insert()`` except -that it produces an UPDATE SQL string instead of an INSERT SQL string. - -For more information view documentation for `$this->db->get_compiled_insert()`. - -.. note:: This method doesn't work for batched updates. - -************* -Deleting Data -************* - -**$this->db->delete()** - -Generates a delete SQL string and runs the query. - -:: - - $this->db->delete('mytable', array('id' => $id)); // Produces: // DELETE FROM mytable // WHERE id = $id - -The first parameter is the table name, the second is the where clause. -You can also use the where() or or_where() functions instead of passing -the data to the second parameter of the function:: - - $this->db->where('id', $id); - $this->db->delete('mytable'); - - // Produces: - // DELETE FROM mytable - // WHERE id = $id - - -An array of table names can be passed into delete() if you would like to -delete data from more than 1 table. - -:: - - $tables = array('table1', 'table2', 'table3'); - $this->db->where('id', '5'); - $this->db->delete($tables); - - -If you want to delete all data from a table, you can use the truncate() -function, or empty_table(). - -**$this->db->empty_table()** - -Generates a delete SQL string and runs the -query.:: - - $this->db->empty_table('mytable'); // Produces: DELETE FROM mytable - -**$this->db->truncate()** - -Generates a truncate SQL string and runs the query. - -:: - - $this->db->from('mytable'); - $this->db->truncate(); - - // or - - $this->db->truncate('mytable'); - - // Produce: - // TRUNCATE mytable - -.. note:: If the TRUNCATE command isn't available, truncate() will - execute as "DELETE FROM table". - -**$this->db->get_compiled_delete()** - -This works exactly the same way as ``$this->db->get_compiled_insert()`` except -that it produces a DELETE SQL string instead of an INSERT SQL string. - -For more information view documentation for $this->db->get_compiled_insert(). - -*************** -Method Chaining -*************** - -Method chaining allows you to simplify your syntax by connecting -multiple functions. Consider this example:: - - $query = $this->db->select('title') - ->where('id', $id) - ->limit(10, 20) - ->get('mytable'); - -.. _ar-caching: - -********************* -Query Builder Caching -********************* - -While not "true" caching, Query Builder enables you to save (or "cache") -certain parts of your queries for reuse at a later point in your -script's execution. Normally, when an Query Builder call is completed, -all stored information is reset for the next call. With caching, you can -prevent this reset, and reuse information easily. - -Cached calls are cumulative. If you make 2 cached select() calls, and -then 2 uncached select() calls, this will result in 4 select() calls. -There are three Caching functions available: - -**$this->db->start_cache()** - -This function must be called to begin caching. All Query Builder queries -of the correct type (see below for supported queries) are stored for -later use. - -**$this->db->stop_cache()** - -This function can be called to stop caching. - -**$this->db->flush_cache()** - -This function deletes all items from the Query Builder cache. - -An example of caching ---------------------- - -Here's a usage example:: - - $this->db->start_cache(); - $this->db->select('field1'); - $this->db->stop_cache(); - $this->db->get('tablename'); - //Generates: SELECT `field1` FROM (`tablename`) - - $this->db->select('field2'); - $this->db->get('tablename'); - //Generates: SELECT `field1`, `field2` FROM (`tablename`) - - $this->db->flush_cache(); - $this->db->select('field2'); - $this->db->get('tablename'); - //Generates: SELECT `field2` FROM (`tablename`) - - -.. note:: The following statements can be cached: select, from, join, - where, like, group_by, having, order_by - - -*********************** -Resetting Query Builder -*********************** - -**$this->db->reset_query()** - -Resetting Query Builder allows you to start fresh with your query without -executing it first using a method like $this->db->get() or $this->db->insert(). -Just like the methods that execute a query, this will *not* reset items you've -cached using `Query Builder Caching`_. - -This is useful in situations where you are using Query Builder to generate SQL -(ex. ``$this->db->get_compiled_select()``) but then choose to, for instance, -run the query:: - - // Note that the second parameter of the get_compiled_select method is FALSE - $sql = $this->db->select(array('field1','field2')) - ->where('field3',5) - ->get_compiled_select('mytable', FALSE); - - // ... - // Do something crazy with the SQL code... like add it to a cron script for - // later execution or something... - // ... - - $data = $this->db->get()->result_array(); - - // Would execute and return an array of results of the following query: - // SELECT field1, field1 from mytable where field3 = 5; - -.. note:: Double calls to ``get_compiled_select()`` while you're using the - Query Builder Caching functionality and NOT resetting your queries - will results in the cache being merged twice. That in turn will - i.e. if you're caching a ``select()`` - select the same field twice. - -*************** -Class Reference -*************** - -.. php:class:: CI_DB_query_builder - - .. php:method:: reset_query() - - :returns: CI_DB_query_builder instance (method chaining) - :rtype: CI_DB_query_builder - - Resets the current Query Builder state. Useful when you want - to build a query that can be cancelled under certain conditions. - - .. php:method:: start_cache() - - :returns: CI_DB_query_builder instance (method chaining) - :rtype: CI_DB_query_builder - - Starts the Query Builder cache. - - .. php:method:: stop_cache() - - :returns: CI_DB_query_builder instance (method chaining) - :rtype: CI_DB_query_builder - - Stops the Query Builder cache. - - .. php:method:: flush_cache() - - :returns: CI_DB_query_builder instance (method chaining) - :rtype: CI_DB_query_builder - - Empties the Query Builder cache. - - .. php:method:: set_dbprefix([$prefix = '']) - - :param string $prefix: The new prefix to use - :returns: The DB prefix in use - :rtype: string - - Sets the database prefix, without having to reconnect. - - .. php:method:: dbprefix([$table = '']) - - :param string $table: The table name to prefix - :returns: The prefixed table name - :rtype: string - - Prepends a database prefix, if one exists in configuration. - - .. php:method:: count_all_results([$table = '', [$reset = TRUE]]) - - :param string $table: Table name - :param bool $reset: Whether to reset values for SELECTs - :returns: Number of rows in the query result - :rtype: int - - Generates a platform-specific query string that counts - all records returned by an Query Builder query. - - .. php:method:: get([$table = ''[, $limit = NULL[, $offset = NULL]]]) - - :param string $table: The table to query - :param int $limit: The LIMIT clause - :param int $offset: The OFFSET clause - :returns: CI_DB_result instance (method chaining) - :rtype: CI_DB_result - - Compiles and runs SELECT statement based on the already - called Query Builder methods. - - .. php:method:: get_where([$table = ''[, $where = NULL[, $limit = NULL[, $offset = NULL]]]]) - - :param mixed $table: The table(s) to fetch data from; string or array - :param string $where: The WHERE clause - :param int $limit: The LIMIT clause - :param int $offset: The OFFSET clause - :returns: CI_DB_result instance (method chaining) - :rtype: CI_DB_result - - Same as ``get()``, but also allows the WHERE to be added directly. - - .. php:method:: select([$select = '*'[, $escape = NULL]]) - - :param string $select: The SELECT portion of a query - :param bool $escape: Whether to escape values and identifiers - :returns: CI_DB_query_builder instance (method chaining) - :rtype: CI_DB_query_builder - - Adds a SELECT clause to a query. - - .. php:method:: select_avg([$select = ''[, $alias = '']]) - - :param string $select: Field to compute the average of - :param string $alias: Alias for the resulting value name - :returns: CI_DB_query_builder instance (method chaining) - :rtype: CI_DB_query_builder - - Adds a SELECT AVG(field) clause to a query. - - .. php:method:: select_max([$select = ''[, $alias = '']]) - - :param string $select: Field to compute the maximum of - :param string $alias: Alias for the resulting value name - :returns: CI_DB_query_builder instance (method chaining) - :rtype: CI_DB_query_builder - - Adds a SELECT MAX(field) clause to a query. - - .. php:method:: select_min([$select = ''[, $alias = '']]) - - :param string $select: Field to compute the minimum of - :param string $alias: Alias for the resulting value name - :returns: CI_DB_query_builder instance (method chaining) - :rtype: CI_DB_query_builder - - Adds a SELECT MIN(field) clause to a query. - - .. php:method:: select_sum([$select = ''[, $alias = '']]) - - :param string $select: Field to compute the sum of - :param string $alias: Alias for the resulting value name - :returns: CI_DB_query_builder instance (method chaining) - :rtype: CI_DB_query_builder - - Adds a SELECT SUM(field) clause to a query. - - .. php:method:: distinct([$val = TRUE]) - - :param bool $val: Desired value of the "distinct" flag - :returns: CI_DB_query_builder instance (method chaining) - :rtype: CI_DB_query_builder - - Sets a flag which tells the query builder to add - a DISTINCT clause to the SELECT portion of the query. - - .. php:method:: from($from) - - :param mixed $from: Table name(s); string or array - :returns: CI_DB_query_builder instance (method chaining) - :rtype: CI_DB_query_builder - - Specifies the FROM clause of a query. - - .. php:method:: join($table, $cond[, $type = ''[, $escape = NULL]]) - - :param string $table: Table name to join - :param string $cond: The JOIN ON condition - :param string $type: The JOIN type - :param bool $escape: Whether to escape values and identifiers - :returns: CI_DB_query_builder instance (method chaining) - :rtype: CI_DB_query_builder - - Adds a JOIN clause to a query. - - .. php:method:: where($key[, $value = NULL[, $escape = NULL]]) - - :param mixed $key: Name of field to compare, or associative array - :param mixed $value: If a single key, compared to this value - :param bool $escape: Whether to escape values and identifiers - :returns: DB_query_builder instance - :rtype: object - - Generates the WHERE portion of the query. - Separates multiple calls with 'AND'. - - .. php:method:: or_where($key[, $value = NULL[, $escape = NULL]]) - - :param mixed $key: Name of field to compare, or associative array - :param mixed $value: If a single key, compared to this value - :param bool $escape: Whether to escape values and identifiers - :returns: DB_query_builder instance - :rtype: object - - Generates the WHERE portion of the query. - Separates multiple calls with 'OR'. - - .. php:method:: or_where_in([$key = NULL[, $values = NULL[, $escape = NULL]]]) - - :param string $key: The field to search - :param array $values: The values searched on - :param bool $escape: Whether to escape values and identifiers - :returns: DB_query_builder instance - :rtype: object - - Generates a WHERE field IN('item', 'item') SQL query, - joined with 'OR' if appropriate. - - .. php:method:: or_where_not_in([$key = NULL[, $values = NULL[, $escape = NULL]]]) - - :param string $key: The field to search - :param array $values: The values searched on - :param bool $escape: Whether to escape values and identifiers - :returns: DB_query_builder instance - :rtype: object - - Generates a WHERE field NOT IN('item', 'item') SQL query, - joined with 'OR' if appropriate. - - .. php:method:: where_in([$key = NULL[, $values = NULL[, $escape = NULL]]]) - - :param string $key: Name of field to examine - :param array $values: Array of target values - :param bool $escape: Whether to escape values and identifiers - :returns: DB_query_builder instance - :rtype: object - - Generates a WHERE field IN('item', 'item') SQL query, - joined with 'AND' if appropriate. - - .. php:method:: where_not_in([$key = NULL[, $values = NULL[, $escape = NULL]]]) - - :param string $key: Name of field to examine - :param array $values: Array of target values - :param bool $escape: Whether to escape values and identifiers - :returns: DB_query_builder instance - :rtype: object - - Generates a WHERE field NOT IN('item', 'item') SQL query, - joined with 'AND' if appropriate. - - .. php:method:: group_start() - - :returns: CI_DB_query_builder instance (method chaining) - :rtype: CI_DB_query_builder - - Starts a group expression, using ANDs for the conditions inside it. - - .. php:method:: or_group_start() - - :returns: CI_DB_query_builder instance (method chaining) - :rtype: CI_DB_query_builder - - Starts a group expression, using ORs for the conditions inside it. - - .. php:method:: not_group_start() - - :returns: CI_DB_query_builder instance (method chaining) - :rtype: CI_DB_query_builder - - Starts a group expression, using AND NOTs for the conditions inside it. - - .. php:method:: or_not_group_start() - - :returns: CI_DB_query_builder instance (method chaining) - :rtype: CI_DB_query_builder - - Starts a group expression, using OR NOTs for the conditions inside it. - - .. php:method:: group_end() - - :returns: DB_query_builder instance - :rtype: object - - Ends a group expression. - - .. php:method:: like($field[, $match = ''[, $side = 'both'[, $escape = NULL]]]) - - :param string $field: Field name - :param string $match: Text portion to match - :param string $side: Which side of the expression to put the '%' wildcard on - :param bool $escape: Whether to escape values and identifiers - :returns: CI_DB_query_builder instance (method chaining) - :rtype: CI_DB_query_builder - - Adds a LIKE clause to a query, separating multiple calls with AND. - - .. php:method:: or_like($field[, $match = ''[, $side = 'both'[, $escape = NULL]]]) - - :param string $field: Field name - :param string $match: Text portion to match - :param string $side: Which side of the expression to put the '%' wildcard on - :param bool $escape: Whether to escape values and identifiers - :returns: CI_DB_query_builder instance (method chaining) - :rtype: CI_DB_query_builder - - Adds a LIKE clause to a query, separating multiple class with OR. - - .. php:method:: not_like($field[, $match = ''[, $side = 'both'[, $escape = NULL]]]) - - :param string $field: Field name - :param string $match: Text portion to match - :param string $side: Which side of the expression to put the '%' wildcard on - :param bool $escape: Whether to escape values and identifiers - :returns: CI_DB_query_builder instance (method chaining) - :rtype: CI_DB_query_builder - - Adds a NOT LIKE clause to a query, separating multiple calls with AND. - - .. php:method:: or_not_like($field[, $match = ''[, $side = 'both'[, $escape = NULL]]]) - - :param string $field: Field name - :param string $match: Text portion to match - :param string $side: Which side of the expression to put the '%' wildcard on - :param bool $escape: Whether to escape values and identifiers - :returns: CI_DB_query_builder instance (method chaining) - :rtype: CI_DB_query_builder - - Adds a NOT LIKE clause to a query, separating multiple calls with OR. - - .. php:method:: having($key[, $value = NULL[, $escape = NULL]]) - - :param mixed $key: Identifier (string) or associative array of field/value pairs - :param string $value: Value sought if $key is an identifier - :param string $escape: Whether to escape values and identifiers - :returns: CI_DB_query_builder instance (method chaining) - :rtype: CI_DB_query_builder - - Adds a HAVING clause to a query, separating multiple calls with AND. - - .. php:method:: or_having($key[, $value = NULL[, $escape = NULL]]) - - :param mixed $key: Identifier (string) or associative array of field/value pairs - :param string $value: Value sought if $key is an identifier - :param string $escape: Whether to escape values and identifiers - :returns: CI_DB_query_builder instance (method chaining) - :rtype: CI_DB_query_builder - - Adds a HAVING clause to a query, separating multiple calls with OR. - - .. php:method:: group_by($by[, $escape = NULL]) - - :param mixed $by: Field(s) to group by; string or array - :returns: CI_DB_query_builder instance (method chaining) - :rtype: CI_DB_query_builder - - Adds a GROUP BY clause to a query. - - .. php:method:: order_by($orderby[, $direction = ''[, $escape = NULL]]) - - :param string $orderby: Field to order by - :param string $direction: The order requested - ASC, DESC or random - :param bool $escape: Whether to escape values and identifiers - :returns: CI_DB_query_builder instance (method chaining) - :rtype: CI_DB_query_builder - - Adds an ORDER BY clause to a query. - - .. php:method:: limit($value[, $offset = 0]) - - :param int $value: Number of rows to limit the results to - :param int $offset: Number of rows to skip - :returns: CI_DB_query_builder instance (method chaining) - :rtype: CI_DB_query_builder - - Adds LIMIT and OFFSET clauses to a query. - - .. php:method:: offset($offset) - - :param int $offset: Number of rows to skip - :returns: CI_DB_query_builder instance (method chaining) - :rtype: CI_DB_query_builder - - Adds an OFFSET clause to a query. - - .. php:method:: set($key[, $value = ''[, $escape = NULL]]) - - :param mixed $key: Field name, or an array of field/value pairs - :param string $value: Field value, if $key is a single field - :param bool $escape: Whether to escape values and identifiers - :returns: CI_DB_query_builder instance (method chaining) - :rtype: CI_DB_query_builder - - Adds field/value pairs to be passed later to ``insert()``, - ``update()`` or ``replace()``. - - .. php:method:: insert([$table = ''[, $set = NULL[, $escape = NULL]]]) - - :param string $table: Table name - :param array $set: An associative array of field/value pairs - :param bool $escape: Whether to escape values and identifiers - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Compiles and executes an INSERT statement. - - .. php:method:: insert_batch($table[, $set = NULL[, $escape = NULL[, $batch_size = 100]]]) - - :param string $table: Table name - :param array $set: Data to insert - :param bool $escape: Whether to escape values and identifiers - :param int $batch_size: Count of rows to insert at once - :returns: Number of rows inserted or FALSE on failure - :rtype: mixed - - Compiles and executes batch ``INSERT`` statements. - - .. note:: When more than ``$batch_size`` rows are provided, multiple - ``INSERT`` queries will be executed, each trying to insert - up to ``$batch_size`` rows. - - .. php:method:: set_insert_batch($key[, $value = ''[, $escape = NULL]]) - - :param mixed $key: Field name or an array of field/value pairs - :param string $value: Field value, if $key is a single field - :param bool $escape: Whether to escape values and identifiers - :returns: CI_DB_query_builder instance (method chaining) - :rtype: CI_DB_query_builder - - Adds field/value pairs to be inserted in a table later via ``insert_batch()``. - - .. php:method:: update([$table = ''[, $set = NULL[, $where = NULL[, $limit = NULL]]]]) - - :param string $table: Table name - :param array $set: An associative array of field/value pairs - :param string $where: The WHERE clause - :param int $limit: The LIMIT clause - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Compiles and executes an UPDATE statement. - - .. php:method:: update_batch($table[, $set = NULL[, $value = NULL[, $batch_size = 100]]]) - - :param string $table: Table name - :param array $set: Field name, or an associative array of field/value pairs - :param string $value: Field value, if $set is a single field - :param int $batch_size: Count of conditions to group in a single query - :returns: Number of rows updated or FALSE on failure - :rtype: mixed - - Compiles and executes batch ``UPDATE`` statements. - - .. note:: When more than ``$batch_size`` field/value pairs are provided, - multiple queries will be executed, each handling up to - ``$batch_size`` field/value pairs. - - .. php:method:: set_update_batch($key[, $value = ''[, $escape = NULL]]) - - :param mixed $key: Field name or an array of field/value pairs - :param string $value: Field value, if $key is a single field - :param bool $escape: Whether to escape values and identifiers - :returns: CI_DB_query_builder instance (method chaining) - :rtype: CI_DB_query_builder - - Adds field/value pairs to be updated in a table later via ``update_batch()``. - - .. php:method:: replace([$table = ''[, $set = NULL]]) - - :param string $table: Table name - :param array $set: An associative array of field/value pairs - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Compiles and executes a REPLACE statement. - - .. php:method:: delete([$table = ''[, $where = ''[, $limit = NULL[, $reset_data = TRUE]]]]) - - :param mixed $table: The table(s) to delete from; string or array - :param string $where: The WHERE clause - :param int $limit: The LIMIT clause - :param bool $reset_data: TRUE to reset the query "write" clause - :returns: CI_DB_query_builder instance (method chaining) or FALSE on failure - :rtype: mixed - - Compiles and executes a DELETE query. - - .. php:method:: truncate([$table = '']) - - :param string $table: Table name - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Executes a TRUNCATE statement on a table. - - .. note:: If the database platform in use doesn't support TRUNCATE, - a DELETE statement will be used instead. - - .. php:method:: empty_table([$table = '']) - - :param string $table: Table name - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Deletes all records from a table via a DELETE statement. - - .. php:method:: get_compiled_select([$table = ''[, $reset = TRUE]]) - - :param string $table: Table name - :param bool $reset: Whether to reset the current QB values or not - :returns: The compiled SQL statement as a string - :rtype: string - - Compiles a SELECT statement and returns it as a string. - - .. php:method:: get_compiled_insert([$table = ''[, $reset = TRUE]]) - - :param string $table: Table name - :param bool $reset: Whether to reset the current QB values or not - :returns: The compiled SQL statement as a string - :rtype: string - - Compiles an INSERT statement and returns it as a string. - - .. php:method:: get_compiled_update([$table = ''[, $reset = TRUE]]) - - :param string $table: Table name - :param bool $reset: Whether to reset the current QB values or not - :returns: The compiled SQL statement as a string - :rtype: string - - Compiles an UPDATE statement and returns it as a string. - - .. php:method:: get_compiled_delete([$table = ''[, $reset = TRUE]]) - - :param string $table: Table name - :param bool $reset: Whether to reset the current QB values or not - :returns: The compiled SQL statement as a string - :rtype: string - - Compiles a DELETE statement and returns it as a string. diff --git a/user_guide_src/source/database/results.rst b/user_guide_src/source/database/results.rst deleted file mode 100644 index 6fea7c6be..000000000 --- a/user_guide_src/source/database/results.rst +++ /dev/null @@ -1,507 +0,0 @@ -######################## -Generating Query Results -######################## - -There are several ways to generate query results: - -.. contents:: - :local: - :depth: 2 - -************* -Result Arrays -************* - -**result()** - -This method returns the query result as an array of **objects**, or -**an empty array** on failure. Typically you'll use this in a foreach -loop, like this:: - - $query = $this->db->query("YOUR QUERY"); - - foreach ($query->result() as $row) - { - echo $row->title; - echo $row->name; - echo $row->body; - } - -The above method is an alias of ``result_object()``. - -You can also pass a string to ``result()`` which represents a class to -instantiate for each result object (note: this class must be loaded) - -:: - - $query = $this->db->query("SELECT * FROM users;"); - - foreach ($query->result('User') as $user) - { - echo $user->name; // access attributes - echo $user->reverse_name(); // or methods defined on the 'User' class - } - -**result_array()** - -This method returns the query result as a pure array, or an empty -array when no result is produced. Typically you'll use this in a foreach -loop, like this:: - - $query = $this->db->query("YOUR QUERY"); - - foreach ($query->result_array() as $row) - { - echo $row['title']; - echo $row['name']; - echo $row['body']; - } - -*********** -Result Rows -*********** - -**row()** - -This method returns a single result row. If your query has more than -one row, it returns only the first row. The result is returned as an -**object**. Here's a usage example:: - - $query = $this->db->query("YOUR QUERY"); - - $row = $query->row(); - - if (isset($row)) - { - echo $row->title; - echo $row->name; - echo $row->body; - } - -If you want a specific row returned you can submit the row number as a -digit in the first parameter:: - - $row = $query->row(5); - -You can also add a second String parameter, which is the name of a class -to instantiate the row with:: - - $query = $this->db->query("SELECT * FROM users LIMIT 1;"); - $row = $query->row(0, 'User'); - - echo $row->name; // access attributes - echo $row->reverse_name(); // or methods defined on the 'User' class - -**row_array()** - -Identical to the above ``row()`` method, except it returns an array. -Example:: - - $query = $this->db->query("YOUR QUERY"); - - $row = $query->row_array(); - - if (isset($row)) - { - echo $row['title']; - echo $row['name']; - echo $row['body']; - } - -If you want a specific row returned you can submit the row number as a -digit in the first parameter:: - - $row = $query->row_array(5); - -In addition, you can walk forward/backwards/first/last through your -results using these variations: - - | **$row = $query->first_row()** - | **$row = $query->last_row()** - | **$row = $query->next_row()** - | **$row = $query->previous_row()** - -By default they return an object unless you put the word "array" in the -parameter: - - | **$row = $query->first_row('array')** - | **$row = $query->last_row('array')** - | **$row = $query->next_row('array')** - | **$row = $query->previous_row('array')** - -.. note:: All the methods above will load the whole result into memory - (prefetching). Use ``unbuffered_row()`` for processing large - result sets. - -**unbuffered_row()** - -This method returns a single result row without prefetching the whole -result in memory as ``row()`` does. If your query has more than one row, -it returns the current row and moves the internal data pointer ahead. - -:: - - $query = $this->db->query("YOUR QUERY"); - - while ($row = $query->unbuffered_row()) - { - echo $row->title; - echo $row->name; - echo $row->body; - } - -You can optionally pass 'object' (default) or 'array' in order to specify -the returned value's type:: - - $query->unbuffered_row(); // object - $query->unbuffered_row('object'); // object - $query->unbuffered_row('array'); // associative array - -********************* -Custom Result Objects -********************* - -You can have the results returned as an instance of a custom class instead -of a ``stdClass`` or array, as the ``result()`` and ``result_array()`` -methods allow. This requires that the class is already loaded into memory. -The object will have all values returned from the database set as properties. -If these have been declared and are non-public then you should provide a -``__set()`` method to allow them to be set. - -Example:: - - class User { - - public $id; - public $email; - public $username; - - protected $last_login; - - public function last_login($format) - { - return $this->last_login->format($format); - } - - public function __set($name, $value) - { - if ($name === 'last_login') - { - $this->last_login = DateTime::createFromFormat('U', $value); - } - } - - public function __get($name) - { - if (isset($this->$name)) - { - return $this->$name; - } - } - } - -In addition to the two methods listed below, the following methods also can -take a class name to return the results as: ``first_row()``, ``last_row()``, -``next_row()``, and ``previous_row()``. - -**custom_result_object()** - -Returns the entire result set as an array of instances of the class requested. -The only parameter is the name of the class to instantiate. - -Example:: - - $query = $this->db->query("YOUR QUERY"); - - $rows = $query->custom_result_object('User'); - - foreach ($rows as $row) - { - echo $row->id; - echo $row->email; - echo $row->last_login('Y-m-d'); - } - -**custom_row_object()** - -Returns a single row from your query results. The first parameter is the row -number of the results. The second parameter is the class name to instantiate. - -Example:: - - $query = $this->db->query("YOUR QUERY"); - - $row = $query->custom_row_object(0, 'User'); - - if (isset($row)) - { - echo $row->email; // access attributes - echo $row->last_login('Y-m-d'); // access class methods - } - -You can also use the ``row()`` method in exactly the same way. - -Example:: - - $row = $query->custom_row_object(0, 'User'); - -********************* -Result Helper Methods -********************* - -**num_rows()** - -The number of rows returned by the query. Note: In this example, $query -is the variable that the query result object is assigned to:: - - $query = $this->db->query('SELECT * FROM my_table'); - - echo $query->num_rows(); - -.. note:: Not all database drivers have a native way of getting the total - number of rows for a result set. When this is the case, all of - the data is prefetched and ``count()`` is manually called on the - resulting array in order to achieve the same result. - -**num_fields()** - -The number of FIELDS (columns) returned by the query. Make sure to call -the method using your query result object:: - - $query = $this->db->query('SELECT * FROM my_table'); - - echo $query->num_fields(); - -**free_result()** - -It frees the memory associated with the result and deletes the result -resource ID. Normally PHP frees its memory automatically at the end of -script execution. However, if you are running a lot of queries in a -particular script you might want to free the result after each query -result has been generated in order to cut down on memory consumption. - -Example:: - - $query = $this->db->query('SELECT title FROM my_table'); - - foreach ($query->result() as $row) - { - echo $row->title; - } - - $query->free_result(); // The $query result object will no longer be available - - $query2 = $this->db->query('SELECT name FROM some_table'); - - $row = $query2->row(); - echo $row->name; - $query2->free_result(); // The $query2 result object will no longer be available - -**data_seek()** - -This method sets the internal pointer for the next result row to be -fetched. It is only useful in combination with ``unbuffered_row()``. - -It accepts a positive integer value, which defaults to 0 and returns -TRUE on success or FALSE on failure. - -:: - - $query = $this->db->query('SELECT `field_name` FROM `table_name`'); - $query->data_seek(5); // Skip the first 5 rows - $row = $query->unbuffered_row(); - -.. note:: Not all database drivers support this feature and will return FALSE. - Most notably - you won't be able to use it with PDO. - -*************** -Class Reference -*************** - -.. php:class:: CI_DB_result - - .. php:method:: result([$type = 'object']) - - :param string $type: Type of requested results - array, object, or class name - :returns: Array containing the fetched rows - :rtype: array - - A wrapper for the ``result_array()``, ``result_object()`` - and ``custom_result_object()`` methods. - - Usage: see `Result Arrays`_. - - .. php:method:: result_array() - - :returns: Array containing the fetched rows - :rtype: array - - Returns the query results as an array of rows, where each - row is itself an associative array. - - Usage: see `Result Arrays`_. - - .. php:method:: result_object() - - :returns: Array containing the fetched rows - :rtype: array - - Returns the query results as an array of rows, where each - row is an object of type ``stdClass``. - - Usage: see `Result Arrays`_. - - .. php:method:: custom_result_object($class_name) - - :param string $class_name: Class name for the resulting rows - :returns: Array containing the fetched rows - :rtype: array - - Returns the query results as an array of rows, where each - row is an instance of the specified class. - - .. php:method:: row([$n = 0[, $type = 'object']]) - - :param int $n: Index of the query results row to be returned - :param string $type: Type of the requested result - array, object, or class name - :returns: The requested row or NULL if it doesn't exist - :rtype: mixed - - A wrapper for the ``row_array()``, ``row_object() and - ``custom_row_object()`` methods. - - Usage: see `Result Rows`_. - - .. php:method:: unbuffered_row([$type = 'object']) - - :param string $type: Type of the requested result - array, object, or class name - :returns: Next row from the result set or NULL if it doesn't exist - :rtype: mixed - - Fetches the next result row and returns it in the - requested form. - - Usage: see `Result Rows`_. - - .. php:method:: row_array([$n = 0]) - - :param int $n: Index of the query results row to be returned - :returns: The requested row or NULL if it doesn't exist - :rtype: array - - Returns the requested result row as an associative array. - - Usage: see `Result Rows`_. - - .. php:method:: row_object([$n = 0]) - - :param int $n: Index of the query results row to be returned - :returns: The requested row or NULL if it doesn't exist - :rtype: stdClass - - Returns the requested result row as an object of type - ``stdClass``. - - Usage: see `Result Rows`_. - - .. php:method:: custom_row_object($n, $type) - - :param int $n: Index of the results row to return - :param string $class_name: Class name for the resulting row - :returns: The requested row or NULL if it doesn't exist - :rtype: $type - - Returns the requested result row as an instance of the - requested class. - - .. php:method:: data_seek([$n = 0]) - - :param int $n: Index of the results row to be returned next - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Moves the internal results row pointer to the desired offset. - - Usage: see `Result Helper Methods`_. - - .. php:method:: set_row($key[, $value = NULL]) - - :param mixed $key: Column name or array of key/value pairs - :param mixed $value: Value to assign to the column, $key is a single field name - :rtype: void - - Assigns a value to a particular column. - - .. php:method:: next_row([$type = 'object']) - - :param string $type: Type of the requested result - array, object, or class name - :returns: Next row of result set, or NULL if it doesn't exist - :rtype: mixed - - Returns the next row from the result set. - - .. php:method:: previous_row([$type = 'object']) - - :param string $type: Type of the requested result - array, object, or class name - :returns: Previous row of result set, or NULL if it doesn't exist - :rtype: mixed - - Returns the previous row from the result set. - - .. php:method:: first_row([$type = 'object']) - - :param string $type: Type of the requested result - array, object, or class name - :returns: First row of result set, or NULL if it doesn't exist - :rtype: mixed - - Returns the first row from the result set. - - .. php:method:: last_row([$type = 'object']) - - :param string $type: Type of the requested result - array, object, or class name - :returns: Last row of result set, or NULL if it doesn't exist - :rtype: mixed - - Returns the last row from the result set. - - .. php:method:: num_rows() - - :returns: Number of rows in the result set - :rtype: int - - Returns the number of rows in the result set. - - Usage: see `Result Helper Methods`_. - - .. php:method:: num_fields() - - :returns: Number of fields in the result set - :rtype: int - - Returns the number of fields in the result set. - - Usage: see `Result Helper Methods`_. - - .. php:method:: field_data() - - :returns: Array containing field meta-data - :rtype: array - - Generates an array of ``stdClass`` objects containing - field meta-data. - - .. php:method:: free_result() - - :rtype: void - - Frees a result set. - - Usage: see `Result Helper Methods`_. - - .. php:method:: list_fields() - - :returns: Array of column names - :rtype: array - - Returns an array containing the field names in the - result set. diff --git a/user_guide_src/source/database/transactions.rst b/user_guide_src/source/database/transactions.rst deleted file mode 100644 index cfd6a566d..000000000 --- a/user_guide_src/source/database/transactions.rst +++ /dev/null @@ -1,127 +0,0 @@ -############ -Transactions -############ - -CodeIgniter's database abstraction allows you to use transactions with -databases that support transaction-safe table types. In MySQL, you'll -need to be running InnoDB or BDB table types rather than the more common -MyISAM. Most other database platforms support transactions natively. - -If you are not familiar with transactions we recommend you find a good -online resource to learn about them for your particular database. The -information below assumes you have a basic understanding of -transactions. - -CodeIgniter's Approach to Transactions -====================================== - -CodeIgniter utilizes an approach to transactions that is very similar to -the process used by the popular database class ADODB. We've chosen that -approach because it greatly simplifies the process of running -transactions. In most cases all that is required are two lines of code. - -Traditionally, transactions have required a fair amount of work to -implement since they demand that you keep track of your queries and -determine whether to commit or rollback based on the success or failure -of your queries. This is particularly cumbersome with nested queries. In -contrast, we've implemented a smart transaction system that does all -this for you automatically (you can also manage your transactions -manually if you choose to, but there's really no benefit). - -Running Transactions -==================== - -To run your queries using transactions you will use the -$this->db->trans_start() and $this->db->trans_complete() functions as -follows:: - - $this->db->trans_start(); - $this->db->query('AN SQL QUERY...'); - $this->db->query('ANOTHER QUERY...'); - $this->db->query('AND YET ANOTHER QUERY...'); - $this->db->trans_complete(); - -You can run as many queries as you want between the start/complete -functions and they will all be committed or rolled back based on success -or failure of any given query. - -Strict Mode -=========== - -By default CodeIgniter runs all transactions in Strict Mode. When strict -mode is enabled, if you are running multiple groups of transactions, if -one group fails all groups will be rolled back. If strict mode is -disabled, each group is treated independently, meaning a failure of one -group will not affect any others. - -Strict Mode can be disabled as follows:: - - $this->db->trans_strict(FALSE); - -Managing Errors -=============== - -If you have error reporting enabled in your config/database.php file -you'll see a standard error message if the commit was unsuccessful. If -debugging is turned off, you can manage your own errors like this:: - - $this->db->trans_start(); - $this->db->query('AN SQL QUERY...'); - $this->db->query('ANOTHER QUERY...'); - $this->db->trans_complete(); - - if ($this->db->trans_status() === FALSE) - { - // generate an error... or use the log_message() function to log your error - } - -Disabling Transactions -====================== - -If you would like to disable transactions you can do so using -``$this->db->trans_off()``:: - - $this->db->trans_off(); - - $this->db->trans_start(); - $this->db->query('AN SQL QUERY...'); - $this->db->trans_complete(); - -When transactions are disabled, your queries will be auto-committed, just as -they are when running queries without transactions, practically ignoring -any calls to ``trans_start()``, ``trans_complete()``, etc. - -Test Mode -========= - -You can optionally put the transaction system into "test mode", which -will cause your queries to be rolled back -- even if the queries produce -a valid result. To use test mode simply set the first parameter in the -$this->db->trans_start() function to TRUE:: - - $this->db->trans_start(TRUE); // Query will be rolled back - $this->db->query('AN SQL QUERY...'); - $this->db->trans_complete(); - -Running Transactions Manually -============================= - -If you would like to run transactions manually you can do so as follows:: - - $this->db->trans_begin(); - - $this->db->query('AN SQL QUERY...'); - $this->db->query('ANOTHER QUERY...'); - $this->db->query('AND YET ANOTHER QUERY...'); - - if ($this->db->trans_status() === FALSE) - { - $this->db->trans_rollback(); - } - else - { - $this->db->trans_commit(); - } - -.. note:: Make sure to use $this->db->trans_begin() when running manual - transactions, **NOT** $this->db->trans_start(). diff --git a/user_guide_src/source/database/utilities.rst b/user_guide_src/source/database/utilities.rst deleted file mode 100644 index 114291f85..000000000 --- a/user_guide_src/source/database/utilities.rst +++ /dev/null @@ -1,316 +0,0 @@ -###################### -Database Utility Class -###################### - -The Database Utility Class contains methods that help you manage your -database. - -.. contents:: - :local: - :depth: 2 - -****************************** -Initializing the Utility Class -****************************** - -.. important:: In order to initialize the Utility class, your database - driver must already be running, since the utilities class relies on it. - -Load the Utility Class as follows:: - - $this->load->dbutil(); - -You can also pass another database object to the DB Utility loader, in case -the database you want to manage isn't the default one:: - - $this->myutil = $this->load->dbutil($this->other_db, TRUE); - -In the above example, we're passing a custom database object as the first -parameter and then tell it to return the dbutil object, instead of -assigning it directly to ``$this->dbutil``. - -.. note:: Both of the parameters can be used individually, just pass an empty - value as the first one if you wish to skip it. - -Once initialized you will access the methods using the ``$this->dbutil`` -object:: - - $this->dbutil->some_method(); - -**************************** -Using the Database Utilities -**************************** - -Retrieve list of database names -================================ - -Returns an array of database names:: - - $dbs = $this->dbutil->list_databases(); - - foreach ($dbs as $db) - { - echo $db; - } - - -Determine If a Database Exists -============================== - -Sometimes it's helpful to know whether a particular database exists. -Returns a boolean TRUE/FALSE. Usage example:: - - if ($this->dbutil->database_exists('database_name')) - { - // some code... - } - -.. note:: Replace *database_name* with the name of the database you are - looking for. This method is case sensitive. - -Optimize a Table -================ - -Permits you to optimize a table using the table name specified in the -first parameter. Returns TRUE/FALSE based on success or failure:: - - if ($this->dbutil->optimize_table('table_name')) - { - echo 'Success!'; - } - -.. note:: Not all database platforms support table optimization. It is - mostly for use with MySQL. - -Repair a Table -============== - -Permits you to repair a table using the table name specified in the -first parameter. Returns TRUE/FALSE based on success or failure:: - - if ($this->dbutil->repair_table('table_name')) - { - echo 'Success!'; - } - -.. note:: Not all database platforms support table repairs. - -Optimize a Database -=================== - -Permits you to optimize the database your DB class is currently -connected to. Returns an array containing the DB status messages or -FALSE on failure. - -:: - - $result = $this->dbutil->optimize_database(); - - if ($result !== FALSE) - { - print_r($result); - } - -.. note:: Not all database platforms support database optimization. It - it is mostly for use with MySQL. - -Export a Query Result as a CSV File -=================================== - -Permits you to generate a CSV file from a query result. The first -parameter of the method must contain the result object from your -query. Example:: - - $this->load->dbutil(); - - $query = $this->db->query("SELECT * FROM mytable"); - - echo $this->dbutil->csv_from_result($query); - -The second, third, and fourth parameters allow you to set the delimiter -newline, and enclosure characters respectively. By default commas are -used as the delimiter, "\n" is used as a new line, and a double-quote -is used as the enclosure. Example:: - - $delimiter = ","; - $newline = "\r\n"; - $enclosure = '"'; - - echo $this->dbutil->csv_from_result($query, $delimiter, $newline, $enclosure); - -.. important:: This method will NOT write the CSV file for you. It - simply creates the CSV layout. If you need to write the file - use the :doc:`File Helper <../helpers/file_helper>`. - -Export a Query Result as an XML Document -======================================== - -Permits you to generate an XML file from a query result. The first -parameter expects a query result object, the second may contain an -optional array of config parameters. Example:: - - $this->load->dbutil(); - - $query = $this->db->query("SELECT * FROM mytable"); - - $config = array ( - 'root' => 'root', - 'element' => 'element', - 'newline' => "\n", - 'tab' => "\t" - ); - - echo $this->dbutil->xml_from_result($query, $config); - -.. important:: This method will NOT write the XML file for you. It - simply creates the XML layout. If you need to write the file - use the :doc:`File Helper <../helpers/file_helper>`. - -******************** -Backup Your Database -******************** - -Database Backup Notes -===================== - -Permits you to backup your full database or individual tables. The -backup data can be compressed in either Zip or Gzip format. - -.. note:: This feature is only available for MySQL and Interbase/Firebird databases. - -.. note:: For Interbase/Firebird databases, the backup file name is the only parameter. - - $this->dbutil->backup('db_backup_filename'); - -.. note:: Due to the limited execution time and memory available to PHP, - backing up very large databases may not be possible. If your database is - very large you might need to backup directly from your SQL server via - the command line, or have your server admin do it for you if you do not - have root privileges. - -Usage Example -============= - -:: - - // Load the DB utility class - $this->load->dbutil(); - - // Backup your entire database and assign it to a variable - $backup = $this->dbutil->backup(); - - // Load the file helper and write the file to your server - $this->load->helper('file'); - write_file('/path/to/mybackup.gz', $backup); - - // Load the download helper and send the file to your desktop - $this->load->helper('download'); - force_download('mybackup.gz', $backup); - -Setting Backup Preferences -========================== - -Backup preferences are set by submitting an array of values to the first -parameter of the ``backup()`` method. Example:: - - $prefs = array( - 'tables' => array('table1', 'table2'), // Array of tables to backup. - 'ignore' => array(), // List of tables to omit from the backup - 'format' => 'txt', // gzip, zip, txt - 'filename' => 'mybackup.sql', // File name - NEEDED ONLY WITH ZIP FILES - 'add_drop' => TRUE, // Whether to add DROP TABLE statements to backup file - 'add_insert' => TRUE, // Whether to add INSERT data to backup file - 'newline' => "\n" // Newline character used in backup file - ); - - $this->dbutil->backup($prefs); - -Description of Backup Preferences -================================= - -======================= ======================= ======================= ======================================================================== -Preference Default Value Options Description -======================= ======================= ======================= ======================================================================== -**tables** empty array None An array of tables you want backed up. If left blank all tables will be - exported. -**ignore** empty array None An array of tables you want the backup routine to ignore. -**format** gzip gzip, zip, txt The file format of the export file. -**filename** the current date/time None The name of the backed-up file. The name is needed only if you are using - zip compression. -**add_drop** TRUE TRUE/FALSE Whether to include DROP TABLE statements in your SQL export file. -**add_insert** TRUE TRUE/FALSE Whether to include INSERT statements in your SQL export file. -**newline** "\\n" "\\n", "\\r", "\\r\\n" Type of newline to use in your SQL export file. -**foreign_key_checks** TRUE TRUE/FALSE Whether output should keep foreign key checks enabled. -======================= ======================= ======================= ======================================================================== - -*************** -Class Reference -*************** - -.. php:class:: CI_DB_utility - - .. php:method:: backup([$params = array()]) - - :param array $params: An associative array of options - :returns: raw/(g)zipped SQL query string - :rtype: string - - Perform a database backup, per user preferences. - - .. php:method:: database_exists($database_name) - - :param string $database_name: Database name - :returns: TRUE if the database exists, FALSE otherwise - :rtype: bool - - Check for the existence of a database. - - .. php:method:: list_databases() - - :returns: Array of database names found - :rtype: array - - Retrieve a list of all the database names. - - .. php:method:: optimize_database() - - :returns: Array of optimization messages or FALSE on failure - :rtype: array - - Optimizes the database. - - .. php:method:: optimize_table($table_name) - - :param string $table_name: Name of the table to optimize - :returns: Array of optimization messages or FALSE on failure - :rtype: array - - Optimizes a database table. - - .. php:method:: repair_table($table_name) - - :param string $table_name: Name of the table to repair - :returns: Array of repair messages or FALSE on failure - :rtype: array - - Repairs a database table. - - .. php:method:: csv_from_result($query[, $delim = ','[, $newline = "\n"[, $enclosure = '"']]]) - - :param object $query: A database result object - :param string $delim: The CSV field delimiter to use - :param string $newline: The newline character to use - :param string $enclosure: The enclosure delimiter to use - :returns: The generated CSV file as a string - :rtype: string - - Translates a database result object into a CSV document. - - .. php:method:: xml_from_result($query[, $params = array()]) - - :param object $query: A database result object - :param array $params: An associative array of preferences - :returns: The generated XML document as a string - :rtype: string - - Translates a database result object into an XML document. diff --git a/user_guide_src/source/documentation/ELDocs.tmbundle.zip b/user_guide_src/source/documentation/ELDocs.tmbundle.zip Binary files differdeleted file mode 100644 index f7a11b364..000000000 --- a/user_guide_src/source/documentation/ELDocs.tmbundle.zip +++ /dev/null diff --git a/user_guide_src/source/documentation/index.rst b/user_guide_src/source/documentation/index.rst deleted file mode 100644 index aaac33ecb..000000000 --- a/user_guide_src/source/documentation/index.rst +++ /dev/null @@ -1,202 +0,0 @@ -################################# -Writing CodeIgniter Documentation -################################# - -CodeIgniter uses Sphinx to generate its documentation in a variety of formats, -using reStructuredText to handle the formatting. If you are familiar with -Markdown or Textile, you will quickly grasp reStructuredText. The focus is -on readability and user friendliness. -While they can be quite technical, we always write for humans! - -A local table of contents should always be included, like the one below. -It is created automatically by inserting the following: - -:: - - .. contents:: - :local: - - .. raw:: html - - <div class="custom-index container"></div> - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -The <div> that is inserted as raw HTML is a hook for the documentation's -JavaScript to dynamically add links to any function and method definitions -contained in the current page. - -************** -Tools Required -************** - -To see the rendered HTML, ePub, PDF, etc., you will need to install Sphinx -along with the PHP domain extension for Sphinx. The underlying requirement -is to have Python installed. Lastly, you will install the CI Lexer for -Pygments, so that code blocks can be properly highlighted. - -.. code-block:: bash - - easy_install "sphinx==1.2.3" - easy_install "sphinxcontrib-phpdomain==0.1.3.post1" - -Then follow the directions in the README file in the :samp:`cilexer` folder -inside the documentation repository to install the CI Lexer. - - - -***************************************** -Page and Section Headings and Subheadings -***************************************** - -Headings not only provide order and sections within a page, but they also -are used to automatically build both the page and document table of contents. -Headings are formed by using certain characters as underlines for a bit of -text. Major headings, like page titles and section headings also use -overlines. Other headings just use underlines, with the following hierarchy:: - - # with overline for page titles - * with overline for major sections - = for subsections - - for subsubsections - ^ for subsubsubsections - " for subsubsubsubsections (!) - -The :download:`TextMate ELDocs Bundle <./ELDocs.tmbundle.zip>` can help you -create these with the following tab triggers:: - - title-> - - ########## - Page Title - ########## - - sec-> - - ************* - Major Section - ************* - - sub-> - - Subsection - ========== - - sss-> - - SubSubSection - ------------- - - ssss-> - - SubSubSubSection - ^^^^^^^^^^^^^^^^ - - sssss-> - - SubSubSubSubSection (!) - """"""""""""""""""""""" - - - - -******************** -Method Documentation -******************** - -When documenting class methods for third party developers, Sphinx provides -directives to assist and keep things simple. -For example, consider the following ReST: - -.. code-block:: rst - - .. php:class:: Some_class - - .. php:method:: some_method ( $foo [, $bar [, $bat]]) - - This function will perform some action. The ``$bar`` array must contain - a something and something else, and along with ``$bat`` is an optional - parameter. - - :param int $foo: the foo id to do something in - :param mixed $bar: A data array that must contain a something and something else - :param bool $bat: whether or not to do something - :returns: FALSE on failure, TRUE if successful - :rtype: bool - - :: - - $this->load->library('some_class'); - - $bar = array( - 'something' => 'Here is this parameter!', - 'something_else' => 42 - ); - - $bat = $this->some_class->should_do_something(); - - if ($this->some_class->some_method(4, $bar, $bat) === FALSE) - { - show_error('An Error Occurred Doing Some Method'); - } - - .. note:: Here is something that you should be aware of when using some_method(). - For real. - - See also :meth:`Some_class::should_do_something` - - - .. php:method:: should_do_something() - - :returns: Whether or not something should be done - :rtype: bool - - -It creates the following display: - -.. php:class:: Some_class - - - .. php:method:: some_method ( $foo [, $bar [, $bat]]) - - This function will perform some action. The ``$bar`` array must contain - a something and something else, and along with ``$bat`` is an optional - parameter. - - :param int $foo: the foo id to do something in - :param mixed $bar: A data array that must contain a something and something else - :param bool $bat: whether or not to do something - :returns: FALSE on failure, TRUE if successful - :rtype: bool - - :: - - $this->load->library('some_class'); - - $bar = array( - 'something' => 'Here is this parameter!', - 'something_else' => 42 - ); - - $bat = $this->some_class->should_do_something(); - - if ($this->some_class->some_method(4, $bar, $bat) === FALSE) - { - show_error('An Error Occurred Doing Some Method'); - } - - .. note:: Here is something that you should be aware of when using some_method(). - For real. - - See also :meth:`Some_class::should_do_something` - - - .. php:method:: should_do_something() - - :returns: Whether or not something should be done - :rtype: bool diff --git a/user_guide_src/source/general/alternative_php.rst b/user_guide_src/source/general/alternative_php.rst deleted file mode 100644 index 418d2e6eb..000000000 --- a/user_guide_src/source/general/alternative_php.rst +++ /dev/null @@ -1,75 +0,0 @@ -################################### -Alternate PHP Syntax for View Files -################################### - -If you do not utilize CodeIgniter's :doc:`template -engine <../libraries/parser>`, you'll be using pure PHP in your -View files. To minimize the PHP code in these files, and to make it -easier to identify the code blocks it is recommended that you use PHPs -alternative syntax for control structures and short tag echo statements. -If you are not familiar with this syntax, it allows you to eliminate the -braces from your code, and eliminate "echo" statements. - -Automatic Short Tag Support -=========================== - -.. note:: If you find that the syntax described in this page does not - work on your server it might be that "short tags" are disabled in your - PHP ini file. CodeIgniter will optionally rewrite short tags on-the-fly, - allowing you to use that syntax even if your server doesn't support it. - This feature can be enabled in your *config/config.php* file. - -Please note that if you do use this feature, if PHP errors are -encountered in your **view files**, the error message and line number -will not be accurately shown. Instead, all errors will be shown as -``eval()`` errors. - -Alternative Echos -================= - -Normally to echo, or print out a variable you would do this:: - - <?php echo $variable; ?> - -With the alternative syntax you can instead do it this way:: - - <?=$variable?> - -Alternative Control Structures -============================== - -Controls structures, like if, for, foreach, and while can be written in -a simplified format as well. Here is an example using ``foreach``:: - - <ul> - - <?php foreach ($todo as $item): ?> - - <li><?=$item?></li> - - <?php endforeach; ?> - - </ul> - -Notice that there are no braces. Instead, the end brace is replaced with -``endforeach``. Each of the control structures listed above has a similar -closing syntax: ``endif``, ``endfor``, ``endforeach``, and ``endwhile`` - -Also notice that instead of using a semicolon after each structure -(except the last one), there is a colon. This is important! - -Here is another example, using ``if``/``elseif``/``else``. Notice the colons:: - - <?php if ($username === 'sally'): ?> - - <h3>Hi Sally</h3> - - <?php elseif ($username === 'joe'): ?> - - <h3>Hi Joe</h3> - - <?php else: ?> - - <h3>Hi unknown user</h3> - - <?php endif; ?>
\ No newline at end of file diff --git a/user_guide_src/source/general/ancillary_classes.rst b/user_guide_src/source/general/ancillary_classes.rst deleted file mode 100644 index 4d6528aae..000000000 --- a/user_guide_src/source/general/ancillary_classes.rst +++ /dev/null @@ -1,80 +0,0 @@ -########################## -Creating Ancillary Classes -########################## - -In some cases you may want to develop classes that exist apart from your -controllers but have the ability to utilize all of CodeIgniter's -resources. This is easily possible as you'll see. - -get_instance() -============== - -.. php:function:: get_instance() - - :returns: Reference to your controller's instance - :rtype: CI_Controller - -**Any class that you instantiate within your controller methods can -access CodeIgniter's native resources** simply by using the -``get_instance()`` function. This function returns the main -CodeIgniter object. - -Normally, to call any of the available methods, CodeIgniter requires -you to use the ``$this`` construct:: - - $this->load->helper('url'); - $this->load->library('session'); - $this->config->item('base_url'); - // etc. - -``$this``, however, only works within your controllers, your models, -or your views. If you would like to use CodeIgniter's classes from -within your own custom classes you can do so as follows: - -First, assign the CodeIgniter object to a variable:: - - $CI =& get_instance(); - -Once you've assigned the object to a variable, you'll use that variable -*instead* of ``$this``:: - - $CI =& get_instance(); - - $CI->load->helper('url'); - $CI->load->library('session'); - $CI->config->item('base_url'); - // etc. - -If you'll be using ``get_instance()`` inside another class, then it would -be better if you assign it to a property. This way, you won't need to call -``get_instance()`` in every single method. - -Example:: - - class Example { - - protected $CI; - - // We'll use a constructor, as you can't directly call a function - // from a property definition. - public function __construct() - { - // Assign the CodeIgniter super-object - $this->CI =& get_instance(); - } - - public function foo() - { - $this->CI->load->helper('url'); - redirect(); - } - - public function bar() - { - $this->CI->config->item('base_url'); - } - } - -In the above example, both methods ``foo()`` and ``bar()`` will work -after you instantiate the Example class, without the need to call -``get_instance()`` in each of them. diff --git a/user_guide_src/source/general/autoloader.rst b/user_guide_src/source/general/autoloader.rst deleted file mode 100644 index 2f1223e28..000000000 --- a/user_guide_src/source/general/autoloader.rst +++ /dev/null @@ -1,27 +0,0 @@ -###################### -Auto-loading Resources -###################### - -CodeIgniter comes with an "Auto-load" feature that permits libraries, -helpers, and models to be initialized automatically every time the -system runs. If you need certain resources globally throughout your -application you should consider auto-loading them for convenience. - -The following items can be loaded automatically: - -- Classes found in the *libraries/* directory -- Helper files found in the *helpers/* directory -- Custom config files found in the *config/* directory -- Language files found in the *system/language/* directory -- Models found in the *models/* folder - -To autoload resources, open the **application/config/autoload.php** -file and add the item you want loaded to the autoload array. You'll -find instructions in that file corresponding to each type of item. - -.. note:: Do not include the file extension (.php) when adding items to - the autoload array. - -Additionally, if you want CodeIgniter to use a `Composer <https://getcomposer.org/>`_ -auto-loader, just set ``$config['composer_autoload']`` to ``TRUE`` or -a custom path in **application/config/config.php**.
\ No newline at end of file diff --git a/user_guide_src/source/general/caching.rst b/user_guide_src/source/general/caching.rst deleted file mode 100644 index f499f6e93..000000000 --- a/user_guide_src/source/general/caching.rst +++ /dev/null @@ -1,71 +0,0 @@ -################ -Web Page Caching -################ - -CodeIgniter lets you cache your pages in order to achieve maximum -performance. - -Although CodeIgniter is quite fast, the amount of dynamic information -you display in your pages will correlate directly to the server -resources, memory, and processing cycles utilized, which affect your -page load speeds. By caching your pages, since they are saved in their -fully rendered state, you can achieve performance that nears that of -static web pages. - -How Does Caching Work? -====================== - -Caching can be enabled on a per-page basis, and you can set the length -of time that a page should remain cached before being refreshed. When a -page is loaded for the first time, the cache file will be written to -your application/cache folder. On subsequent page loads the cache file -will be retrieved and sent to the requesting user's browser. If it has -expired, it will be deleted and refreshed before being sent to the -browser. - -.. note: The Benchmark tag is not cached so you can still view your page - load speed when caching is enabled. - -Enabling Caching -================ - -To enable caching, put the following tag in any of your controller -methods:: - - $this->output->cache($n); - -Where ``$n`` is the number of **minutes** you wish the page to remain -cached between refreshes. - -The above tag can go anywhere within a method. It is not affected by -the order that it appears, so place it wherever it seems most logical to -you. Once the tag is in place, your pages will begin being cached. - -.. important:: Because of the way CodeIgniter stores content for output, - caching will only work if you are generating display for your - controller with a :doc:`view <./views>`. - -.. important:: If you change configuration options that might affect - your output, you have to manually delete your cache files. - -.. note:: Before the cache files can be written you must set the file - permissions on your *application/cache/* directory such that - it is writable. - -Deleting Caches -=============== - -If you no longer wish to cache a file you can remove the caching tag and -it will no longer be refreshed when it expires. - -.. note:: Removing the tag will not delete the cache immediately. It will - have to expire normally. - -If you need to manually delete the cache, you can use the ``delete_cache()`` -method:: - - // Deletes cache for the currently requested URI - $this->output->delete_cache(); - - // Deletes cache for /foo/bar - $this->output->delete_cache('/foo/bar');
\ No newline at end of file diff --git a/user_guide_src/source/general/cli.rst b/user_guide_src/source/general/cli.rst deleted file mode 100644 index 764a6b835..000000000 --- a/user_guide_src/source/general/cli.rst +++ /dev/null @@ -1,78 +0,0 @@ -################### -Running via the CLI -################### - -As well as calling an applications :doc:`Controllers <./controllers>` -via the URL in a browser they can also be loaded via the command-line -interface (CLI). - -.. contents:: Page Contents - -What is the CLI? -================ - -The command-line interface is a text-based method of interacting with -computers. For more information, check the `Wikipedia -article <http://en.wikipedia.org/wiki/Command-line_interface>`_. - -Why run via the command-line? -============================= - -There are many reasons for running CodeIgniter from the command-line, -but they are not always obvious. - -- Run your cron-jobs without needing to use *wget* or *curl* -- Make your cron-jobs inaccessible from being loaded in the URL by - checking the return value of :php:func:`is_cli()`. -- Make interactive "tasks" that can do things like set permissions, - prune cache folders, run backups, etc. -- Integrate with other applications in other languages. For example, a - random C++ script could call one command and run code in your models! - -Let's try it: Hello World! -========================== - -Let's create a simple controller so you can see it in action. Using your -text editor, create a file called Tools.php, and put the following code -in it:: - - <?php - class Tools extends CI_Controller { - - public function message($to = 'World') - { - echo "Hello {$to}!".PHP_EOL; - } - } - -Then save the file to your *application/controllers/* folder. - -Now normally you would visit the site using a URL similar to this:: - - example.com/index.php/tools/message/to - -Instead, we are going to open the terminal in Mac/Linux or go to Run > "cmd" -in Windows and navigate to our CodeIgniter project. - -.. code-block:: bash - - $ cd /path/to/project; - $ php index.php tools message - -If you did it right, you should see *Hello World!* printed. - -.. code-block:: bash - - $ php index.php tools message "John Smith" - -Here we are passing it a argument in the same way that URL parameters -work. "John Smith" is passed as a argument and output is:: - - Hello John Smith! - -That's it! -========== - -That, in a nutshell, is all there is to know about controllers on the -command line. Remember that this is just a normal controller, so routing -and ``_remap()`` works fine. diff --git a/user_guide_src/source/general/common_functions.rst b/user_guide_src/source/general/common_functions.rst deleted file mode 100644 index 3e3e42264..000000000 --- a/user_guide_src/source/general/common_functions.rst +++ /dev/null @@ -1,188 +0,0 @@ -################ -Common Functions -################ - -CodeIgniter uses a few functions for its operation that are globally -defined, and are available to you at any point. These do not require -loading any libraries or helpers. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -.. php:function:: is_php($version) - - :param string $version: Version number - :returns: TRUE if the running PHP version is at least the one specified or FALSE if not - :rtype: bool - - Determines if the PHP version being used is greater than the - supplied version number. - - Example:: - - if (is_php('5.3')) - { - $str = quoted_printable_encode($str); - } - - Returns boolean TRUE if the installed version of PHP is equal to or - greater than the supplied version number. Returns FALSE if the installed - version of PHP is lower than the supplied version number. - -.. php:function:: is_really_writable($file) - - :param string $file: File path - :returns: TRUE if the path is writable, FALSE if not - :rtype: bool - - ``is_writable()`` returns TRUE on Windows servers when you really can't - write to the file as the OS reports to PHP as FALSE only if the - read-only attribute is marked. - - This function determines if a file is actually writable by attempting - to write to it first. Generally only recommended on platforms where - this information may be unreliable. - - Example:: - - if (is_really_writable('file.txt')) - { - echo "I could write to this if I wanted to"; - } - else - { - echo "File is not writable"; - } - - .. note:: See also `PHP bug #54709 <https://bugs.php.net/bug.php?id=54709>`_ for more info. - -.. php:function:: config_item($key) - - :param string $key: Config item key - :returns: Configuration key value or NULL if not found - :rtype: mixed - - The :doc:`Config Library <../libraries/config>` is the preferred way of - accessing configuration information, however ``config_item()`` can be used - to retrieve single keys. See :doc:`Config Library <../libraries/config>` - documentation for more information. - -.. :noindex: function:: show_error($message, $status_code[, $heading = 'An Error Was Encountered']) - - :param mixed $message: Error message - :param int $status_code: HTTP Response status code - :param string $heading: Error page heading - :rtype: void - - This function calls ``CI_Exception::show_error()``. For more info, - please see the :doc:`Error Handling <errors>` documentation. - -.. :noindex: function:: show_404([$page = ''[, $log_error = TRUE]]) - - :param string $page: URI string - :param bool $log_error: Whether to log the error - :rtype: void - - This function calls ``CI_Exception::show_404()``. For more info, - please see the :doc:`Error Handling <errors>` documentation. - -.. :noindex: function:: log_message($level, $message) - - :param string $level: Log level: 'error', 'debug' or 'info' - :param string $message: Message to log - :rtype: void - - This function is an alias for ``CI_Log::write_log()``. For more info, - please see the :doc:`Error Handling <errors>` documentation. - -.. php:function:: set_status_header($code[, $text = '']) - - :param int $code: HTTP Response status code - :param string $text: A custom message to set with the status code - :rtype: void - - Permits you to manually set a server status header. Example:: - - set_status_header(401); - // Sets the header as: Unauthorized - - `See here <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html>`_ for - a full list of headers. - -.. php:function:: remove_invisible_characters($str[, $url_encoded = TRUE]) - - :param string $str: Input string - :param bool $url_encoded: Whether to remove URL-encoded characters as well - :returns: Sanitized string - :rtype: string - - This function prevents inserting NULL characters between ASCII - characters, like Java\\0script. - - Example:: - - remove_invisible_characters('Java\\0script'); - // Returns: 'Javascript' - -.. php:function:: html_escape($var) - - :param mixed $var: Variable to escape (string or array) - :returns: HTML escaped string(s) - :rtype: mixed - - This function acts as an alias for PHP's native ``htmlspecialchars()`` - function, with the advantage of being able to accept an array of strings. - - It is useful in preventing Cross Site Scripting (XSS). - -.. php:function:: get_mimes() - - :returns: An associative array of file types - :rtype: array - - This function returns a *reference* to the MIMEs array from - *application/config/mimes.php*. - -.. php:function:: is_https() - - :returns: TRUE if currently using HTTP-over-SSL, FALSE if not - :rtype: bool - - Returns TRUE if a secure (HTTPS) connection is used and FALSE - in any other case (including non-HTTP requests). - -.. php:function:: is_cli() - - :returns: TRUE if currently running under CLI, FALSE otherwise - :rtype: bool - - Returns TRUE if the application is run through the command line - and FALSE if not. - - .. note:: This function checks both if the ``PHP_SAPI`` value is 'cli' - or if the ``STDIN`` constant is defined. - -.. php:function:: function_usable($function_name) - - :param string $function_name: Function name - :returns: TRUE if the function can be used, FALSE if not - :rtype: bool - - Returns TRUE if a function exists and is usable, FALSE otherwise. - - This function runs a ``function_exists()`` check and if the - `Suhosin extension <http://www.hardened-php.net/suhosin/>` is loaded, - checks if it doesn't disable the function being checked. - - It is useful if you want to check for the availability of functions - such as ``eval()`` and ``exec()``, which are dangerous and might be - disabled on servers with highly restrictive security policies. - - .. note:: This function was introduced because Suhosin terminated - script execution, but this turned out to be a bug. A fix - has been available for some time (version 0.9.34), but is - unfortunately not released yet.
\ No newline at end of file diff --git a/user_guide_src/source/general/compatibility_functions.rst b/user_guide_src/source/general/compatibility_functions.rst deleted file mode 100644 index 584968663..000000000 --- a/user_guide_src/source/general/compatibility_functions.rst +++ /dev/null @@ -1,232 +0,0 @@ -####################### -Compatibility Functions -####################### - -CodeIgniter provides a set of compatibility functions that enable -you to use functions what are otherwise natively available in PHP, -but only in higher versions or depending on a certain extension. - -Being custom implementations, these functions will also have some -set of dependencies on their own, but are still useful if your -PHP setup doesn't offer them natively. - -.. note:: Much like the :doc:`common functions <common_functions>`, the - compatibility functions are always available, as long as - their dependencies are met. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -**************** -Password Hashing -**************** - -This set of compatibility functions offers a "backport" of PHP's -standard `Password Hashing extension <http://php.net/password>`_ -that is otherwise available only since PHP 5.5. - -Dependencies -============ - -- PHP 5.3.7 -- ``CRYPT_BLOWFISH`` support for ``crypt()`` - -Constants -========= - -- ``PASSWORD_BCRYPT`` -- ``PASSWORD_DEFAULT`` - -Function reference -================== - -.. php:function:: password_get_info($hash) - - :param string $hash: Password hash - :returns: Information about the hashed password - :rtype: array - - For more information, please refer to the `PHP manual for - password_get_info() <http://php.net/password_get_info>`_. - -.. php:function:: password_hash($password, $algo[, $options = array()]) - - :param string $password: Plain-text password - :param int $algo: Hashing algorithm - :param array $options: Hashing options - :returns: Hashed password or FALSE on failure - :rtype: string - - For more information, please refer to the `PHP manual for - password_hash() <http://php.net/password_hash>`_. - - .. note:: Unless you provide your own (and valid) salt, this function - has a further dependency on an available CSPRNG source. Each - of the following would satisfy that: - - ``mcrypt_create_iv()`` with ``MCRYPT_DEV_URANDOM`` - - ``openssl_random_pseudo_bytes()`` - - /dev/arandom - - /dev/urandom - -.. php:function:: password_needs_rehash() - - :param string $hash: Password hash - :param int $algo: Hashing algorithm - :param array $options: Hashing options - :returns: TRUE if the hash should be rehashed to match the given algorithm and options, FALSE otherwise - :rtype: bool - - For more information, please refer to the `PHP manual for - password_needs_rehash() <http://php.net/password_needs_rehash>`_. - -.. php:function:: password_verify($password, $hash) - - :param string $password: Plain-text password - :param string $hash: Password hash - :returns: TRUE if the password matches the hash, FALSE if not - :rtype: bool - - For more information, please refer to the `PHP manual for - password_verify() <http://php.net/password_verify>`_. - -********************* -Hash (Message Digest) -********************* - -This compatibility layer contains backports for the ``hash_equals()`` -and ``hash_pbkdf2()`` functions, which otherwise require PHP 5.6 and/or -PHP 5.5 respectively. - -Dependencies -============ - -- None - -Function reference -================== - -.. php:function:: hash_equals($known_string, $user_string) - - :param string $known_string: Known string - :param string $user_string: User-supplied string - :returns: TRUE if the strings match, FALSE otherwise - :rtype: string - - For more information, please refer to the `PHP manual for - hash_equals() <http://php.net/hash_equals>`_. - -.. php:function:: hash_pbkdf2($algo, $password, $salt, $iterations[, $length = 0[, $raw_output = FALSE]]) - - :param string $algo: Hashing algorithm - :param string $password: Password - :param string $salt: Hash salt - :param int $iterations: Number of iterations to perform during derivation - :param int $length: Output string length - :param bool $raw_output: Whether to return raw binary data - :returns: Password-derived key or FALSE on failure - :rtype: string - - For more information, please refer to the `PHP manual for - hash_pbkdf2() <http://php.net/hash_pbkdf2>`_. - -**************** -Multibyte String -**************** - -This set of compatibility functions offers limited support for PHP's -`Multibyte String extension <http://php.net/mbstring>`_. Because of -the limited alternative solutions, only a few functions are available. - -.. note:: When a character set parameter is ommited, - ``$config['charset']`` will be used. - -Dependencies -============ - -- `iconv <http://php.net/iconv>`_ extension - -.. important:: This dependency is optional and these functions will - always be declared. If iconv is not available, they WILL - fall-back to their non-mbstring versions. - -.. important:: Where a character set is supplied, it must be - supported by iconv and in a format that it recognizes. - -.. note:: For you own dependency check on the actual mbstring - extension, use the ``MB_ENABLED`` constant. - -Function reference -================== - -.. php:function:: mb_strlen($str[, $encoding = NULL]) - - :param string $str: Input string - :param string $encoding: Character set - :returns: Number of characters in the input string or FALSE on failure - :rtype: string - - For more information, please refer to the `PHP manual for - mb_strlen() <http://php.net/mb_strlen>`_. - -.. php:function:: mb_strpos($haystack, $needle[, $offset = 0[, $encoding = NULL]]) - - :param string $haystack: String to search in - :param string $needle: Part of string to search for - :param int $offset: Search offset - :param string $encoding: Character set - :returns: Numeric character position of where $needle was found or FALSE if not found - :rtype: mixed - - For more information, please refer to the `PHP manual for - mb_strpos() <http://php.net/mb_strpos>`_. - -.. php:function:: mb_substr($str, $start[, $length = NULL[, $encoding = NULL]]) - - :param string $str: Input string - :param int $start: Position of first character - :param int $length: Maximum number of characters - :param string $encoding: Character set - :returns: Portion of $str specified by $start and $length or FALSE on failure - :rtype: string - - For more information, please refer to the `PHP manual for - mb_substr() <http://php.net/mb_substr>`_. - -****************** -Standard Functions -****************** - -This set of compatibility functions offers support for a few -standard functions in PHP that otherwise require a newer PHP version. - -Dependencies -============ - -- None - -Function reference -================== - -.. php:function:: array_column(array $array, $column_key[, $index_key = NULL]) - - :param array $array: Array to fetch results from - :param mixed $column_key: Key of the column to return values from - :param mixed $index_key: Key to use for the returned values - :returns: An array of values representing a single column from the input array - :rtype: array - - For more information, please refer to the `PHP manual for - array_column() <http://php.net/array_column>`_. - -.. php:function:: hex2bin($data) - - :param array $data: Hexadecimal representation of data - :returns: Binary representation of the given data - :rtype: string - - For more information, please refer to the `PHP manual for hex2bin() - <http://php.net/hex2bin>`_. diff --git a/user_guide_src/source/general/controllers.rst b/user_guide_src/source/general/controllers.rst deleted file mode 100644 index 14e583636..000000000 --- a/user_guide_src/source/general/controllers.rst +++ /dev/null @@ -1,340 +0,0 @@ -########### -Controllers -########### - -Controllers are the heart of your application, as they determine how -HTTP requests should be handled. - -.. contents:: Page Contents - -What is a Controller? -===================== - -**A Controller is simply a class file that is named in a way that can be -associated with a URI.** - -Consider this URI:: - - example.com/index.php/blog/ - -In the above example, CodeIgniter would attempt to find a controller -named Blog.php and load it. - -**When a controller's name matches the first segment of a URI, it will -be loaded.** - -Let's try it: Hello World! -========================== - -Let's create a simple controller so you can see it in action. Using your -text editor, create a file called Blog.php, and put the following code -in it:: - - <?php - class Blog extends CI_Controller { - - public function index() - { - echo 'Hello World!'; - } - } - -Then save the file to your *application/controllers/* directory. - -.. important:: The file must be called 'Blog.php', with a capital 'B'. - -Now visit the your site using a URL similar to this:: - - example.com/index.php/blog/ - -If you did it right, you should see: - - Hello World! - -.. important:: Class names must start with an uppercase letter. - -This is valid:: - - <?php - class Blog extends CI_Controller { - - } - -This is **not** valid:: - - <?php - class blog extends CI_Controller { - - } - -Also, always make sure your controller extends the parent controller -class so that it can inherit all its methods. - -Methods -======= - -In the above example the method name is ``index()``. The "index" method -is always loaded by default if the **second segment** of the URI is -empty. Another way to show your "Hello World" message would be this:: - - example.com/index.php/blog/index/ - -**The second segment of the URI determines which method in the -controller gets called.** - -Let's try it. Add a new method to your controller:: - - <?php - class Blog extends CI_Controller { - - public function index() - { - echo 'Hello World!'; - } - - public function comments() - { - echo 'Look at this!'; - } - } - -Now load the following URL to see the comment method:: - - example.com/index.php/blog/comments/ - -You should see your new message. - -Passing URI Segments to your methods -==================================== - -If your URI contains more than two segments they will be passed to your -method as parameters. - -For example, let's say you have a URI like this:: - - example.com/index.php/products/shoes/sandals/123 - -Your method will be passed URI segments 3 and 4 ("sandals" and "123"):: - - <?php - class Products extends CI_Controller { - - public function shoes($sandals, $id) - { - echo $sandals; - echo $id; - } - } - -.. important:: If you are using the :doc:`URI Routing <routing>` - feature, the segments passed to your method will be the re-routed - ones. - -Defining a Default Controller -============================= - -CodeIgniter can be told to load a default controller when a URI is not -present, as will be the case when only your site root URL is requested. -To specify a default controller, open your **application/config/routes.php** -file and set this variable:: - - $route['default_controller'] = 'blog'; - -Where 'blog' is the name of the controller class you want used. If you now -load your main index.php file without specifying any URI segments you'll -see your "Hello World" message by default. - -For more information, please refer to the "Reserved Routes" section of the -:doc:`URI Routing <routing>` documentation. - -Remapping Method Calls -====================== - -As noted above, the second segment of the URI typically determines which -method in the controller gets called. CodeIgniter permits you to override -this behavior through the use of the ``_remap()`` method:: - - public function _remap() - { - // Some code here... - } - -.. important:: If your controller contains a method named _remap(), - it will **always** get called regardless of what your URI contains. It - overrides the normal behavior in which the URI determines which method - is called, allowing you to define your own method routing rules. - -The overridden method call (typically the second segment of the URI) will -be passed as a parameter to the ``_remap()`` method:: - - public function _remap($method) - { - if ($method === 'some_method') - { - $this->$method(); - } - else - { - $this->default_method(); - } - } - -Any extra segments after the method name are passed into ``_remap()`` as an -optional second parameter. This array can be used in combination with -PHP's `call_user_func_array() <http://php.net/call_user_func_array>`_ -to emulate CodeIgniter's default behavior. - -Example:: - - public function _remap($method, $params = array()) - { - $method = 'process_'.$method; - if (method_exists($this, $method)) - { - return call_user_func_array(array($this, $method), $params); - } - show_404(); - } - -Processing Output -================= - -CodeIgniter has an output class that takes care of sending your final -rendered data to the web browser automatically. More information on this -can be found in the :doc:`Views <views>` and :doc:`Output Class -<../libraries/output>` pages. In some cases, however, you might want to -post-process the finalized data in some way and send it to the browser -yourself. CodeIgniter permits you to add a method named ``_output()`` -to your controller that will receive the finalized output data. - -.. important:: If your controller contains a method named ``_output()``, - it will **always** be called by the output class instead of - echoing the finalized data directly. The first parameter of the - method will contain the finalized output. - -Here is an example:: - - public function _output($output) - { - echo $output; - } - -.. note:: - - Please note that your ``_output()`` method will receive the - data in its finalized state. Benchmark and memory usage data - will be rendered, cache files written (if you have caching - enabled), and headers will be sent (if you use that - :doc:`feature <../libraries/output>`) before it is handed off - to the ``_output()`` method. - To have your controller's output cached properly, its - ``_output()`` method can use:: - - if ($this->output->cache_expiration > 0) - { - $this->output->_write_cache($output); - } - - If you are using this feature the page execution timer and - memory usage stats might not be perfectly accurate since they - will not take into account any further processing you do. - For an alternate way to control output *before* any of the - final processing is done, please see the available methods - in the :doc:`Output Library <../libraries/output>`. - -Private methods -=============== - -In some cases you may want certain methods hidden from public access. -In order to achieve this, simply declare the method as being private -or protected and it will not be served via a URL request. For example, -if you were to have a method like this:: - - private function _utility() - { - // some code - } - -Trying to access it via the URL, like this, will not work:: - - example.com/index.php/blog/_utility/ - -.. note:: Prefixing method names with an underscore will also prevent - them from being called. This is a legacy feature that is left - for backwards-compatibility. - -Organizing Your Controllers into Sub-directories -================================================ - -If you are building a large application you might want to hierarchically -organize or structure your controllers into sub-directories. CodeIgniter -permits you to do this. - -Simply create sub-directories under the main *application/controllers/* -one and place your controller classes within them. - -.. note:: When using this feature the first segment of your URI must - specify the folder. For example, let's say you have a controller located - here:: - - application/controllers/products/Shoes.php - - To call the above controller your URI will look something like this:: - - example.com/index.php/products/shoes/show/123 - -Each of your sub-directories may contain a default controller which will be -called if the URL contains *only* the sub-directory. Simply put a controller -in there that matches the name of your 'default_controller' as specified in -your *application/config/routes.php* file. - -CodeIgniter also permits you to remap your URIs using its :doc:`URI -Routing <routing>` feature. - -Class Constructors -================== - -If you intend to use a constructor in any of your Controllers, you -**MUST** place the following line of code in it:: - - parent::__construct(); - -The reason this line is necessary is because your local constructor will -be overriding the one in the parent controller class so we need to -manually call it. - -Example:: - - <?php - class Blog extends CI_Controller { - - public function __construct() - { - parent::__construct(); - // Your own constructor code - } - } - -Constructors are useful if you need to set some default values, or run a -default process when your class is instantiated. Constructors can't -return a value, but they can do some default work. - -Reserved method names -===================== - -Since your controller classes will extend the main application -controller you must be careful not to name your methods identically to -the ones used by that class, otherwise your local functions will -override them. See :doc:`Reserved Names <reserved_names>` for a full -list. - -.. important:: You should also never have a method named identically - to its class name. If you do, and there is no ``__construct()`` - method in the same class, then your e.g. ``Index::index()`` - method will be executed as a class constructor! This is a PHP4 - backwards-compatibility feature. - -That's it! -========== - -That, in a nutshell, is all there is to know about controllers. diff --git a/user_guide_src/source/general/core_classes.rst b/user_guide_src/source/general/core_classes.rst deleted file mode 100644 index 9ccded75c..000000000 --- a/user_guide_src/source/general/core_classes.rst +++ /dev/null @@ -1,117 +0,0 @@ -############################ -Creating Core System Classes -############################ - -Every time CodeIgniter runs there are several base classes that are -initialized automatically as part of the core framework. It is possible, -however, to swap any of the core system classes with your own versions -or even extend the core versions. - -**Most users will never have any need to do this, but the option to -replace or extend them does exist for those who would like to -significantly alter the CodeIgniter core.** - -.. note:: Messing with a core system class has a lot of implications, so - make sure you know what you are doing before attempting it. - -System Class List -================= - -The following is a list of the core system files that are invoked every -time CodeIgniter runs: - -- Benchmark -- Config -- Controller -- Exceptions -- Hooks -- Input -- Language -- Loader -- Log -- Output -- Router -- Security -- URI -- Utf8 - -Replacing Core Classes -====================== - -To use one of your own system classes instead of a default one simply -place your version inside your local *application/core/* directory:: - - application/core/some_class.php - -If this directory does not exist you can create it. - -Any file named identically to one from the list above will be used -instead of the one normally used. - -Please note that your class must use CI as a prefix. For example, if -your file is named Input.php the class will be named:: - - class CI_Input { - - } - -Extending Core Class -==================== - -If all you need to do is add some functionality to an existing library - -perhaps add a method or two - then it's overkill to replace the entire -library with your version. In this case it's better to simply extend the -class. Extending a class is nearly identical to replacing a class with a -couple exceptions: - -- The class declaration must extend the parent class. -- Your new class name and filename must be prefixed with MY\_ (this - item is configurable. See below.). - -For example, to extend the native Input class you'll create a file named -application/core/MY_Input.php, and declare your class with:: - - class MY_Input extends CI_Input { - - } - -.. note:: If you need to use a constructor in your class make sure you - extend the parent constructor:: - - class MY_Input extends CI_Input { - - public function __construct() - { - parent::__construct(); - // Your own constructor code - } - } - -**Tip:** Any functions in your class that are named identically to the -methods in the parent class will be used instead of the native ones -(this is known as "method overriding"). This allows you to substantially -alter the CodeIgniter core. - -If you are extending the Controller core class, then be sure to extend -your new class in your application controller's constructors. - -:: - - class Welcome extends MY_Controller { - - public function index() - { - $this->load->view('welcome_message'); - } - } - -Setting Your Own Prefix ------------------------ - -To set your own sub-class prefix, open your -*application/config/config.php* file and look for this item:: - - $config['subclass_prefix'] = 'MY_'; - -Please note that all native CodeIgniter libraries are prefixed -with CI\_ so DO NOT use that as your prefix. diff --git a/user_guide_src/source/general/creating_drivers.rst b/user_guide_src/source/general/creating_drivers.rst deleted file mode 100644 index 63ac83902..000000000 --- a/user_guide_src/source/general/creating_drivers.rst +++ /dev/null @@ -1,25 +0,0 @@ -################ -Creating Drivers -################ - -Driver Directory and File Structure -=================================== - -Sample driver directory and file structure layout: - -- /application/libraries/Driver_name - - - Driver_name.php - - drivers - - - Driver_name_subclass_1.php - - Driver_name_subclass_2.php - - Driver_name_subclass_3.php - -.. note:: In order to maintain compatibility on case-sensitive - file systems, the Driver_name directory must be - named in the format returned by ``ucfirst()``. - -.. note:: The Driver library's architecture is such that - the subclasses don't extend and therefore don't inherit - properties or methods of the main driver.
\ No newline at end of file diff --git a/user_guide_src/source/general/creating_libraries.rst b/user_guide_src/source/general/creating_libraries.rst deleted file mode 100644 index 83742b619..000000000 --- a/user_guide_src/source/general/creating_libraries.rst +++ /dev/null @@ -1,260 +0,0 @@ -################## -Creating Libraries -################## - -When we use the term "Libraries" we are normally referring to the -classes that are located in the libraries directory and described in the -Class Reference of this user guide. In this case, however, we will -instead describe how you can create your own libraries within your -application/libraries directory in order to maintain separation between -your local resources and the global framework resources. - -As an added bonus, CodeIgniter permits your libraries to extend native -classes if you simply need to add some functionality to an existing -library. Or you can even replace native libraries just by placing -identically named versions in your *application/libraries* directory. - -In summary: - -- You can create entirely new libraries. -- You can extend native libraries. -- You can replace native libraries. - -The page below explains these three concepts in detail. - -.. note:: The Database classes can not be extended or replaced with your - own classes. All other classes are able to be replaced/extended. - -Storage -======= - -Your library classes should be placed within your *application/libraries* -directory, as this is where CodeIgniter will look for them when they are -initialized. - -Naming Conventions -================== - -- File names must be capitalized. For example: Myclass.php -- Class declarations must be capitalized. For example: class Myclass -- Class names and file names must match. - -The Class File -============== - -Classes should have this basic prototype:: - - <?php - defined('BASEPATH') OR exit('No direct script access allowed'); - - class Someclass { - - public function some_method() - { - } - } - -.. note:: We are using the name Someclass purely as an example. - -Using Your Class -================ - -From within any of your :doc:`Controller <controllers>` methods you -can initialize your class using the standard:: - - $this->load->library('someclass'); - -Where *someclass* is the file name, without the ".php" file extension. -You can submit the file name capitalized or lower case. CodeIgniter -doesn't care. - -Once loaded you can access your class using the lower case version:: - - $this->someclass->some_method(); // Object instances will always be lower case - -Passing Parameters When Initializing Your Class -=============================================== - -In the library loading method you can dynamically pass data as an -array via the second parameter and it will be passed to your class -constructor:: - - $params = array('type' => 'large', 'color' => 'red'); - - $this->load->library('someclass', $params); - -If you use this feature you must set up your class constructor to expect -data:: - - <?php defined('BASEPATH') OR exit('No direct script access allowed'); - - class Someclass { - - public function __construct($params) - { - // Do something with $params - } - } - -You can also pass parameters stored in a config file. Simply create a -config file named identically to the class file name and store it in -your *application/config/* directory. Note that if you dynamically pass -parameters as described above, the config file option will not be -available. - -Utilizing CodeIgniter Resources within Your Library -=================================================== - -To access CodeIgniter's native resources within your library use the -``get_instance()`` method. This method returns the CodeIgniter super -object. - -Normally from within your controller methods you will call any of the -available CodeIgniter methods using the ``$this`` construct:: - - $this->load->helper('url'); - $this->load->library('session'); - $this->config->item('base_url'); - // etc. - -``$this``, however, only works directly within your controllers, your -models, or your views. If you would like to use CodeIgniter's classes -from within your own custom classes you can do so as follows: - -First, assign the CodeIgniter object to a variable:: - - $CI =& get_instance(); - -Once you've assigned the object to a variable, you'll use that variable -*instead* of ``$this``:: - - $CI =& get_instance(); - - $CI->load->helper('url'); - $CI->load->library('session'); - $CI->config->item('base_url'); - // etc. - -.. note:: You'll notice that the above ``get_instance()`` function is being - passed by reference:: - - $CI =& get_instance(); - - This is very important. Assigning by reference allows you to use the - original CodeIgniter object rather than creating a copy of it. - -However, since a library is a class, it would be better if you -take full advantage of the OOP principles. So, in order to -be able to use the CodeIgniter super-object in all of the class -methods, you're encouraged to assign it to a property instead:: - - class Example_library { - - protected $CI; - - // We'll use a constructor, as you can't directly call a function - // from a property definition. - public function __construct() - { - // Assign the CodeIgniter super-object - $this->CI =& get_instance(); - } - - public function foo() - { - $this->CI->load->helper('url'); - redirect(); - } - - public function bar() - { - echo $this->CI->config->item('base_url'); - } - - } - -Replacing Native Libraries with Your Versions -============================================= - -Simply by naming your class files identically to a native library will -cause CodeIgniter to use it instead of the native one. To use this -feature you must name the file and the class declaration exactly the -same as the native library. For example, to replace the native Email -library you'll create a file named *application/libraries/Email.php*, -and declare your class with:: - - class CI_Email { - - } - -Note that most native classes are prefixed with CI\_. - -To load your library you'll see the standard loading method:: - - $this->load->library('email'); - -.. note:: At this time the Database classes can not be replaced with - your own versions. - -Extending Native Libraries -========================== - -If all you need to do is add some functionality to an existing library - -perhaps add a method or two - then it's overkill to replace the entire -library with your version. In this case it's better to simply extend the -class. Extending a class is nearly identical to replacing a class with a -couple exceptions: - -- The class declaration must extend the parent class. -- Your new class name and filename must be prefixed with MY\_ (this - item is configurable. See below.). - -For example, to extend the native Email class you'll create a file named -*application/libraries/MY_Email.php*, and declare your class with:: - - class MY_Email extends CI_Email { - - } - -If you need to use a constructor in your class make sure you -extend the parent constructor:: - - class MY_Email extends CI_Email { - - public function __construct($config = array()) - { - parent::__construct($config); - // Your own constructor code - } - - } - -.. note:: Not all of the libraries have the same (or any) parameters - in their constructor. Take a look at the library that you're - extending first to see how it should be implemented. - -Loading Your Sub-class ----------------------- - -To load your sub-class you'll use the standard syntax normally used. DO -NOT include your prefix. For example, to load the example above, which -extends the Email class, you will use:: - - $this->load->library('email'); - -Once loaded you will use the class variable as you normally would for -the class you are extending. In the case of the email class all calls -will use:: - - $this->email->some_method(); - -Setting Your Own Prefix ------------------------ - -To set your own sub-class prefix, open your -*application/config/config.php* file and look for this item:: - - $config['subclass_prefix'] = 'MY_'; - -Please note that all native CodeIgniter libraries are prefixed with CI\_ -so DO NOT use that as your prefix. diff --git a/user_guide_src/source/general/credits.rst b/user_guide_src/source/general/credits.rst deleted file mode 100644 index d0f14b3bd..000000000 --- a/user_guide_src/source/general/credits.rst +++ /dev/null @@ -1,22 +0,0 @@ -####### -Credits -####### - -CodeIgniter was originally developed by `Rick Ellis <https://ellislab.com/>`_ -(CEO of `EllisLab, Inc. <https://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 -<https://ellislab.com/expressionengine>`_. - -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://www.bcit.ca/>`_ and was then officially announced as a community-maintained -project. - -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 diff --git a/user_guide_src/source/general/drivers.rst b/user_guide_src/source/general/drivers.rst deleted file mode 100644 index b64b0e75e..000000000 --- a/user_guide_src/source/general/drivers.rst +++ /dev/null @@ -1,40 +0,0 @@ -######################### -Using CodeIgniter Drivers -######################### - -Drivers are a special type of Library that has a parent class and any -number of potential child classes. Child classes have access to the -parent class, but not their siblings. Drivers provide an elegant syntax -in your :doc:`controllers <controllers>` for libraries that benefit -from or require being broken down into discrete classes. - -Drivers are found in the *system/libraries/* directory, in their own -sub-directory which is identically named to the parent library class. -Also inside that directory is a subdirectory named drivers, which -contains all of the possible child class files. - -To use a driver you will initialize it within a controller using the -following initialization method:: - - $this->load->driver('class_name'); - -Where class name is the name of the driver class you want to invoke. For -example, to load a driver named "Some_parent" you would do this:: - - $this->load->driver('some_parent'); - -Methods of that class can then be invoked with:: - - $this->some_parent->some_method(); - -The child classes, the drivers themselves, can then be called directly -through the parent class, without initializing them:: - - $this->some_parent->child_one->some_method(); - $this->some_parent->child_two->another_method(); - -Creating Your Own Drivers -========================= - -Please read the section of the user guide that discusses how to :doc:`create -your own drivers <creating_drivers>`.
\ No newline at end of file diff --git a/user_guide_src/source/general/environments.rst b/user_guide_src/source/general/environments.rst deleted file mode 100644 index ac6f3235e..000000000 --- a/user_guide_src/source/general/environments.rst +++ /dev/null @@ -1,52 +0,0 @@ -############################## -Handling Multiple Environments -############################## - -Developers often desire different system behavior depending on whether -an application is running in a development or production environment. -For example, verbose error output is something that would be useful -while developing an application, but it may also pose a security issue -when "live". - -The ENVIRONMENT Constant -======================== - -By default, CodeIgniter comes with the environment constant set to use -the value provided in ``$_SERVER['CI_ENV']``, otherwise defaults to -'development'. At the top of index.php, you will see:: - - define('ENVIRONMENT', isset($_SERVER['CI_ENV']) ? $_SERVER['CI_ENV'] : 'development'); - -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 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 -differentiate between which environment you are running in. - -Effects On Default Framework Behavior -===================================== - -There are some places in the CodeIgniter system where the ENVIRONMENT -constant is used. This section describes how default framework behavior -is affected. - -Error Reporting ---------------- - -Setting the ENVIRONMENT constant to a value of 'development' will cause -all PHP errors to be rendered to the browser when they occur. -Conversely, setting the constant to 'production' will disable all error -output. Disabling error reporting in production is a :doc:`good security -practice <security>`. - -Configuration Files -------------------- - -Optionally, you can have CodeIgniter load environment-specific -configuration files. This may be useful for managing things like -differing API keys across multiple environments. This is described in -more detail in the environment section of the :doc:`Config Class -<../libraries/config>` documentation.
\ No newline at end of file diff --git a/user_guide_src/source/general/errors.rst b/user_guide_src/source/general/errors.rst deleted file mode 100644 index a1cc3517a..000000000 --- a/user_guide_src/source/general/errors.rst +++ /dev/null @@ -1,120 +0,0 @@ -############## -Error Handling -############## - -CodeIgniter lets you build error reporting into your applications using -the functions described below. In addition, it has an error logging -class that permits error and debugging messages to be saved as text -files. - -.. note:: By default, CodeIgniter displays all PHP errors. You might - wish to change this behavior once your development is complete. You'll - find the error_reporting() function located at the top of your main - index.php file. Disabling error reporting will NOT prevent log files - from being written if there are errors. - -Unlike most systems in CodeIgniter, the error functions are simple -procedural interfaces that are available globally throughout the -application. This approach permits error messages to get triggered -without having to worry about class/function scoping. - -CodeIgniter also returns a status code whenever a portion of the core -calls ``exit()``. This exit status code is separate from the HTTP status -code, and serves as a notice to other processes that may be watching of -whether the script completed successfully, or if not, what kind of -problem it encountered that caused it to abort. These values are -defined in *application/config/constants.php*. While exit status codes -are most useful in CLI settings, returning the proper code helps server -software keep track of your scripts and the health of your application. - -The following functions let you generate errors: - -.. php:function:: show_error($message, $status_code, $heading = 'An Error Was Encountered') - - :param mixed $message: Error message - :param int $status_code: HTTP Response status code - :param string $heading: Error page heading - :rtype: void - - This function will display the error message supplied to it using - the error template appropriate to your execution:: - - application/views/errors/html/error_general.php - - or: - - application/views/errors/cli/error_general.php - - The optional parameter ``$status_code`` determines what HTTP status - code should be sent with the error. If ``$status_code`` is less - than 100, the HTTP status code will be set to 500, and the exit - status code will be set to ``$status_code + EXIT__AUTO_MIN``. - If that value is larger than ``EXIT__AUTO_MAX``, or if - ``$status_code`` is 100 or higher, the exit status code will be set - to ``EXIT_ERROR``. - You can check in *application/config/constants.php* for more detail. - -.. php:function:: show_404($page = '', $log_error = TRUE) - - :param string $page: URI string - :param bool $log_error: Whether to log the error - :rtype: void - - This function will display the 404 error message supplied to it - using the error template appropriate to your execution:: - - application/views/errors/html/error_404.php - - or: - - application/views/errors/cli/error_404.php - - The function expects the string passed to it to be the file path to - the page that isn't found. The exit status code will be set to - ``EXIT_UNKNOWN_FILE``. - Note that CodeIgniter automatically shows 404 messages if - controllers are not found. - - CodeIgniter automatically logs any ``show_404()`` calls. Setting the - optional second parameter to FALSE will skip logging. - -.. php:function:: log_message($level, $message) - - :param string $level: Log level: 'error', 'debug' or 'info' - :param string $message: Message to log - :rtype: void - - This function lets you write messages to your log files. You must - supply one of three "levels" in the first parameter, indicating what - type of message it is (debug, error, info), with the message itself - in the second parameter. - - Example:: - - if ($some_var == '') - { - log_message('error', 'Some variable did not contain a value.'); - } - else - { - log_message('debug', 'Some variable was correctly set'); - } - - log_message('info', 'The purpose of some variable is to provide some value.'); - - There are three message types: - - #. Error Messages. These are actual errors, such as PHP errors or - user errors. - #. Debug Messages. These are messages that assist in debugging. For - example, if a class has been initialized, you could log this as - debugging info. - #. Informational Messages. These are the lowest priority messages, - simply giving information regarding some process. - - .. note:: In order for the log file to actually be written, the - *logs/* directory must be writable. In addition, you must - set the "threshold" for logging in - *application/config/config.php*. You might, for example, - only want error messages to be logged, and not the other - two types. If you set it to zero logging will be disabled. diff --git a/user_guide_src/source/general/helpers.rst b/user_guide_src/source/general/helpers.rst deleted file mode 100644 index d171aa8ed..000000000 --- a/user_guide_src/source/general/helpers.rst +++ /dev/null @@ -1,145 +0,0 @@ -################ -Helper Functions -################ - -Helpers, as the name suggests, help you with tasks. Each helper file is -simply a collection of functions in a particular category. There are **URL -Helpers**, that assist in creating links, there are Form Helpers that help -you create form elements, **Text Helpers** perform various text formatting -routines, **Cookie Helpers** set and read cookies, File Helpers help you -deal with files, etc. - -Unlike most other systems in CodeIgniter, Helpers are not written in an -Object Oriented format. They are simple, procedural functions. Each -helper function performs one specific task, with no dependence on other -functions. - -CodeIgniter does not load Helper Files by default, so the first step in -using a Helper is to load it. Once loaded, it becomes globally available -in your :doc:`controller <../general/controllers>` and -:doc:`views <../general/views>`. - -Helpers are typically stored in your **system/helpers**, or -**application/helpers directory**. CodeIgniter will look first in your -**application/helpers directory**. If the directory does not exist or the -specified helper is not located there CI will instead look in your -global *system/helpers/* directory. - -Loading a Helper -================ - -Loading a helper file is quite simple using the following method:: - - $this->load->helper('name'); - -Where **name** is the file name of the helper, without the .php file -extension or the "helper" part. - -For example, to load the **URL Helper** file, which is named -**url_helper.php**, you would do this:: - - $this->load->helper('url'); - -A helper can be loaded anywhere within your controller methods (or -even within your View files, although that's not a good practice), as -long as you load it before you use it. You can load your helpers in your -controller constructor so that they become available automatically in -any function, or you can load a helper in a specific function that needs -it. - -.. note:: The Helper loading method above does not return a value, so - don't try to assign it to a variable. Just use it as shown. - -Loading Multiple Helpers -======================== - -If you need to load more than one helper you can specify them in an -array, like this:: - - $this->load->helper( - array('helper1', 'helper2', 'helper3') - ); - -Auto-loading Helpers -==================== - -If you find that you need a particular helper globally throughout your -application, you can tell CodeIgniter to auto-load it during system -initialization. This is done by opening the **application/config/autoload.php** -file and adding the helper to the autoload array. - -Using a Helper -============== - -Once you've loaded the Helper File containing the function you intend to -use, you'll call it the way you would a standard PHP function. - -For example, to create a link using the ``anchor()`` function in one of -your view files you would do this:: - - <?php echo anchor('blog/comments', 'Click Here');?> - -Where "Click Here" is the name of the link, and "blog/comments" is the -URI to the controller/method you wish to link to. - -"Extending" Helpers -=================== - -To "extend" Helpers, create a file in your **application/helpers/** folder -with an identical name to the existing Helper, but prefixed with **MY\_** -(this item is configurable. See below.). - -If all you need to do is add some functionality to an existing helper - -perhaps add a function or two, or change how a particular helper -function operates - then it's overkill to replace the entire helper with -your version. In this case it's better to simply "extend" the Helper. - -.. note:: The term "extend" is used loosely since Helper functions are - procedural and discrete and cannot be extended in the traditional - programmatic sense. Under the hood, this gives you the ability to - add to or or to replace the functions a Helper provides. - -For example, to extend the native **Array Helper** you'll create a file -named **application/helpers/MY_array_helper.php**, and add or override -functions:: - - // any_in_array() is not in the Array Helper, so it defines a new function - function any_in_array($needle, $haystack) - { - $needle = is_array($needle) ? $needle : array($needle); - - foreach ($needle as $item) - { - if (in_array($item, $haystack)) - { - return TRUE; - } - } - - return FALSE; - } - - // random_element() is included in Array Helper, so it overrides the native function - function random_element($array) - { - shuffle($array); - return array_pop($array); - } - -Setting Your Own Prefix ------------------------ - -The filename prefix for "extending" Helpers is the same used to extend -libraries and core classes. To set your own prefix, open your -**application/config/config.php** file and look for this item:: - - $config['subclass_prefix'] = 'MY_'; - -Please note that all native CodeIgniter libraries are prefixed with **CI\_** -so DO NOT use that as your prefix. - -Now What? -========= - -In the Table of Contents you'll find a list of all the available Helper -Files. Browse each one to see what they do.
\ No newline at end of file diff --git a/user_guide_src/source/general/hooks.rst b/user_guide_src/source/general/hooks.rst deleted file mode 100644 index 6cc3407a3..000000000 --- a/user_guide_src/source/general/hooks.rst +++ /dev/null @@ -1,127 +0,0 @@ -#################################### -Hooks - Extending the Framework Core -#################################### - -CodeIgniter's Hooks feature provides a means to tap into and modify the -inner workings of the framework without hacking the core files. When -CodeIgniter runs it follows a specific execution process, diagramed in -the :doc:`Application Flow <../overview/appflow>` page. There may be -instances, however, where you'd like to cause some action to take place -at a particular stage in the execution process. For example, you might -want to run a script right before your controllers get loaded, or right -after, or you might want to trigger one of your own scripts in some -other location. - -Enabling Hooks -============== - -The hooks feature can be globally enabled/disabled by setting the -following item in the **application/config/config.php** file:: - - $config['enable_hooks'] = TRUE; - -Defining a Hook -=============== - -Hooks are defined in the **application/config/hooks.php** file. -Each hook is specified as an array with this prototype:: - - $hook['pre_controller'] = array( - 'class' => 'MyClass', - 'function' => 'Myfunction', - 'filename' => 'Myclass.php', - 'filepath' => 'hooks', - 'params' => array('beer', 'wine', 'snacks') - ); - -**Notes:** - -The array index correlates to the name of the particular hook point you -want to use. In the above example the hook point is pre_controller. A -list of hook points is found below. The following items should be -defined in your associative hook array: - -- **class** The name of the class you wish to invoke. If you prefer to - use a procedural function instead of a class, leave this item blank. -- **function** The function (or method) name you wish to call. -- **filename** The file name containing your class/function. -- **filepath** The name of the directory containing your script. - Note: - Your script must be located in a directory INSIDE your *application/* - directory, so the file path is relative to that directory. For example, - if your script is located in *application/hooks/*, you will simply use - 'hooks' as your filepath. If your script is located in - *application/hooks/utilities/* you will use 'hooks/utilities' as your - filepath. No trailing slash. -- **params** Any parameters you wish to pass to your script. This item - is optional. - -You can also use lambda/anoymous functions (or closures) as hooks, with -a simpler syntax:: - - $hook['post_controller'] = function() - { - /* do something here */ - }; - -Multiple Calls to the Same Hook -=============================== - -If want to use the same hook point with more than one script, simply -make your array declaration multi-dimensional, like this:: - - $hook['pre_controller'][] = array( - 'class' => 'MyClass', - 'function' => 'MyMethod', - 'filename' => 'Myclass.php', - 'filepath' => 'hooks', - 'params' => array('beer', 'wine', 'snacks') - ); - - $hook['pre_controller'][] = array( - 'class' => 'MyOtherClass', - 'function' => 'MyOtherMethod', - 'filename' => 'Myotherclass.php', - 'filepath' => 'hooks', - 'params' => array('red', 'yellow', 'blue') - ); - -Notice the brackets after each array index:: - - $hook['pre_controller'][] - -This permits you to have the same hook point with multiple scripts. The -order you define your array will be the execution order. - -Hook Points -=========== - -The following is a list of available hook points. - -- **pre_system** - Called very early during system execution. Only the benchmark and - hooks class have been loaded at this point. No routing or other - processes have happened. -- **pre_controller** - Called immediately prior to any of your controllers being called. - All base classes, routing, and security checks have been done. -- **post_controller_constructor** - Called immediately after your controller is instantiated, but prior - to any method calls happening. -- **post_controller** - Called immediately after your controller is fully executed. -- **display_override** - Overrides the ``_display()`` method, used to send the finalized page - to the web browser at the end of system execution. This permits you - to use your own display methodology. Note that you will need to - reference the CI superobject with ``$this->CI =& get_instance()`` and - then the finalized data will be available by calling - ``$this->CI->output->get_output()``. -- **cache_override** - Enables you to call your own method instead of the ``_display_cache()`` - method in the :doc:`Output Library <../libraries/output>`. This permits - you to use your own cache display mechanism. -- **post_system** - Called after the final rendered page is sent to the browser, at the - end of system execution after the finalized data is sent to the - browser.
\ No newline at end of file diff --git a/user_guide_src/source/general/index.rst b/user_guide_src/source/general/index.rst deleted file mode 100644 index 195c4a98a..000000000 --- a/user_guide_src/source/general/index.rst +++ /dev/null @@ -1,33 +0,0 @@ -############## -General Topics -############## - -.. toctree:: - :titlesonly: - - urls - controllers - reserved_names - views - models - Helpers <helpers> - libraries - creating_libraries - drivers - creating_drivers - core_classes - ancillary_classes - hooks - autoloader - common_functions - compatibility_functions - routing - errors - Caching <caching> - profiling - cli - managing_apps - environments - alternative_php - security - PHP Style Guide <styleguide>
\ No newline at end of file diff --git a/user_guide_src/source/general/libraries.rst b/user_guide_src/source/general/libraries.rst deleted file mode 100644 index 9bbda51bb..000000000 --- a/user_guide_src/source/general/libraries.rst +++ /dev/null @@ -1,32 +0,0 @@ -########################### -Using CodeIgniter Libraries -########################### - -All of the available libraries are located in your *system/libraries/* -directory. In most cases, to use one of these classes involves initializing -it within a :doc:`controller <controllers>` using the following -initialization method:: - - $this->load->library('class_name'); - -Where 'class_name' is the name of the class you want to invoke. For -example, to load the :doc:`Form Validation Library -<../libraries/form_validation>` you would do this:: - - $this->load->library('form_validation'); - -Once initialized you can use it as indicated in the user guide page -corresponding to that class. - -Additionally, multiple libraries can be loaded at the same time by -passing an array of libraries to the load method. - -Example:: - - $this->load->library(array('email', 'table')); - -Creating Your Own Libraries -=========================== - -Please read the section of the user guide that discusses how to -:doc:`create your own libraries <creating_libraries>`.
\ No newline at end of file diff --git a/user_guide_src/source/general/managing_apps.rst b/user_guide_src/source/general/managing_apps.rst deleted file mode 100644 index 4861ba71a..000000000 --- a/user_guide_src/source/general/managing_apps.rst +++ /dev/null @@ -1,61 +0,0 @@ -########################## -Managing your Applications -########################## - -By default it is assumed that you only intend to use CodeIgniter to -manage one application, which you will build in your *application/* -directory. It is possible, however, to have multiple sets of -applications that share a single CodeIgniter installation, or even to -rename or relocate your application directory. - -Renaming the Application Directory -================================== - -If you would like to rename your application directory you may do so -as long as you open your main index.php file and set its name using -the ``$application_folder`` variable:: - - $application_folder = 'application'; - -Relocating your Application Directory -===================================== - -It is possible to move your application directory to a different -location on your server than your web root. To do so open -your main index.php and set a *full server path* in the -``$application_folder`` variable:: - - $application_folder = '/path/to/your/application'; - -Running Multiple Applications with one CodeIgniter Installation -=============================================================== - -If you would like to share a common CodeIgniter installation to manage -several different applications simply put all of the directories located -inside your application directory into their own sub-directory. - -For example, let's say you want to create two applications, named "foo" -and "bar". You could structure your application directories like this:: - - applications/foo/ - applications/foo/config/ - applications/foo/controllers/ - applications/foo/libraries/ - applications/foo/models/ - applications/foo/views/ - applications/bar/ - applications/bar/config/ - applications/bar/controllers/ - applications/bar/libraries/ - applications/bar/models/ - applications/bar/views/ - -To select a particular application for use requires that you open your -main index.php file and set the ``$application_folder`` variable. For -example, to select the "foo" application for use you would do this:: - - $application_folder = 'applications/foo'; - -.. note:: Each of your applications will need its own index.php file - which calls the desired application. The index.php file can be named - anything you want.
\ No newline at end of file diff --git a/user_guide_src/source/general/models.rst b/user_guide_src/source/general/models.rst deleted file mode 100644 index 0b20164e9..000000000 --- a/user_guide_src/source/general/models.rst +++ /dev/null @@ -1,167 +0,0 @@ -###### -Models -###### - -Models are **optionally** available for those who want to use a more -traditional MVC approach. - -.. contents:: Page Contents - -What is a Model? -================ - -Models are PHP classes that are designed to work with information in -your database. For example, let's say you use CodeIgniter to manage a -blog. You might have a model class that contains functions to insert, -update, and retrieve your blog data. Here is an example of what such a -model class might look like:: - - class Blog_model extends CI_Model { - - public $title; - public $content; - public $date; - - public function get_last_ten_entries() - { - $query = $this->db->get('entries', 10); - return $query->result(); - } - - public function insert_entry() - { - $this->title = $_POST['title']; // please read the below note - $this->content = $_POST['content']; - $this->date = time(); - - $this->db->insert('entries', $this); - } - - public function update_entry() - { - $this->title = $_POST['title']; - $this->content = $_POST['content']; - $this->date = time(); - - $this->db->update('entries', $this, array('id' => $_POST['id'])); - } - - } - -.. note:: The methods in the above example use the :doc:`Query Builder - <../database/query_builder>` database methods. - -.. note:: For the sake of simplicity in this example we're using ``$_POST`` - directly. This is generally bad practice, and a more common approach - would be to use the :doc:`Input Library <../libraries/input>` - ``$this->input->post('title')``. - -Anatomy of a Model -================== - -Model classes are stored in your **application/models/** directory. -They can be nested within sub-directories if you want this type of -organization. - -The basic prototype for a model class is this:: - - class Model_name extends CI_Model { - - } - -Where **Model_name** is the name of your class. Class names **must** have -the first letter capitalized with the rest of the name lowercase. Make -sure your class extends the base Model class. - -The file name must match the class name. For example, if this is your class:: - - class User_model extends CI_Model { - - } - -Your file will be this:: - - application/models/User_model.php - -Loading a Model -=============== - -Your models will typically be loaded and called from within your -:doc:`controller <controllers>` methods. To load a model you will use -the following method:: - - $this->load->model('model_name'); - -If your model is located in a sub-directory, include the relative path -from your models directory. For example, if you have a model located at -*application/models/blog/Queries.php* you'll load it using:: - - $this->load->model('blog/queries'); - -Once loaded, you will access your model methods using an object with the -same name as your class:: - - $this->load->model('model_name'); - - $this->model_name->method(); - -If you would like your model assigned to a different object name you can -specify it via the second parameter of the loading method:: - - $this->load->model('model_name', 'foobar'); - - $this->foobar->method(); - -Here is an example of a controller, that loads a model, then serves a -view:: - - class Blog_controller extends CI_Controller { - - public function blog() - { - $this->load->model('blog'); - - $data['query'] = $this->blog->get_last_ten_entries(); - - $this->load->view('blog', $data); - } - } - - -Auto-loading Models -=================== - -If you find that you need a particular model globally throughout your -application, you can tell CodeIgniter to auto-load it during system -initialization. This is done by opening the -**application/config/autoload.php** file and adding the model to the -autoload array. - -Connecting to your Database -=========================== - -When a model is loaded it does **NOT** connect automatically to your -database. The following options for connecting are available to you: - -- You can connect using the standard database methods :doc:`described - here <../database/connecting>`, either from within your - Controller class or your Model class. -- You can tell the model loading method to auto-connect by passing - TRUE (boolean) via the third parameter, and connectivity settings, - as defined in your database config file will be used:: - - $this->load->model('model_name', '', TRUE); - -- You can manually pass database connectivity settings via the third - parameter:: - - $config['hostname'] = 'localhost'; - $config['username'] = 'myusername'; - $config['password'] = 'mypassword'; - $config['database'] = 'mydatabase'; - $config['dbdriver'] = 'mysqli'; - $config['dbprefix'] = ''; - $config['pconnect'] = FALSE; - $config['db_debug'] = TRUE; - - $this->load->model('model_name', '', $config); diff --git a/user_guide_src/source/general/profiling.rst b/user_guide_src/source/general/profiling.rst deleted file mode 100644 index 2716d1781..000000000 --- a/user_guide_src/source/general/profiling.rst +++ /dev/null @@ -1,90 +0,0 @@ -########################## -Profiling Your Application -########################## - -The Profiler Class will display benchmark results, queries you have run, -and ``$_POST`` data at the bottom of your pages. This information can be -useful during development in order to help with debugging and -optimization. - -Initializing the Class -====================== - -.. important:: This class does NOT need to be initialized. It is loaded - automatically by the :doc:`Output Library <../libraries/output>` - if profiling is enabled as shown below. - -Enabling the Profiler -===================== - -To enable the profiler place the following line anywhere within your -:doc:`Controller <controllers>` methods:: - - $this->output->enable_profiler(TRUE); - -When enabled a report will be generated and inserted at the bottom of -your pages. - -To disable the profiler you will use:: - - $this->output->enable_profiler(FALSE); - -Setting Benchmark Points -======================== - -In order for the Profiler to compile and display your benchmark data you -must name your mark points using specific syntax. - -Please read the information on setting Benchmark points in the -:doc:`Benchmark Library <../libraries/benchmark>` page. - -Enabling and Disabling Profiler Sections -======================================== - -Each section of Profiler data can be enabled or disabled by setting a -corresponding config variable to TRUE or FALSE. This can be done one of -two ways. First, you can set application wide defaults with the -*application/config/profiler.php* config file. - -Example:: - - $config['config'] = FALSE; - $config['queries'] = FALSE; - -In your controllers, you can override the defaults and config file -values by calling the ``set_profiler_sections()`` method of the -:doc:`Output Library <../libraries/output>`:: - - $sections = array( - 'config' => TRUE, - 'queries' => TRUE - ); - - $this->output->set_profiler_sections($sections); - -Available sections and the array key used to access them are described -in the table below. - -======================= =================================================================== ======== -Key Description Default -======================= =================================================================== ======== -**benchmarks** Elapsed time of Benchmark points and total execution time TRUE -**config** CodeIgniter Config variables TRUE -**controller_info** The Controller class and method requested TRUE -**get** Any GET data passed in the request TRUE -**http_headers** The HTTP headers for the current request TRUE -**memory_usage** Amount of memory consumed by the current request, in bytes TRUE -**post** Any POST data passed in the request TRUE -**queries** Listing of all database queries executed, including execution time TRUE -**uri_string** The URI of the current request TRUE -**session_data** Data stored in the current session TRUE -**query_toggle_count** The number of queries after which the query block will default to 25 - hidden. -======================= =================================================================== ======== - -.. 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/requirements.rst b/user_guide_src/source/general/requirements.rst deleted file mode 100644 index f2729f3d5..000000000 --- a/user_guide_src/source/general/requirements.rst +++ /dev/null @@ -1,21 +0,0 @@ -################### -Server Requirements -################### - -`PHP <http://php.net/>`_ version 5.6 or newer is recommended. - -It should work on 5.3.7 as well, but we strongly advise you NOT to run -such old versions of PHP, because of potential security and performance -issues, as well as missing features. - -A database is required for most web application programming. -Currently supported databases are: - - - MySQL (5.1+) via the *mysql* (deprecated), *mysqli* and *pdo* drivers - - Oracle via the *oci8* and *pdo* drivers - - PostgreSQL via the *postgre* and *pdo* drivers - - MS SQL via the *mssql*, *sqlsrv* (version 2005 and above only) and *pdo* drivers - - SQLite via the *sqlite* (version 2), *sqlite3* (version 3) and *pdo* drivers - - CUBRID via the *cubrid* and *pdo* drivers - - Interbase/Firebird via the *ibase* and *pdo* drivers - - ODBC via the *odbc* and *pdo* drivers (you should know that ODBC is actually an abstraction layer)
\ 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 deleted file mode 100644 index 5d745cba6..000000000 --- a/user_guide_src/source/general/reserved_names.rst +++ /dev/null @@ -1,88 +0,0 @@ -############## -Reserved Names -############## - -In order to help out, CodeIgniter uses a series of function, method, -class and variable names in its operation. Because of this, some names -cannot be used by a developer. Following is a list of reserved names -that cannot be used. - -Controller names ----------------- - -Since your controller classes will extend the main application -controller you must be careful not to name your methods identically to -the ones used by that class, otherwise your local methods will -override them. The following is a list of reserved names. Do not name -your controller any of these: - -- CI_Controller -- Default -- index - -Functions ---------- - -- :php:func:`is_php()` -- :php:func:`is_really_writable()` -- ``load_class()`` -- ``is_loaded()`` -- ``get_config()`` -- :php:func:`config_item()` -- :php:func:`show_error()` -- :php:func:`show_404()` -- :php:func:`log_message()` -- :php:func:`set_status_header()` -- :php:func:`get_mimes()` -- :php:func:`html_escape()` -- :php:func:`remove_invisible_characters()` -- :php:func:`is_https()` -- :php:func:`function_usable()` -- :php:func:`get_instance()` -- ``_error_handler()`` -- ``_exception_handler()`` -- ``_stringify_attributes()`` - -Variables ---------- - -- ``$config`` -- ``$db`` -- ``$lang`` - -Constants ---------- - -- ENVIRONMENT -- FCPATH -- SELF -- BASEPATH -- APPPATH -- VIEWPATH -- CI_VERSION -- MB_ENABLED -- ICONV_ENABLED -- UTF8_ENABLED -- FILE_READ_MODE -- FILE_WRITE_MODE -- DIR_READ_MODE -- DIR_WRITE_MODE -- FOPEN_READ -- FOPEN_READ_WRITE -- FOPEN_WRITE_CREATE_DESTRUCTIVE -- FOPEN_READ_WRITE_CREATE_DESTRUCTIVE -- FOPEN_WRITE_CREATE -- FOPEN_READ_WRITE_CREATE -- FOPEN_WRITE_CREATE_STRICT -- FOPEN_READ_WRITE_CREATE_STRICT -- SHOW_DEBUG_BACKTRACE -- EXIT_SUCCESS -- EXIT_ERROR -- EXIT_CONFIG -- EXIT_UNKNOWN_FILE -- EXIT_UNKNOWN_CLASS -- EXIT_UNKNOWN_METHOD -- EXIT_USER_INPUT -- EXIT_DATABASE -- EXIT__AUTO_MIN -- EXIT__AUTO_MAX
\ No newline at end of file diff --git a/user_guide_src/source/general/routing.rst b/user_guide_src/source/general/routing.rst deleted file mode 100644 index 909289d8d..000000000 --- a/user_guide_src/source/general/routing.rst +++ /dev/null @@ -1,207 +0,0 @@ -########### -URI Routing -########### - -Typically there is a one-to-one relationship between a URL string and -its corresponding controller class/method. The segments in a URI -normally follow this pattern:: - - example.com/class/function/id/ - -In some instances, however, you may want to remap this relationship so -that a different class/method can be called instead of the one -corresponding to the URL. - -For example, let's say you want your URLs to have this prototype:: - - example.com/product/1/ - example.com/product/2/ - example.com/product/3/ - example.com/product/4/ - -Normally the second segment of the URL is reserved for the method -name, but in the example above it instead has a product ID. To -overcome this, CodeIgniter allows you to remap the URI handler. - -Setting your own routing rules -============================== - -Routing rules are defined in your *application/config/routes.php* file. -In it you'll see an array called ``$route`` that permits you to specify -your own routing criteria. Routes can either be specified using wildcards -or Regular Expressions. - -Wildcards -========= - -A typical wildcard route might look something like this:: - - $route['product/:num'] = 'catalog/product_lookup'; - -In a route, the array key contains the URI to be matched, while the -array value contains the destination it should be re-routed to. In the -above example, if the literal word "product" is found in the first -segment of the URL, and a number is found in the second segment, the -"catalog" class and the "product_lookup" method are instead used. - -You can match literal values or you can use two wildcard types: - -**(:num)** will match a segment containing only numbers. -**(:any)** will match a segment containing any character (except for '/', which is the segment delimiter). - -.. note:: Wildcards are actually aliases for regular expressions, with - **:any** being translated to **[^/]+** and **:num** to **[0-9]+**, - respectively. - -.. note:: Routes will run in the order they are defined. Higher routes - will always take precedence over lower ones. - -.. note:: Route rules are not filters! Setting a rule of e.g. - 'foo/bar/(:num)' will not prevent controller *Foo* and method - *bar* to be called with a non-numeric value if that is a valid - route. - -Examples -======== - -Here are a few routing examples:: - - $route['journals'] = 'blogs'; - -A URL containing the word "journals" in the first segment will be -remapped to the "blogs" class. - -:: - - $route['blog/joe'] = 'blogs/users/34'; - -A URL containing the segments blog/joe will be remapped to the "blogs" -class and the "users" method. The ID will be set to "34". - -:: - - $route['product/(:any)'] = 'catalog/product_lookup'; - -A URL with "product" as the first segment, and anything in the second -will be remapped to the "catalog" class and the "product_lookup" -method. - -:: - - $route['product/(:num)'] = 'catalog/product_lookup_by_id/$1'; - -A URL with "product" as the first segment, and a number in the second -will be remapped to the "catalog" class and the -"product_lookup_by_id" method passing in the match as a variable to -the method. - -.. important:: Do not use leading/trailing slashes. - -Regular Expressions -=================== - -If you prefer you can use regular expressions to define your routing -rules. Any valid regular expression is allowed, as are back-references. - -.. note:: If you use back-references you must use the dollar syntax - rather than the double backslash syntax. - -A typical RegEx route might look something like this:: - - $route['products/([a-z]+)/(\d+)'] = '$1/id_$2'; - -In the above example, a URI similar to products/shirts/123 would instead -call the "shirts" controller class and the "id_123" method. - -With regular expressions, you can also catch multiple segments at once. -For example, if a user accesses a password protected area of your web -application and you wish to be able to redirect them back to the same -page after they log in, you may find this example useful:: - - $route['login/(.+)'] = 'auth/login/$1'; - -.. note:: In the above example, if the ``$1`` placeholder contains a - slash, it will still be split into multiple parameters when - passed to ``Auth::login()``. - -For those of you who don't know regular expressions and want to learn -more about them, `regular-expressions.info <http://www.regular-expressions.info/>`_ -might be a good starting point. - -.. note:: You can also mix and match wildcards with regular expressions. - -Callbacks -========= - -You can also use callbacks in place of the normal routing rules to process -the back-references. Example:: - - $route['products/([a-zA-Z]+)/edit/(\d+)'] = function ($product_type, $id) - { - return 'catalog/product_edit/' . strtolower($product_type) . '/' . $id; - }; - -Using HTTP verbs in routes -========================== - -It is possible to use HTTP verbs (request method) to define your routing rules. -This is particularly useful when building RESTful applications. You can use standard HTTP -verbs (GET, PUT, POST, DELETE, PATCH) or a custom one such (e.g. PURGE). HTTP verb rules -are case-insensitive. All you need to do is to add the verb as an array key to your route. -Example:: - - $route['products']['put'] = 'product/insert'; - -In the above example, a PUT request to URI "products" would call the ``Product::insert()`` -controller method. - -:: - - $route['products/(:num)']['DELETE'] = 'product/delete/$1'; - -A DELETE request to URL with "products" as first the segment and a number in the second will be -mapped to the ``Product::delete()`` method, passing the numeric value as the first parameter. - -Using HTTP verbs is of course, optional. - -Reserved Routes -=============== - -There are three reserved routes:: - - $route['default_controller'] = 'welcome'; - -This route points to the action that should be executed if the URI contains -no data, which will be the case when people load your root URL. -The setting accepts a **controller/method** value and ``index()`` would be -the default method if you don't specify one. In the above example, it is -``Welcome::index()`` that would be called. - -.. note:: You can NOT use a directory as a part of this setting! - -You are encouraged to always have a default route as otherwise a 404 page -will appear by default. - -:: - - $route['404_override'] = ''; - -This route indicates which controller class should be loaded if the -requested controller is not found. It will override the default 404 -error page. Same per-directory rules as with 'default_controller' -apply here as well. - -It won't affect to the ``show_404()`` function, which will -continue loading the default *error_404.php* file at -*application/views/errors/error_404.php*. - -:: - - $route['translate_uri_dashes'] = FALSE; - -As evident by the boolean value, this is not exactly a route. This -option enables you to automatically replace dashes ('-') with -underscores in the controller and method URI segments, thus saving you -additional route entries if you need to do that. -This is required, because the dash isn't a valid class or method name -character and would cause a fatal error if you try to use it. diff --git a/user_guide_src/source/general/security.rst b/user_guide_src/source/general/security.rst deleted file mode 100644 index 744a2c934..000000000 --- a/user_guide_src/source/general/security.rst +++ /dev/null @@ -1,200 +0,0 @@ -######## -Security -######## - -This page describes some "best practices" regarding web security, and -details CodeIgniter's internal security features. - -.. note:: If you came here looking for a security contact, please refer to - our `Contribution Guide <../contributing/index>`. - -URI Security -============ - -CodeIgniter is fairly restrictive regarding which characters it allows -in your URI strings in order to help minimize the possibility that -malicious data can be passed to your application. URIs may only contain -the following: - -- Alpha-numeric text (latin characters only) -- Tilde: ~ -- Percent sign: % -- Period: . -- Colon: : -- Underscore: \_ -- Dash: - -- Space - -Register_globals -================ - -During system initialization all global variables that are found to exist -in the ``$_GET``, ``$_POST``, ``$_REQUEST`` and ``$_COOKIE`` are unset. - -The unsetting routine is effectively the same as *register_globals = off*. - -display_errors -============== - -In production environments, it is typically desirable to "disable" PHP's -error reporting by setting the internal *display_errors* flag to a value -of 0. This disables native PHP errors from being rendered as output, -which may potentially contain sensitive information. - -Setting CodeIgniter's **ENVIRONMENT** constant in index.php to a value of -**\'production\'** will turn off these errors. In development mode, it is -recommended that a value of 'development' is used. More information -about differentiating between environments can be found on the -:doc:`Handling Environments <environments>` page. - -magic_quotes_runtime -==================== - -The *magic_quotes_runtime* directive is turned off during system -initialization so that you don't have to remove slashes when retrieving -data from your database. - -************** -Best Practices -************** - -Before accepting any data into your application, whether it be POST data -from a form submission, COOKIE data, URI data, XML-RPC data, or even -data from the SERVER array, you are encouraged to practice this three -step approach: - -#. Validate the data to ensure it conforms to the correct type, length, - size, etc. -#. Filter the data as if it were tainted. -#. Escape the data before submitting it into your database or outputting - it to a browser. - -CodeIgniter provides the following functions and tips to assist you -in this process: - -XSS Filtering -============= - -CodeIgniter comes with a Cross Site Scripting filter. This filter -looks for commonly used techniques to embed malicious JavaScript into -your data, or other types of code that attempt to hijack cookies or -do other malicious things. The XSS Filter is described -:doc:`here <../libraries/security>`. - -.. note:: XSS filtering should *only be performed on output*. Filtering - input data may modify the data in undesirable ways, including - stripping special characters from passwords, which reduces - security instead of improving it. - -CSRF protection -=============== - -CSRF stands for Cross-Site Request Forgery, which is the process of an -attacker tricking their victim into unknowingly submitting a request. - -CodeIgniter provides CSRF protection out of the box, which will get -automatically triggered for every non-GET HTTP request, but also needs -you to create your submit forms in a certain way. This is explained in -the :doc:`Security Library <../libraries/security>` documentation. - -Password handling -================= - -It is *critical* that you handle passwords in your application properly. - -Unfortunately, many developers don't know how to do that, and the web is -full of outdated or otherwise wrongful advices, which doesn't help. - -We would like to give you a list of combined do's and don'ts to help you -with that. Please read below. - -- DO NOT store passwords in plain-text format. - - Always **hash** your passwords. - -- DO NOT use Base64 or similar encoding for storing passwords. - - This is as good as storing them in plain-text. Really. Do **hashing**, - not *encoding*. - - Encoding, and encryption too, are two-way processes. Passwords are - secrets that must only be known to their owner, and thus must work - only in one direction. Hashing does that - there's *no* un-hashing or - de-hashing, but there is decoding and decryption. - -- DO NOT use weak or broken hashing algorithms like MD5 or SHA1. - - These algorithms are old, proven to be flawed, and not designed for - password hashing in the first place. - - Also, DON'T invent your own algorithms. - - Only use strong password hashing algorithms like BCrypt, which is used - in PHP's own `Password Hashing <http://php.net/password>`_ functions. - - Please use them, even if you're not running PHP 5.5+, CodeIgniter - provides them for you. - -- DO NOT ever display or send a password in plain-text format! - - Even to the password's owner, if you need a "Forgotten password" - feature, just randomly generate a new, one-time (this is also important) - password and send that instead. - -- DO NOT put unnecessary limits on your users' passwords. - - If you're using a hashing algorithm other than BCrypt (which has a limit - of 72 characters), you should set a relatively high limit on password - lengths in order to mitigate DoS attacks - say, 1024 characters. - - Other than that however, there's no point in forcing a rule that a - password can only be up to a number of characters, or that it can't - contain a certain set of special characters. - - Not only does this **reduce** security instead of improving it, but - there's literally no reason to do it. No technical limitations and - no (practical) storage constraints apply once you've hashed them, none! - -Validate input data -=================== - -CodeIgniter has a :doc:`Form Validation Library -<../libraries/form_validation>` that assists you in -validating, filtering, and prepping your data. - -Even if that doesn't work for your use case however, be sure to always -validate and sanitize all input data. For example, if you expect a numeric -string for an input variable, you can check for that with ``is_numeric()`` -or ``ctype_digit()``. Always try to narrow down your checks to a certain -pattern. - -Have it in mind that this includes not only ``$_POST`` and ``$_GET`` -variables, but also cookies, the user-agent string and basically -*all data that is not created directly by your own code*. - - -Escape all data before database insertion -========================================= - -Never insert information into your database without escaping it. -Please see the section that discusses :doc:`database queries -<../database/queries>` for more information. - -Hide your files -=============== - -Another good security practice is to only leave your *index.php* -and "assets" (e.g. .js, css and image files) under your server's -*webroot* directory (most commonly named "htdocs/"). These are -the only files that you would need to be accessible from the web. - -Allowing your visitors to see anything else would potentially -allow them to access sensitive data, execute scripts, etc. - -If you're not allowed to do that, you can try using a .htaccess -file to restrict access to those resources. - -CodeIgniter will have an index.html file in all of its -directories in an attempt to hide some of this data, but have -it in mind that this is not enough to prevent a serious -attacker. diff --git a/user_guide_src/source/general/styleguide.rst b/user_guide_src/source/general/styleguide.rst deleted file mode 100644 index 9b4a84e14..000000000 --- a/user_guide_src/source/general/styleguide.rst +++ /dev/null @@ -1,636 +0,0 @@ -############### -PHP Style Guide -############### - - -The following page describes the coding styles adhered to when -contributing to the development of CodeIgniter. There is no requirement -to use these styles in your own CodeIgniter application, though they -are recommended. - -.. contents:: Table of Contents - -File Format -=========== - -Files should be saved with Unicode (UTF-8) encoding. The BOM should -*not* be used. Unlike UTF-16 and UTF-32, there's no byte order to -indicate in a UTF-8 encoded file, and the BOM can have a negative side -effect in PHP of sending output, preventing the application from being -able to set its own headers. Unix line endings should be used (LF). - -Here is how to apply these settings in some of the more common text -editors. Instructions for your text editor may vary; check your text -editor's documentation. - -TextMate -'''''''' - -#. Open the Application Preferences -#. Click Advanced, and then the "Saving" tab -#. In "File Encoding", select "UTF-8 (recommended)" -#. In "Line Endings", select "LF (recommended)" -#. *Optional:* Check "Use for existing files as well" if you wish to - modify the line endings of files you open to your new preference. - -BBEdit -'''''' - -#. Open the Application Preferences -#. Select "Text Encodings" on the left. -#. In "Default text encoding for new documents", select "Unicode (UTF-8, - no BOM)" -#. *Optional:* In "If file's encoding can't be guessed, use", select - "Unicode (UTF-8, no BOM)" -#. Select "Text Files" on the left. -#. In "Default line breaks", select "Mac OS X and Unix (LF)" - -PHP Closing Tag -=============== - -The PHP closing tag on a PHP document **?>** is optional to the PHP -parser. However, if used, any whitespace following the closing tag, -whether introduced by the developer, user, or an FTP application, can -cause unwanted output, PHP errors, or if the latter are suppressed, -blank pages. For this reason, all PHP files MUST OMIT the PHP closing -tag and end with a single empty line instead. - -File Naming -=========== - -Class files must be named in a Ucfirst-like manner, while any other file name -(configurations, views, generic scripts, etc.) should be in all lowercase. - -**INCORRECT**:: - - somelibrary.php - someLibrary.php - SOMELIBRARY.php - Some_Library.php - - Application_config.php - Application_Config.php - applicationConfig.php - -**CORRECT**:: - - Somelibrary.php - Some_library.php - - applicationconfig.php - application_config.php - -Furthermore, class file names should match the name of the class itself. -For example, if you have a class named `Myclass`, then its filename must -be **Myclass.php**. - -Class and Method Naming -======================= - -Class names should always start with an uppercase letter. Multiple words -should be separated with an underscore, and not CamelCased. - -**INCORRECT**:: - - class superclass - class SuperClass - -**CORRECT**:: - - class Super_class - -:: - - class Super_class { - - public function __construct() - { - - } - } - -Class methods should be entirely lowercased and named to clearly -indicate their function, preferably including a verb. Try to avoid -overly long and verbose names. Multiple words should be separated -with an underscore. - -**INCORRECT**:: - - function fileproperties() // not descriptive and needs underscore separator - function fileProperties() // not descriptive and uses CamelCase - function getfileproperties() // Better! But still missing underscore separator - function getFileProperties() // uses CamelCase - function get_the_file_properties_from_the_file() // wordy - -**CORRECT**:: - - function get_file_properties() // descriptive, underscore separator, and all lowercase letters - -Variable Names -============== - -The guidelines for variable naming are very similar to those used for -class methods. Variables should contain only lowercase letters, -use underscore separators, and be reasonably named to indicate their -purpose and contents. Very short, non-word variables should only be used -as iterators in for() loops. - -**INCORRECT**:: - - $j = 'foo'; // single letter variables should only be used in for() loops - $Str // contains uppercase letters - $bufferedText // uses CamelCasing, and could be shortened without losing semantic meaning - $groupid // multiple words, needs underscore separator - $name_of_last_city_used // too long - -**CORRECT**:: - - for ($j = 0; $j < 10; $j++) - $str - $buffer - $group_id - $last_city - -Commenting -========== - -In general, code should be commented prolifically. It not only helps -describe the flow and intent of the code for less experienced -programmers, but can prove invaluable when returning to your own code -months down the line. There is not a required format for comments, but -the following are recommended. - -`DocBlock <http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#basics.docblock>`_ -style comments preceding class, method, and property declarations so they can be -picked up by IDEs:: - - /** - * Super Class - * - * @package Package Name - * @subpackage Subpackage - * @category Category - * @author Author Name - * @link http://example.com - */ - class Super_class { - -:: - - /** - * Encodes string for use in XML - * - * @param string $str Input string - * @return string - */ - function xml_encode($str) - -:: - - /** - * Data for class manipulation - * - * @var array - */ - public $data = array(); - -Use single line comments within code, leaving a blank line between large -comment blocks and code. - -:: - - // break up the string by newlines - $parts = explode("\n", $str); - - // A longer comment that needs to give greater detail on what is - // occurring and why can use multiple single-line comments. Try to - // keep the width reasonable, around 70 characters is the easiest to - // read. Don't hesitate to link to permanent external resources - // that may provide greater detail: - // - // http://example.com/information_about_something/in_particular/ - - $parts = $this->foo($parts); - -Constants -========= - -Constants follow the same guidelines as do variables, except constants -should always be fully uppercase. *Always use CodeIgniter constants when -appropriate, i.e. SLASH, LD, RD, PATH_CACHE, etc.* - -**INCORRECT**:: - - myConstant // missing underscore separator and not fully uppercase - N // no single-letter constants - S_C_VER // not descriptive - $str = str_replace('{foo}', 'bar', $str); // should use LD and RD constants - -**CORRECT**:: - - MY_CONSTANT - NEWLINE - SUPER_CLASS_VERSION - $str = str_replace(LD.'foo'.RD, 'bar', $str); - -TRUE, FALSE, and NULL -===================== - -**TRUE**, **FALSE**, and **NULL** keywords should always be fully -uppercase. - -**INCORRECT**:: - - if ($foo == true) - $bar = false; - function foo($bar = null) - -**CORRECT**:: - - if ($foo == TRUE) - $bar = FALSE; - function foo($bar = NULL) - -Logical Operators -================= - -Use of the ``||`` "or" comparison operator is discouraged, as its clarity -on some output devices is low (looking like the number 11, for instance). -``&&`` is preferred over ``AND`` but either are acceptable, and a space should -always precede and follow ``!``. - -**INCORRECT**:: - - if ($foo || $bar) - if ($foo AND $bar) // okay but not recommended for common syntax highlighting applications - if (!$foo) - if (! is_array($foo)) - -**CORRECT**:: - - if ($foo OR $bar) - if ($foo && $bar) // recommended - if ( ! $foo) - if ( ! is_array($foo)) - - -Comparing Return Values and Typecasting -======================================= - -Some PHP functions return FALSE on failure, but may also have a valid -return value of "" or 0, which would evaluate to FALSE in loose -comparisons. Be explicit by comparing the variable type when using these -return values in conditionals to ensure the return value is indeed what -you expect, and not a value that has an equivalent loose-type -evaluation. - -Use the same stringency in returning and checking your own variables. -Use **===** and **!==** as necessary. - -**INCORRECT**:: - - // If 'foo' is at the beginning of the string, strpos will return a 0, - // resulting in this conditional evaluating as TRUE - if (strpos($str, 'foo') == FALSE) - -**CORRECT**:: - - if (strpos($str, 'foo') === FALSE) - -**INCORRECT**:: - - function build_string($str = "") - { - if ($str == "") // uh-oh! What if FALSE or the integer 0 is passed as an argument? - { - - } - } - -**CORRECT**:: - - function build_string($str = "") - { - if ($str === "") - { - - } - } - - -See also information regarding `typecasting -<http://php.net/manual/en/language.types.type-juggling.php#language.types.typecasting>`_, -which can be quite useful. Typecasting has a slightly different effect -which may be desirable. When casting a variable as a string, for -instance, NULL and boolean FALSE variables become empty strings, 0 (and -other numbers) become strings of digits, and boolean TRUE becomes "1":: - - $str = (string) $str; // cast $str as a string - -Debugging Code -============== - -Do not leave debugging code in your submissions, even when commented out. -Things such as ``var_dump()``, ``print_r()``, ``die()``/``exit()`` should not be included -in your code unless it serves a specific purpose other than debugging. - -Whitespace in Files -=================== - -No whitespace can precede the opening PHP tag or follow the closing PHP -tag. Output is buffered, so whitespace in your files can cause output to -begin before CodeIgniter outputs its content, leading to errors and an -inability for CodeIgniter to send proper headers. - -Compatibility -============= - -CodeIgniter recommends PHP 5.6 or newer to be used, but it should be -compatible with PHP 5.3.7. Your code must either be compatible with this -requirement, provide a suitable fallback, or be an optional feature that -dies quietly without affecting a user's application. - -Additionally, do not use PHP functions that require non-default libraries -to be installed unless your code contains an alternative method when the -function is not available. - -One File per Class -================== - -Use separate files for each class, unless the classes are *closely related*. -An example of a CodeIgniter file that contains multiple classes is the -Xmlrpc library file. - -Whitespace -========== - -Use tabs for whitespace in your code, not spaces. This may seem like a -small thing, but using tabs instead of whitespace allows the developer -looking at your code to have indentation at levels that they prefer and -customize in whatever application they use. And as a side benefit, it -results in (slightly) more compact files, storing one tab character -versus, say, four space characters. - -Line Breaks -=========== - -Files must be saved with Unix line breaks. This is more of an issue for -developers who work in Windows, but in any case ensure that your text -editor is setup to save files with Unix line breaks. - -Code Indenting -============== - -Use Allman style indenting. With the exception of Class declarations, -braces are always placed on a line by themselves, and indented at the -same level as the control statement that "owns" them. - -**INCORRECT**:: - - function foo($bar) { - // ... - } - - foreach ($arr as $key => $val) { - // ... - } - - if ($foo == $bar) { - // ... - } else { - // ... - } - - for ($i = 0; $i < 10; $i++) - { - for ($j = 0; $j < 10; $j++) - { - // ... - } - } - - try { - // ... - } - catch() { - // ... - } - -**CORRECT**:: - - function foo($bar) - { - // ... - } - - foreach ($arr as $key => $val) - { - // ... - } - - if ($foo == $bar) - { - // ... - } - else - { - // ... - } - - for ($i = 0; $i < 10; $i++) - { - for ($j = 0; $j < 10; $j++) - { - // ... - } - } - - try - { - // ... - } - catch() - { - // ... - } - -Bracket and Parenthetic Spacing -=============================== - -In general, parenthesis and brackets should not use any additional -spaces. The exception is that a space should always follow PHP control -structures that accept arguments with parenthesis (declare, do-while, -elseif, for, foreach, if, switch, while), to help distinguish them from -functions and increase readability. - -**INCORRECT**:: - - $arr[ $foo ] = 'foo'; - -**CORRECT**:: - - $arr[$foo] = 'foo'; // no spaces around array keys - -**INCORRECT**:: - - function foo ( $bar ) - { - - } - -**CORRECT**:: - - function foo($bar) // no spaces around parenthesis in function declarations - { - - } - -**INCORRECT**:: - - foreach( $query->result() as $row ) - -**CORRECT**:: - - foreach ($query->result() as $row) // single space following PHP control structures, but not in interior parenthesis - -Localized Text -============== - -CodeIgniter libraries should take advantage of corresponding language files -whenever possible. - -**INCORRECT**:: - - return "Invalid Selection"; - -**CORRECT**:: - - return $this->lang->line('invalid_selection'); - -Private Methods and Variables -============================= - -Methods and variables that are only accessed internally, -such as utility and helper functions that your public methods use for -code abstraction, should be prefixed with an underscore. - -:: - - public function convert_text() - private function _convert_text() - -PHP Errors -========== - -Code must run error free and not rely on warnings and notices to be -hidden to meet this requirement. For instance, never access a variable -that you did not set yourself (such as ``$_POST`` array keys) without first -checking to see that it ``isset()``. - -Make sure that your dev environment has error reporting enabled -for ALL users, and that display_errors is enabled in the PHP -environment. You can check this setting with:: - - if (ini_get('display_errors') == 1) - { - exit "Enabled"; - } - -On some servers where *display_errors* is disabled, and you do not have -the ability to change this in the php.ini, you can often enable it with:: - - ini_set('display_errors', 1); - -.. note:: Setting the `display_errors - <http://php.net/manual/en/errorfunc.configuration.php#ini.display-errors>`_ - setting with ``ini_set()`` at runtime is not identical to having - it enabled in the PHP environment. Namely, it will not have any - effect if the script has fatal errors. - -Short Open Tags -=============== - -Always use full PHP opening tags, in case a server does not have -*short_open_tag* enabled. - -**INCORRECT**:: - - <? echo $foo; ?> - - <?=$foo?> - -**CORRECT**:: - - <?php echo $foo; ?> - -.. note:: PHP 5.4 will always have the **<?=** tag available. - -One Statement Per Line -====================== - -Never combine statements on one line. - -**INCORRECT**:: - - $foo = 'this'; $bar = 'that'; $bat = str_replace($foo, $bar, $bag); - -**CORRECT**:: - - $foo = 'this'; - $bar = 'that'; - $bat = str_replace($foo, $bar, $bag); - -Strings -======= - -Always use single quoted strings unless you need variables parsed, and -in cases where you do need variables parsed, use braces to prevent -greedy token parsing. You may also use double-quoted strings if the -string contains single quotes, so you do not have to use escape -characters. - -**INCORRECT**:: - - "My String" // no variable parsing, so no use for double quotes - "My string $foo" // needs braces - 'SELECT foo FROM bar WHERE baz = \'bag\'' // ugly - -**CORRECT**:: - - 'My String' - "My string {$foo}" - "SELECT foo FROM bar WHERE baz = 'bag'" - -SQL Queries -=========== - -SQL keywords are always capitalized: SELECT, INSERT, UPDATE, WHERE, -AS, JOIN, ON, IN, etc. - -Break up long queries into multiple lines for legibility, preferably -breaking for each clause. - -**INCORRECT**:: - - // keywords are lowercase and query is too long for - // a single line (... indicates continuation of line) - $query = $this->db->query("select foo, bar, baz, foofoo, foobar as raboof, foobaz from exp_pre_email_addresses - ...where foo != 'oof' and baz != 'zab' order by foobaz limit 5, 100"); - -**CORRECT**:: - - $query = $this->db->query("SELECT foo, bar, baz, foofoo, foobar AS raboof, foobaz - FROM exp_pre_email_addresses - WHERE foo != 'oof' - AND baz != 'zab' - ORDER BY foobaz - LIMIT 5, 100"); - -Default Function Arguments -========================== - -Whenever appropriate, provide function argument defaults, which helps -prevent PHP errors with mistaken calls and provides common fallback -values which can save a few lines of code. Example:: - - function foo($bar = '', $baz = FALSE)
\ No newline at end of file diff --git a/user_guide_src/source/general/urls.rst b/user_guide_src/source/general/urls.rst deleted file mode 100644 index b8a1b9f5b..000000000 --- a/user_guide_src/source/general/urls.rst +++ /dev/null @@ -1,100 +0,0 @@ -################ -CodeIgniter URLs -################ - -By default, URLs in CodeIgniter are designed to be search-engine and -human friendly. Rather than using the standard "query string" approach -to URLs that is synonymous with dynamic systems, CodeIgniter uses a -**segment-based** approach:: - - example.com/news/article/my_article - -.. note:: Query string URLs can be optionally enabled, as described - below. - -URI Segments -============ - -The segments in the URL, in following with the Model-View-Controller -approach, usually represent:: - - example.com/class/function/ID - -#. The first segment represents the controller **class** that should be - invoked. -#. The second segment represents the class **function**, or method, that - should be called. -#. The third, and any additional segments, represent the ID and any - variables that will be passed to the controller. - -The :doc:`URI Library <../libraries/uri>` and the :doc:`URL Helper -<../helpers/url_helper>` contain functions that make it easy to work -with your URI data. In addition, your URLs can be remapped using the -:doc:`URI Routing <routing>` feature for more flexibility. - -Removing the index.php file -=========================== - -By default, the **index.php** file will be included in your URLs:: - - example.com/index.php/news/article/my_article - -If your Apache server has *mod_rewrite* enabled, you can easily remove this -file by using a .htaccess file with some simple rules. Here is an example -of such a file, using the "negative" method in which everything is redirected -except the specified items: - -.. code-block:: apache - - RewriteEngine On - RewriteCond %{REQUEST_FILENAME} !-f - RewriteCond %{REQUEST_FILENAME} !-d - RewriteRule ^(.*)$ index.php/$1 [L] - -In the above example, any HTTP request other than those for existing -directories and existing files is treated as a request for your index.php file. - -.. note:: These specific rules might not work for all server configurations. - -.. note:: Make sure to also exclude from the above rule any assets that you - might need to be accessible from the outside world. - -Adding a URL Suffix -=================== - -In your **config/config.php** file you can specify a suffix that will be -added to all URLs generated by CodeIgniter. For example, if a URL is -this:: - - example.com/index.php/products/view/shoes - -You can optionally add a suffix, like **.html,** making the page appear to -be of a certain type:: - - example.com/index.php/products/view/shoes.html - -Enabling Query Strings -====================== - -In some cases you might prefer to use query strings URLs:: - - index.php?c=products&m=view&id=345 - -CodeIgniter optionally supports this capability, which can be enabled in -your **application/config.php** file. If you open your config file you'll -see these items:: - - $config['enable_query_strings'] = FALSE; - $config['controller_trigger'] = 'c'; - $config['function_trigger'] = 'm'; - -If you change "enable_query_strings" to TRUE this feature will become -active. Your controllers and functions will then be accessible using the -"trigger" words you've set to invoke your controllers and methods:: - - index.php?c=controller&m=method - -.. note:: If you are using query strings you will have to build your own - URLs, rather than utilizing the URL helpers (and other helpers - that generate URLs, like some of the form helpers) as these are - designed to work with segment based URLs.
\ No newline at end of file diff --git a/user_guide_src/source/general/views.rst b/user_guide_src/source/general/views.rst deleted file mode 100644 index 2fc0cb2ca..000000000 --- a/user_guide_src/source/general/views.rst +++ /dev/null @@ -1,213 +0,0 @@ -##### -Views -##### - -A view is simply a web page, or a page fragment, like a header, footer, -sidebar, etc. In fact, views can flexibly be embedded within other views -(within other views, etc., etc.) if you need this type of hierarchy. - -Views are never called directly, they must be loaded by a -:doc:`controller <controllers>`. Remember that in an MVC framework, the -Controller acts as the traffic cop, so it is responsible for fetching a -particular view. If you have not read the -:doc:`Controllers <controllers>` page you should do so before -continuing. - -Using the example controller you created in the -:doc:`controller <controllers>` page, let's add a view to it. - -Creating a View -=============== - -Using your text editor, create a file called blogview.php, and put this -in it:: - - <html> - <head> - <title>My Blog</title> - </head> - <body> - <h1>Welcome to my Blog!</h1> - </body> - </html> - -Then save the file in your *application/views/* directory. - -Loading a View -============== - -To load a particular view file you will use the following method:: - - $this->load->view('name'); - -Where name is the name of your view file. - -.. note:: The .php file extension does not need to be specified - unless you use something other than .php. - -Now, open the controller file you made earlier called Blog.php, and -replace the echo statement with the view loading method:: - - <?php - class Blog extends CI_Controller { - - public function index() - { - $this->load->view('blogview'); - } - } - -If you visit your site using the URL you did earlier you should see your -new view. The URL was similar to this:: - - example.com/index.php/blog/ - -Loading multiple views -====================== - -CodeIgniter will intelligently handle multiple calls to -``$this->load->view()`` from within a controller. If more than one call -happens they will be appended together. For example, you may wish to -have a header view, a menu view, a content view, and a footer view. That -might look something like this:: - - <?php - - class Page extends CI_Controller { - - public function index() - { - $data['page_title'] = 'Your title'; - $this->load->view('header'); - $this->load->view('menu'); - $this->load->view('content', $data); - $this->load->view('footer'); - } - - } - -In the example above, we are using "dynamically added data", which you -will see below. - -Storing Views within Sub-directories -==================================== - -Your view files can also be stored within sub-directories if you prefer -that type of organization. When doing so you will need to include the -directory name loading the view. Example:: - - $this->load->view('directory_name/file_name'); - -Adding Dynamic Data to the View -=============================== - -Data is passed from the controller to the view by way of an **array** or -an **object** in the second parameter of the view loading method. Here -is an example using an array:: - - $data = array( - 'title' => 'My Title', - 'heading' => 'My Heading', - 'message' => 'My Message' - ); - - $this->load->view('blogview', $data); - -And here's an example using an object:: - - $data = new Someclass(); - $this->load->view('blogview', $data); - -.. note:: If you use an object, the class variables will be turned - into array elements. - -Let's try it with your controller file. Open it add this code:: - - <?php - class Blog extends CI_Controller { - - public function index() - { - $data['title'] = "My Real Title"; - $data['heading'] = "My Real Heading"; - - $this->load->view('blogview', $data); - } - } - -Now open your view file and change the text to variables that correspond -to the array keys in your data:: - - <html> - <head> - <title><?php echo $title;?></title> - </head> - <body> - <h1><?php echo $heading;?></h1> - </body> - </html> - -Then load the page at the URL you've been using and you should see the -variables replaced. - -Creating Loops -============== - -The data array you pass to your view files is not limited to simple -variables. You can pass multi dimensional arrays, which can be looped to -generate multiple rows. For example, if you pull data from your database -it will typically be in the form of a multi-dimensional array. - -Here's a simple example. Add this to your controller:: - - <?php - class Blog extends CI_Controller { - - public function index() - { - $data['todo_list'] = array('Clean House', 'Call Mom', 'Run Errands'); - - $data['title'] = "My Real Title"; - $data['heading'] = "My Real Heading"; - - $this->load->view('blogview', $data); - } - } - -Now open your view file and create a loop:: - - <html> - <head> - <title><?php echo $title;?></title> - </head> - <body> - <h1><?php echo $heading;?></h1> - - <h3>My Todo List</h3> - - <ul> - <?php foreach ($todo_list as $item):?> - - <li><?php echo $item;?></li> - - <?php endforeach;?> - </ul> - - </body> - </html> - -.. note:: You'll notice that in the example above we are using PHP's - alternative syntax. If you are not familiar with it you can read about - it :doc:`here <alternative_php>`. - -Returning views as data -======================= - -There is a third **optional** parameter lets you change the behavior of -the method so that it returns data as a string rather than sending it -to your browser. This can be useful if you want to process the data in -some way. If you set the parameter to TRUE (boolean) it will return -data. The default behavior is false, which sends it to your browser. -Remember to assign it to a variable if you want the data returned:: - - $string = $this->load->view('myfile', '', TRUE);
\ No newline at end of file diff --git a/user_guide_src/source/general/welcome.rst b/user_guide_src/source/general/welcome.rst deleted file mode 100644 index b6f473c2b..000000000 --- a/user_guide_src/source/general/welcome.rst +++ /dev/null @@ -1,32 +0,0 @@ -###################### -Welcome to CodeIgniter -###################### - -CodeIgniter is an Application Development Framework - a toolkit - for -people who build web sites using PHP. Its goal is to enable you to -develop projects much faster than you could if you were writing code -from scratch, by providing a rich set of libraries for commonly needed -tasks, as well as a simple interface and logical structure to access -these libraries. CodeIgniter lets you creatively focus on your project -by minimizing the amount of code needed for a given task. - -*********************** -Who is CodeIgniter For? -*********************** - -CodeIgniter is right for you if: - -- You want a framework with a small footprint. -- You need exceptional performance. -- You need broad compatibility with standard hosting accounts that run - a variety of PHP versions and configurations. -- You want a framework that requires nearly zero configuration. -- You want a framework that does not require you to use the command - line. -- You want a framework that does not require you to adhere to - restrictive coding rules. -- You are not interested in large-scale monolithic libraries like PEAR. -- You do not want to be forced to learn a templating language (although - a template parser is optionally available if you desire one). -- You eschew complexity, favoring simple solutions. -- You need clear, thorough documentation.
\ No newline at end of file diff --git a/user_guide_src/source/helpers/array_helper.rst b/user_guide_src/source/helpers/array_helper.rst deleted file mode 100644 index d6b48773f..000000000 --- a/user_guide_src/source/helpers/array_helper.rst +++ /dev/null @@ -1,133 +0,0 @@ -############ -Array Helper -############ - -The Array Helper file contains functions that assist in working with -arrays. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -Loading this Helper -=================== - -This helper is loaded using the following code:: - - $this->load->helper('array'); - - -Available Functions -=================== - -The following functions are available: - - -.. php:function:: element($item, $array[, $default = NULL]) - - :param string $item: Item to fetch from the array - :param array $array: Input array - :param bool $default: What to return if the array isn't valid - :returns: NULL on failure or the array item. - :rtype: mixed - - Lets you fetch an item from an array. The function tests whether the - array index is set and whether it has a value. If a value exists it is - returned. If a value does not exist it returns NULL, or whatever you've - specified as the default value via the third parameter. - - Example:: - - $array = array( - 'color' => 'red', - 'shape' => 'round', - 'size' => '' - ); - - echo element('color', $array); // returns "red" - echo element('size', $array, 'foobar'); // returns "foobar" - - -.. php:function:: elements($items, $array[, $default = NULL]) - - :param string $item: Item to fetch from the array - :param array $array: Input array - :param bool $default: What to return if the array isn't valid - :returns: NULL on failure or the array item. - :rtype: mixed - - Lets you fetch a number of items from an array. The function tests - whether each of the array indices is set. If an index does not exist it - is set to NULL, or whatever you've specified as the default value via - the third parameter. - - Example:: - - $array = array( - 'color' => 'red', - 'shape' => 'round', - 'radius' => '10', - 'diameter' => '20' - ); - - $my_shape = elements(array('color', 'shape', 'height'), $array); - - The above will return the following array:: - - array( - 'color' => 'red', - 'shape' => 'round', - 'height' => NULL - ); - - You can set the third parameter to any default value you like. - :: - - $my_shape = elements(array('color', 'shape', 'height'), $array, 'foobar'); - - The above will return the following array:: - - array( - 'color' => 'red', - 'shape' => 'round', - 'height' => 'foobar' - ); - - This is useful when sending the ``$_POST`` array to one of your Models. - This prevents users from sending additional POST data to be entered into - your tables. - - :: - - $this->load->model('post_model'); - $this->post_model->update( - elements(array('id', 'title', 'content'), $_POST) - ); - - This ensures that only the id, title and content fields are sent to be - updated. - - -.. php:function:: random_element($array) - - :param array $array: Input array - :returns: A random element from the array - :rtype: mixed - - Takes an array as input and returns a random element from it. - - Usage example:: - - $quotes = array( - "I find that the harder I work, the more luck I seem to have. - Thomas Jefferson", - "Don't stay in bed, unless you can make money in bed. - George Burns", - "We didn't lose the game; we just ran out of time. - Vince Lombardi", - "If everything seems under control, you're not going fast enough. - Mario Andretti", - "Reality is merely an illusion, albeit a very persistent one. - Albert Einstein", - "Chance favors the prepared mind - Louis Pasteur" - ); - - echo random_element($quotes);
\ No newline at end of file diff --git a/user_guide_src/source/helpers/captcha_helper.rst b/user_guide_src/source/helpers/captcha_helper.rst deleted file mode 100644 index be1b20aaf..000000000 --- a/user_guide_src/source/helpers/captcha_helper.rst +++ /dev/null @@ -1,168 +0,0 @@ -############## -CAPTCHA Helper -############## - -The CAPTCHA Helper file contains functions that assist in creating -CAPTCHA images. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -Loading this Helper -=================== - -This helper is loaded using the following code:: - - $this->load->helper('captcha'); - -Using the CAPTCHA helper -======================== - -Once loaded you can generate a CAPTCHA like this:: - - $vals = array( - 'word' => 'Random word', - 'img_path' => './captcha/', - 'img_url' => 'http://example.com/captcha/', - 'font_path' => './path/to/fonts/texb.ttf', - 'img_width' => '150', - 'img_height' => 30, - 'expiration' => 7200, - 'word_length' => 8, - 'font_size' => 16, - 'img_id' => 'Imageid', - 'pool' => '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ', - - // White background and border, black text and red grid - 'colors' => array( - 'background' => array(255, 255, 255), - 'border' => array(255, 255, 255), - 'text' => array(0, 0, 0), - 'grid' => array(255, 40, 40) - ) - ); - - $cap = create_captcha($vals); - echo $cap['image']; - -- The captcha function requires the GD image library. -- Only the **img_path** and **img_url** are required. -- If a **word** is not supplied, the function will generate a random - ASCII string. You might put together your own word library that you - can draw randomly from. -- If you do not specify a path to a TRUE TYPE font, the native ugly GD - font will be used. -- The "captcha" directory must be writable -- The **expiration** (in seconds) signifies how long an image will remain - in the captcha folder before it will be deleted. The default is two - hours. -- **word_length** defaults to 8, **pool** defaults to '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ' -- **font_size** defaults to 16, the native GD font has a size limit. Specify a "true type" font for bigger sizes. -- The **img_id** will be set as the "id" of the captcha image. -- If any of the **colors** values is missing, it will be replaced by the default. - -Adding a Database ------------------ - -In order for the captcha function to prevent someone from submitting, -you will need to add the information returned from ``create_captcha()`` -to your database. Then, when the data from the form is submitted by -the user you will need to verify that the data exists in the database -and has not expired. - -Here is a table prototype:: - - CREATE TABLE captcha ( - captcha_id bigint(13) unsigned NOT NULL auto_increment, - captcha_time int(10) unsigned NOT NULL, - ip_address varchar(45) NOT NULL, - word varchar(20) NOT NULL, - PRIMARY KEY `captcha_id` (`captcha_id`), - KEY `word` (`word`) - ); - -Here is an example of usage with a database. On the page where the -CAPTCHA will be shown you'll have something like this:: - - $this->load->helper('captcha'); - $vals = array( - 'img_path' => './captcha/', - 'img_url' => 'http://example.com/captcha/' - ); - - $cap = create_captcha($vals); - $data = array( - 'captcha_time' => $cap['time'], - 'ip_address' => $this->input->ip_address(), - 'word' => $cap['word'] - ); - - $query = $this->db->insert_string('captcha', $data); - $this->db->query($query); - - echo 'Submit the word you see below:'; - echo $cap['image']; - echo '<input type="text" name="captcha" value="" />'; - -Then, on the page that accepts the submission you'll have something like -this:: - - // First, delete old captchas - $expiration = time() - 7200; // Two hour limit - $this->db->where('captcha_time < ', $expiration) - ->delete('captcha'); - - // Then see if a captcha exists: - $sql = 'SELECT COUNT(*) AS count FROM captcha WHERE word = ? AND ip_address = ? AND captcha_time > ?'; - $binds = array($_POST['captcha'], $this->input->ip_address(), $expiration); - $query = $this->db->query($sql, $binds); - $row = $query->row(); - - if ($row->count == 0) - { - echo 'You must submit the word that appears in the image.'; - } - -Available Functions -=================== - -The following functions are available: - -.. php:function:: create_captcha([$data = ''[, $img_path = ''[, $img_url = ''[, $font_path = '']]]]) - - :param array $data: Array of data for the CAPTCHA - :param string $img_path: Path to create the image in (DEPRECATED) - :param string $img_url: URL to the CAPTCHA image folder (DEPRECATED) - :param string $font_path: Server path to font (DEPRECATED) - :returns: array('word' => $word, 'time' => $now, 'image' => $img) - :rtype: array - - Takes an array of information to generate the CAPTCHA as input and - creates the image to your specifications, returning an array of - associative data about the image. - - :: - - array( - 'image' => IMAGE TAG - 'time' => TIMESTAMP (in microtime) - 'word' => CAPTCHA WORD - ) - - The **image** is the actual image tag:: - - <img src="http://example.com/captcha/12345.jpg" width="140" height="50" /> - - The **time** is the micro timestamp used as the image name without the - file extension. It will be a number like this: 1139612155.3422 - - The **word** is the word that appears in the captcha image, which if not - supplied to the function, will be a random string. - - .. note:: Usage of the ``$img_path``, ``$img_url`` and ``$font_path`` - parameters is DEPRECATED. Provide them in the ``$data`` array - instead. diff --git a/user_guide_src/source/helpers/cookie_helper.rst b/user_guide_src/source/helpers/cookie_helper.rst deleted file mode 100644 index 2ad51e78c..000000000 --- a/user_guide_src/source/helpers/cookie_helper.rst +++ /dev/null @@ -1,79 +0,0 @@ -############# -Cookie Helper -############# - -The Cookie Helper file contains functions that assist in working with -cookies. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -Loading this Helper -=================== - -This helper is loaded using the following code:: - - $this->load->helper('cookie'); - -Available Functions -=================== - -The following functions are available: - - -.. php:function:: set_cookie($name[, $value = ''[, $expire = ''[, $domain = ''[, $path = '/'[, $prefix = ''[, $secure = NULL[, $httponly = NULL]]]]]]]) - - :param mixed $name: Cookie name *or* associative array of all of the parameters available to this function - :param string $value: Cookie value - :param int $expire: Number of seconds until expiration - :param string $domain: Cookie domain (usually: .yourdomain.com) - :param string $path: Cookie path - :param string $prefix: Cookie name prefix - :param bool $secure: Whether to only send the cookie through HTTPS - :param bool $httponly: Whether to hide the cookie from JavaScript - :rtype: void - - This helper function gives you friendlier syntax to set browser - cookies. Refer to the :doc:`Input Library <../libraries/input>` for - a description of its use, as this function is an alias for - ``CI_Input::set_cookie()``. - -.. php:function:: get_cookie($index[, $xss_clean = NULL]) - - :param string $index: Cookie name - :param bool $xss_clean: Whether to apply XSS filtering to the returned value - :returns: The cookie value or NULL if not found - :rtype: mixed - - This helper function gives you friendlier syntax to get browser - cookies. Refer to the :doc:`Input Library <../libraries/input>` for - detailed description of its use, as this function acts very - similarly to ``CI_Input::cookie()``, except it will also prepend - the ``$config['cookie_prefix']`` that you might've set in your - *application/config/config.php* file. - -.. php:function:: delete_cookie($name[, $domain = ''[, $path = '/'[, $prefix = '']]]) - - :param string $name: Cookie name - :param string $domain: Cookie domain (usually: .yourdomain.com) - :param string $path: Cookie path - :param string $prefix: Cookie name prefix - :rtype: void - - Lets you delete a cookie. Unless you've set a custom path or other - values, only the name of the cookie is needed. - :: - - delete_cookie('name'); - - This function is otherwise identical to ``set_cookie()``, except that it - does not have the value and expiration parameters. You can submit an - array of values in the first parameter or you can set discrete - parameters. - :: - - delete_cookie($name, $domain, $path, $prefix); diff --git a/user_guide_src/source/helpers/date_helper.rst b/user_guide_src/source/helpers/date_helper.rst deleted file mode 100644 index 6bc6c2b05..000000000 --- a/user_guide_src/source/helpers/date_helper.rst +++ /dev/null @@ -1,440 +0,0 @@ -########### -Date Helper -########### - -The Date Helper file contains functions that help you work with dates. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -Loading this Helper -=================== - -This helper is loaded using the following code:: - - $this->load->helper('date'); - -Available Functions -=================== - -The following functions are available: - - -.. php:function:: now([$timezone = NULL]) - - :param string $timezone: Timezone - :returns: UNIX timestamp - :rtype: int - - Returns the current time as a UNIX timestamp, referenced either to your server's - local time or any PHP supported timezone, based on the "time reference" setting - in your config file. If you do not intend to set your master time reference to - any other PHP supported timezone (which you'll typically do if you run a site - that lets each user set their own timezone settings) there is no benefit to using - this function over PHP's ``time()`` function. - :: - - echo now('Australia/Victoria'); - - If a timezone is not provided, it will return ``time()`` based on the - **time_reference** setting. - -.. php:function:: mdate([$datestr = ''[, $time = '']]) - - :param string $datestr: Date string - :param int $time: UNIX timestamp - :returns: MySQL-formatted date - :rtype: string - - This function is identical to PHP's `date() <http://php.net/manual/en/function.date.php>`_ - function, except that it lets you use MySQL style date codes, where each - code letter is preceded with a percent sign, e.g. `%Y %m %d` - - The benefit of doing dates this way is that you don't have to worry - about escaping any characters that are not date codes, as you would - normally have to do with the ``date()`` function. - - Example:: - - $datestring = 'Year: %Y Month: %m Day: %d - %h:%i %a'; - $time = time(); - echo mdate($datestring, $time); - - If a timestamp is not included in the second parameter the current time - will be used. - -.. php:function:: standard_date([$fmt = 'DATE_RFC822'[, $time = NULL]]) - - :param string $fmt: Date format - :param int $time: UNIX timestamp - :returns: Formatted date or FALSE on invalid format - :rtype: string - - Lets you generate a date string in one of several standardized formats. - - Example:: - - $format = 'DATE_RFC822'; - $time = time(); - echo standard_date($format, $time); - - .. note:: This function is DEPRECATED. Use the native ``date()`` combined with - `DateTime's format constants - <https://secure.php.net/manual/en/class.datetime.php#datetime.constants.types>`_ - instead:: - - echo date(DATE_RFC822, time()); - - **Supported formats:** - - =============== ======================= ====================================== - Constant Description Example - =============== ======================= ====================================== - DATE_ATOM Atom 2005-08-15T16:13:03+0000 - DATE_COOKIE HTTP Cookies Sun, 14 Aug 2005 16:13:03 UTC - DATE_ISO8601 ISO-8601 2005-08-14T16:13:03+00:00 - DATE_RFC822 RFC 822 Sun, 14 Aug 05 16:13:03 UTC - DATE_RFC850 RFC 850 Sunday, 14-Aug-05 16:13:03 UTC - DATE_RFC1036 RFC 1036 Sunday, 14-Aug-05 16:13:03 UTC - DATE_RFC1123 RFC 1123 Sun, 14 Aug 2005 16:13:03 UTC - DATE_RFC2822 RFC 2822 Sun, 14 Aug 2005 16:13:03 +0000 - DATE_RSS RSS Sun, 14 Aug 2005 16:13:03 UTC - DATE_W3C W3C 2005-08-14T16:13:03+0000 - =============== ======================= ====================================== - -.. php:function:: local_to_gmt([$time = '']) - - :param int $time: UNIX timestamp - :returns: UNIX timestamp - :rtype: int - - Takes a UNIX timestamp as input and returns it as GMT. - - Example:: - - $gmt = local_to_gmt(time()); - -.. php:function:: gmt_to_local([$time = ''[, $timezone = 'UTC'[, $dst = FALSE]]]) - - :param int $time: UNIX timestamp - :param string $timezone: Timezone - :param bool $dst: Whether DST is active - :returns: UNIX timestamp - :rtype: int - - Takes a UNIX timestamp (referenced to GMT) as input, and converts it to - a localized timestamp based on the timezone and Daylight Saving Time - submitted. - - Example:: - - $timestamp = 1140153693; - $timezone = 'UM8'; - $daylight_saving = TRUE; - echo gmt_to_local($timestamp, $timezone, $daylight_saving); - - - .. note:: For a list of timezones see the reference at the bottom of this page. - -.. php:function:: mysql_to_unix([$time = '']) - - :param string $time: MySQL timestamp - :returns: UNIX timestamp - :rtype: int - - Takes a MySQL Timestamp as input and returns it as a UNIX timestamp. - - Example:: - - $unix = mysql_to_unix('20061124092345'); - -.. php:function:: unix_to_human([$time = ''[, $seconds = FALSE[, $fmt = 'us']]]) - - :param int $time: UNIX timestamp - :param bool $seconds: Whether to show seconds - :param string $fmt: format (us or euro) - :returns: Formatted date - :rtype: string - - Takes a UNIX timestamp as input and returns it in a human readable - format with this prototype:: - - YYYY-MM-DD HH:MM:SS AM/PM - - This can be useful if you need to display a date in a form field for - submission. - - The time can be formatted with or without seconds, and it can be set to - European or US format. If only the timestamp is submitted it will return - the time without seconds formatted for the U.S. - - Examples:: - - $now = time(); - echo unix_to_human($now); // U.S. time, no seconds - echo unix_to_human($now, TRUE, 'us'); // U.S. time with seconds - echo unix_to_human($now, TRUE, 'eu'); // Euro time with seconds - -.. php:function:: human_to_unix([$datestr = '']) - - :param int $datestr: Date string - :returns: UNIX timestamp or FALSE on failure - :rtype: int - - The opposite of the :php:func:`unix_to_time()` function. Takes a "human" - time as input and returns it as a UNIX timestamp. This is useful if you - accept "human" formatted dates submitted via a form. Returns boolean FALSE - date string passed to it is not formatted as indicated above. - - Example:: - - $now = time(); - $human = unix_to_human($now); - $unix = human_to_unix($human); - -.. php:function:: nice_date([$bad_date = ''[, $format = FALSE]]) - - :param int $bad_date: The terribly formatted date-like string - :param string $format: Date format to return (same as PHP's ``date()`` function) - :returns: Formatted date - :rtype: string - - This function can take a number poorly-formed date formats and convert - them into something useful. It also accepts well-formed dates. - - The function will return a UNIX timestamp by default. You can, optionally, - pass a format string (the same type as the PHP ``date()`` function accepts) - as the second parameter. - - Example:: - - $bad_date = '199605'; - // Should Produce: 1996-05-01 - $better_date = nice_date($bad_date, 'Y-m-d'); - - $bad_date = '9-11-2001'; - // Should Produce: 2001-09-11 - $better_date = nice_date($bad_date, 'Y-m-d'); - - .. note:: This function is DEPRECATED. Use PHP's native `DateTime class - <https://secure.php.net/datetime>`_ instead. - -.. php:function:: timespan([$seconds = 1[, $time = ''[, $units = '']]]) - - :param int $seconds: Number of seconds - :param string $time: UNIX timestamp - :param int $units: Number of time units to display - :returns: Formatted time difference - :rtype: string - - Formats a UNIX timestamp so that is appears similar to this:: - - 1 Year, 10 Months, 2 Weeks, 5 Days, 10 Hours, 16 Minutes - - The first parameter must contain a UNIX timestamp. - The second parameter must contain a timestamp that is greater that the - first timestamp. - The thirdparameter is optional and limits the number of time units to display. - - If the second parameter empty, the current time will be used. - - The most common purpose for this function is to show how much time has - elapsed from some point in time in the past to now. - - Example:: - - $post_date = '1079621429'; - $now = time(); - $units = 2; - echo timespan($post_date, $now, $units); - - .. note:: The text generated by this function is found in the following language - file: `language/<your_lang>/date_lang.php` - -.. php:function:: days_in_month([$month = 0[, $year = '']]) - - :param int $month: a numeric month - :param int $year: a numeric year - :returns: Count of days in the specified month - :rtype: int - - Returns the number of days in a given month/year. Takes leap years into - account. - - Example:: - - echo days_in_month(06, 2005); - - If the second parameter is empty, the current year will be used. - - .. note:: This function will alias the native ``cal_days_in_month()``, if - it is available. - -.. php:function:: date_range([$unix_start = ''[, $mixed = ''[, $is_unix = TRUE[, $format = 'Y-m-d']]]]) - - :param int $unix_start: UNIX timestamp of the range start date - :param int $mixed: UNIX timestamp of the range end date or interval in days - :param bool $is_unix: set to FALSE if $mixed is not a timestamp - :param string $format: Output date format, same as in ``date()`` - :returns: An array of dates - :rtype: array - - Returns a list of dates within a specified period. - - Example:: - - $range = date_range('2012-01-01', '2012-01-15'); - echo "First 15 days of 2012:"; - foreach ($range as $date) - { - echo $date."\n"; - } - -.. php:function:: timezones([$tz = '']) - - :param string $tz: A numeric timezone - :returns: Hour difference from UTC - :rtype: int - - Takes a timezone reference (for a list of valid timezones, see the - "Timezone Reference" below) and returns the number of hours offset from - UTC. - - Example:: - - echo timezones('UM5'); - - - This function is useful when used with :php:func:`timezone_menu()`. - -.. php:function:: timezone_menu([$default = 'UTC'[, $class = ''[, $name = 'timezones'[, $attributes = '']]]]) - - :param string $default: Timezone - :param string $class: Class name - :param string $name: Menu name - :param mixed $attributes: HTML attributes - :returns: HTML drop down menu with time zones - :rtype: string - - Generates a pull-down menu of timezones, like this one: - - .. raw:: html - - <form action="#"> - <select name="timezones"> - <option value='UM12'>(UTC -12:00) Baker/Howland Island</option> - <option value='UM11'>(UTC -11:00) Samoa Time Zone, Niue</option> - <option value='UM10'>(UTC -10:00) Hawaii-Aleutian Standard Time, Cook Islands, Tahiti</option> - <option value='UM95'>(UTC -9:30) Marquesas Islands</option> - <option value='UM9'>(UTC -9:00) Alaska Standard Time, Gambier Islands</option> - <option value='UM8'>(UTC -8:00) Pacific Standard Time, Clipperton Island</option> - <option value='UM7'>(UTC -7:00) Mountain Standard Time</option> - <option value='UM6'>(UTC -6:00) Central Standard Time</option> - <option value='UM5'>(UTC -5:00) Eastern Standard Time, Western Caribbean Standard Time</option> - <option value='UM45'>(UTC -4:30) Venezuelan Standard Time</option> - <option value='UM4'>(UTC -4:00) Atlantic Standard Time, Eastern Caribbean Standard Time</option> - <option value='UM35'>(UTC -3:30) Newfoundland Standard Time</option> - <option value='UM3'>(UTC -3:00) Argentina, Brazil, French Guiana, Uruguay</option> - <option value='UM2'>(UTC -2:00) South Georgia/South Sandwich Islands</option> - <option value='UM1'>(UTC -1:00) Azores, Cape Verde Islands</option> - <option value='UTC' selected='selected'>(UTC) Greenwich Mean Time, Western European Time</option> - <option value='UP1'>(UTC +1:00) Central European Time, West Africa Time</option> - <option value='UP2'>(UTC +2:00) Central Africa Time, Eastern European Time, Kaliningrad Time</option> - <option value='UP3'>(UTC +3:00) Moscow Time, East Africa Time</option> - <option value='UP35'>(UTC +3:30) Iran Standard Time</option> - <option value='UP4'>(UTC +4:00) Azerbaijan Standard Time, Samara Time</option> - <option value='UP45'>(UTC +4:30) Afghanistan</option> - <option value='UP5'>(UTC +5:00) Pakistan Standard Time, Yekaterinburg Time</option> - <option value='UP55'>(UTC +5:30) Indian Standard Time, Sri Lanka Time</option> - <option value='UP575'>(UTC +5:45) Nepal Time</option> - <option value='UP6'>(UTC +6:00) Bangladesh Standard Time, Bhutan Time, Omsk Time</option> - <option value='UP65'>(UTC +6:30) Cocos Islands, Myanmar</option> - <option value='UP7'>(UTC +7:00) Krasnoyarsk Time, Cambodia, Laos, Thailand, Vietnam</option> - <option value='UP8'>(UTC +8:00) Australian Western Standard Time, Beijing Time, Irkutsk Time</option> - <option value='UP875'>(UTC +8:45) Australian Central Western Standard Time</option> - <option value='UP9'>(UTC +9:00) Japan Standard Time, Korea Standard Time, Yakutsk Time</option> - <option value='UP95'>(UTC +9:30) Australian Central Standard Time</option> - <option value='UP10'>(UTC +10:00) Australian Eastern Standard Time, Vladivostok Time</option> - <option value='UP105'>(UTC +10:30) Lord Howe Island</option> - <option value='UP11'>(UTC +11:00) Srednekolymsk Time, Solomon Islands, Vanuatu</option> - <option value='UP115'>(UTC +11:30) Norfolk Island</option> - <option value='UP12'>(UTC +12:00) Fiji, Gilbert Islands, Kamchatka Time, New Zealand Standard Time</option> - <option value='UP1275'>(UTC +12:45) Chatham Islands Standard Time</option> - <option value='UP13'>(UTC +13:00) Phoenix Islands Time, Tonga</option> - <option value='UP14'>(UTC +14:00) Line Islands</option> - </select> - </form> - - - This menu is useful if you run a membership site in which your users are - allowed to set their local timezone value. - - The first parameter lets you set the "selected" state of the menu. For - example, to set Pacific time as the default you will do this:: - - echo timezone_menu('UM8'); - - Please see the timezone reference below to see the values of this menu. - - The second parameter lets you set a CSS class name for the menu. - - The fourth parameter lets you set one or more attributes on the generated select tag. - - .. note:: The text contained in the menu is found in the following - language file: `language/<your_lang>/date_lang.php` - -Timezone Reference -================== - -The following table indicates each timezone and its location. - -Note some of the location lists have been abridged for clarity and formatting. - -=========== ===================================================================== -Time Zone Location -=========== ===================================================================== -UM12 (UTC - 12:00) Baker/Howland Island -UM11 (UTC - 11:00) Samoa Time Zone, Niue -UM10 (UTC - 10:00) Hawaii-Aleutian Standard Time, Cook Islands -UM95 (UTC - 09:30) Marquesas Islands -UM9 (UTC - 09:00) Alaska Standard Time, Gambier Islands -UM8 (UTC - 08:00) Pacific Standard Time, Clipperton Island -UM7 (UTC - 07:00) Mountain Standard Time -UM6 (UTC - 06:00) Central Standard Time -UM5 (UTC - 05:00) Eastern Standard Time, Western Caribbean -UM45 (UTC - 04:30) Venezuelan Standard Time -UM4 (UTC - 04:00) Atlantic Standard Time, Eastern Caribbean -UM35 (UTC - 03:30) Newfoundland Standard Time -UM3 (UTC - 03:00) Argentina, Brazil, French Guiana, Uruguay -UM2 (UTC - 02:00) South Georgia/South Sandwich Islands -UM1 (UTC -1:00) Azores, Cape Verde Islands -UTC (UTC) Greenwich Mean Time, Western European Time -UP1 (UTC +1:00) Central European Time, West Africa Time -UP2 (UTC +2:00) Central Africa Time, Eastern European Time -UP3 (UTC +3:00) Moscow Time, East Africa Time -UP35 (UTC +3:30) Iran Standard Time -UP4 (UTC +4:00) Azerbaijan Standard Time, Samara Time -UP45 (UTC +4:30) Afghanistan -UP5 (UTC +5:00) Pakistan Standard Time, Yekaterinburg Time -UP55 (UTC +5:30) Indian Standard Time, Sri Lanka Time -UP575 (UTC +5:45) Nepal Time -UP6 (UTC +6:00) Bangladesh Standard Time, Bhutan Time, Omsk Time -UP65 (UTC +6:30) Cocos Islands, Myanmar -UP7 (UTC +7:00) Krasnoyarsk Time, Cambodia, Laos, Thailand, Vietnam -UP8 (UTC +8:00) Australian Western Standard Time, Beijing Time -UP875 (UTC +8:45) Australian Central Western Standard Time -UP9 (UTC +9:00) Japan Standard Time, Korea Standard Time, Yakutsk -UP95 (UTC +9:30) Australian Central Standard Time -UP10 (UTC +10:00) Australian Eastern Standard Time, Vladivostok Time -UP105 (UTC +10:30) Lord Howe Island -UP11 (UTC +11:00) Srednekolymsk Time, Solomon Islands, Vanuatu -UP115 (UTC +11:30) Norfolk Island -UP12 (UTC +12:00) Fiji, Gilbert Islands, Kamchatka, New Zealand -UP1275 (UTC +12:45) Chatham Islands Standard Time -UP13 (UTC +13:00) Phoenix Islands Time, Tonga -UP14 (UTC +14:00) Line Islands -=========== ===================================================================== diff --git a/user_guide_src/source/helpers/directory_helper.rst b/user_guide_src/source/helpers/directory_helper.rst deleted file mode 100644 index b5f1093c1..000000000 --- a/user_guide_src/source/helpers/directory_helper.rst +++ /dev/null @@ -1,83 +0,0 @@ -################ -Directory Helper -################ - -The Directory Helper file contains functions that assist in working with -directories. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -Loading this Helper -=================== - -This helper is loaded using the following code: - -:: - - $this->load->helper('directory'); - -Available Functions -=================== - -The following functions are available: - - -.. php:function:: directory_map($source_dir[, $directory_depth = 0[, $hidden = FALSE]]) - - :param string $source_dir: Path to the source directory - :param int $directory_depth: Depth of directories to traverse (0 = fully recursive, 1 = current dir, etc) - :param bool $hidden: Whether to include hidden directories - :returns: An array of files - :rtype: array - - Examples:: - - $map = directory_map('./mydirectory/'); - - .. note:: Paths are almost always relative to your main index.php file. - - - Sub-folders contained within the directory will be mapped as well. If - you wish to control the recursion depth, you can do so using the second - parameter (integer). A depth of 1 will only map the top level directory:: - - $map = directory_map('./mydirectory/', 1); - - By default, hidden files will not be included in the returned array. To - override this behavior, you may set a third parameter to true (boolean):: - - $map = directory_map('./mydirectory/', FALSE, TRUE); - - Each folder name will be an array index, while its contained files will - be numerically indexed. Here is an example of a typical array:: - - Array ( - [libraries] => Array - ( - [0] => benchmark.html - [1] => config.html - ["database/"] => Array - ( - [0] => query_builder.html - [1] => binds.html - [2] => configuration.html - [3] => connecting.html - [4] => examples.html - [5] => fields.html - [6] => index.html - [7] => queries.html - ) - [2] => email.html - [3] => file_uploading.html - [4] => image_lib.html - [5] => input.html - [6] => language.html - [7] => loader.html - [8] => pagination.html - [9] => uri.html - )
\ No newline at end of file diff --git a/user_guide_src/source/helpers/download_helper.rst b/user_guide_src/source/helpers/download_helper.rst deleted file mode 100644 index 1a4065073..000000000 --- a/user_guide_src/source/helpers/download_helper.rst +++ /dev/null @@ -1,56 +0,0 @@ -############### -Download Helper -############### - -The Download Helper lets you download data to your desktop. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -Loading this Helper -=================== - -This helper is loaded using the following code:: - - $this->load->helper('download'); - -Available Functions -=================== - -The following functions are available: - - -.. php:function:: force_download([$filename = ''[, $data = ''[, $set_mime = FALSE]]]) - - :param string $filename: Filename - :param mixed $data: File contents - :param bool $set_mime: Whether to try to send the actual MIME type - :rtype: void - - Generates server headers which force data to be downloaded to your - desktop. Useful with file downloads. The first parameter is the **name - you want the downloaded file to be named**, the second parameter is the - file data. - - If you set the second parameter to NULL and ``$filename`` is an existing, readable - file path, then its content will be read instead. - - If you set the third parameter to boolean TRUE, then the actual file MIME type - (based on the filename extension) will be sent, so that if your browser has a - handler for that type - it can use it. - - Example:: - - $data = 'Here is some text!'; - $name = 'mytext.txt'; - force_download($name, $data); - - If you want to download an existing file from your server you'll need to - do the following:: - - // Contents of photo.jpg will be automatically read - force_download('/path/to/photo.jpg', NULL);
\ No newline at end of file diff --git a/user_guide_src/source/helpers/email_helper.rst b/user_guide_src/source/helpers/email_helper.rst deleted file mode 100644 index 1ee97d902..000000000 --- a/user_guide_src/source/helpers/email_helper.rst +++ /dev/null @@ -1,75 +0,0 @@ -############ -Email Helper -############ - -The Email Helper provides some assistive functions for working with -Email. For a more robust email solution, see CodeIgniter's :doc:`Email -Class <../libraries/email>`. - -.. important:: The Email helper is DEPRECATED and is currently - only kept for backwards compatibility. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -Loading this Helper -=================== - -This helper is loaded using the following code:: - - $this->load->helper('email'); - -Available Functions -=================== - -The following functions are available: - - -.. php:function:: valid_email($email) - - :param string $email: E-mail address - :returns: TRUE if a valid email is supplied, FALSE otherwise - :rtype: bool - - Checks if the input is a correctly formatted e-mail address. Note that is - doesn't actually prove that the address will be able recieve mail, but - simply that it is a validly formed address. - - Example:: - - if (valid_email('email@somesite.com')) - { - echo 'email is valid'; - } - else - { - echo 'email is not valid'; - } - - .. note:: All that this function does is to use PHP's native ``filter_var()``:: - - (bool) filter_var($email, FILTER_VALIDATE_EMAIL); - -.. php:function:: send_email($recipient, $subject, $message) - - :param string $recipient: E-mail address - :param string $subject: Mail subject - :param string $message: Message body - :returns: TRUE if the mail was successfully sent, FALSE in case of an error - :rtype: bool - - Sends an email using PHP's native `mail() <http://php.net/function.mail>`_ - function. - - .. note:: All that this function does is to use PHP's native ``mail`` - - :: - - mail($recipient, $subject, $message); - - For a more robust email solution, see CodeIgniter's :doc:`Email Library - <../libraries/email>`.
\ No newline at end of file diff --git a/user_guide_src/source/helpers/file_helper.rst b/user_guide_src/source/helpers/file_helper.rst deleted file mode 100644 index 833cddea4..000000000 --- a/user_guide_src/source/helpers/file_helper.rst +++ /dev/null @@ -1,202 +0,0 @@ -########### -File Helper -########### - -The File Helper file contains functions that assist in working with files. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -Loading this Helper -=================== - -This helper is loaded using the following code:: - - $this->load->helper('file'); - -Available Functions -=================== - -The following functions are available: - - -.. php:function:: read_file($file) - - :param string $file: File path - :returns: File contents or FALSE on failure - :rtype: string - - Returns the data contained in the file specified in the path. - - Example:: - - $string = read_file('./path/to/file.php'); - - The path can be a relative or full server path. Returns FALSE (boolean) on failure. - - .. note:: The path is relative to your main site index.php file, NOT your - controller or view files. CodeIgniter uses a front controller so paths - are always relative to the main site index. - - .. note:: This function is DEPRECATED. Use the native ``file_get_contents()`` - instead. - - .. important:: If your server is running an **open_basedir** restriction this - function might not work if you are trying to access a file above the - calling script. - -.. php:function:: write_file($path, $data[, $mode = 'wb']) - - :param string $path: File path - :param string $data: Data to write to file - :param string $mode: ``fopen()`` mode - :returns: TRUE if the write was successful, FALSE in case of an error - :rtype: bool - - Writes data to the file specified in the path. If the file does not exist then the - function will create it. - - Example:: - - $data = 'Some file data'; - if ( ! write_file('./path/to/file.php', $data)) - { - echo 'Unable to write the file'; - } - else - { - echo 'File written!'; - } - - You can optionally set the write mode via the third parameter:: - - write_file('./path/to/file.php', $data, 'r+'); - - The default mode is 'wb'. Please see the `PHP user guide <http://php.net/manual/en/function.fopen.php>`_ - for mode options. - - .. note: In order for this function to write data to a file, its permissions must - be set such that it is writable. If the file does not already exist, - then the directory containing it must be writable. - - .. note:: The path is relative to your main site index.php file, NOT your - controller or view files. CodeIgniter uses a front controller so paths - are always relative to the main site index. - - .. note:: This function acquires an exclusive lock on the file while writing to it. - -.. php:function:: delete_files($path[, $del_dir = FALSE[, $htdocs = FALSE]]) - - :param string $path: Directory path - :param bool $del_dir: Whether to also delete directories - :param bool $htdocs: Whether to skip deleting .htaccess and index page files - :returns: TRUE on success, FALSE in case of an error - :rtype: bool - - Deletes ALL files contained in the supplied path. - - Example:: - - delete_files('./path/to/directory/'); - - If the second parameter is set to TRUE, any directories contained within the supplied - root path will be deleted as well. - - Example:: - - delete_files('./path/to/directory/', TRUE); - - .. note:: The files must be writable or owned by the system in order to be deleted. - -.. php:function:: get_filenames($source_dir[, $include_path = FALSE]) - - :param string $source_dir: Directory path - :param bool $include_path: Whether to include the path as part of the filenames - :returns: An array of file names - :rtype: array - - Takes a server path as input and returns an array containing the names of all files - contained within it. The file path can optionally be added to the file names by setting - the second parameter to TRUE. - - Example:: - - $controllers = get_filenames(APPPATH.'controllers/'); - -.. php:function:: get_dir_file_info($source_dir, $top_level_only) - - :param string $source_dir: Directory path - :param bool $top_level_only: Whether to look only at the specified directory (excluding sub-directories) - :returns: An array containing info on the supplied directory's contents - :rtype: array - - Reads the specified directory and builds an array containing the filenames, filesize, - dates, and permissions. Sub-folders contained within the specified path are only read - if forced by sending the second parameter to FALSE, as this can be an intensive - operation. - - Example:: - - $models_info = get_dir_file_info(APPPATH.'models/'); - -.. php:function:: get_file_info($file[, $returned_values = array('name', 'server_path', 'size', 'date')]) - - :param string $file: File path - :param array $returned_values: What type of info to return - :returns: An array containing info on the specified file or FALSE on failure - :rtype: array - - Given a file and path, returns (optionally) the *name*, *path*, *size* and *date modified* - information attributes for a file. Second parameter allows you to explicitly declare what - information you want returned. - - Valid ``$returned_values`` options are: `name`, `size`, `date`, `readable`, `writeable`, - `executable` and `fileperms`. - -.. php:function:: get_mime_by_extension($filename) - - :param string $filename: File name - :returns: MIME type string or FALSE on failure - :rtype: string - - Translates a filename extension into a MIME type based on *config/mimes.php*. - Returns FALSE if it can't determine the type, or read the MIME config file. - - :: - - $file = 'somefile.png'; - echo $file.' is has a mime type of '.get_mime_by_extension($file); - - .. note:: This is not an accurate way of determining file MIME types, and - is here strictly for convenience. It should not be used for security - purposes. - -.. php:function:: symbolic_permissions($perms) - - :param int $perms: Permissions - :returns: Symbolic permissions string - :rtype: string - - Takes numeric permissions (such as is returned by ``fileperms()``) and returns - standard symbolic notation of file permissions. - - :: - - echo symbolic_permissions(fileperms('./index.php')); // -rw-r--r-- - -.. php:function:: octal_permissions($perms) - - :param int $perms: Permissions - :returns: Octal permissions string - :rtype: string - - Takes numeric permissions (such as is returned by ``fileperms()``) and returns - a three character octal notation of file permissions. - - :: - - echo octal_permissions(fileperms('./index.php')); // 644
\ No newline at end of file diff --git a/user_guide_src/source/helpers/form_helper.rst b/user_guide_src/source/helpers/form_helper.rst deleted file mode 100644 index 8da5d22b5..000000000 --- a/user_guide_src/source/helpers/form_helper.rst +++ /dev/null @@ -1,743 +0,0 @@ -########### -Form Helper -########### - -The Form Helper file contains functions that assist in working with -forms. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -Loading this Helper -=================== - -This helper is loaded using the following code:: - - $this->load->helper('form'); - -Escaping field values -===================== - -You may need to use HTML and characters such as quotes within your form -elements. In order to do that safely, you'll need to use -:doc:`common function <../general/common_functions>` -:func:`html_escape()`. - -Consider the following example:: - - $string = 'Here is a string containing "quoted" text.'; - - <input type="text" name="myfield" value="<?php echo $string; ?>" /> - -Since the above string contains a set of quotes, it will cause the form -to break. The :php:func:`html_escape()` function converts HTML special -characters so that it can be used safely:: - - <input type="text" name="myfield" value="<?php echo html_escape($string); ?>" /> - -.. note:: If you use any of the form helper functions listed on this page, - the form values will be automatically escaped, so there is no need - to call this function. Use it only if you are creating your own - form elements. - -Available Functions -=================== - -The following functions are available: - - -.. php:function:: form_open([$action = ''[, $attributes = ''[, $hidden = array()]]]) - - :param string $action: Form action/target URI string - :param array $attributes: HTML attributes - :param array $hidden: An array of hidden fields' definitions - :returns: An HTML form opening tag - :rtype: string - - Creates an opening form tag with a base URL **built from your config preferences**. - It will optionally let you add form attributes and hidden input fields, and - will always add the `accept-charset` attribute based on the charset value in your - config file. - - The main benefit of using this tag rather than hard coding your own HTML is that - it permits your site to be more portable in the event your URLs ever change. - - Here's a simple example:: - - echo form_open('email/send'); - - The above example would create a form that points to your base URL plus the - "email/send" URI segments, like this:: - - <form method="post" accept-charset="utf-8" action="http://example.com/index.php/email/send"> - - **Adding Attributes** - - Attributes can be added by passing an associative array to the second - parameter, like this:: - - $attributes = array('class' => 'email', 'id' => 'myform'); - echo form_open('email/send', $attributes); - - Alternatively, you can specify the second parameter as a string:: - - echo form_open('email/send', 'class="email" id="myform"'); - - The above examples would create a form similar to this:: - - <form method="post" accept-charset="utf-8" action="http://example.com/index.php/email/send" class="email" id="myform"> - - **Adding Hidden Input Fields** - - Hidden fields can be added by passing an associative array to the - third parameter, like this:: - - $hidden = array('username' => 'Joe', 'member_id' => '234'); - echo form_open('email/send', '', $hidden); - - You can skip the second parameter by passing any falsy value to it. - - The above example would create a form similar to this:: - - <form method="post" accept-charset="utf-8" action="http://example.com/index.php/email/send"> - <input type="hidden" name="username" value="Joe" /> - <input type="hidden" name="member_id" value="234" /> - - -.. php:function:: form_open_multipart([$action = ''[, $attributes = array()[, $hidden = array()]]]) - - :param string $action: Form action/target URI string - :param array $attributes: HTML attributes - :param array $hidden: An array of hidden fields' definitions - :returns: An HTML multipart form opening tag - :rtype: string - - This function is absolutely identical to :php:func:`form_open()` above, - except that it adds a *multipart* attribute, which is necessary if you - would like to use the form to upload files with. - - -.. php:function:: form_hidden($name[, $value = '']) - - :param string $name: Field name - :param string $value: Field value - :returns: An HTML hidden input field tag - :rtype: string - - Lets you generate hidden input fields. You can either submit a - name/value string to create one field:: - - form_hidden('username', 'johndoe'); - // Would produce: <input type="hidden" name="username" value="johndoe" /> - - ... or you can submit an associative array to create multiple fields:: - - $data = array( - 'name' => 'John Doe', - 'email' => 'john@example.com', - 'url' => 'http://example.com' - ); - - echo form_hidden($data); - - /* - Would produce: - <input type="hidden" name="name" value="John Doe" /> - <input type="hidden" name="email" value="john@example.com" /> - <input type="hidden" name="url" value="http://example.com" /> - */ - - You can also pass an associative array to the value field:: - - $data = array( - 'name' => 'John Doe', - 'email' => 'john@example.com', - 'url' => 'http://example.com' - ); - - echo form_hidden('my_array', $data); - - /* - Would produce: - - <input type="hidden" name="my_array[name]" value="John Doe" /> - <input type="hidden" name="my_array[email]" value="john@example.com" /> - <input type="hidden" name="my_array[url]" value="http://example.com" /> - */ - - If you want to create hidden input fields with extra attributes:: - - $data = array( - 'type' => 'hidden', - 'name' => 'email', - 'id' => 'hiddenemail', - 'value' => 'john@example.com', - 'class' => 'hiddenemail' - ); - - echo form_input($data); - - /* - Would produce: - - <input type="hidden" name="email" value="john@example.com" id="hiddenemail" class="hiddenemail" /> - */ - -.. php:function:: form_input([$data = ''[, $value = ''[, $extra = '']]]) - - :param array $data: Field attributes data - :param string $value: Field value - :param mixed $extra: Extra attributes to be added to the tag either as an array or a literal string - :returns: An HTML text input field tag - :rtype: string - - Lets you generate a standard text input field. You can minimally pass - the field name and value in the first and second parameter:: - - echo form_input('username', 'johndoe'); - - Or you can pass an associative array containing any data you wish your - form to contain:: - - $data = array( - 'name' => 'username', - 'id' => 'username', - 'value' => 'johndoe', - 'maxlength' => '100', - 'size' => '50', - 'style' => 'width:50%' - ); - - echo form_input($data); - - /* - Would produce: - - <input type="text" name="username" value="johndoe" id="username" maxlength="100" size="50" style="width:50%" /> - */ - - If you would like your form to contain some additional data, like - JavaScript, you can pass it as a string in the third parameter:: - - $js = 'onClick="some_function()"'; - echo form_input('username', 'johndoe', $js); - - Or you can pass it as an array:: - - $js = array('onClick' => 'some_function();'); - echo form_input('username', 'johndoe', $js); - -.. php:function:: form_password([$data = ''[, $value = ''[, $extra = '']]]) - - :param array $data: Field attributes data - :param string $value: Field value - :param mixed $extra: Extra attributes to be added to the tag either as an array or a literal string - :returns: An HTML password input field tag - :rtype: string - - This function is identical in all respects to the :php:func:`form_input()` - function above except that it uses the "password" input type. - - -.. php:function:: form_upload([$data = ''[, $value = ''[, $extra = '']]]) - - :param array $data: Field attributes data - :param string $value: Field value - :param mixed $extra: Extra attributes to be added to the tag either as an array or a literal string - :returns: An HTML file upload input field tag - :rtype: string - - This function is identical in all respects to the :php:func:`form_input()` - function above except that it uses the "file" input type, allowing it to - be used to upload files. - - -.. php:function:: form_textarea([$data = ''[, $value = ''[, $extra = '']]]) - - :param array $data: Field attributes data - :param string $value: Field value - :param mixed $extra: Extra attributes to be added to the tag either as an array or a literal string - :returns: An HTML textarea tag - :rtype: string - - This function is identical in all respects to the :php:func:`form_input()` - function above except that it generates a "textarea" type. - - .. note:: Instead of the *maxlength* and *size* attributes in the above example, - you will instead specify *rows* and *cols*. - -.. php:function:: form_dropdown([$name = ''[, $options = array()[, $selected = array()[, $extra = '']]]]) - - :param string $name: Field name - :param array $options: An associative array of options to be listed - :param array $selected: List of fields to mark with the *selected* attribute - :param mixed $extra: Extra attributes to be added to the tag either as an array or a literal string - :returns: An HTML dropdown select field tag - :rtype: string - - Lets you create a standard drop-down field. The first parameter will - contain the name of the field, the second parameter will contain an - associative array of options, and the third parameter will contain the - value you wish to be selected. You can also pass an array of multiple - items through the third parameter, and CodeIgniter will create a - multiple select for you. - - Example:: - - $options = array( - 'small' => 'Small Shirt', - 'med' => 'Medium Shirt', - 'large' => 'Large Shirt', - 'xlarge' => 'Extra Large Shirt', - ); - - $shirts_on_sale = array('small', 'large'); - echo form_dropdown('shirts', $options, 'large'); - - /* - Would produce: - - <select name="shirts"> - <option value="small">Small Shirt</option> - <option value="med">Medium Shirt</option> - <option value="large" selected="selected">Large Shirt</option> - <option value="xlarge">Extra Large Shirt</option> - </select> - */ - - echo form_dropdown('shirts', $options, $shirts_on_sale); - - /* - Would produce: - - <select name="shirts" multiple="multiple"> - <option value="small" selected="selected">Small Shirt</option> - <option value="med">Medium Shirt</option> - <option value="large" selected="selected">Large Shirt</option> - <option value="xlarge">Extra Large Shirt</option> - </select> - */ - - If you would like the opening <select> to contain additional data, like - an id attribute or JavaScript, you can pass it as a string in the fourth - parameter:: - - $js = 'id="shirts" onChange="some_function();"'; - echo form_dropdown('shirts', $options, 'large', $js); - - Or you can pass it as an array:: - - $js = array( - 'id' => 'shirts', - 'onChange' => 'some_function();' - ); - echo form_dropdown('shirts', $options, 'large', $js); - - If the array passed as ``$options`` is a multidimensional array, then - ``form_dropdown()`` will produce an <optgroup> with the array key as the - label. - - -.. php:function:: form_multiselect([$name = ''[, $options = array()[, $selected = array()[, $extra = '']]]]) - - :param string $name: Field name - :param array $options: An associative array of options to be listed - :param array $selected: List of fields to mark with the *selected* attribute - :param mixed $extra: Extra attributes to be added to the tag either as an array or a literal string - :returns: An HTML dropdown multiselect field tag - :rtype: string - - Lets you create a standard multiselect field. The first parameter will - contain the name of the field, the second parameter will contain an - associative array of options, and the third parameter will contain the - value or values you wish to be selected. - - The parameter usage is identical to using :php:func:`form_dropdown()` above, - except of course that the name of the field will need to use POST array - syntax, e.g. foo[]. - - -.. php:function:: form_fieldset([$legend_text = ''[, $attributes = array()]]) - - :param string $legend_text: Text to put in the <legend> tag - :param array $attributes: Attributes to be set on the <fieldset> tag - :returns: An HTML fieldset opening tag - :rtype: string - - Lets you generate fieldset/legend fields. - - Example:: - - echo form_fieldset('Address Information'); - echo "<p>fieldset content here</p>\n"; - echo form_fieldset_close(); - - /* - Produces: - - <fieldset> - <legend>Address Information</legend> - <p>form content here</p> - </fieldset> - */ - - Similar to other functions, you can submit an associative array in the - second parameter if you prefer to set additional attributes:: - - $attributes = array( - 'id' => 'address_info', - 'class' => 'address_info' - ); - - echo form_fieldset('Address Information', $attributes); - echo "<p>fieldset content here</p>\n"; - echo form_fieldset_close(); - - /* - Produces: - - <fieldset id="address_info" class="address_info"> - <legend>Address Information</legend> - <p>form content here</p> - </fieldset> - */ - - -.. php:function:: form_fieldset_close([$extra = '']) - - :param string $extra: Anything to append after the closing tag, *as is* - :returns: An HTML fieldset closing tag - :rtype: string - - - Produces a closing </fieldset> tag. The only advantage to using this - function is it permits you to pass data to it which will be added below - the tag. For example - - :: - - $string = '</div></div>'; - echo form_fieldset_close($string); - // Would produce: </fieldset></div></div> - - -.. php:function:: form_checkbox([$data = ''[, $value = ''[, $checked = FALSE[, $extra = '']]]]) - - :param array $data: Field attributes data - :param string $value: Field value - :param bool $checked: Whether to mark the checkbox as being *checked* - :param mixed $extra: Extra attributes to be added to the tag either as an array or a literal string - :returns: An HTML checkbox input tag - :rtype: string - - Lets you generate a checkbox field. Simple example:: - - echo form_checkbox('newsletter', 'accept', TRUE); - // Would produce: <input type="checkbox" name="newsletter" value="accept" checked="checked" /> - - The third parameter contains a boolean TRUE/FALSE to determine whether - the box should be checked or not. - - Similar to the other form functions in this helper, you can also pass an - array of attributes to the function:: - - $data = array( - 'name' => 'newsletter', - 'id' => 'newsletter', - 'value' => 'accept', - 'checked' => TRUE, - 'style' => 'margin:10px' - ); - - echo form_checkbox($data); - // Would produce: <input type="checkbox" name="newsletter" id="newsletter" value="accept" checked="checked" style="margin:10px" /> - - Also as with other functions, if you would like the tag to contain - additional data like JavaScript, you can pass it as a string in the - fourth parameter:: - - $js = 'onClick="some_function()"'; - echo form_checkbox('newsletter', 'accept', TRUE, $js); - - Or you can pass it as an array:: - - $js = array('onClick' => 'some_function();'); - echo form_checkbox('newsletter', 'accept', TRUE, $js); - - -.. php:function:: form_radio([$data = ''[, $value = ''[, $checked = FALSE[, $extra = '']]]]) - - :param array $data: Field attributes data - :param string $value: Field value - :param bool $checked: Whether to mark the radio button as being *checked* - :param mixed $extra: Extra attributes to be added to the tag either as an array or a literal string - :returns: An HTML radio input tag - :rtype: string - - This function is identical in all respects to the :php:func:`form_checkbox()` - function above except that it uses the "radio" input type. - - -.. php:function:: form_label([$label_text = ''[, $id = ''[, $attributes = array()]]]) - - :param string $label_text: Text to put in the <label> tag - :param string $id: ID of the form element that we're making a label for - :param mixed $attributes: HTML attributes - :returns: An HTML field label tag - :rtype: string - - Lets you generate a <label>. Simple example:: - - echo form_label('What is your Name', 'username'); - // Would produce: <label for="username">What is your Name</label> - - Similar to other functions, you can submit an associative array in the - third parameter if you prefer to set additional attributes. - - Example:: - - $attributes = array( - 'class' => 'mycustomclass', - 'style' => 'color: #000;' - ); - - echo form_label('What is your Name', 'username', $attributes); - // Would produce: <label for="username" class="mycustomclass" style="color: #000;">What is your Name</label> - - -.. php:function:: form_submit([$data = ''[, $value = ''[, $extra = '']]]) - - :param string $data: Button name - :param string $value: Button value - :param mixed $extra: Extra attributes to be added to the tag either as an array or a literal string - :returns: An HTML input submit tag - :rtype: string - - Lets you generate a standard submit button. Simple example:: - - echo form_submit('mysubmit', 'Submit Post!'); - // Would produce: <input type="submit" name="mysubmit" value="Submit Post!" /> - - Similar to other functions, you can submit an associative array in the - first parameter if you prefer to set your own attributes. The third - parameter lets you add extra data to your form, like JavaScript. - - -.. php:function:: form_reset([$data = ''[, $value = ''[, $extra = '']]]) - - :param string $data: Button name - :param string $value: Button value - :param mixed $extra: Extra attributes to be added to the tag either as an array or a literal string - :returns: An HTML input reset button tag - :rtype: string - - Lets you generate a standard reset button. Use is identical to - :func:`form_submit()`. - - -.. php:function:: form_button([$data = ''[, $content = ''[, $extra = '']]]) - - :param string $data: Button name - :param string $content: Button label - :param mixed $extra: Extra attributes to be added to the tag either as an array or a literal string - :returns: An HTML button tag - :rtype: string - - Lets you generate a standard button element. You can minimally pass the - button name and content in the first and second parameter:: - - echo form_button('name','content'); - // Would produce: <button name="name" type="button">Content</button> - - Or you can pass an associative array containing any data you wish your - form to contain:: - - $data = array( - 'name' => 'button', - 'id' => 'button', - 'value' => 'true', - 'type' => 'reset', - 'content' => 'Reset' - ); - - echo form_button($data); - // Would produce: <button name="button" id="button" value="true" type="reset">Reset</button> - - If you would like your form to contain some additional data, like - JavaScript, you can pass it as a string in the third parameter:: - - $js = 'onClick="some_function()"'; - echo form_button('mybutton', 'Click Me', $js); - - -.. php:function:: form_close([$extra = '']) - - :param string $extra: Anything to append after the closing tag, *as is* - :returns: An HTML form closing tag - :rtype: string - - Produces a closing </form> tag. The only advantage to using this - function is it permits you to pass data to it which will be added below - the tag. For example:: - - $string = '</div></div>'; - echo form_close($string); - // Would produce: </form> </div></div> - - -.. php:function:: set_value($field[, $default = ''[, $html_escape = TRUE]]) - - :param string $field: Field name - :param string $default: Default value - :param bool $html_escape: Whether to turn off HTML escaping of the value - :returns: Field value - :rtype: string - - Permits you to set the value of an input form or textarea. You must - supply the field name via the first parameter of the function. The - second (optional) parameter allows you to set a default value for the - form. The third (optional) parameter allows you to turn off HTML escaping - of the value, in case you need to use this function in combination with - i.e. :php:func:`form_input()` and avoid double-escaping. - - Example:: - - <input type="text" name="quantity" value="<?php echo set_value('quantity', '0'); ?>" size="50" /> - - The above form will show "0" when loaded for the first time. - - .. note:: If you've loaded the :doc:`Form Validation Library <../libraries/form_validation>` and - have set a validation rule for the field name in use with this helper, then it will - forward the call to the :doc:`Form Validation Library <../libraries/form_validation>`'s - own ``set_value()`` method. Otherwise, this function looks in ``$_POST`` for the - field value. - -.. php:function:: set_select($field[, $value = ''[, $default = FALSE]]) - - :param string $field: Field name - :param string $value: Value to check for - :param string $default: Whether the value is also a default one - :returns: 'selected' attribute or an empty string - :rtype: string - - If you use a <select> menu, this function permits you to display the - menu item that was selected. - - The first parameter must contain the name of the select menu, the second - parameter must contain the value of each item, and the third (optional) - parameter lets you set an item as the default (use boolean TRUE/FALSE). - - Example:: - - <select name="myselect"> - <option value="one" <?php echo set_select('myselect', 'one', TRUE); ?> >One</option> - <option value="two" <?php echo set_select('myselect', 'two'); ?> >Two</option> - <option value="three" <?php echo set_select('myselect', 'three'); ?> >Three</option> - </select> - -.. php:function:: set_checkbox($field[, $value = ''[, $default = FALSE]]) - - :param string $field: Field name - :param string $value: Value to check for - :param string $default: Whether the value is also a default one - :returns: 'checked' attribute or an empty string - :rtype: string - - Permits you to display a checkbox in the state it was submitted. - - The first parameter must contain the name of the checkbox, the second - parameter must contain its value, and the third (optional) parameter - lets you set an item as the default (use boolean TRUE/FALSE). - - Example:: - - <input type="checkbox" name="mycheck" value="1" <?php echo set_checkbox('mycheck', '1'); ?> /> - <input type="checkbox" name="mycheck" value="2" <?php echo set_checkbox('mycheck', '2'); ?> /> - -.. php:function:: set_radio($field[, $value = ''[, $default = FALSE]]) - - :param string $field: Field name - :param string $value: Value to check for - :param string $default: Whether the value is also a default one - :returns: 'checked' attribute or an empty string - :rtype: string - - Permits you to display radio buttons in the state they were submitted. - This function is identical to the :php:func:`set_checkbox()` function above. - - Example:: - - <input type="radio" name="myradio" value="1" <?php echo set_radio('myradio', '1', TRUE); ?> /> - <input type="radio" name="myradio" value="2" <?php echo set_radio('myradio', '2'); ?> /> - - .. note:: If you are using the Form Validation class, you must always specify - a rule for your field, even if empty, in order for the ``set_*()`` - functions to work. This is because if a Form Validation object is - defined, the control for ``set_*()`` is handed over to a method of the - class instead of the generic helper function. - -.. php:function:: form_error([$field = ''[, $prefix = ''[, $suffix = '']]]) - - :param string $field: Field name - :param string $prefix: Error opening tag - :param string $suffix: Error closing tag - :returns: HTML-formatted form validation error message(s) - :rtype: string - - Returns a validation error message from the :doc:`Form Validation Library - <../libraries/form_validation>`, associated with the specified field name. - You can optionally specify opening and closing tag(s) to put around the error - message. - - Example:: - - // Assuming that the 'username' field value was incorrect: - echo form_error('myfield', '<div class="error">', '</div>'); - - // Would produce: <div class="error">Error message associated with the "username" field.</div> - - -.. php:function:: validation_errors([$prefix = ''[, $suffix = '']]) - - :param string $prefix: Error opening tag - :param string $suffix: Error closing tag - :returns: HTML-formatted form validation error message(s) - :rtype: string - - Similarly to the :php:func:`form_error()` function, returns all validation - error messages produced by the :doc:`Form Validation Library - <../libraries/form_validation>`, with optional opening and closing tags - around each of the messages. - - Example:: - - echo validation_errors('<span class="error">', '</span>'); - - /* - Would produce, e.g.: - - <span class="error">The "email" field doesn't contain a valid e-mail address!</span> - <span class="error">The "password" field doesn't match the "repeat_password" field!</span> - - */ - -.. php:function:: form_prep($str) - - :param string $str: Value to escape - :returns: Escaped value - :rtype: string - - Allows you to safely use HTML and characters such as quotes within form - elements without breaking out of the form. - - .. note:: If you use any of the form helper functions listed in this page the form - values will be prepped automatically, so there is no need to call this - function. Use it only if you are creating your own form elements. - - .. note:: This function is DEPRECATED and is just an alias for - :doc:`common function <../general/common_functions>` - :func:`html_escape()` - please use that instead. diff --git a/user_guide_src/source/helpers/html_helper.rst b/user_guide_src/source/helpers/html_helper.rst deleted file mode 100644 index 2c748bea0..000000000 --- a/user_guide_src/source/helpers/html_helper.rst +++ /dev/null @@ -1,407 +0,0 @@ -########### -HTML Helper -########### - -The HTML Helper file contains functions that assist in working with -HTML. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -Loading this Helper -=================== - -This helper is loaded using the following code:: - - $this->load->helper('html'); - -Available Functions -=================== - -The following functions are available: - - -.. php:function:: heading([$data = ''[, $h = '1'[, $attributes = '']]]) - - :param string $data: Content - :param string $h: Heading level - :param mixed $attributes: HTML attributes - :returns: HTML heading tag - :rtype: string - - Lets you create HTML heading tags. The first parameter will contain the - data, the second the size of the heading. Example:: - - echo heading('Welcome!', 3); - - The above would produce: <h3>Welcome!</h3> - - Additionally, in order to add attributes to the heading tag such as HTML - classes, ids or inline styles, a third parameter accepts either a string - or an array:: - - echo heading('Welcome!', 3, 'class="pink"'); - echo heading('How are you?', 4, array('id' => 'question', 'class' => 'green')); - - The above code produces: - - .. code-block:: html - - <h3 class="pink">Welcome!<h3> - <h4 id="question" class="green">How are you?</h4> - -.. php:function:: img([$src = ''[, $index_page = FALSE[, $attributes = '']]]) - - :param string $src: Image source data - :param bool $index_page: Whether to treat $src as a routed URI string - :param array $attributes: HTML attributes - :returns: HTML image tag - :rtype: string - - Lets you create HTML <img /> tags. The first parameter contains the - image source. Example:: - - echo img('images/picture.jpg'); // gives <img src="http://site.com/images/picture.jpg" /> - - There is an optional second parameter that is a TRUE/FALSE value that - specifics if the *src* should have the page specified by - ``$config['index_page']`` added to the address it creates. - Presumably, this would be if you were using a media controller:: - - echo img('images/picture.jpg', TRUE); // gives <img src="http://site.com/index.php/images/picture.jpg" alt="" /> - - Additionally, an associative array can be passed to the ``img()`` function - for complete control over all attributes and values. If an *alt* attribute - is not provided, CodeIgniter will generate an empty string. - - Example:: - - $image_properties = array( - 'src' => 'images/picture.jpg', - 'alt' => 'Me, demonstrating how to eat 4 slices of pizza at one time', - 'class' => 'post_images', - 'width' => '200', - 'height'=> '200', - 'title' => 'That was quite a night', - 'rel' => 'lightbox' - ); - - img($image_properties); - // <img src="http://site.com/index.php/images/picture.jpg" alt="Me, demonstrating how to eat 4 slices of pizza at one time" class="post_images" width="200" height="200" title="That was quite a night" rel="lightbox" /> - -.. php:function:: link_tag([$href = ''[, $rel = 'stylesheet'[, $type = 'text/css'[, $title = ''[, $media = ''[, $index_page = FALSE]]]]]]) - - :param string $href: What are we linking to - :param string $rel: Relation type - :param string $type: Type of the related document - :param string $title: Link title - :param string $media: Media type - :param bool $index_page: Whether to treat $src as a routed URI string - :returns: HTML link tag - :rtype: string - - Lets you create HTML <link /> tags. This is useful for stylesheet links, - as well as other links. The parameters are *href*, with optional *rel*, - *type*, *title*, *media* and *index_page*. - - *index_page* is a boolean value that specifies if the *href* should have - the page specified by ``$config['index_page']`` added to the address it creates. - - Example:: - - echo link_tag('css/mystyles.css'); - // gives <link href="http://site.com/css/mystyles.css" rel="stylesheet" type="text/css" /> - - Further examples:: - - echo link_tag('favicon.ico', 'shortcut icon', 'image/ico'); - // <link href="http://site.com/favicon.ico" rel="shortcut icon" type="image/ico" /> - - echo link_tag('feed', 'alternate', 'application/rss+xml', 'My RSS Feed'); - // <link href="http://site.com/feed" rel="alternate" type="application/rss+xml" title="My RSS Feed" /> - - Additionally, an associative array can be passed to the ``link()`` function - for complete control over all attributes and values:: - - $link = array( - 'href' => 'css/printer.css', - 'rel' => 'stylesheet', - 'type' => 'text/css', - 'media' => 'print' - ); - - echo link_tag($link); - // <link href="http://site.com/css/printer.css" rel="stylesheet" type="text/css" media="print" /> - - -.. php:function:: ul($list[, $attributes = '']) - - :param array $list: List entries - :param array $attributes: HTML attributes - :returns: HTML-formatted unordered list - :rtype: string - - Permits you to generate unordered HTML lists from simple or - multi-dimensional arrays. Example:: - - $list = array( - 'red', - 'blue', - 'green', - 'yellow' - ); - - $attributes = array( - 'class' => 'boldlist', - 'id' => 'mylist' - ); - - echo ul($list, $attributes); - - The above code will produce this: - - .. code-block:: html - - <ul class="boldlist" id="mylist"> - <li>red</li> - <li>blue</li> - <li>green</li> - <li>yellow</li> - </ul> - - Here is a more complex example, using a multi-dimensional array:: - - $attributes = array( - 'class' => 'boldlist', - 'id' => 'mylist' - ); - - $list = array( - 'colors' => array( - 'red', - 'blue', - 'green' - ), - 'shapes' => array( - 'round', - 'square', - 'circles' => array( - 'ellipse', - 'oval', - 'sphere' - ) - ), - 'moods' => array( - 'happy', - 'upset' => array( - 'defeated' => array( - 'dejected', - 'disheartened', - 'depressed' - ), - 'annoyed', - 'cross', - 'angry' - ) - ) - ); - - echo ul($list, $attributes); - - The above code will produce this: - - .. code-block:: html - - <ul class="boldlist" id="mylist"> - <li>colors - <ul> - <li>red</li> - <li>blue</li> - <li>green</li> - </ul> - </li> - <li>shapes - <ul> - <li>round</li> - <li>suare</li> - <li>circles - <ul> - <li>elipse</li> - <li>oval</li> - <li>sphere</li> - </ul> - </li> - </ul> - </li> - <li>moods - <ul> - <li>happy</li> - <li>upset - <ul> - <li>defeated - <ul> - <li>dejected</li> - <li>disheartened</li> - <li>depressed</li> - </ul> - </li> - <li>annoyed</li> - <li>cross</li> - <li>angry</li> - </ul> - </li> - </ul> - </li> - </ul> - -.. php:function:: ol($list, $attributes = '') - - :param array $list: List entries - :param array $attributes: HTML attributes - :returns: HTML-formatted ordered list - :rtype: string - - Identical to :php:func:`ul()`, only it produces the <ol> tag for - ordered lists instead of <ul>. - -.. php:function:: meta([$name = ''[, $content = ''[, $type = 'name'[, $newline = "\n"]]]]) - - :param string $name: Meta name - :param string $content: Meta content - :param string $type: Meta type - :param string $newline: Newline character - :returns: HTML meta tag - :rtype: string - - Helps you generate meta tags. You can pass strings to the function, or - simple arrays, or multidimensional ones. - - Examples:: - - echo meta('description', 'My Great site'); - // Generates: <meta name="description" content="My Great Site" /> - - echo meta('Content-type', 'text/html; charset=utf-8', 'equiv'); - // Note the third parameter. Can be "equiv" or "name" - // Generates: <meta http-equiv="Content-type" content="text/html; charset=utf-8" /> - - echo meta(array('name' => 'robots', 'content' => 'no-cache')); - // Generates: <meta name="robots" content="no-cache" /> - - $meta = array( - array( - 'name' => 'robots', - 'content' => 'no-cache' - ), - array( - 'name' => 'description', - 'content' => 'My Great Site' - ), - array( - 'name' => 'keywords', - 'content' => 'love, passion, intrigue, deception' - ), - array( - 'name' => 'robots', - 'content' => 'no-cache' - ), - array( - 'name' => 'Content-type', - 'content' => 'text/html; charset=utf-8', 'type' => 'equiv' - ) - ); - - echo meta($meta); - // Generates: - // <meta name="robots" content="no-cache" /> - // <meta name="description" content="My Great Site" /> - // <meta name="keywords" content="love, passion, intrigue, deception" /> - // <meta name="robots" content="no-cache" /> - // <meta http-equiv="Content-type" content="text/html; charset=utf-8" /> - - -.. php:function:: doctype([$type = 'xhtml1-strict']) - - :param string $type: Doctype name - :returns: HTML DocType tag - :rtype: string - - Helps you generate document type declarations, or DTD's. XHTML 1.0 - Strict is used by default, but many doctypes are available. - - Example:: - - echo doctype(); // <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - - echo doctype('html4-trans'); // <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> - - The following is a list of doctype choices. These are configurable, and - pulled from application/config/doctypes.php - - =============================== =================== ================================================================================================================================================== - Document type Option Result - =============================== =================== ================================================================================================================================================== - XHTML 1.1 xhtml11 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - XHTML 1.0 Strict xhtml1-strict <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - XHTML 1.0 Transitional xhtml1-trans <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> - XHTML 1.0 Frameset xhtml1-frame <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd"> - XHTML Basic 1.1 xhtml-basic11 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML Basic 1.1//EN" "http://www.w3.org/TR/xhtml-basic/xhtml-basic11.dtd"> - HTML 5 html5 <!DOCTYPE html> - HTML 4 Strict html4-strict <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> - HTML 4 Transitional html4-trans <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> - HTML 4 Frameset html4-frame <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd"> - MathML 1.01 mathml1 <!DOCTYPE math SYSTEM "http://www.w3.org/Math/DTD/mathml1/mathml.dtd"> - MathML 2.0 mathml2 <!DOCTYPE math PUBLIC "-//W3C//DTD MathML 2.0//EN" "http://www.w3.org/Math/DTD/mathml2/mathml2.dtd"> - SVG 1.0 svg10 <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.0//EN" "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd"> - SVG 1.1 Full svg11 <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"> - SVG 1.1 Basic svg11-basic <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1 Basic//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-basic.dtd"> - SVG 1.1 Tiny svg11-tiny <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1 Tiny//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-tiny.dtd"> - XHTML+MathML+SVG (XHTML host) xhtml-math-svg-xh <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd"> - XHTML+MathML+SVG (SVG host) xhtml-math-svg-sh <!DOCTYPE svg:svg PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd"> - XHTML+RDFa 1.0 xhtml-rdfa-1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML+RDFa 1.0//EN" "http://www.w3.org/MarkUp/DTD/xhtml-rdfa-1.dtd"> - XHTML+RDFa 1.1 xhtml-rdfa-2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML+RDFa 1.1//EN" "http://www.w3.org/MarkUp/DTD/xhtml-rdfa-2.dtd"> - =============================== =================== ================================================================================================================================================== - -.. php:function:: br([$count = 1]) - - :param int $count: Number of times to repeat the tag - :returns: HTML line break tag - :rtype: string - - Generates line break tags (<br />) based on the number you submit. - Example:: - - echo br(3); - - The above would produce: - - .. code-block:: html - - <br /><br /><br /> - - .. note:: This function is DEPRECATED. Use the native ``str_repeat()`` - in combination with ``<br />`` instead. - -.. php:function:: nbs([$num = 1]) - - :param int $num: Number of space entities to produce - :returns: A sequence of non-breaking space HTML entities - :rtype: string - - Generates non-breaking spaces ( ) based on the number you submit. - Example:: - - echo nbs(3); - - The above would produce: - - .. code-block:: html - - - - .. note:: This function is DEPRECATED. Use the native ``str_repeat()`` - in combination with `` `` instead. diff --git a/user_guide_src/source/helpers/index.rst b/user_guide_src/source/helpers/index.rst deleted file mode 100644 index f28c8e164..000000000 --- a/user_guide_src/source/helpers/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -####### -Helpers -####### - -.. toctree:: - :glob: - :titlesonly: - - *
\ No newline at end of file diff --git a/user_guide_src/source/helpers/inflector_helper.rst b/user_guide_src/source/helpers/inflector_helper.rst deleted file mode 100644 index df0c568c0..000000000 --- a/user_guide_src/source/helpers/inflector_helper.rst +++ /dev/null @@ -1,96 +0,0 @@ -################ -Inflector Helper -################ - -The Inflector Helper file contains functions that permits you to change -**English** words to plural, singular, camel case, etc. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -Loading this Helper -=================== - -This helper is loaded using the following code:: - - $this->load->helper('inflector'); - -Available Functions -=================== - -The following functions are available: - - -.. php:function:: singular($str) - - :param string $str: Input string - :returns: A singular word - :rtype: string - - Changes a plural word to singular. Example:: - - echo singular('dogs'); // Prints 'dog' - -.. php:function:: plural($str) - - :param string $str: Input string - :returns: A plural word - :rtype: string - - Changes a singular word to plural. Example:: - - echo plural('dog'); // Prints 'dogs' - -.. php:function:: camelize($str) - - :param string $str: Input string - :returns: Camelized string - :rtype: string - - Changes a string of words separated by spaces or underscores to camel - case. Example:: - - echo camelize('my_dog_spot'); // Prints 'myDogSpot' - -.. php:function:: underscore($str) - - :param string $str: Input string - :returns: String containing underscores instead of spaces - :rtype: string - - Takes multiple words separated by spaces and underscores them. - Example:: - - echo underscore('my dog spot'); // Prints 'my_dog_spot' - -.. php:function:: humanize($str[, $separator = '_']) - - :param string $str: Input string - :param string $separator: Input separator - :returns: Humanized string - :rtype: string - - Takes multiple words separated by underscores and adds spaces between - them. Each word is capitalized. - - Example:: - - echo humanize('my_dog_spot'); // Prints 'My Dog Spot' - - To use dashes instead of underscores:: - - echo humanize('my-dog-spot', '-'); // Prints 'My Dog Spot' - -.. php:function:: is_countable($word) - - :param string $word: Input string - :returns: TRUE if the word is countable or FALSE if not - :rtype: bool - - Checks if the given word has a plural version. Example:: - - is_countable('equipment'); // Returns FALSE
\ No newline at end of file diff --git a/user_guide_src/source/helpers/language_helper.rst b/user_guide_src/source/helpers/language_helper.rst deleted file mode 100644 index cfbd6c057..000000000 --- a/user_guide_src/source/helpers/language_helper.rst +++ /dev/null @@ -1,46 +0,0 @@ -############### -Language Helper -############### - -The Language Helper file contains functions that assist in working with -language files. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -Loading this Helper -=================== - -This helper is loaded using the following code:: - - $this->load->helper('language'); - -Available Functions -=================== - -The following functions are available: - - -.. php:function:: lang($line[, $for = ''[, $attributes = array()]]) - - :param string $line: Language line key - :param string $for: HTML "for" attribute (ID of the element we're creating a label for) - :param array $attributes: Any additional HTML attributes - :returns: The language line; in an HTML label tag, if the ``$for`` parameter is not empty - :rtype: string - - This function returns a line of text from a loaded language file with - simplified syntax that may be more desirable for view files than - ``CI_Lang::line()``. - - Examples:: - - echo lang('language_key'); - // Outputs: Language line - - echo lang('language_key', 'form_item_id', array('class' => 'myClass')); - // Outputs: <label for="form_item_id" class="myClass">Language line</label>
\ No newline at end of file diff --git a/user_guide_src/source/helpers/number_helper.rst b/user_guide_src/source/helpers/number_helper.rst deleted file mode 100644 index 9d5e98cfb..000000000 --- a/user_guide_src/source/helpers/number_helper.rst +++ /dev/null @@ -1,52 +0,0 @@ -############# -Number Helper -############# - -The Number Helper file contains functions that help you work with -numeric data. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -Loading this Helper -=================== - -This helper is loaded using the following code:: - - $this->load->helper('number'); - -Available Functions -=================== - -The following functions are available: - - -.. php:function:: byte_format($num[, $precision = 1]) - - :param mixed $num: Number of bytes - :param int $precision: Floating point precision - :returns: Formatted data size string - :rtype: string - - Formats numbers as bytes, based on size, and adds the appropriate - suffix. Examples:: - - echo byte_format(456); // Returns 456 Bytes - echo byte_format(4567); // Returns 4.5 KB - echo byte_format(45678); // Returns 44.6 KB - echo byte_format(456789); // Returns 447.8 KB - echo byte_format(3456789); // Returns 3.3 MB - echo byte_format(12345678912345); // Returns 1.8 GB - echo byte_format(123456789123456789); // Returns 11,228.3 TB - - An optional second parameter allows you to set the precision of the - result:: - - echo byte_format(45678, 2); // Returns 44.61 KB - - .. note:: The text generated by this function is found in the following - language file: *language/<your_lang>/number_lang.php*
\ No newline at end of file diff --git a/user_guide_src/source/helpers/path_helper.rst b/user_guide_src/source/helpers/path_helper.rst deleted file mode 100644 index f46cbad44..000000000 --- a/user_guide_src/source/helpers/path_helper.rst +++ /dev/null @@ -1,53 +0,0 @@ -########### -Path Helper -########### - -The Path Helper file contains functions that permits you to work with -file paths on the server. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -Loading this Helper -=================== - -This helper is loaded using the following code:: - - $this->load->helper('path'); - -Available Functions -=================== - -The following functions are available: - - -.. php:function:: set_realpath($path[, $check_existance = FALSE]) - - :param string $path: Path - :param bool $check_existance: Whether to check if the path actually exists - :returns: An absolute path - :rtype: string - - This function will return a server path without symbolic links or - relative directory structures. An optional second argument will - cause an error to be triggered if the path cannot be resolved. - - Examples:: - - $file = '/etc/php5/apache2/php.ini'; - echo set_realpath($file); // Prints '/etc/php5/apache2/php.ini' - - $non_existent_file = '/path/to/non-exist-file.txt'; - echo set_realpath($non_existent_file, TRUE); // Shows an error, as the path cannot be resolved - echo set_realpath($non_existent_file, FALSE); // Prints '/path/to/non-exist-file.txt' - - $directory = '/etc/php5'; - echo set_realpath($directory); // Prints '/etc/php5/' - - $non_existent_directory = '/path/to/nowhere'; - echo set_realpath($non_existent_directory, TRUE); // Shows an error, as the path cannot be resolved - echo set_realpath($non_existent_directory, FALSE); // Prints '/path/to/nowhere'
\ No newline at end of file diff --git a/user_guide_src/source/helpers/security_helper.rst b/user_guide_src/source/helpers/security_helper.rst deleted file mode 100644 index 103880cf9..000000000 --- a/user_guide_src/source/helpers/security_helper.rst +++ /dev/null @@ -1,106 +0,0 @@ -############### -Security Helper -############### - -The Security Helper file contains security related functions. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -Loading this Helper -=================== - -This helper is loaded using the following code:: - - $this->load->helper('security'); - -Available Functions -=================== - -The following functions are available: - - -.. php:function:: xss_clean($str[, $is_image = FALSE]) - - :param string $str: Input data - :param bool $is_image: Whether we're dealing with an image - :returns: XSS-clean string - :rtype: string - - Provides Cross Site Script Hack filtering. - - This function is an alias for ``CI_Input::xss_clean()``. For more info, - please see the :doc:`Input Library <../libraries/input>` documentation. - -.. php:function:: sanitize_filename($filename) - - :param string $filename: Filename - :returns: Sanitized file name - :rtype: string - - Provides protection against directory traversal. - - This function is an alias for ``CI_Security::sanitize_filename()``. - For more info, please see the :doc:`Security Library <../libraries/security>` - documentation. - - -.. php:function:: do_hash($str[, $type = 'sha1']) - - :param string $str: Input - :param string $type: Algorithm - :returns: Hex-formatted hash - :rtype: string - - Permits you to create one way hashes suitable for encrypting - passwords. Will use SHA1 by default. - - See `hash_algos() <http://php.net/function.hash_algos>`_ - for a full list of supported algorithms. - - Examples:: - - $str = do_hash($str); // SHA1 - $str = do_hash($str, 'md5'); // MD5 - - .. note:: This function was formerly named ``dohash()``, which has been - removed in favor of ``do_hash()``. - - .. note:: This function is DEPRECATED. Use the native ``hash()`` instead. - - -.. php:function:: strip_image_tags($str) - - :param string $str: Input string - :returns: The input string with no image tags - :rtype: string - - This is a security function that will strip image tags from a string. - It leaves the image URL as plain text. - - Example:: - - $string = strip_image_tags($string); - - This function is an alias for ``CI_Security::strip_image_tags()``. For - more info, please see the :doc:`Security Library <../libraries/security>` - documentation. - - -.. php:function:: encode_php_tags($str) - - :param string $str: Input string - :returns: Safely formatted string - :rtype: string - - This is a security function that converts PHP tags to entities. - - .. note:: :php:func:`xss_clean()` does this automatically, if you use it. - - Example:: - - $string = encode_php_tags($string);
\ No newline at end of file diff --git a/user_guide_src/source/helpers/smiley_helper.rst b/user_guide_src/source/helpers/smiley_helper.rst deleted file mode 100644 index 3e7669942..000000000 --- a/user_guide_src/source/helpers/smiley_helper.rst +++ /dev/null @@ -1,169 +0,0 @@ -############# -Smiley Helper -############# - -The Smiley Helper file contains functions that let you manage smileys -(emoticons). - -.. important:: The Smiley helper is DEPRECATED and should not be used. - It is currently only kept for backwards compatibility. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -Loading this Helper -=================== - -This helper is loaded using the following code:: - - $this->load->helper('smiley'); - -Overview -======== - -The Smiley helper has a renderer that takes plain text smileys, like -:-) and turns them into a image representation, like |smile!| - -It also lets you display a set of smiley images that when clicked will -be inserted into a form field. For example, if you have a blog that -allows user commenting you can show the smileys next to the comment -form. Your users can click a desired smiley and with the help of some -JavaScript it will be placed into the form field. - -Clickable Smileys Tutorial -========================== - -Here is an example demonstrating how you might create a set of clickable -smileys next to a form field. This example requires that you first -download and install the smiley images, then create a controller and the -View as described. - -.. important:: Before you begin, please `download the smiley images - <https://ellislab.com/asset/ci_download_files/smileys.zip>`_ - and put them in a publicly accessible place on your server. - This helper also assumes you have the smiley replacement array - located at `application/config/smileys.php` - -The Controller --------------- - -In your **application/controllers/** directory, create a file called -Smileys.php and place the code below in it. - -.. important:: Change the URL in the :php:func:`get_clickable_smileys()` - function below so that it points to your smiley folder. - -You'll notice that in addition to the smiley helper, we are also using -the :doc:`Table Class <../libraries/table>`:: - - <?php - - class Smileys extends CI_Controller { - - public function index() - { - $this->load->helper('smiley'); - $this->load->library('table'); - - $image_array = get_clickable_smileys('http://example.com/images/smileys/', 'comments'); - $col_array = $this->table->make_columns($image_array, 8); - - $data['smiley_table'] = $this->table->generate($col_array); - $this->load->view('smiley_view', $data); - } - - } - -In your **application/views/** directory, create a file called **smiley_view.php** -and place this code in it:: - - <html> - <head> - <title>Smileys</title> - <?php echo smiley_js(); ?> - </head> - <body> - <form name="blog"> - <textarea name="comments" id="comments" cols="40" rows="4"></textarea> - </form> - <p>Click to insert a smiley!</p> - <?php echo $smiley_table; ?> </body> </html> - When you have created the above controller and view, load it by visiting http://www.example.com/index.php/smileys/ - </body> - </html> - -Field Aliases -------------- - -When making changes to a view it can be inconvenient to have the field -id in the controller. To work around this, you can give your smiley -links a generic name that will be tied to a specific id in your view. - -:: - - $image_array = get_smiley_links("http://example.com/images/smileys/", "comment_textarea_alias"); - -To map the alias to the field id, pass them both into the -:func:`smiley_js()` function:: - - $image_array = smiley_js("comment_textarea_alias", "comments"); - -Available Functions -=================== - -.. php:function:: get_clickable_smileys($image_url[, $alias = ''[, $smileys = NULL]]) - - :param string $image_url: URL path to the smileys directory - :param string $alias: Field alias - :returns: An array of ready to use smileys - :rtype: array - - Returns an array containing your smiley images wrapped in a clickable - link. You must supply the URL to your smiley folder and a field id or - field alias. - - Example:: - - $image_array = get_clickable_smileys('http://example.com/images/smileys/', 'comment'); - -.. php:function:: smiley_js([$alias = ''[, $field_id = ''[, $inline = TRUE]]]) - - :param string $alias: Field alias - :param string $field_id: Field ID - :param bool $inline: Whether we're inserting an inline smiley - :returns: Smiley-enabling JavaScript code - :rtype: string - - Generates the JavaScript that allows the images to be clicked and - inserted into a form field. If you supplied an alias instead of an id - when generating your smiley links, you need to pass the alias and - corresponding form id into the function. This function is designed to be - placed into the <head> area of your web page. - - Example:: - - <?php echo smiley_js(); ?> - -.. php:function:: parse_smileys([$str = ''[, $image_url = ''[, $smileys = NULL]]]) - - :param string $str: Text containing smiley codes - :param string $image_url: URL path to the smileys directory - :param array $smileys: An array of smileys - :returns: Parsed smileys - :rtype: string - - Takes a string of text as input and replaces any contained plain text - smileys into the image equivalent. The first parameter must contain your - string, the second must contain the URL to your smiley folder - - Example:: - - $str = 'Here are some smileys: :-) ;-)'; - $str = parse_smileys($str, 'http://example.com/images/smileys/'); - echo $str; - -.. |smile!| image:: ../images/smile.gif
\ No newline at end of file diff --git a/user_guide_src/source/helpers/string_helper.rst b/user_guide_src/source/helpers/string_helper.rst deleted file mode 100644 index 6dabc60d3..000000000 --- a/user_guide_src/source/helpers/string_helper.rst +++ /dev/null @@ -1,223 +0,0 @@ -############# -String Helper -############# - -The String Helper file contains functions that assist in working with -strings. - -.. important:: Please note that these functions are NOT intended, nor - suitable to be used for any kind of security-related logic. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -Loading this Helper -=================== - -This helper is loaded using the following code:: - - $this->load->helper('string'); - -Available Functions -=================== - -The following functions are available: - - -.. php:function:: random_string([$type = 'alnum'[, $len = 8]]) - - :param string $type: Randomization type - :param int $len: Output string length - :returns: A random string - :rtype: string - - Generates a random string based on the type and length you specify. - Useful for creating passwords or generating random hashes. - - The first parameter specifies the type of string, the second parameter - specifies the length. The following choices are available: - - - **alpha**: A string with lower and uppercase letters only. - - **alnum**: Alpha-numeric string with lower and uppercase characters. - - **basic**: A random number based on ``mt_rand()``. - - **numeric**: Numeric string. - - **nozero**: Numeric string with no zeros. - - **md5**: An encrypted random number based on ``md5()`` (fixed length of 32). - - **sha1**: An encrypted random number based on ``sha1()`` (fixed length of 40). - - Usage example:: - - echo random_string('alnum', 16); - - .. note:: Usage of the *unique* and *encrypt* types is DEPRECATED. They - are just aliases for *md5* and *sha1* respectively. - -.. php:function:: increment_string($str[, $separator = '_'[, $first = 1]]) - - :param string $str: Input string - :param string $separator: Separator to append a duplicate number with - :param int $first: Starting number - :returns: An incremented string - :rtype: string - - Increments a string by appending a number to it or increasing the - number. Useful for creating "copies" or a file or duplicating database - content which has unique titles or slugs. - - Usage example:: - - echo increment_string('file', '_'); // "file_1" - echo increment_string('file', '-', 2); // "file-2" - echo increment_string('file_4'); // "file_5" - - -.. php:function:: alternator($args) - - :param mixed $args: A variable number of arguments - :returns: Alternated string(s) - :rtype: mixed - - Allows two or more items to be alternated between, when cycling through - a loop. Example:: - - for ($i = 0; $i < 10; $i++) - { - echo alternator('string one', 'string two'); - } - - You can add as many parameters as you want, and with each iteration of - your loop the next item will be returned. - - :: - - for ($i = 0; $i < 10; $i++) - { - echo alternator('one', 'two', 'three', 'four', 'five'); - } - - .. note:: To use multiple separate calls to this function simply call the - function with no arguments to re-initialize. - -.. php:function:: repeater($data[, $num = 1]) - - :param string $data: Input - :param int $num: Number of times to repeat - :returns: Repeated string - :rtype: string - - Generates repeating copies of the data you submit. Example:: - - $string = "\n"; - echo repeater($string, 30); - - The above would generate 30 newlines. - - .. note:: This function is DEPRECATED. Use the native ``str_repeat()`` - instead. - - -.. php:function:: reduce_double_slashes($str) - - :param string $str: Input string - :returns: A string with normalized slashes - :rtype: string - - Converts double slashes in a string to a single slash, except those - found in URL protocol prefixes (e.g. \http://). - - Example:: - - $string = "http://example.com//index.php"; - echo reduce_double_slashes($string); // results in "http://example.com/index.php" - - -.. php:function:: strip_slashes($data) - - :param mixed $data: Input string or an array of strings - :returns: String(s) with stripped slashes - :rtype: mixed - - Removes any slashes from an array of strings. - - Example:: - - $str = array( - 'question' => 'Is your name O\'reilly?', - 'answer' => 'No, my name is O\'connor.' - ); - - $str = strip_slashes($str); - - The above will return the following array:: - - array( - 'question' => "Is your name O'reilly?", - 'answer' => "No, my name is O'connor." - ); - - .. note:: For historical reasons, this function will also accept - and handle string inputs. This however makes it just an - alias for ``stripslashes()``. - -.. php:function:: trim_slashes($str) - - :param string $str: Input string - :returns: Slash-trimmed string - :rtype: string - - Removes any leading/trailing slashes from a string. Example:: - - $string = "/this/that/theother/"; - echo trim_slashes($string); // results in this/that/theother - - .. note:: This function is DEPRECATED. Use the native ``trim()`` instead: - | - | trim($str, '/'); - -.. php:function:: reduce_multiples($str[, $character = ''[, $trim = FALSE]]) - - :param string $str: Text to search in - :param string $character: Character to reduce - :param bool $trim: Whether to also trim the specified character - :returns: Reduced string - :rtype: string - - Reduces multiple instances of a particular character occurring directly - after each other. Example:: - - $string = "Fred, Bill,, Joe, Jimmy"; - $string = reduce_multiples($string,","); //results in "Fred, Bill, Joe, Jimmy" - - If the third parameter is set to TRUE it will remove occurrences of the - character at the beginning and the end of the string. Example:: - - $string = ",Fred, Bill,, Joe, Jimmy,"; - $string = reduce_multiples($string, ", ", TRUE); //results in "Fred, Bill, Joe, Jimmy" - -.. php:function:: quotes_to_entities($str) - - :param string $str: Input string - :returns: String with quotes converted to HTML entities - :rtype: string - - Converts single and double quotes in a string to the corresponding HTML - entities. Example:: - - $string = "Joe's \"dinner\""; - $string = quotes_to_entities($string); //results in "Joe's "dinner"" - - -.. php:function:: strip_quotes($str) - - :param string $str: Input string - :returns: String with quotes stripped - :rtype: string - - Removes single and double quotes from a string. Example:: - - $string = "Joe's \"dinner\""; - $string = strip_quotes($string); //results in "Joes dinner" diff --git a/user_guide_src/source/helpers/text_helper.rst b/user_guide_src/source/helpers/text_helper.rst deleted file mode 100644 index ef47882fb..000000000 --- a/user_guide_src/source/helpers/text_helper.rst +++ /dev/null @@ -1,230 +0,0 @@ -########### -Text Helper -########### - -The Text Helper file contains functions that assist in working with -text. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -Loading this Helper -=================== - -This helper is loaded using the following code:: - - $this->load->helper('text'); - -Available Functions -=================== - -The following functions are available: - -.. php:function:: word_limiter($str[, $limit = 100[, $end_char = '…']]) - - :param string $str: Input string - :param int $limit: Limit - :param string $end_char: End character (usually an ellipsis) - :returns: Word-limited string - :rtype: string - - Truncates a string to the number of *words* specified. Example:: - - $string = "Here is a nice text string consisting of eleven words."; - $string = word_limiter($string, 4); - // Returns: Here is a nice - - The third parameter is an optional suffix added to the string. By - default it adds an ellipsis. - - -.. php:function:: character_limiter($str[, $n = 500[, $end_char = '…']]) - - :param string $str: Input string - :param int $n: Number of characters - :param string $end_char: End character (usually an ellipsis) - :returns: Character-limited string - :rtype: string - - Truncates a string to the number of *characters* specified. It - maintains the integrity of words so the character count may be slightly - more or less than what you specify. - - Example:: - - $string = "Here is a nice text string consisting of eleven words."; - $string = character_limiter($string, 20); - // Returns: Here is a nice text string - - The third parameter is an optional suffix added to the string, if - undeclared this helper uses an ellipsis. - - .. note:: If you need to truncate to an exact number of characters please - see the :php:func:`ellipsize()` function below. - -.. php:function:: ascii_to_entities($str) - - :param string $str: Input string - :returns: A string with ASCII values converted to entities - :rtype: string - - Converts ASCII values to character entities, including high ASCII and MS - Word characters that can cause problems when used in a web page, so that - they can be shown consistently regardless of browser settings or stored - reliably in a database. There is some dependence on your server's - supported character sets, so it may not be 100% reliable in all cases, - but for the most part it should correctly identify characters outside - the normal range (like accented characters). - - Example:: - - $string = ascii_to_entities($string); - -.. php:function::entities_to_ascii($str[, $all = TRUE]) - - :param string $str: Input string - :param bool $all: Whether to convert unsafe entities as well - :returns: A string with HTML entities converted to ASCII characters - :rtype: string - - This function does the opposite of :php:func:`ascii_to_entities()`. - It turns character entities back into ASCII. - -.. php:function:: convert_accented_characters($str) - - :param string $str: Input string - :returns: A string with accented characters converted - :rtype: string - - Transliterates high ASCII characters to low ASCII equivalents. Useful - when non-English characters need to be used where only standard ASCII - characters are safely used, for instance, in URLs. - - Example:: - - $string = convert_accented_characters($string); - - .. note:: This function uses a companion config file - `application/config/foreign_chars.php` to define the to and - from array for transliteration. - -.. php:function:: word_censor($str, $censored[, $replacement = '']) - - :param string $str: Input string - :param array $censored: List of bad words to censor - :param string $replacement: What to replace bad words with - :returns: Censored string - :rtype: string - - Enables you to censor words within a text string. The first parameter - will contain the original string. The second will contain an array of - words which you disallow. The third (optional) parameter can contain - a replacement value for the words. If not specified they are replaced - with pound signs: ####. - - Example:: - - $disallowed = array('darn', 'shucks', 'golly', 'phooey'); - $string = word_censor($string, $disallowed, 'Beep!'); - -.. php:function:: highlight_code($str) - - :param string $str: Input string - :returns: String with code highlighted via HTML - :rtype: string - - Colorizes a string of code (PHP, HTML, etc.). Example:: - - $string = highlight_code($string); - - The function uses PHP's ``highlight_string()`` function, so the - colors used are the ones specified in your php.ini file. - - -.. php:function:: highlight_phrase($str, $phrase[, $tag_open = '<mark>'[, $tag_close = '</mark>']]) - - :param string $str: Input string - :param string $phrase: Phrase to highlight - :param string $tag_open: Opening tag used for the highlight - :param string $tag_close: Closing tag for the highlight - :returns: String with a phrase highlighted via HTML - :rtype: string - - Will highlight a phrase within a text string. The first parameter will - contain the original string, the second will contain the phrase you wish - to highlight. The third and fourth parameters will contain the - opening/closing HTML tags you would like the phrase wrapped in. - - Example:: - - $string = "Here is a nice text string about nothing in particular."; - echo highlight_phrase($string, "nice text", '<span style="color:#990000;">', '</span>'); - - The above code prints:: - - Here is a <span style="color:#990000;">nice text</span> string about nothing in particular. - - .. note:: This function used to use the ``<strong>`` tag by default. Older browsers - might not support the new HTML5 mark tag, so it is recommended that you - insert the following CSS code into your stylesheet if you need to support - such browsers:: - - mark { - background: #ff0; - color: #000; - }; - -.. php:function:: word_wrap($str[, $charlim = 76]) - - :param string $str: Input string - :param int $charlim: Character limit - :returns: Word-wrapped string - :rtype: string - - Wraps text at the specified *character* count while maintaining - complete words. - - Example:: - - $string = "Here is a simple string of text that will help us demonstrate this function."; - echo word_wrap($string, 25); - - // Would produce: - // Here is a simple string - // of text that will help us - // demonstrate this - // function. - -.. php:function:: ellipsize($str, $max_length[, $position = 1[, $ellipsis = '…']]) - - :param string $str: Input string - :param int $max_length: String length limit - :param mixed $position: Position to split at (int or float) - :param string $ellipsis: What to use as the ellipsis character - :returns: Ellipsized string - :rtype: string - - This function will strip tags from a string, split it at a defined - maximum length, and insert an ellipsis. - - The first parameter is the string to ellipsize, the second is the number - of characters in the final string. The third parameter is where in the - string the ellipsis should appear from 0 - 1, left to right. For - example. a value of 1 will place the ellipsis at the right of the - string, .5 in the middle, and 0 at the left. - - An optional forth parameter is the kind of ellipsis. By default, - … will be inserted. - - Example:: - - $str = 'this_string_is_entirely_too_long_and_might_break_my_design.jpg'; - echo ellipsize($str, 32, .5); - - Produces:: - - this_string_is_e…ak_my_design.jpg
\ No newline at end of file diff --git a/user_guide_src/source/helpers/typography_helper.rst b/user_guide_src/source/helpers/typography_helper.rst deleted file mode 100644 index 89730b03d..000000000 --- a/user_guide_src/source/helpers/typography_helper.rst +++ /dev/null @@ -1,75 +0,0 @@ -################# -Typography Helper -################# - -The Typography Helper file contains functions that help your format text -in semantically relevant ways. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -Loading this Helper -=================== - -This helper is loaded using the following code:: - - $this->load->helper('typography'); - -Available Functions -=================== - -The following functions are available: - - -.. php:function:: auto_typography($str[, $reduce_linebreaks = FALSE]) - - :param string $str: Input string - :param bool $reduce_linebreaks: Whether to reduce multiple instances of double newlines to two - :returns: HTML-formatted typography-safe string - :rtype: string - - Formats text so that it is semantically and typographically correct - HTML. - - This function is an alias for ``CI_Typography::auto_typography()``. - For more info, please see the :doc:`Typography Library - <../libraries/typography>` documentation. - - Usage example:: - - $string = auto_typography($string); - - .. note:: Typographic formatting can be processor intensive, particularly if - you have a lot of content being formatted. If you choose to use this - function you may want to consider :doc:`caching <../general/caching>` your - pages. - - -.. php:function:: nl2br_except_pre($str) - - :param string $str: Input string - :returns: String with HTML-formatted line breaks - :rtype: string - - Converts newlines to <br /> tags unless they appear within <pre> tags. - This function is identical to the native PHP ``nl2br()`` function, - except that it ignores <pre> tags. - - Usage example:: - - $string = nl2br_except_pre($string); - -.. php:function:: entity_decode($str, $charset = NULL) - - :param string $str: Input string - :param string $charset: Character set - :returns: String with decoded HTML entities - :rtype: string - - This function is an alias for ``CI_Security::entity_decode()``. - Fore more info, please see the :doc:`Security Library - <../libraries/security>` documentation.
\ No newline at end of file diff --git a/user_guide_src/source/helpers/url_helper.rst b/user_guide_src/source/helpers/url_helper.rst deleted file mode 100644 index e117d37c0..000000000 --- a/user_guide_src/source/helpers/url_helper.rst +++ /dev/null @@ -1,373 +0,0 @@ -########## -URL Helper -########## - -The URL Helper file contains functions that assist in working with URLs. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -Loading this Helper -=================== - -This helper is loaded using the following code:: - - $this->load->helper('url'); - -Available Functions -=================== - -The following functions are available: - -.. php:function:: site_url([$uri = ''[, $protocol = NULL]]) - - :param string $uri: URI string - :param string $protocol: Protocol, e.g. 'http' or 'https' - :returns: Site URL - :rtype: string - - Returns your site URL, as specified in your config file. The index.php - file (or whatever you have set as your site **index_page** in your config - file) will be added to the URL, as will any URI segments you pass to the - function, plus the **url_suffix** as set in your config file. - - You are encouraged to use this function any time you need to generate a - local URL so that your pages become more portable in the event your URL - changes. - - Segments can be optionally passed to the function as a string or an - array. Here is a string example:: - - echo site_url('news/local/123'); - - The above example would return something like: - *http://example.com/index.php/news/local/123* - - Here is an example of segments passed as an array:: - - $segments = array('news', 'local', '123'); - echo site_url($segments); - - This function is an alias for ``CI_Config::site_url()``. For more info, - please see the :doc:`Config Library <../libraries/config>` documentation. - -.. php:function:: base_url($uri = '', $protocol = NULL) - - :param string $uri: URI string - :param string $protocol: Protocol, e.g. 'http' or 'https' - :returns: Base URL - :rtype: string - - Returns your site base URL, as specified in your config file. Example:: - - echo base_url(); - - This function returns the same thing as :php:func:`site_url()`, without - the *index_page* or *url_suffix* being appended. - - Also like :php:func:`site_url()`, you can supply segments as a string or - an array. Here is a string example:: - - echo base_url("blog/post/123"); - - The above example would return something like: - *http://example.com/blog/post/123* - - This is useful because unlike :php:func:`site_url()`, you can supply a - string to a file, such as an image or stylesheet. For example:: - - echo base_url("images/icons/edit.png"); - - This would give you something like: - *http://example.com/images/icons/edit.png* - - This function is an alias for ``CI_Config::base_url()``. For more info, - please see the :doc:`Config Library <../libraries/config>` documentation. - -.. php:function:: current_url() - - :returns: The current URL - :rtype: string - - Returns the full URL (including segments) of the page being currently - viewed. - - .. note:: Calling this function is the same as doing this: - | - | site_url(uri_string()); - - -.. php:function:: uri_string() - - :returns: An URI string - :rtype: string - - Returns the URI segments of any page that contains this function. - For example, if your URL was this:: - - http://some-site.com/blog/comments/123 - - The function would return:: - - blog/comments/123 - - This function is an alias for ``CI_Config::uri_string()``. For more info, - please see the :doc:`Config Library <../libraries/config>` documentation. - - -.. php:function:: index_page() - - :returns: 'index_page' value - :rtype: mixed - - Returns your site **index_page**, as specified in your config file. - Example:: - - echo index_page(); - -.. php:function:: anchor($uri = '', $title = '', $attributes = '') - - :param string $uri: URI string - :param string $title: Anchor title - :param mixed $attributes: HTML attributes - :returns: HTML hyperlink (anchor tag) - :rtype: string - - Creates a standard HTML anchor link based on your local site URL. - - The first parameter can contain any segments you wish appended to the - URL. As with the :php:func:`site_url()` function above, segments can - be a string or an array. - - .. note:: If you are building links that are internal to your application - do not include the base URL (\http://...). This will be added - automatically from the information specified in your config file. - Include only the URI segments you wish appended to the URL. - - The second segment is the text you would like the link to say. If you - leave it blank, the URL will be used. - - The third parameter can contain a list of attributes you would like - added to the link. The attributes can be a simple string or an - associative array. - - Here are some examples:: - - echo anchor('news/local/123', 'My News', 'title="News title"'); - // Prints: <a href="http://example.com/index.php/news/local/123" title="News title">My News</a> - - echo anchor('news/local/123', 'My News', array('title' => 'The best news!')); - // Prints: <a href="http://example.com/index.php/news/local/123" title="The best news!">My News</a> - - echo anchor('', 'Click here'); - // Prints: <a href="http://example.com">Click Here</a> - - -.. php:function:: anchor_popup($uri = '', $title = '', $attributes = FALSE) - - :param string $uri: URI string - :param string $title: Anchor title - :param mixed $attributes: HTML attributes - :returns: Pop-up hyperlink - :rtype: string - - Nearly identical to the :php:func:`anchor()` function except that it - opens the URL in a new window. You can specify JavaScript window - attributes in the third parameter to control how the window is opened. - If the third parameter is not set it will simply open a new window with - your own browser settings. - - Here is an example with attributes:: - - $atts = array( - 'width' => 800, - 'height' => 600, - 'scrollbars' => 'yes', - 'status' => 'yes', - 'resizable' => 'yes', - 'screenx' => 0, - 'screeny' => 0, - 'window_name' => '_blank' - ); - - echo anchor_popup('news/local/123', 'Click Me!', $atts); - - .. note:: The above attributes are the function defaults so you only need to - set the ones that are different from what you need. If you want the - function to use all of its defaults simply pass an empty array in the - third parameter: - | - | echo anchor_popup('news/local/123', 'Click Me!', array()); - - .. note:: The **window_name** is not really an attribute, but an argument to - the JavaScript `window.open() <http://www.w3schools.com/jsref/met_win_open.asp>` - method, which accepts either a window name or a window target. - - .. note:: Any other attribute than the listed above will be parsed as an - HTML attribute to the anchor tag. - - -.. php:function:: mailto($email, $title = '', $attributes = '') - - :param string $email: E-mail address - :param string $title: Anchor title - :param mixed $attributes: HTML attributes - :returns: A "mail to" hyperlink - :rtype: string - - Creates a standard HTML e-mail link. Usage example:: - - echo mailto('me@my-site.com', 'Click Here to Contact Me'); - - As with the :php:func:`anchor()` tab above, you can set attributes using the - third parameter:: - - $attributes = array('title' => 'Mail me'); - echo mailto('me@my-site.com', 'Contact Me', $attributes); - -.. php:function:: safe_mailto($email, $title = '', $attributes = '') - - :param string $email: E-mail address - :param string $title: Anchor title - :param mixed $attributes: HTML attributes - :returns: A spam-safe "mail to" hyperlink - :rtype: string - - Identical to the :php:func:`mailto()` function except it writes an obfuscated - version of the *mailto* tag using ordinal numbers written with JavaScript to - help prevent the e-mail address from being harvested by spam bots. - -.. php:function:: auto_link($str, $type = 'both', $popup = FALSE) - - :param string $str: Input string - :param string $type: Link type ('email', 'url' or 'both') - :param bool $popup: Whether to create popup links - :returns: Linkified string - :rtype: string - - Automatically turns URLs and e-mail addresses contained in a string into - links. Example:: - - $string = auto_link($string); - - The second parameter determines whether URLs and e-mails are converted or - just one or the other. Default behavior is both if the parameter is not - specified. E-mail links are encoded as :php:func:`safe_mailto()` as shown - above. - - Converts only URLs:: - - $string = auto_link($string, 'url'); - - Converts only e-mail addresses:: - - $string = auto_link($string, 'email'); - - The third parameter determines whether links are shown in a new window. - The value can be TRUE or FALSE (boolean):: - - $string = auto_link($string, 'both', TRUE); - - -.. php:function:: url_title($str, $separator = '-', $lowercase = FALSE) - - :param string $str: Input string - :param string $separator: Word separator - :param bool $lowercase: Whether to transform the output string to lower-case - :returns: URL-formatted string - :rtype: string - - Takes a string as input and creates a human-friendly URL string. This is - useful if, for example, you have a blog in which you'd like to use the - title of your entries in the URL. Example:: - - $title = "What's wrong with CSS?"; - $url_title = url_title($title); - // Produces: Whats-wrong-with-CSS - - The second parameter determines the word delimiter. By default dashes - are used. Preferred options are: **-** (dash) or **_** (underscore) - - Example:: - - $title = "What's wrong with CSS?"; - $url_title = url_title($title, 'underscore'); - // Produces: Whats_wrong_with_CSS - - .. note:: Old usage of 'dash' and 'underscore' as the second parameter - is DEPRECATED. - - The third parameter determines whether or not lowercase characters are - forced. By default they are not. Options are boolean TRUE/FALSE. - - Example:: - - $title = "What's wrong with CSS?"; - $url_title = url_title($title, 'underscore', TRUE); - // Produces: whats_wrong_with_css - - -.. php:function:: prep_url($str = '') - - :param string $str: URL string - :returns: Protocol-prefixed URL string - :rtype: string - - This function will add \http:// in the event that a protocol prefix - is missing from a URL. - - Pass the URL string to the function like this:: - - $url = prep_url('example.com'); - - -.. php:function:: redirect($uri = '', $method = 'auto', $code = NULL) - - :param string $uri: URI string - :param string $method: Redirect method ('auto', 'location' or 'refresh') - :param string $code: HTTP Response code (usually 302 or 303) - :rtype: void - - Does a "header redirect" to the URI specified. If you specify the full - site URL that link will be built, but for local links simply providing - the URI segments to the controller you want to direct to will create the - link. The function will build the URL based on your config file values. - - The optional second parameter allows you to force a particular redirection - method. The available methods are **auto**, **location** and **refresh**, - with location being faster but less reliable on IIS servers. - The default is **auto**, which will attempt to intelligently choose the - method based on the server environment. - - The optional third parameter allows you to send a specific HTTP Response - Code - this could be used for example to create 301 redirects for search - engine purposes. The default Response Code is 302. The third parameter is - *only* available with **location** redirects, and not *refresh*. Examples:: - - if ($logged_in == FALSE) - { - redirect('/login/form/'); - } - - // with 301 redirect - redirect('/article/13', 'location', 301); - - .. note:: In order for this function to work it must be used before anything - is outputted to the browser since it utilizes server headers. - - .. note:: For very fine grained control over headers, you should use the - :doc:`Output Library </libraries/output>` ``set_header()`` method. - - .. note:: To IIS users: if you hide the `Server` HTTP header, the *auto* - method won't detect IIS, in that case it is advised you explicitly - use the **refresh** method. - - .. note:: When the **location** method is used, an HTTP status code of 303 - will *automatically* be selected when the page is currently accessed - via POST and HTTP/1.1 is used. - - .. important:: This function will terminate script execution. diff --git a/user_guide_src/source/helpers/xml_helper.rst b/user_guide_src/source/helpers/xml_helper.rst deleted file mode 100644 index 903e925c2..000000000 --- a/user_guide_src/source/helpers/xml_helper.rst +++ /dev/null @@ -1,55 +0,0 @@ -########## -XML Helper -########## - -The XML Helper file contains functions that assist in working with XML -data. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -Loading this Helper -=================== - -This helper is loaded using the following code - -:: - - $this->load->helper('xml'); - -Available Functions -=================== - -The following functions are available: - -.. php:function:: xml_convert($str[, $protect_all = FALSE]) - - :param string $str: the text string to convert - :param bool $protect_all: Whether to protect all content that looks like a potential entity instead of just numbered entities, e.g. &foo; - :returns: XML-converted string - :rtype: string - - Takes a string as input and converts the following reserved XML - characters to entities: - - - Ampersands: & - - Less than and greater than characters: < > - - Single and double quotes: ' " - - Dashes: - - - This function ignores ampersands if they are part of existing numbered - character entities, e.g. {. Example:: - - $string = '<p>Here is a paragraph & an entity ({).</p>'; - $string = xml_convert($string); - echo $string; - - outputs: - - .. code-block:: html - - <p>Here is a paragraph & an entity ({).</p>
\ No newline at end of file diff --git a/user_guide_src/source/images/appflowchart.gif b/user_guide_src/source/images/appflowchart.gif Binary files differdeleted file mode 100644 index 422332c9e..000000000 --- a/user_guide_src/source/images/appflowchart.gif +++ /dev/null diff --git a/user_guide_src/source/images/arrow.gif b/user_guide_src/source/images/arrow.gif Binary files differdeleted file mode 100644 index 9e9c79a79..000000000 --- a/user_guide_src/source/images/arrow.gif +++ /dev/null diff --git a/user_guide_src/source/images/ci-icon.ico b/user_guide_src/source/images/ci-icon.ico Binary files differdeleted file mode 100644 index 7ecfce214..000000000 --- a/user_guide_src/source/images/ci-icon.ico +++ /dev/null diff --git a/user_guide_src/source/images/ci_logo.jpg b/user_guide_src/source/images/ci_logo.jpg Binary files differdeleted file mode 100644 index 3ae0eee07..000000000 --- a/user_guide_src/source/images/ci_logo.jpg +++ /dev/null diff --git a/user_guide_src/source/images/ci_logo_flame.jpg b/user_guide_src/source/images/ci_logo_flame.jpg Binary files differdeleted file mode 100644 index 17e9c586b..000000000 --- a/user_guide_src/source/images/ci_logo_flame.jpg +++ /dev/null diff --git a/user_guide_src/source/images/file.gif b/user_guide_src/source/images/file.gif Binary files differdeleted file mode 100644 index 8141e0357..000000000 --- a/user_guide_src/source/images/file.gif +++ /dev/null diff --git a/user_guide_src/source/images/folder.gif b/user_guide_src/source/images/folder.gif Binary files differdeleted file mode 100644 index fef31a60b..000000000 --- a/user_guide_src/source/images/folder.gif +++ /dev/null diff --git a/user_guide_src/source/images/smile.gif b/user_guide_src/source/images/smile.gif Binary files differdeleted file mode 100644 index bf0922504..000000000 --- a/user_guide_src/source/images/smile.gif +++ /dev/null diff --git a/user_guide_src/source/index.rst b/user_guide_src/source/index.rst deleted file mode 100644 index 615c27f3c..000000000 --- a/user_guide_src/source/index.rst +++ /dev/null @@ -1,122 +0,0 @@ -###################### -CodeIgniter User Guide -###################### - -- :doc:`License Agreement <license>` -- :doc:`Change Log <changelog>` - -.. contents:: - :local: - :depth: 2 - -******* -Welcome -******* - -.. toctree:: - :titlesonly: - - general/welcome - -********** -Basic Info -********** - -- :doc:`general/requirements` -- :doc:`general/credits` - -************ -Installation -************ -.. toctree:: - :includehidden: - :maxdepth: 2 - :titlesonly: - - installation/index - -************ -Introduction -************ - -.. toctree:: - :titlesonly: - - overview/index - -******** -Tutorial -******** - -.. toctree:: - :includehidden: - :titlesonly: - - tutorial/index - -*************************** -Contributing to CodeIgniter -*************************** - -.. toctree:: - :glob: - :titlesonly: - - contributing/index - -************** -General Topics -************** - -.. toctree:: - :glob: - :titlesonly: - - general/index - -***************** -Library Reference -***************** - -.. toctree:: - :glob: - :titlesonly: - - libraries/index - -****************** -Database Reference -****************** - -.. toctree:: - :glob: - :titlesonly: - - database/index - -**************** -Helper Reference -**************** - -.. toctree:: - :glob: - :titlesonly: - - helpers/index - -.. toctree:: - :glob: - :titlesonly: - :hidden: - - * - overview/index - general/requirements - general/welcome - installation/index - general/index - libraries/index - database/index - helpers/index - tutorial/index - general/credits diff --git a/user_guide_src/source/installation/downloads.rst b/user_guide_src/source/installation/downloads.rst deleted file mode 100644 index 27675a13c..000000000 --- a/user_guide_src/source/installation/downloads.rst +++ /dev/null @@ -1,45 +0,0 @@ -####################### -Downloading CodeIgniter -####################### - -- `CodeIgniter v3.1.8 (Current version) <https://codeload.github.com/bcit-ci/CodeIgniter/zip/3.1.8>`_ -- `CodeIgniter v3.1.7 <https://codeload.github.com/bcit-ci/CodeIgniter/zip/3.1.7>`_ -- `CodeIgniter v3.1.6 <https://codeload.github.com/bcit-ci/CodeIgniter/zip/3.1.6>`_ -- `CodeIgniter v3.1.5 <https://codeload.github.com/bcit-ci/CodeIgniter/zip/3.1.5>`_ -- `CodeIgniter v3.1.4 <https://codeload.github.com/bcit-ci/CodeIgniter/zip/3.1.4>`_ -- `CodeIgniter v3.1.3 <https://codeload.github.com/bcit-ci/CodeIgniter/zip/3.1.3>`_ -- `CodeIgniter v3.1.2 <https://codeload.github.com/bcit-ci/CodeIgniter/zip/3.1.2>`_ -- `CodeIgniter v3.1.1 <https://codeload.github.com/bcit-ci/CodeIgniter/zip/3.1.1>`_ -- `CodeIgniter v3.1.0 <https://codeload.github.com/bcit-ci/CodeIgniter/zip/3.1.0>`_ -- `CodeIgniter v3.0.6 <https://codeload.github.com/bcit-ci/CodeIgniter/zip/3.0.6>`_ -- `CodeIgniter v3.0.5 <https://codeload.github.com/bcit-ci/CodeIgniter/zip/3.0.5>`_ -- `CodeIgniter v3.0.4 <https://codeload.github.com/bcit-ci/CodeIgniter/zip/3.0.4>`_ -- `CodeIgniter v3.0.3 <https://codeload.github.com/bcit-ci/CodeIgniter/zip/3.0.3>`_ -- `CodeIgniter v3.0.2 <https://codeload.github.com/bcit-ci/CodeIgniter/zip/3.0.2>`_ -- `CodeIgniter v3.0.1 <https://codeload.github.com/bcit-ci/CodeIgniter/zip/3.0.1>`_ -- `CodeIgniter v3.0.0 <https://codeload.github.com/bcit-ci/CodeIgniter/zip/3.0.0>`_ -- `CodeIgniter v2.2.6 <https://codeload.github.com/bcit-ci/CodeIgniter/zip/2.2.6>`_ -- `CodeIgniter v2.2.5 <https://codeload.github.com/bcit-ci/CodeIgniter/zip/2.2.5>`_ -- `CodeIgniter v2.2.4 <https://codeload.github.com/bcit-ci/CodeIgniter/zip/2.2.4>`_ -- `CodeIgniter v2.2.3 <https://codeload.github.com/bcit-ci/CodeIgniter/zip/2.2.3>`_ -- `CodeIgniter v2.2.2 <https://codeload.github.com/bcit-ci/CodeIgniter/zip/2.2.2>`_ -- `CodeIgniter v2.2.1 <https://codeload.github.com/bcit-ci/CodeIgniter/zip/2.2.1>`_ -- `CodeIgniter v2.2.0 <https://codeload.github.com/bcit-ci/CodeIgniter/zip/2.2.0>`_ -- `CodeIgniter v2.1.4 <https://codeload.github.com/bcit-ci/CodeIgniter/zip/2.1.4>`_ -- `CodeIgniter v2.1.3 <https://codeload.github.com/bcit-ci/CodeIgniter/zip/2.1.3>`_ -- `CodeIgniter v2.1.2 <https://codeload.github.com/bcit-ci/CodeIgniter/zip/2.1.2>`_ -- `CodeIgniter v2.1.1 <https://codeload.github.com/bcit-ci/CodeIgniter/zip/2.1.1>`_ -- `CodeIgniter v2.1.0 <https://codeload.github.com/bcit-ci/CodeIgniter/zip/v2.1.0>`_ - -****** -GitHub -****** - -`Git <http://git-scm.com/about>`_ is a distributed version control system. - -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/bcit-ci/CodeIgniter/releases>`_. diff --git a/user_guide_src/source/installation/index.rst b/user_guide_src/source/installation/index.rst deleted file mode 100644 index fbf6ecee1..000000000 --- a/user_guide_src/source/installation/index.rst +++ /dev/null @@ -1,57 +0,0 @@ -######################### -Installation Instructions -######################### - -CodeIgniter is installed in four steps: - -#. Unzip the package. -#. Upload the CodeIgniter folders and files to your server. Normally the - *index.php* file will be at your root. -#. Open the *application/config/config.php* file with a text editor and - set your base URL. If you intend to use encryption or sessions, set - your encryption key. -#. If you intend to use a database, open the - *application/config/database.php* file with a text editor and set your - database settings. - -If you wish to increase security by hiding the location of your -CodeIgniter files you can rename the system and application folders to -something more private. If you do rename them, you must open your main -*index.php* file and set the ``$system_path`` and ``$application_folder`` -variables at the top of the file with the new name you've chosen. - -For the best security, both the system and any application folders -should be placed above web root so that they are not directly accessible -via a browser. By default, *.htaccess* files are included in each folder -to help prevent direct access, but it is best to remove them from public -access entirely in case the web server configuration changes or doesn't -abide by the *.htaccess*. - -If you would like to keep your views public it is also possible to move -the views folder out of your application folder. - -After moving them, open your main index.php file and set the -``$system_path``, ``$application_folder`` and ``$view_folder`` variables, -preferably with a full path, e.g. '*/www/MyUser/system*'. - -One additional measure to take in production environments is to disable -PHP error reporting and any other development-only functionality. In -CodeIgniter, this can be done by setting the ``ENVIRONMENT`` constant, which -is more fully described on the :doc:`security -page <../general/security>`. - -That's it! - -If you're new to CodeIgniter, please read the :doc:`Getting -Started <../overview/getting_started>` section of the User Guide -to begin learning how to build dynamic PHP applications. Enjoy! - -.. toctree:: - :hidden: - :titlesonly: - - downloads - self - upgrading - troubleshooting - diff --git a/user_guide_src/source/installation/troubleshooting.rst b/user_guide_src/source/installation/troubleshooting.rst deleted file mode 100644 index cca290763..000000000 --- a/user_guide_src/source/installation/troubleshooting.rst +++ /dev/null @@ -1,18 +0,0 @@ -############### -Troubleshooting -############### - -If you find that no matter what you put in your URL only your default -page is loading, it might be that your server does not support the -REQUEST_URI variable needed to serve search-engine friendly URLs. As a -first step, open your *application/config/config.php* file and look for -the URI Protocol information. It will recommend that you try a couple -alternate settings. If it still doesn't work after you've tried this -you'll need to force CodeIgniter to add a question mark to your URLs. To -do this open your *application/config/config.php* file and change this:: - - $config['index_page'] = "index.php"; - -To this:: - - $config['index_page'] = "index.php?"; diff --git a/user_guide_src/source/installation/upgrade_120.rst b/user_guide_src/source/installation/upgrade_120.rst deleted file mode 100644 index 76c510d66..000000000 --- a/user_guide_src/source/installation/upgrade_120.rst +++ /dev/null @@ -1,20 +0,0 @@ -#################################### -Upgrading From Beta 1.0 to Final 1.2 -#################################### - -To upgrade to Version 1.2 please replace the following directories with -the new versions: - -.. note:: If you have any custom developed files in these folders please - make copies of them first. - -- drivers -- helpers -- init -- language -- libraries -- plugins -- scaffolding - -Please also replace your local copy of the user guide with the new -version. diff --git a/user_guide_src/source/installation/upgrade_130.rst b/user_guide_src/source/installation/upgrade_130.rst deleted file mode 100644 index 6d6d4b9ac..000000000 --- a/user_guide_src/source/installation/upgrade_130.rst +++ /dev/null @@ -1,125 +0,0 @@ -######################### -Upgrading from 1.2 to 1.3 -######################### - -.. note:: The instructions on this page assume you are running version - 1.2. If you have not upgraded to that version please do so first. - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace the following directories in your "system" folder with the new -versions: - -.. note:: If you have any custom developed files in these folders please - make copies of them first. - -- application/**models**/ (new for 1.3) -- codeigniter (new for 1.3) -- drivers -- helpers -- init -- language -- libraries -- plugins -- scaffolding - -Step 2: Update your error files -=============================== - -Version 1.3 contains two new error templates located in -application/errors, and for naming consistency the other error templates -have been renamed. - -If you **have not** customized any of the error templates simply replace -this folder: - -- application/errors/ - -If you **have** customized your error templates, rename them as follows: - -- 404.php = error_404.php -- error.php = error_general.php -- error_db.php (new) -- error_php.php (new) - -Step 3: Update your index.php file -================================== - -Please open your main index.php file (located at your root). At the very -bottom of the file, change this:: - - require_once BASEPATH.'libraries/Front_controller'.EXT; - -To this:: - - require_once BASEPATH.'codeigniter/CodeIgniter'.EXT; - -Step 4: Update your config.php file -=================================== - -Open your application/config/config.php file and add these new items:: - - - /* - |------------------------------------------------ - | URL suffix - |------------------------------------------------ - | - | This option allows you to add a suffix to all URLs. - | For example, if a URL is this: - | - | example.com/index.php/products/view/shoes - | - | You can optionally add a suffix, like ".html", - | making the page appear to be of a certain type: - | - | example.com/index.php/products/view/shoes.html - | - */ - $config['url_suffix'] = ""; - - - /* - |------------------------------------------------ - | Enable Query Strings - |------------------------------------------------ - | - | By default CodeIgniter uses search-engine and - | human-friendly segment based URLs: - | - | example.com/who/what/where/ - | - | You can optionally enable standard query string - | based URLs: - | - | example.com?who=me&what=something&where=here - | - | Options are: TRUE or FALSE (boolean) - | - | The two other items let you set the query string "words" - | that will invoke your controllers and functions: - | example.com/index.php?c=controller&m=function - | - */ - $config['enable_query_strings'] = FALSE; - $config['controller_trigger'] = 'c'; - $config['function_trigger'] = 'm'; - -Step 5: Update your database.php file -===================================== - -Open your application/config/database.php file and add these new items:: - - - $db['default']['dbprefix'] = ""; - $db['default']['active_r'] = TRUE; - -Step 6: Update your user guide -============================== - -Please also replace your local copy of the user guide with the new -version. diff --git a/user_guide_src/source/installation/upgrade_131.rst b/user_guide_src/source/installation/upgrade_131.rst deleted file mode 100644 index 8927c1b12..000000000 --- a/user_guide_src/source/installation/upgrade_131.rst +++ /dev/null @@ -1,30 +0,0 @@ -########################### -Upgrading from 1.3 to 1.3.1 -########################### - -.. note:: The instructions on this page assume you are running version - 1.3. If you have not upgraded to that version please do so first. - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace the following directories in your "system" folder with the new -versions: - -.. note:: If you have any custom developed files in these folders please - make copies of them first. - -- drivers -- init/init_unit_test.php (new for 1.3.1) -- language/ -- libraries -- scaffolding - -Step 2: Update your user guide -============================== - -Please also replace your local copy of the user guide with the new -version. diff --git a/user_guide_src/source/installation/upgrade_132.rst b/user_guide_src/source/installation/upgrade_132.rst deleted file mode 100644 index 84b7cb4f7..000000000 --- a/user_guide_src/source/installation/upgrade_132.rst +++ /dev/null @@ -1,28 +0,0 @@ -############################# -Upgrading from 1.3.1 to 1.3.2 -############################# - -.. note:: The instructions on this page assume you are running version - 1.3.1. If you have not upgraded to that version please do so first. - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace the following directories in your "system" folder with the new -versions: - -.. note:: If you have any custom developed files in these folders please - make copies of them first. - -- drivers -- init -- libraries - -Step 2: Update your user guide -============================== - -Please also replace your local copy of the user guide with the new -version. diff --git a/user_guide_src/source/installation/upgrade_133.rst b/user_guide_src/source/installation/upgrade_133.rst deleted file mode 100644 index 4212e4588..000000000 --- a/user_guide_src/source/installation/upgrade_133.rst +++ /dev/null @@ -1,44 +0,0 @@ -############################# -Upgrading from 1.3.2 to 1.3.3 -############################# - -.. note:: The instructions on this page assume you are running version - 1.3.2. If you have not upgraded to that version please do so first. - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace the following directories in your "system" folder with the new -versions: - -.. note:: If you have any custom developed files in these folders please - make copies of them first. - -- codeigniter -- drivers -- helpers -- init -- libraries - -Step 2: Update your Models -========================== - -If you are **NOT** using CodeIgniter's -:doc:`Models <../general/models>` feature disregard this step. - -As of version 1.3.3, CodeIgniter does **not** connect automatically to -your database when a model is loaded. This allows you greater -flexibility in determining which databases you would like used with your -models. If your application is not connecting to your database prior to -a model being loaded you will have to update your code. There are -several options for connecting, :doc:`as described -here <../general/models>`. - -Step 3: Update your user guide -============================== - -Please also replace your local copy of the user guide with the new -version. diff --git a/user_guide_src/source/installation/upgrade_140.rst b/user_guide_src/source/installation/upgrade_140.rst deleted file mode 100644 index 987281fe1..000000000 --- a/user_guide_src/source/installation/upgrade_140.rst +++ /dev/null @@ -1,72 +0,0 @@ -############################# -Upgrading from 1.3.3 to 1.4.0 -############################# - -.. note:: The instructions on this page assume you are running version - 1.3.3. If you have not upgraded to that version please do so first. - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace the following directories in your "system" folder with the new -versions: - -.. note:: If you have any custom developed files in these folders please - make copies of them first. - -- application/config/**hooks.php** -- application/config/**mimes.php** -- codeigniter -- drivers -- helpers -- init -- language -- libraries -- scaffolding - -Step 2: Update your config.php file -=================================== - -Open your application/config/config.php file and add these new items:: - - - - /* - |-------------------------------------------------------------------------- - | Enable/Disable System Hooks - |-------------------------------------------------------------------------- - | - | If you would like to use the "hooks" feature you must enable it by - | setting this variable to TRUE (boolean). See the user guide for details. - | - */ - $config['enable_hooks'] = FALSE; - - - /* - |-------------------------------------------------------------------------- - | Allowed URL Characters - |-------------------------------------------------------------------------- - | - | This lets you specify which characters are permitted within your URLs. - | When someone tries to submit a URL with disallowed characters they will - | get a warning message. - | - | As a security measure you are STRONGLY encouraged to restrict URLs to - | as few characters as possible. By default only these are allowed: a-z 0-9~%.:_- - | - | Leave blank to allow all characters -- but only if you are insane. - | - | DO NOT CHANGE THIS UNLESS YOU FULLY UNDERSTAND THE REPERCUSSIONS!! - | - */ - $config['permitted_uri_chars'] = 'a-z 0-9~%.:_-'; - -Step 3: Update your user guide -============================== - -Please also replace your local copy of the user guide with the new -version. diff --git a/user_guide_src/source/installation/upgrade_141.rst b/user_guide_src/source/installation/upgrade_141.rst deleted file mode 100644 index c9c2ca461..000000000 --- a/user_guide_src/source/installation/upgrade_141.rst +++ /dev/null @@ -1,71 +0,0 @@ -############################# -Upgrading from 1.4.0 to 1.4.1 -############################# - -.. note:: The instructions on this page assume you are running version - 1.4.0. If you have not upgraded to that version please do so first. - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace the following directories in your "system" folder with the new -versions: - -.. note:: If you have any custom developed files in these folders please - make copies of them first. - -- codeigniter -- drivers -- helpers -- libraries - -Step 2: Update your config.php file -=================================== - -Open your application/config/config.php file and add this new item:: - - - - /* - |-------------------------------------------------------------------------- - | Output Compression - |-------------------------------------------------------------------------- - | - | Enables Gzip output compression for faster page loads. When enabled, - | the output class will test whether your server supports Gzip. - | Even if it does, however, not all browsers support compression - | so enable only if you are reasonably sure your visitors can handle it. - | - | VERY IMPORTANT: If you are getting a blank page when compression is enabled it - | means you are prematurely outputting something to your browser. It could - | even be a line of whitespace at the end of one of your scripts. For - | compression to work, nothing can be sent before the output buffer is called - | by the output class. Do not "echo" any values with compression enabled. - | - */ - $config['compress_output'] = FALSE; - -Step 3: Rename an Autoload Item -=============================== - -Open the following file: application/config/autoload.php - -Find this array item:: - - $autoload['core'] = array(); - -And rename it to this:: - - $autoload['libraries'] = array(); - -This change was made to improve clarity since some users were not sure -that their own libraries could be auto-loaded. - -Step 4: Update your user guide -============================== - -Please also replace your local copy of the user guide with the new -version. diff --git a/user_guide_src/source/installation/upgrade_150.rst b/user_guide_src/source/installation/upgrade_150.rst deleted file mode 100644 index 50eb5eae5..000000000 --- a/user_guide_src/source/installation/upgrade_150.rst +++ /dev/null @@ -1,100 +0,0 @@ -############################# -Upgrading from 1.4.1 to 1.5.0 -############################# - -.. note:: The instructions on this page assume you are running version - 1.4.1. If you have not upgraded to that version please do so first. - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace these files and directories in your "system" folder with the new -versions: - -- application/config/user_agents.php (new file for 1.5) -- application/config/smileys.php (new file for 1.5) -- codeigniter/ -- database/ (new folder for 1.5. Replaces the "drivers" folder) -- helpers/ -- language/ -- libraries/ -- scaffolding/ - -.. note:: If you have any custom developed files in these folders please - make copies of them first. - -Step 2: Update your database.php file -===================================== - -Open your application/config/database.php file and add these new items:: - - - $db['default']['cache_on'] = FALSE; - $db['default']['cachedir'] = ''; - -Step 3: Update your config.php file -=================================== - -Open your application/config/config.php file and ADD these new items:: - - - /* - |-------------------------------------------------------------------------- - | Class Extension Prefix - |-------------------------------------------------------------------------- - | - | This item allows you to set the filename/classname prefix when extending - | native libraries. For more information please see the user guide: - | - | https://codeigniter.com/user_guide/general/core_classes.html - | https://codeigniter.com/user_guide/general/creating_libraries.html - | - */ - $config['subclass_prefix'] = 'MY_'; - - /* - |-------------------------------------------------------------------------- - | Rewrite PHP Short Tags - |-------------------------------------------------------------------------- - | - | If your PHP installation does not have short tag support enabled CI - | can rewrite the tags on-the-fly, enabling you to utilize that syntax - | in your view files. Options are TRUE or FALSE (boolean) - | - */ - $config['rewrite_short_tags'] = FALSE; - -In that same file REMOVE this item:: - - - /* - |-------------------------------------------------------------------------- - | Enable/Disable Error Logging - |-------------------------------------------------------------------------- - | - | If you would like errors or debug messages logged set this variable to - | TRUE (boolean). Note: You must set the file permissions on the "logs" folder - | such that it is writable. - | - */ - $config['log_errors'] = FALSE; - -Error logging is now disabled simply by setting the threshold to zero. - -Step 4: Update your main index.php file -======================================= - -If you are running a stock index.php file simply replace your version -with the new one. - -If your index.php file has internal modifications, please add your -modifications to the new file and use it. - -Step 5: Update your user guide -============================== - -Please also replace your local copy of the user guide with the new -version. diff --git a/user_guide_src/source/installation/upgrade_152.rst b/user_guide_src/source/installation/upgrade_152.rst deleted file mode 100644 index 781c907e1..000000000 --- a/user_guide_src/source/installation/upgrade_152.rst +++ /dev/null @@ -1,39 +0,0 @@ -############################# -Upgrading from 1.5.0 to 1.5.2 -############################# - -.. note:: The instructions on this page assume you are running version - 1.5.0 or 1.5.1. If you have not upgraded to that version please do so - first. - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace these files and directories in your "system" folder with the new -versions: - -- system/helpers/download_helper.php -- system/helpers/form_helper.php -- system/libraries/Table.php -- system/libraries/User_agent.php -- system/libraries/Exceptions.php -- system/libraries/Input.php -- system/libraries/Router.php -- system/libraries/Loader.php -- system/libraries/Image_lib.php -- system/language/english/unit_test_lang.php -- system/database/DB_active_rec.php -- system/database/drivers/mysqli/mysqli_driver.php -- codeigniter/ - -.. note:: If you have any custom developed files in these folders please - make copies of them first. - -Step 2: Update your user guide -============================== - -Please also replace your local copy of the user guide with the new -version. diff --git a/user_guide_src/source/installation/upgrade_153.rst b/user_guide_src/source/installation/upgrade_153.rst deleted file mode 100644 index e3d487be1..000000000 --- a/user_guide_src/source/installation/upgrade_153.rst +++ /dev/null @@ -1,28 +0,0 @@ -############################# -Upgrading from 1.5.2 to 1.5.3 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace these files and directories in your "system" folder with the new -versions: - -- system/database/drivers -- system/helpers -- system/libraries/Input.php -- system/libraries/Loader.php -- system/libraries/Profiler.php -- system/libraries/Table.php - -.. note:: If you have any custom developed files in these folders please - make copies of them first. - -Step 2: Update your user guide -============================== - -Please also replace your local copy of the user guide with the new -version. diff --git a/user_guide_src/source/installation/upgrade_154.rst b/user_guide_src/source/installation/upgrade_154.rst deleted file mode 100644 index 1d2c51d4a..000000000 --- a/user_guide_src/source/installation/upgrade_154.rst +++ /dev/null @@ -1,56 +0,0 @@ -############################# -Upgrading from 1.5.3 to 1.5.4 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace these files and directories in your "system" folder with the new -versions: - -- application/config/mimes.php -- system/codeigniter -- system/database -- system/helpers -- system/libraries -- system/plugins - -.. note:: If you have any custom developed files in these folders please - make copies of them first. - -Step 2: Add charset to your config.php -====================================== - -Add the following to application/config/config.php - -:: - - /* - |-------------------------------------------------------------------------- - | Default Character Set - |-------------------------------------------------------------------------- - | - | This determines which character set is used by default in various methods - | that require a character set to be provided. - | - */ - $config['charset'] = "UTF-8"; - -Step 3: Autoloading language files -================================== - -If you want to autoload any language files, add this line to -application/config/autoload.php - -:: - - $autoload['language'] = array(); - -Step 4: Update your user guide -============================== - -Please also replace your local copy of the user guide with the new -version. diff --git a/user_guide_src/source/installation/upgrade_160.rst b/user_guide_src/source/installation/upgrade_160.rst deleted file mode 100644 index e5d26611b..000000000 --- a/user_guide_src/source/installation/upgrade_160.rst +++ /dev/null @@ -1,87 +0,0 @@ -############################# -Upgrading from 1.5.4 to 1.6.0 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace these files and directories in your "system" folder with the new -versions: - -- system/codeigniter -- system/database -- system/helpers -- system/libraries -- system/plugins -- system/language - -.. note:: If you have any custom developed files in these folders please - make copies of them first. - -Step 2: Add time_to_update to your config.php -=============================================== - -Add the following to application/config/config.php with the other -session configuration options - -:: - - $config['sess_time_to_update'] = 300; - - -Step 3: Add $autoload['model'] -============================== - -Add the following to application/config/autoload.php - -:: - - /* - | ------------------------------------------------------------------- - | Auto-load Model files - | ------------------------------------------------------------------- - | Prototype: - | - | $autoload['model'] = array('my_model'); - | - */ - - $autoload['model'] = array(); - - -Step 4: Add to your database.php -================================ - -Make the following changes to your application/config/database.php file: - -Add the following variable above the database configuration options, -with $active_group - -:: - - $active_record = TRUE; - - -Remove the following from your database configuration options - -:: - - $db['default']['active_r'] = TRUE; - - -Add the following to your database configuration options - -:: - - $db['default']['char_set'] = "utf8"; - $db['default']['dbcollat'] = "utf8_general_ci"; - - -Step 5: Update your user guide -============================== - -Please also replace your local copy of the user guide with the new -version. diff --git a/user_guide_src/source/installation/upgrade_161.rst b/user_guide_src/source/installation/upgrade_161.rst deleted file mode 100644 index 43869223f..000000000 --- a/user_guide_src/source/installation/upgrade_161.rst +++ /dev/null @@ -1,27 +0,0 @@ -############################# -Upgrading from 1.6.0 to 1.6.1 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace these files and directories in your "system" folder with the new -versions: - -- system/codeigniter -- system/database -- system/helpers -- system/language -- system/libraries - -.. note:: If you have any custom developed files in these folders please - make copies of them first. - -Step 2: Update your user guide -============================== - -Please also replace your local copy of the user guide with the new -version. diff --git a/user_guide_src/source/installation/upgrade_162.rst b/user_guide_src/source/installation/upgrade_162.rst deleted file mode 100644 index 6a618e4ad..000000000 --- a/user_guide_src/source/installation/upgrade_162.rst +++ /dev/null @@ -1,45 +0,0 @@ -############################# -Upgrading from 1.6.1 to 1.6.2 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace these files and directories in your "system" folder with the new -versions: - -- system/codeigniter -- system/database -- system/helpers -- system/language -- system/libraries - -.. note:: If you have any custom developed files in these folders please - make copies of them first. - -Step 2: Encryption Key -====================== - -If you are using sessions, open up application/config/config.php and -verify you've set an encryption key. - -Step 3: Constants File -====================== - -Copy /application/config/constants.php to your installation, and modify -if necessary. - -Step 4: Mimes File -================== - -Replace /application/config/mimes.php with the dowloaded version. If -you've added custom mime types, you'll need to re-add them. - -Step 5: Update your user guide -============================== - -Please also replace your local copy of the user guide with the new -version. diff --git a/user_guide_src/source/installation/upgrade_163.rst b/user_guide_src/source/installation/upgrade_163.rst deleted file mode 100644 index e24e20357..000000000 --- a/user_guide_src/source/installation/upgrade_163.rst +++ /dev/null @@ -1,27 +0,0 @@ -############################# -Upgrading from 1.6.2 to 1.6.3 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace these files and directories in your "system" folder with the new -versions: - -- system/codeigniter -- system/database -- system/helpers -- system/language -- system/libraries - -.. note:: If you have any custom developed files in these folders please - make copies of them first. - -Step 2: Update your user guide -============================== - -Please also replace your local copy of the user guide with the new -version. diff --git a/user_guide_src/source/installation/upgrade_170.rst b/user_guide_src/source/installation/upgrade_170.rst deleted file mode 100644 index fefb2ea51..000000000 --- a/user_guide_src/source/installation/upgrade_170.rst +++ /dev/null @@ -1,56 +0,0 @@ -############################# -Upgrading from 1.6.3 to 1.7.0 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace these files and directories in your "system" folder with the new -versions: - -- system/codeigniter -- system/database -- system/helpers -- system/language -- system/libraries - -.. note:: If you have any custom developed files in these folders please - make copies of them first. - -Step 2: Update your Session Table -================================= - -If you are using the Session class in your application, AND if you are -storing session data to a database, you must add a new column named -user_data to your session table. Here is an example of what this column -might look like for MySQL:: - - user_data text NOT NULL - -To add this column you will run a query similar to this:: - - ALTER TABLE `ci_sessions` ADD `user_data` text NOT NULL - -You'll find more information regarding the new Session functionality in -the :doc:`Session class <../libraries/sessions>` page. - -Step 3: Update your Validation Syntax -===================================== - -This is an **optional**, but recommended step, for people currently -using the Validation class. CI 1.7 introduces a new :doc:`Form Validation -class <../libraries/form_validation>`, which deprecates the old -Validation library. We have left the old one in place so that existing -applications that use it will not break, but you are encouraged to -migrate to the new version as soon as possible. Please read the user -guide carefully as the new library works a little differently, and has -several new features. - -Step 4: Update your user guide -============================== - -Please replace your local copy of the user guide with the new version, -including the image files. diff --git a/user_guide_src/source/installation/upgrade_171.rst b/user_guide_src/source/installation/upgrade_171.rst deleted file mode 100644 index e791b4eba..000000000 --- a/user_guide_src/source/installation/upgrade_171.rst +++ /dev/null @@ -1,27 +0,0 @@ -############################# -Upgrading from 1.7.0 to 1.7.1 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace these files and directories in your "system" folder with the new -versions: - -- system/codeigniter -- system/database -- system/helpers -- system/language -- system/libraries - -.. note:: If you have any custom developed files in these folders please - make copies of them first. - -Step 2: Update your user guide -============================== - -Please replace your local copy of the user guide with the new version, -including the image files. diff --git a/user_guide_src/source/installation/upgrade_172.rst b/user_guide_src/source/installation/upgrade_172.rst deleted file mode 100644 index 16f6dec1f..000000000 --- a/user_guide_src/source/installation/upgrade_172.rst +++ /dev/null @@ -1,48 +0,0 @@ -############################# -Upgrading from 1.7.1 to 1.7.2 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace these files and directories in your "system" folder with the new -versions: - -- system/codeigniter -- system/database -- system/helpers -- system/language -- system/libraries -- index.php - -.. note:: If you have any custom developed files in these folders please - make copies of them first. - -Step 2: Remove header() from 404 error template -=============================================== - -If you are using header() in your 404 error template, such as the case -with the default error_404.php template shown below, remove that line -of code. - -:: - - <?php header("HTTP/1.1 404 Not Found"); ?> - -404 status headers are now properly handled in the show_404() method -itself. - -Step 3: Confirm your system_path -================================= - -In your updated index.php file, confirm that the $system_path variable -is set to your application's system folder. - -Step 4: Update your user guide -============================== - -Please replace your local copy of the user guide with the new version, -including the image files. diff --git a/user_guide_src/source/installation/upgrade_200.rst b/user_guide_src/source/installation/upgrade_200.rst deleted file mode 100644 index 03b8ff4ac..000000000 --- a/user_guide_src/source/installation/upgrade_200.rst +++ /dev/null @@ -1,148 +0,0 @@ -############################# -Upgrading from 1.7.2 to 2.0.0 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -******************* -Update Instructions -******************* - -Step 1: Update your CodeIgniter files -===================================== - -Replace all files and directories in your "system" folder **except** -your application folder. - -.. note:: If you have any custom developed files in these folders please - make copies of them first. - -Step 2: Adjust get_dir_file_info() where necessary -===================================================== - -Version 2.0.0 brings a non-backwards compatible change to -get_dir_file_info() in the :doc:`File -Helper <../helpers/file_helper>`. Non-backwards compatible changes -are extremely rare in CodeIgniter, but this one we feel was warranted -due to how easy it was to create serious server performance issues. If -you *need* recursiveness where you are using this helper function, -change such instances, setting the second parameter, $top_level_only -to FALSE:: - - get_dir_file_info('/path/to/directory', FALSE); - -Step 3: Convert your Plugins to Helpers -======================================= - -2.0.0 gets rid of the "Plugin" system as their functionality was -identical to Helpers, but non-extensible. You will need to rename your -plugin files from filename_pi.php to filename_helper.php, move them to -your helpers folder, and change all instances of:: - - $this->load->plugin('foo'); - -to :: - - $this->load->helper('foo'); - - -Step 4: Update stored encrypted data -==================================== - -.. note:: If your application does not use the Encrypt library, does - not store Encrypted data permanently, or is on an environment that does - not support Mcrypt, you may skip this step. - -The Encrypt library has had a number of improvements, some for -encryption strength and some for performance, that has an unavoidable -consequence of making it no longer possible to decode encrypted data -produced by the original version of this library. To help with the -transition, a new method has been added, encode_from_legacy() that -will decode the data with the original algorithm and return a re-encoded -string using the improved methods. This will enable you to easily -replace stale encrypted data with fresh in your applications, either on -the fly or en masse. - -Please read :doc:`how to use this -method <../libraries/encrypt>` in the Encrypt library -documentation. - -Step 5: Remove loading calls for the compatibility helper. -========================================================== - -The compatibility helper has been removed from the CodeIgniter core. All -methods in it should be natively available in supported PHP versions. - -Step 6: Update Class extension -============================== - -All core classes are now prefixed with CI\_. Update Models and -Controllers to extend CI_Model and CI_Controller, respectively. - -Step 7: Update Parent Constructor calls -======================================= - -All native CodeIgniter classes now use the PHP 5 \__construct() -convention. Please update extended libraries to call -parent::\__construct(). - -Step 8: Move any core extensions to application/core -==================================================== - -Any extensions to core classes (e.g. MY_Controller.php) in your -application/libraries folder must be moved to the new -application/core folder. - -Step 9: Update your user guide -============================== - -Please replace your local copy of the user guide with the new version, -including the image files. - - -************ -Update Notes -************ - -Please refer to the :ref:`2.0.0 Change Log <2.0.0-changelog>` for full -details, but here are some of the larger changes that are more likely to -impact your code: - -- Scaffolding has been removed. -- The CAPTCHA plugin in now a :doc:`helper </helpers/captcha_helper>`. -- The JavaScript calendar plugin was removed. -- The *system/cache* and *system/logs* directories are now in the application - directory. -- The Validation class has been removed. Please see the - :doc:`Form Validation library </libraries/form_validation>` -- "default" is now a reserved name. -- The xss_clean() function has moved to the :doc:`Security Class - </libraries/security>`. -- do_xss_clean() now returns FALSE if the uploaded file fails XSS checks. -- The :doc:`Session Class </libraries/sessions>` requires now the use of an - encryption key set in the config file. -- The following deprecated Active Record functions have been removed: - ``orwhere``, ``orlike``, ``groupby``, ``orhaving``, ``orderby``, - ``getwhere``. -- ``_drop_database()`` and ``_create_database()`` functions have been removed - from the db utility drivers. -- The ``dohash()`` function of the :doc:`Security helper - </helpers/security_helper>` - has been renamed to ``do_hash()`` for naming consistency. - -The config folder -================= - -The following files have been changed: - -- config.php -- database.php -- mimes.php -- routes.php -- user_agents.php - -The following files have been added: - -- foreign_chars.php -- profiler.php
\ No newline at end of file diff --git a/user_guide_src/source/installation/upgrade_201.rst b/user_guide_src/source/installation/upgrade_201.rst deleted file mode 100644 index 93e1aa68d..000000000 --- a/user_guide_src/source/installation/upgrade_201.rst +++ /dev/null @@ -1,39 +0,0 @@ -############################# -Upgrading from 2.0.0 to 2.0.1 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace all files and directories in your "system" folder and replace -your index.php file. If any modifications were made to your index.php -they will need to be made fresh in this new one. - -.. note:: If you have any custom developed files in these folders please - make copies of them first. - -Step 2: Replace config/mimes.php -================================ - -This config file has been updated to contain more mime types, please -copy it to application/config/mimes.php. - -Step 3: Check for forms posting to default controller -===================================================== - -The default behavior for form_open() when called with no parameters -used to be to post to the default controller, but it will now just leave -an empty action="" meaning the form will submit to the current URL. If -submitting to the default controller was the expected behavior it will -need to be changed from:: - - echo form_open(); //<form action="" method="post" accept-charset="utf-8"> - -to use either a / or base_url():: - - echo form_open('/'); //<form action="http://example.com/index.php/" method="post" accept-charset="utf-8"> - echo form_open(base_url()); //<form action="http://example.com/" method="post" accept-charset="utf-8"> - diff --git a/user_guide_src/source/installation/upgrade_202.rst b/user_guide_src/source/installation/upgrade_202.rst deleted file mode 100644 index 8dbd38aff..000000000 --- a/user_guide_src/source/installation/upgrade_202.rst +++ /dev/null @@ -1,33 +0,0 @@ -############################# -Upgrading from 2.0.1 to 2.0.2 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace all files and directories in your "system" folder and replace -your index.php file. If any modifications were made to your index.php -they will need to be made fresh in this new one. - -.. note:: If you have any custom developed files in these folders please - make copies of them first. - -Step 2: Remove loading calls for the Security Library -===================================================== - -Security has been moved to the core and is now always loaded -automatically. Make sure you remove any loading calls as they will -result in PHP errors. - -Step 3: Move MY_Security -========================= - -If you are overriding or extending the Security library, you will need -to move it to application/core. - -csrf_token_name and csrf_hash have changed to protected class -properties. Please use security->get_csrf_hash() and -security->get_csrf_token_name() to access those values. diff --git a/user_guide_src/source/installation/upgrade_203.rst b/user_guide_src/source/installation/upgrade_203.rst deleted file mode 100644 index 717aa3e50..000000000 --- a/user_guide_src/source/installation/upgrade_203.rst +++ /dev/null @@ -1,63 +0,0 @@ -############################# -Upgrading from 2.0.2 to 2.0.3 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace all files and directories in your "system" folder and replace -your index.php file. If any modifications were made to your index.php -they will need to be made fresh in this new one. - -.. note:: If you have any custom developed files in these folders please - make copies of them first. - -Step 2: Update your main index.php file -======================================= - -If you are running a stock index.php file simply replace your version -with the new one. - -If your index.php file has internal modifications, please add your -modifications to the new file and use it. - -Step 3: Replace config/user_agents.php -======================================= - -This config file has been updated to contain more user agent types, -please copy it to application/config/user_agents.php. - -Step 4: Change references of the EXT constant to ".php" -======================================================= - -.. note:: The EXT Constant has been marked as deprecated, but has not - been removed from the application. You are encouraged to make the - changes sooner rather than later. - -Step 5: Remove APPPATH.'third_party' from autoload.php -======================================================= - -Open application/config/autoload.php, and look for the following:: - - $autoload['packages'] = array(APPPATH.'third_party'); - -If you have not chosen to load any additional packages, that line can be -changed to:: - - $autoload['packages'] = array(); - -Which should provide for nominal performance gains if not autoloading -packages. - -Update Sessions Database Tables -=============================== - -If you are using database sessions with the CI Session Library, please -update your ci_sessions database table as follows:: - - CREATE INDEX last_activity_idx ON ci_sessions(last_activity); - ALTER TABLE ci_sessions MODIFY user_agent VARCHAR(120); - diff --git a/user_guide_src/source/installation/upgrade_210.rst b/user_guide_src/source/installation/upgrade_210.rst deleted file mode 100644 index 421435452..000000000 --- a/user_guide_src/source/installation/upgrade_210.rst +++ /dev/null @@ -1,26 +0,0 @@ -############################# -Upgrading from 2.0.3 to 2.1.0 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace all files and directories in your "system" folder. - -.. note:: If you have any custom developed files in these folders please - make copies of them first. - -Step 2: Replace config/mimes.php -================================ - -This config file has been updated to contain more user agent types, -please copy it to *application/config/mimes.php*. - -Step 3: Update your user guide -============================== - -Please also replace your local copy of the user guide with the new -version. diff --git a/user_guide_src/source/installation/upgrade_211.rst b/user_guide_src/source/installation/upgrade_211.rst deleted file mode 100644 index f0e70f6dc..000000000 --- a/user_guide_src/source/installation/upgrade_211.rst +++ /dev/null @@ -1,31 +0,0 @@ -############################# -Upgrading from 2.1.0 to 2.1.1 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace all files and directories in your "system" folder. - -.. note:: If you have any custom developed files in these folders please - make copies of them first. - -Step 2: Replace config/mimes.php -================================ - -This config file has been updated to contain more user mime-types, please copy -it to _application/config/mimes.php*. - -Step 3: Update your IP address tables -===================================== - -This upgrade adds support for IPv6 IP addresses. In order to store them, you need -to enlarge your ip_address columns to 45 characters. For example, CodeIgniter's -session table will need to change - -:: - - ALTER TABLE ci_sessions CHANGE ip_address ip_address varchar(45) default '0' NOT NULL
\ No newline at end of file diff --git a/user_guide_src/source/installation/upgrade_212.rst b/user_guide_src/source/installation/upgrade_212.rst deleted file mode 100644 index 4b76482e3..000000000 --- a/user_guide_src/source/installation/upgrade_212.rst +++ /dev/null @@ -1,20 +0,0 @@ -############################# -Upgrading from 2.1.1 to 2.1.2 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace all files and directories in your "system" folder. - -.. note:: If you have any custom developed files in these folders please - make copies of them first. - -Step 2: Update your user guide -============================== - -Please also replace your local copy of the user guide with the new -version.
\ No newline at end of file diff --git a/user_guide_src/source/installation/upgrade_213.rst b/user_guide_src/source/installation/upgrade_213.rst deleted file mode 100644 index 3a3497ccb..000000000 --- a/user_guide_src/source/installation/upgrade_213.rst +++ /dev/null @@ -1,20 +0,0 @@ -############################# -Upgrading from 2.1.2 to 2.1.3 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace all files and directories in your "system" folder. - -.. note:: If you have any custom developed files in these folders please - make copies of them first. - -Step 2: Update your user guide -============================== - -Please also replace your local copy of the user guide with the new -version.
\ No newline at end of file diff --git a/user_guide_src/source/installation/upgrade_214.rst b/user_guide_src/source/installation/upgrade_214.rst deleted file mode 100644 index ba57e5976..000000000 --- a/user_guide_src/source/installation/upgrade_214.rst +++ /dev/null @@ -1,14 +0,0 @@ -############################# -Upgrading from 2.1.3 to 2.1.4 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace all files and directories in your "system" folder. - -.. note:: If you have any custom developed files in these folders please - make copies of them first.
\ No newline at end of file diff --git a/user_guide_src/source/installation/upgrade_220.rst b/user_guide_src/source/installation/upgrade_220.rst deleted file mode 100644 index 91f9e00cd..000000000 --- a/user_guide_src/source/installation/upgrade_220.rst +++ /dev/null @@ -1,21 +0,0 @@ -############################# -Upgrading from 2.1.4 to 2.2.x -############################# - -.. note:: The :doc:`Encrypt Class </libraries/encrypt>` now requires the - Mcrypt extension. If you were previously using the Encrypt Class - without Mcrypt, then this is a breaking change. You must install - the Mcrypt extension in order to upgrade. For information on - installing Mcrypt please see the PHP `documentation - <http://php.net/manual/en/mcrypt.setup.php>`. - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace all files and directories in your "system" folder. - -.. note:: If you have any custom developed files in these folders please - make copies of them first.
\ No newline at end of file diff --git a/user_guide_src/source/installation/upgrade_221.rst b/user_guide_src/source/installation/upgrade_221.rst deleted file mode 100644 index 4af73867e..000000000 --- a/user_guide_src/source/installation/upgrade_221.rst +++ /dev/null @@ -1,14 +0,0 @@ -############################# -Upgrading from 2.2.0 to 2.2.1 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace all files and directories in your "system" folder. - -.. note:: If you have any custom developed files in these folders please - make copies of them first.
\ No newline at end of file diff --git a/user_guide_src/source/installation/upgrade_222.rst b/user_guide_src/source/installation/upgrade_222.rst deleted file mode 100644 index 9dcc61d0e..000000000 --- a/user_guide_src/source/installation/upgrade_222.rst +++ /dev/null @@ -1,14 +0,0 @@ -############################# -Upgrading from 2.2.1 to 2.2.2 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace all files and directories in your "system" folder. - -.. note:: If you have any custom developed files in these folders please - make copies of them first.
\ No newline at end of file diff --git a/user_guide_src/source/installation/upgrade_223.rst b/user_guide_src/source/installation/upgrade_223.rst deleted file mode 100644 index 252318ae1..000000000 --- a/user_guide_src/source/installation/upgrade_223.rst +++ /dev/null @@ -1,14 +0,0 @@ -############################# -Upgrading from 2.2.2 to 2.2.3 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace all files and directories in your "system" folder. - -.. note:: If you have any custom developed files in these folders please - make copies of them first.
\ No newline at end of file diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst deleted file mode 100644 index 5b2d3947d..000000000 --- a/user_guide_src/source/installation/upgrade_300.rst +++ /dev/null @@ -1,891 +0,0 @@ -############################# -Upgrading from 2.2.x to 3.0.x -############################# - -Before performing an update you should take your site offline by replacing the index.php file with a static one. - -************************************* -Step 1: Update your CodeIgniter files -************************************* - -**Replace** all files and directories in your *system/* directory and -replace your index.php file. If any modifications were made to your -index.php they will need to be made fresh in this new one. - -.. important:: You have to delete the old *system/* directory first and - then put the new one in its place. A simple copy-paste may cause - issues. - -.. note:: If you have any custom developed files in these folders please - make copies of them first. - -************************************** -Step 2: Update your classes file names -************************************** - -Starting with CodeIgniter 3.0, all class filenames (libraries, drivers, controllers -and models) must be named in a Ucfirst-like manner or in other words - they must -start with a capital letter. - -For example, if you have the following library file: - - application/libraries/mylibrary.php - -... then you'll have to rename it to: - - application/libraries/Mylibrary.php - -The same goes for driver libraries and extensions and/or overrides of CodeIgniter's -own libraries and core classes. - - application/libraries/MY_email.php - application/core/MY_log.php - -The above files should respectively be renamed to the following: - - application/libraries/MY_Email.php - application/core/MY_Log.php - -Controllers: - - application/controllers/welcome.php -> application/controllers/Welcome.php - -Models: - - application/models/misc_model.php -> application/models/Misc_model.php - -Please note that this DOES NOT affect directories, configuration files, views, -helpers, hooks and anything else - it is only applied to classes. - -You must now follow just one simple rule - class names in Ucfirst and everything else -in lowercase. - -******************************** -Step 3: Replace config/mimes.php -******************************** - -This config file has been updated to contain more user mime-types, please copy -it to *application/config/mimes.php*. - -************************************************************** -Step 4: Remove $autoload['core'] from your config/autoload.php -************************************************************** - -Use of the ``$autoload['core']`` config array has been deprecated as of CodeIgniter 1.4.1 and is now removed. -Move any entries that you might have listed there to ``$autoload['libraries']`` instead. - -*************************************************** -Step 5: Move your Log class overrides or extensions -*************************************************** - -The Log Class is considered as a "core" class and is now located in the -**system/core/** directory. Therefore, in order for your Log class overrides -or extensions to work, you need to move them to **application/core/**: - - application/libraries/Log.php -> application/core/Log.php - application/libraries/MY_Log.php -> application/core/MY_Log.php - -***************************************** -Step 6: Update your Session library usage -***************************************** - -The :doc:`Session Library </libraries/sessions>` has been completely -re-written in CodeIgniter 3 and now comes with a bunch of new features, -but that also means that there are changes that you should make ... - -Most notably, the library now uses separate storage drivers instead of -always relying on (encrypted) cookies. -In fact, cookies as storage have now been removed and you must always use -some kind of server-side storage engine, with the file-system being the -default option. - -The Session Class now utilizes PHP's own mechanisms for building custom -session handlers, which also means that your session data is now -accessible via the ``$_SESSION`` superglobal (though, we've kept the -possibility to use it as "userdata", like you've done until now). - -A few configuration options have been removed and a few have been added. -You should really read the whole :doc:`Session library manual -</libraries/sessions>` for the details, but here's a short list of changes -that you should make: - - - Set your ``$config['sess_driver']`` value - - It will default to 'files', unless you've previously used - ``$config['sess_use_database']``, in which case it will be set to - 'database'. - - - Set a ``$config['sess_save_path']`` value - - For the 'database' driver, a fallback to ``$config['sess_table_name']`` - is in place, but otherwise requires you to read the manual for the - specific driver of your choice. - - - Update your ``ci_sessions`` table ('database' driver only) - - The table structure has changed a bit, and more specifically: - - - ``session_id`` field is renamed to ``id`` - - ``user_agent`` field is dropped - - ``user_data`` field is renamed to ``data`` and under MySQL is now of type BLOB - - ``last_activity`` field is renamed to ``timestamp`` - - This is accompanied by a slight change in the table indexes too, so - please read the manual about the `Session Database Driver - <../libraries/sessions.html#database-driver>`_ for more information. - - .. important:: Only MySQL and PostgreSQL are officially supported - now. Other databases may still work, but due to lack of advisory - locking features, they are unsafe for concurrent requests and - you should consider using another driver instead. - - - Remove ``$config['sess_match_useragent']`` - - The user-agent string is input supplied by the user's browser, or in - other words: client side input. As such, it is an ineffective feature - and hence why it has been removed. - - - Remove ``$config['sess_encrypt_cookie']`` - - As already noted, the library no longer uses cookies as a storage - mechanism, which renders this option useless. - - - Remove ``$config['sess_expire_on_close']`` - - This option is still usable, but only for backwards compatibility - purposes and it should be otherwise removed. The same effect is - achieved by setting ``$config['sess_expiration']`` to 0. - - - Check "flashdata" for collisions with "userdata" - - Flashdata is now just regular "userdata", only marked for deletion on - the next request. In other words: you can't have both "userdata" and - "flashdata" with the same name, because it's the same thing. - - - Check usage of session metadata - - Previously, you could access the 'session_id', 'ip_address', - 'user_agent' and 'last_activity' metadata items as userdata. - This is no longer possible, and you should read the notes about - `Session Metadata <../libraries/sessions.html#accessing-session-metadata>`_ - if your application relies on those values. - - - Check ``unset_userdata()`` usage - - Previously, this method used to accept an associative array of - ``'key' => 'dummy value'`` pairs for unsetting multiple keys. That - however makes no sense and you now have to pass *only* the keys, as - the elements of an array. - - :: - - // Old - $this->session->unset_userdata(array('item' => '', 'item2' => '')); - - // New - $this->session->unset_userdata(array('item', 'item2')); - -Finally, if you have written a Session extension, you must now move it to -the *application/libraries/Session/* directory, although chances are that -it will now also have to be re-factored. - -*************************************** -Step 7: Update your config/database.php -*************************************** - -Due to 3.0.0's renaming of Active Record to Query Builder, inside your -**config/database.php**, you will need to rename the ``$active_record`` -variable to ``$query_builder``:: - - $active_group = 'default'; - // $active_record = TRUE; - $query_builder = TRUE; - -************************************ -Step 8: Replace your error templates -************************************ - -In CodeIgniter 3.0, the error templates are now considered as views and have been moved to the -*application/views/errors* directory. - -Furthermore, we've added support for CLI error templates in plain-text format that unlike HTML, -is suitable for the command line. This of course requires another level of separation. - -It is safe to move your old templates from *application/errors* to *application/views/errors/html*, -but you'll have to copy the new *application/views/errors/cli* directory from the CodeIgniter archive. - -****************************************** -Step 9: Update your config/routes.php file -****************************************** - -Routes containing :any -====================== - -Historically, CodeIgniter has always provided the **:any** wildcard in -routing, with the intention of providing a way to match any character -**within** an URI segment. - -However, the **:any** wildcard is actually just an alias for a regular -expression and used to be executed in that manner as **.+**. This is -considered a bug, as it also matches the / (forward slash) character, which -is the URI segment delimiter and that was never the intention. - -In CodeIgniter 3, the **:any** wildcard will now represent **[^/]+**, so -that it will not match a forward slash. - -There are certainly many developers that have utilized this bug as an actual -feature. If you're one of them and want to match a forward slash, please use -the **.+** regular expression:: - - (.+) // matches ANYTHING - (:any) // matches any character, except for '/' - -Directories and 'default_controller', '404_override' -==================================================== - -As you should know, the ``$route['default_controller']`` and -``$route['404_override']`` settings accept not only a controller name, but -also *controller/method* pairs. However, a bug in the routing logic has -made it possible for some users to use that as *directory/controller* -instead. - -As already said, this behavior was incidental and was never intended, nor -documented. If you've relied on it, your application will break with -CodeIgniter 3.0. - -Another notable change in version 3 is that 'default_controller' and -'404_override' are now applied *per directory*. To explain what this means, -let's take the following example:: - - $route['default_controller'] = 'main'; - -Now, assuming that your website is located at *example.com*, you already -know that if a user visits ``http://example.com/``, the above setting will -cause your 'Main' controller to be loaded. - -However, what happens if you have an *application/controllers/admin/* -directory and the user visits ``http://example.com/admin/``? -In CodeIgniter 3, the router will look for a 'Main' controller under the -admin/ directory as well. If not found, a Not Found (404) will be triggered. - -The same rule applies to the '404_override' setting. - -************************************************************************* -Step 10: Many functions now return NULL instead of FALSE on missing items -************************************************************************* - -Many methods and functions now return NULL instead of FALSE when the required items don't exist: - - - :doc:`Common functions <../general/common_functions>` - - - config_item() - - - :doc:`Config Class <../libraries/config>` - - - config->item() - - config->slash_item() - - - :doc:`Input Class <../libraries/input>` - - - input->get() - - input->post() - - input->get_post() - - input->cookie() - - input->server() - - input->input_stream() - - input->get_request_header() - - - :doc:`Session Class <../libraries/sessions>` - - - session->userdata() - - session->flashdata() - - - :doc:`URI Class <../libraries/uri>` - - - uri->segment() - - uri->rsegment() - - - :doc:`Array Helper <../helpers/array_helper>` - - - element() - - elements() - -******************************* -Step 11: Usage of XSS filtering -******************************* - -Many functions in CodeIgniter allow you to use its XSS filtering feature -on demand by passing a boolean parameter. The default value of that -parameter used to be boolean FALSE, but it is now changed to NULL and it -will be dynamically determined by your ``$config['global_xss_filtering']`` -value. - -If you used to manually pass a boolean value for the ``$xss_filter`` -parameter or if you've always had ``$config['global_xss_filtering']`` set -to FALSE, then this change doesn't concern you. - -Otherwise however, please review your usage of the following functions: - - - :doc:`Input Library <../libraries/input>` - - - input->get() - - input->post() - - input->get_post() - - input->cookie() - - input->server() - - input->input_stream() - - - :doc:`Cookie Helper <../helpers/cookie_helper>` :php:func:`get_cookie()` - -.. important:: Another related change is that the ``$_GET``, ``$_POST``, - ``$_COOKIE`` and ``$_SERVER`` superglobals are no longer - automatically overwritten when global XSS filtering is turned on. - -************************************************* -Step 12: Check for potential XSS issues with URIs -************************************************* - -The :doc:`URI Library <../libraries/uri>` used to automatically convert -a certain set of "programmatic characters" to HTML entities when they -are encountered in a URI segment. - -This was aimed at providing some automatic XSS protection, in addition -to the ``$config['permitted_uri_chars']`` setting, but has proven to be -problematic and is now removed in CodeIgniter 3.0. - -If your application has relied on this feature, you should update it to -filter URI segments through ``$this->security->xss_clean()`` whenever you -output them. - -**************************************************************** -Step 13: Check for usage of the 'xss_clean' Form validation rule -**************************************************************** - -A largely unknown rule about XSS cleaning is that it should *only be -applied to output*, as opposed to input data. - -We've made that mistake ourselves with our automatic and global XSS cleaning -feature (see previous step about XSS above), so now in an effort to discourage that -practice, we're also removing 'xss_clean' from the officially supported -list of :doc:`form validation <../libraries/form_validation>` rules. - -Because the :doc:`Form Validation library <../libraries/form_validation>` -generally validates *input* data, the 'xss_clean' rule simply doesn't -belong in it. - -If you really, really need to apply that rule, you should now also load the -:doc:`Security Helper <../helpers/security_helper>`, which contains -``xss_clean()`` as a regular function and therefore can be also used as -a validation rule. - -******************************************************** -Step 14: Update usage of Input Class's get_post() method -******************************************************** - -Previously, the :doc:`Input Class <../libraries/input>` method ``get_post()`` -was searching first in POST data, then in GET data. This method has been -modified so that it searches in GET then in POST, as its name suggests. - -A method has been added, ``post_get()``, which searches in POST then in GET, as -``get_post()`` was doing before. - -******************************************************************** -Step 15: Update usage of Directory Helper's directory_map() function -******************************************************************** - -In the resulting array, directories now end with a trailing directory -separator (i.e. a slash, usually). - -************************************************************* -Step 16: Update usage of Database Forge's drop_table() method -************************************************************* - -Up until now, ``drop_table()`` added an IF EXISTS clause by default or it didn't work -at all with some drivers. In CodeIgniter 3.0, the IF EXISTS condition is no longer added -by default and has an optional second parameter that allows that instead and is set to -FALSE by default. - -If your application relies on IF EXISTS, you'll have to change its usage. - -:: - - // Now produces just DROP TABLE `table_name` - $this->dbforge->drop_table('table_name'); - - // Produces DROP TABLE IF EXISTS `table_name` - $this->dbforge->drop_table('table_name', TRUE); - -.. note:: The given example uses MySQL-specific syntax, but it should work across - all drivers with the exception of ODBC. - -*********************************************************** -Step 17: Change usage of Email library with multiple emails -*********************************************************** - -The :doc:`Email Library <../libraries/email>` will automatically clear the -set parameters after successfully sending emails. To override this behaviour, -pass FALSE as the first parameter in the ``send()`` method: - -:: - - if ($this->email->send(FALSE)) - { - // Parameters won't be cleared - } - -*************************************************** -Step 18: Update your Form_validation language lines -*************************************************** - -Two improvements have been made to the :doc:`Form Validation Library -<../libraries/form_validation>`'s :doc:`language <../libraries/language>` -files and error messages format: - - - :doc:`Language Library <../libraries/language>` line keys now must be - prefixed with **form_validation_** in order to avoid collisions:: - - // Old - $lang['rule'] = ... - - // New - $lang['form_validation_rule'] = ... - - - The error messages format has been changed to use named parameters, to - allow more flexibility than what `sprintf()` offers:: - - // Old - 'The %s field does not match the %s field.' - - // New - 'The {field} field does not match the {param} field.' - -.. note:: The old formatting still works, but the non-prefixed line keys - are DEPRECATED and scheduled for removal in CodeIgniter 3.1+. - Therefore you're encouraged to update its usage sooner rather than - later. - -************************************************************ -Step 19: Make sure your 'base_url' config value is not empty -************************************************************ - -When ``$config['base_url']`` is not set, CodeIgniter tries to automatically -detect what your website's base URL is. This is done purely for convenience -when you are starting development of a new application. - -Auto-detection is never reliable and also has security implications, which -is why you should **always** have it manually configured! - -One of the changes in CodeIgniter 3.0.3 is how this auto-detection works, -and more specifically it now falls back to the server's IP address instead -of the hostname requested by the client. Therefore, if you've ever relied -on auto-detection, it will change how your website works now. - -In case you need to allow e.g. multiple domains, or both http:// and -https:// prefixes to be dynamically used depending on the request, -remember that *application/config/config.php* is still a PHP script, in -which you can create this logic with a few lines of code. For example:: - - $allowed_domains = array('domain1.tld', 'domain2.tld'); - $default_domain = 'domain1.tld'; - - if (in_array($_SERVER['HTTP_HOST'], $allowed_domains, TRUE)) - { - $domain = $_SERVER['HTTP_HOST']; - } - else - { - $domain = $default_domain; - } - - if ( ! empty($_SERVER['HTTPS'])) - { - $config['base_url'] = 'https://'.$domain; - } - else - { - $config['base_url'] = 'http://'.$domain; - } - - -**************************************************************** -Step 20: Remove usage of (previously) deprecated functionalities -**************************************************************** - -In addition to the ``$autoload['core']`` configuration setting, there's a -number of other functionalities that have been removed in CodeIgniter 3.0.0: - -The SHA1 library -================ - -The previously deprecated SHA1 library has been removed, alter your code to use PHP's native -``sha1()`` function to generate a SHA1 hash. - -Additionally, the ``sha1()`` method in the :doc:`Encrypt Library <../libraries/encrypt>` has been removed. - -The EXT constant -================ - -Usage of the ``EXT`` constant has been deprecated since dropping support for PHP 4. There's no -longer a need to maintain different filename extensions and in this new CodeIgniter version, -the ``EXT`` constant has been removed. Use just '.php' instead. - -Smiley helper -============= - -The :doc:`Smiley Helper <../helpers/smiley_helper>` is a legacy feature from EllisLab's -ExpressionEngine product. However, it is too specific for a general purpose framework like -CodeIgniter and as such it is now deprecated. - -Also, the previously deprecated ``js_insert_smiley()`` (since version 1.7.2) is now removed. - -The Encrypt library -=================== - -Following numerous vulnerability reports, the :doc:`Encrypt Library <../libraries/encrypt>` has -been deprecated and a new, :doc:`Encryption Library <../libraries/encryption>` is added to take -its place. - -The new library requires either the `MCrypt extension <http://php.net/mcrypt>`_ (and /dev/urandom -availability) or PHP 5.3.3 and the `OpenSSL extension <http://php.net/openssl>`_. -While this might be rather inconvenient, it is a requirement that allows us to have properly -implemented cryptographic functions. - -.. note:: The :doc:`Encrypt Library <../libraries/encrypt>` is still available for the purpose - of keeping backwards compatibility. - -.. important:: You are strongly encouraged to switch to the new :doc:`Encryption Library - <../libraries/encryption>` as soon as possible! - -The Cart library -================ - -The :doc:`Cart Library <../libraries/cart>`, similarly to the :doc:`Smiley Helper -<../helpers/smiley_helper>` is too specific for CodeIgniter. It is now deprecated -and scheduled for removal in CodeIgniter 3.1+. - -.. note:: The library is still available, but you're strongly encouraged to remove its usage sooner - rather than later. - -Database drivers 'mysql', 'sqlite', 'mssql', 'pdo/dblib' -======================================================== - -The **mysql** driver utilizes the old 'mysql' PHP extension, known for its aging code base and -many low-level problems. The extension is deprecated as of PHP 5.5 and CodeIgniter deprecates -it in version 3.0, switching the default configured MySQL driver to **mysqli**. - -Please use either the 'mysqli' or 'pdo/mysql' drivers for MySQL. The old 'mysql' driver will be -removed at some point in the future. - -The **sqlite**, **mssql** and **pdo/dblib** (also known as pdo/mssql or pdo/sybase) drivers -all depend on PHP extensions that for different reasons no longer exist since PHP 5.3. - -Therefore we are now deprecating these drivers as we will have to remove them in one of the next -CodeIgniter versions. You should use the more advanced, **sqlite3**, **sqlsrv** or **pdo/sqlsrv** -drivers respectively. - -.. note:: These drivers are still available, but you're strongly encouraged to switch to other ones - sooner rather than later. - -Security helper do_hash() -========================= - -:doc:`Security Helper <../helpers/security_helper>` function ``do_hash()`` is now just an alias for -PHP's native ``hash()`` function. It is deprecated and scheduled for removal in CodeIgniter 3.1+. - -.. note:: This function is still available, but you're strongly encouraged to remove its usage sooner - rather than later. - -The $config['global_xss_filtering'] setting -=========================================== - -As already explained above, XSS filtering should not be done on input data, -but on output instead. Therefore, the ``$config['global_xss_filtering']``, -which automatically filters *input* data, is considered a bad practice and -is now deprecated. - -Instead, you should manually escape any user-provided data via the -:php:func:`xss_clean()` function when you need to output it, or use a -library like `HTML Purifier <http://htmlpurifier.org/>`_ that does that -for you. - -.. note:: The setting is still available, but you're strongly encouraged to - remove its usage sooner rather than later. - -File helper read_file() -======================= - -:doc:`File Helper <../helpers/file_helper>` function ``read_file()`` is now just an alias for -PHP's native ``file_get_contents()`` function. It is deprecated and scheduled for removal in -CodeIgniter 3.1+. - -.. note:: This function is still available, but you're strongly encouraged to remove its usage sooner - rather than later. - -String helper repeater() -======================== - -:doc:`String Helper <../helpers/string_helper>` function :php:func:`repeater()` is now just an alias for -PHP's native ``str_repeat()`` function. It is deprecated and scheduled for removal in CodeIgniter 3.1+. - -.. note:: This function is still available, but you're strongly encouraged to remove its usage sooner - rather than later. - -String helper trim_slashes() -============================ - -:doc:`String Helper <../helpers/string_helper>` function :php:func:`trim_slashes()` is now just an alias -for PHP's native ``trim()`` function (with a slash passed as its second argument). It is deprecated and -scheduled for removal in CodeIgniter 3.1+. - -.. note:: This function is still available, but you're strongly encouraged to remove its usage sooner - rather than later. - -Form helper form_prep() -======================= - -:doc:`Form Helper <../helpers/form_helper>` function :php:func:`form_prep()` -is now just an alias for :doc:`common function </general/common_functions>` -:func:`html_escape()`. It is deprecated and will be removed in the future. - -Please use :php:func:`html_escape()` instead. - -.. note:: This function is still available, but you're strongly encouraged - to remove its usage sooner rather than later. - -Email helper functions -====================== - -:doc:`Email Helper <../helpers/email_helper>` only has two functions - - - :php:func:`valid_email()` - - :php:func:`send_email()` - -Both of them are now aliases for PHP's native ``filter_var()`` and ``mail()`` functions, respectively. -Therefore the :doc:`Email Helper <../helpers/email_helper>` altogether is being deprecated and -is scheduled for removal in CodeIgniter 3.1+. - -.. note:: These functions are still available, but you're strongly encouraged to remove their usage - sooner rather than later. - -Date helper standard_date() -=========================== - -:doc:`Date Helper <../helpers/date_helper>` function ``standard_date()`` is being deprecated due -to the availability of native PHP `constants <http://php.net/manual/en/class.datetime.php#datetime.constants.types>`_, -which when combined with ``date()`` provide the same functionality. Furthermore, they have the -exact same names as the ones supported by ``standard_date()``. Here are examples of how to replace -its usage: - -:: - - // Old way - standard_date(); // defaults to standard_date('DATE_RFC822', now()); - - // Replacement - date(DATE_RFC822, now()); - - // Old way - standard_date('DATE_ATOM', $time); - - // Replacement - date(DATE_ATOM, $time); - -.. note:: This function is still available, but you're strongly encouraged to remove its usage sooner - rather than later as it is scheduled for removal in CodeIgniter 3.1+. - -HTML helpers nbs(), br() -======================== - -:doc:`HTML Helper <../helpers/html_helper>` functions ``nbs()`` and ``br()`` are just aliases -for the native ``str_repeat()`` function used with `` `` and ``<br >`` respectively. - -Because there's no point in just aliasing native PHP functions, they are now deprecated and -scheduled for removal in CodeIgniter 3.1+. - -.. note:: These functions are still available, but you're strongly encouraged to remove their usage - sooner rather than later. - -Pagination library 'anchor_class' setting -========================================= - -The :doc:`Pagination Library <../libraries/pagination>` now supports adding pretty much any HTML -attribute to your anchors via the 'attributes' configuration setting. This includes passing the -'class' attribute and using the separate 'anchor_class' setting no longer makes sense. -As a result of that, the 'anchor_class' setting is now deprecated and scheduled for removal in -CodeIgniter 3.1+. - -.. note:: This setting is still available, but you're strongly encouraged to remove its usage sooner - rather than later. - -String helper random_string() types 'unique' and 'encrypt' -========================================================== - -When using the :doc:`String Helper <../helpers/string_helper>` function :php:func:`random_string()`, -you should no longer pass the **unique** and **encrypt** randomization types. They are only -aliases for **md5** and **sha1** respectively and are now deprecated and scheduled for removal -in CodeIgniter 3.1+. - -.. note:: These options are still available, but you're strongly encouraged to remove their usage - sooner rather than later. - -URL helper url_title() separators 'dash' and 'underscore' -========================================================= - -When using the :doc:`URL Helper <../helpers/url_helper>` function :php:func:`url_title()`, you -should no longer pass **dash** or **underscore** as the word separator. This function will -now accept any character and you should just pass the chosen character directly, so you -should write '-' instead of 'dash' and '_' instead of 'underscore'. - -**dash** and **underscore** now act as aliases and are deprecated and scheduled for removal -in CodeIgniter 3.1+. - -.. note:: These options are still available, but you're strongly encouraged to remove their usage - sooner rather than later. - -Session Library method all_userdata() -===================================== - -As seen in the :doc:`Change Log <../changelog>`, :doc:`Session Library <../libraries/sessions>` -method ``userdata()`` now allows you to fetch all userdata by simply omitting its parameter:: - - $this->session->userdata(); - -This makes the ``all_userdata()`` method redudant and therefore it is now just an alias for -``userdata()`` with the above shown usage and is being deprecated and scheduled for removal -in CodeIgniter 3.1+. - -.. note:: This method is still available, but you're strongly encouraged to remove its usage - sooner rather than later. - -Database Forge method add_column() with an AFTER clause -======================================================= - -If you have used the **third parameter** for :doc:`Database Forge <../database/forge>` method -``add_column()`` to add a field for an AFTER clause, then you should change its usage. - -That third parameter has been deprecated and scheduled for removal in CodeIgniter 3.1+. - -You should now put AFTER clause field names in the field definition array instead:: - - // Old usage: - $field = array( - 'new_field' => array('type' => 'TEXT') - ); - - $this->dbforge->add_column('table_name', $field, 'another_field'); - - // New usage: - $field = array( - 'new_field' => array('type' => 'TEXT', 'after' => 'another_field') - ); - - $this->dbforge->add_column('table_name', $field); - -.. note:: The parameter is still available, but you're strongly encouraged to remove its usage - sooner rather than later. - -.. note:: This is for MySQL and CUBRID databases only! Other drivers don't support this - clause and will silently ignore it. - -URI Routing methods fetch_directory(), fetch_class(), fetch_method() -==================================================================== - -With properties ``CI_Router::$directory``, ``CI_Router::$class`` and ``CI_Router::$method`` -being public and their respective ``fetch_*()`` no longer doing anything else to just return -the properties - it doesn't make sense to keep them. - -Those are all internal, undocumented methods, but we've opted to deprecate them for now -in order to maintain backwards-compatibility just in case. If some of you have utilized them, -then you can now just access the properties instead:: - - $this->router->directory; - $this->router->class; - $this->router->method; - -.. note:: Those methods are still available, but you're strongly encouraged to remove their usage - sooner rather than later. - -Input library method is_cli_request() -===================================== - -Calls to the ``CI_Input::is_cli_request()`` method are necessary at many places -in the CodeIgniter internals and this is often before the :doc:`Input Library -<../libraries/input>` is loaded. Because of that, it is being replaced by a common -function named :php:func:`is_cli()` and this method is now just an alias. - -The new function is both available at all times for you to use and shorter to type. - -:: - - // Old - $this->input->is_cli_request(); - - // New - is_cli(); - -``CI_Input::is_cli_request()`` is now now deprecated and scheduled for removal in -CodeIgniter 3.1+. - -.. note:: This method is still available, but you're strongly encouraged to remove its usage - sooner rather than later. - -Config library method system_url() -================================== - -Usage of ``CI_Config::system_url()`` encourages insecure coding practices. -Namely, your CodeIgniter *system/* directory shouldn't be publicly accessible -from a security point of view. - -Because of this, this method is now deprecated and scheduled for removal in -CodeIgniter 3.1+. - -.. note:: This method is still available, but you're strongly encouraged to remove its usage - sooner rather than later. - -The Javascript library -====================== - -The :doc:`Javascript Library <../libraries/javascript>` has always had an -'experimental' status and was never really useful, nor a proper solution. - -It is now deprecated and scheduled for removal in CodeIgniter 3.1+. - -.. note:: This library is still available, but you're strongly encouraged to remove its usage - sooner rather than later. - -Form Validation method prep_for_form() -====================================== - -The :doc:`Form Validation Library <../libraries/form_validation>` has a -``prep_for_form()`` method, which is/can also be used as a rule in -``set_rules()`` to automatically perform HTML encoding on input data. - -Automatically encoding input (instead of output) data is a bad practice in -the first place, and CodeIgniter and PHP itself offer other alternatives -to this method anyway. -For example, :doc:`Form Helper <../helpers/form_helper>` functions will -automatically perform HTML escaping when necessary. - -Therefore, the *prep_for_form* method/rule is pretty much useless and is now -deprecated and scheduled for removal in 3.1+. - -.. note:: The method is still available, but you're strongly encouraged to - remove its usage sooner rather than later. - -*********************************************************** -Step 21: Check your usage of Text helper highlight_phrase() -*********************************************************** - -The default HTML tag used by :doc:`Text Helper <../helpers/text_helper>` function -:func:`highlight_phrase()` has been changed from ``<strong>`` to the new HTML5 -tag ``<mark>``. - -Unless you've used your own highlighting tags, this might cause trouble -for your visitors who use older web browsers such as Internet Explorer 8. -We therefore suggest that you add the following code to your CSS files -in order to avoid backwards compatibility with old browsers:: - - mark { - background: #ff0; - color: #000; - }; diff --git a/user_guide_src/source/installation/upgrade_301.rst b/user_guide_src/source/installation/upgrade_301.rst deleted file mode 100644 index 450cdb288..000000000 --- a/user_guide_src/source/installation/upgrade_301.rst +++ /dev/null @@ -1,19 +0,0 @@ -############################# -Upgrading from 3.0.0 to 3.0.1 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace all files and directories in your *system/* directory. - -.. note:: If you have any custom developed files in these directories, - please make copies of them first. - -Step 2: Update your CLI error templates -======================================= - -Replace all files under your *application/views/errors/cli/* directory. diff --git a/user_guide_src/source/installation/upgrade_302.rst b/user_guide_src/source/installation/upgrade_302.rst deleted file mode 100644 index 93d87ac41..000000000 --- a/user_guide_src/source/installation/upgrade_302.rst +++ /dev/null @@ -1,24 +0,0 @@ -############################# -Upgrading from 3.0.1 to 3.0.2 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace all files and directories in your *system/* directory. - -.. note:: If you have any custom developed files in these directories, - please make copies of them first. - -Step 2: Update your application/config/constants.php file -========================================================= - -The *application/config/constants.php* file has been updated to check -if constants aren't already defined before doing that, making it easier -to add an environment-specific configuration. - -.. note:: If you've made modifications to this file, please make a - backup first and cross-check the differences first.
\ No newline at end of file diff --git a/user_guide_src/source/installation/upgrade_303.rst b/user_guide_src/source/installation/upgrade_303.rst deleted file mode 100644 index d13a0fe46..000000000 --- a/user_guide_src/source/installation/upgrade_303.rst +++ /dev/null @@ -1,55 +0,0 @@ -############################# -Upgrading from 3.0.2 to 3.0.3 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace all files and directories in your *system/* directory. - -.. note:: If you have any custom developed files in these directories, - please make copies of them first. - -Step 2: Make sure your 'base_url' config value is not empty -=========================================================== - -When ``$config['base_url']`` is not set, CodeIgniter tries to automatically -detect what your website's base URL is. This is done purely for convenience -when you are starting development of a new application. - -Auto-detection is never reliable and also has security implications, which -is why you should **always** have it manually configured! - -One of the changes in CodeIgniter 3.0.3 is how this auto-detection works, -and more specifically it now falls back to the server's IP address instead -of the hostname requested by the client. Therefore, if you've ever relied -on auto-detection, it will change how your website works now. - -In case you need to allow e.g. multiple domains, or both http:// and -https:// prefixes to be dynamically used depending on the request, -remember that *application/config/config.php* is still a PHP script, in -which you can create this logic with a few lines of code. For example:: - - $allowed_domains = array('domain1.tld', 'domain2.tld'); - $default_domain = 'domain1.tld'; - - if (in_array($_SERVER['HTTP_HOST'], $allowed_domains, TRUE)) - { - $domain = $_SERVER['HTTP_HOST']; - } - else - { - $domain = $default_domain; - } - - if ( ! empty($_SERVER['HTTPS'])) - { - $config['base_url'] = 'https://'.$domain; - } - else - { - $config['base_url'] = 'http://'.$domain; - } diff --git a/user_guide_src/source/installation/upgrade_304.rst b/user_guide_src/source/installation/upgrade_304.rst deleted file mode 100644 index 4d5bd2bb0..000000000 --- a/user_guide_src/source/installation/upgrade_304.rst +++ /dev/null @@ -1,14 +0,0 @@ -############################# -Upgrading from 3.0.3 to 3.0.4 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace all files and directories in your *system/* directory. - -.. note:: If you have any custom developed files in these directories, - please make copies of them first. diff --git a/user_guide_src/source/installation/upgrade_305.rst b/user_guide_src/source/installation/upgrade_305.rst deleted file mode 100644 index a47982481..000000000 --- a/user_guide_src/source/installation/upgrade_305.rst +++ /dev/null @@ -1,14 +0,0 @@ -############################# -Upgrading from 3.0.4 to 3.0.5 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace all files and directories in your *system/* directory. - -.. note:: If you have any custom developed files in these directories, - please make copies of them first. diff --git a/user_guide_src/source/installation/upgrade_306.rst b/user_guide_src/source/installation/upgrade_306.rst deleted file mode 100644 index 3863e0afa..000000000 --- a/user_guide_src/source/installation/upgrade_306.rst +++ /dev/null @@ -1,48 +0,0 @@ -############################# -Upgrading from 3.0.5 to 3.0.6 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace all files and directories in your *system/* directory. - -.. note:: If you have any custom developed files in these directories, - please make copies of them first. - -Step 2: Update your index.php file (optional) -============================================= - -We've made some tweaks to the index.php file, mostly related to proper -usage of directory separators (i.e. use the ``DIRECTORY_SEPARATOR`` -constant instead of a hard coded forward slash "/"). - -Nothing will break if you skip this step, but if you're running Windows -or just want to be up to date with every change - we do recommend that -you update your index.php file. - -*Tip: Just copy the ``ENVIRONMENT``, ``$system_path``, ``$application_folder`` -and ``$view_folder`` declarations from the old file and put them into the -new one, replacing the defaults.* - -Step 3: Remove 'prep_for_form' usage (deprecation) -================================================== - -The :doc:`Form Validation Library <../libraries/form_validation>` has a -``prep_for_form()`` method, which is/can also be used as a rule in -``set_rules()`` to automatically perform HTML encoding on input data. - -Automatically encoding input (instead of output) data is a bad practice in -the first place, and CodeIgniter and PHP itself offer other alternatives -to this method anyway. -For example, :doc:`Form Helper <../helpers/form_helper>` functions will -automatically perform HTML escaping when necessary. - -Therefore, the *prep_for_form* method/rule is pretty much useless and is now -deprecated and scheduled for removal in 3.1+. - -.. note:: The method is still available, but you're strongly encouraged to - remove its usage sooner rather than later. diff --git a/user_guide_src/source/installation/upgrade_310.rst b/user_guide_src/source/installation/upgrade_310.rst deleted file mode 100644 index 9e0108691..000000000 --- a/user_guide_src/source/installation/upgrade_310.rst +++ /dev/null @@ -1,38 +0,0 @@ -############################# -Upgrading from 3.0.6 to 3.1.0 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace all files and directories in your *system/* directory. - -.. note:: If you have any custom developed files in these directories, - please make copies of them first. - -Step 2: Check your PHP version -============================== - -We recommend always running versions that are `currently supported -<https://secure.php.net/supported-versions.php>`_, which right now is at least PHP 5.6. - -PHP 5.2.x versions are now officially not supported by CodeIgniter, and while 5.3.7+ -may be at least runnable, we strongly discourage you from using any PHP versions below -the ones listed on the `PHP.net Supported Versions <https://secure.php.net/supported-versions.php>`_ -page. - -Step 3: If you're using the 'odbc' database driver, check for usage of Query Builder -==================================================================================== - -:doc:`Query Builder <../database/query_builder>` functionality and ``escape()`` can -no longer be used with the 'odbc' database driver. - -This is because, due to its nature, the `ODBC extension for PHP <https://secure.php.net/odbc>`_ -does not provide a function that allows to safely escape user-supplied strings for usage -inside an SQL query (which our :doc:`Query Builder <../database/query_builder>` relies on). - -Thus, user inputs MUST be bound, as shown in :doc:`Running Queries <../database/queries>`, -under the "Query Bindings" section.
\ No newline at end of file diff --git a/user_guide_src/source/installation/upgrade_311.rst b/user_guide_src/source/installation/upgrade_311.rst deleted file mode 100644 index a36e72323..000000000 --- a/user_guide_src/source/installation/upgrade_311.rst +++ /dev/null @@ -1,14 +0,0 @@ -############################# -Upgrading from 3.1.0 to 3.1.1 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace all files and directories in your *system/* directory. - -.. note:: If you have any custom developed files in these directories, - please make copies of them first. diff --git a/user_guide_src/source/installation/upgrade_312.rst b/user_guide_src/source/installation/upgrade_312.rst deleted file mode 100644 index e0b2191dd..000000000 --- a/user_guide_src/source/installation/upgrade_312.rst +++ /dev/null @@ -1,40 +0,0 @@ -############################# -Upgrading from 3.1.1 to 3.1.2 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace all files and directories in your *system/* directory. - -.. note:: If you have any custom developed files in these directories, - please make copies of them first. - -Step 2: Update your "ci_sessions" database table -================================================ - -If you're using the :doc:`Session Library </libraries/sessions>` with the -'database' driver, you may have to ``ALTER`` your sessions table for your -sessions to continue to work. - -.. note:: The table in question is not necessarily named "ci_sessions". - It is what you've set as your ``$config['sess_save_path']``. - -This will only affect you if you've changed your ``session.hash_function`` -*php.ini* setting to something like 'sha512'. Or if you've been running -an older CodeIgniter version on PHP 7.1+. - -It is recommended that you do this anyway, just to avoid potential issues -in the future if you do change your configuration. - -Just execute the one of the following SQL queries, depending on your -database:: - - // MySQL: - ALTER TABLE ci_sessions CHANGE id id varchar(128) NOT NULL; - - // PostgreSQL - ALTER TABLE ci_sessions ALTER COLUMN id SET DATA TYPE varchar(128); diff --git a/user_guide_src/source/installation/upgrade_313.rst b/user_guide_src/source/installation/upgrade_313.rst deleted file mode 100644 index 13af775a1..000000000 --- a/user_guide_src/source/installation/upgrade_313.rst +++ /dev/null @@ -1,46 +0,0 @@ -############################# -Upgrading from 3.1.2 to 3.1.3 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace all files and directories in your *system/* directory. - -.. note:: If you have any custom developed files in these directories, - please make copies of them first. - -Step 2: Remove usage of nice_date() helper (deprecation) -======================================================== - -The :doc:`Date Helper <../helpers/date_helper>` function ``nice_date()`` is -no longer useful since the introduction of PHP's `DateTime classes -<https://secure.php.net/datetime>`_ - -You can replace it with the following: -:: - - DateTime::createFromFormat($input_format, $input_date)->format($desired_output_format); - -Thus, ``nice_date()`` is now deprecated and scheduled for removal in -CodeIgniter 3.2+. - -.. note:: The function is still available, but you're strongly encouraged - to remove its usage sooner rather than later. - -Step 3: Remove usage of $config['standardize_newlines'] -======================================================= - -The :doc:`Input Library <../libraries/input>` would optionally replace -occurrences of `\r\n`, `\r`, `\n` in input data with whatever the ``PHP_EOL`` -value is on your system - if you've set ``$config['standardize_newlines']`` -to ``TRUE`` in your *application/config/config.php*. - -This functionality is now deprecated and scheduled for removal in -CodeIgniter 3.2.+. - -.. note:: The functionality is still available, but you're strongly - encouraged to remove its usage sooner rather than later. diff --git a/user_guide_src/source/installation/upgrade_314.rst b/user_guide_src/source/installation/upgrade_314.rst deleted file mode 100644 index 3f2da6564..000000000 --- a/user_guide_src/source/installation/upgrade_314.rst +++ /dev/null @@ -1,14 +0,0 @@ -############################# -Upgrading from 3.1.3 to 3.1.4 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace all files and directories in your *system/* directory. - -.. note:: If you have any custom developed files in these directories, - please make copies of them first. diff --git a/user_guide_src/source/installation/upgrade_315.rst b/user_guide_src/source/installation/upgrade_315.rst deleted file mode 100644 index cf673abbb..000000000 --- a/user_guide_src/source/installation/upgrade_315.rst +++ /dev/null @@ -1,14 +0,0 @@ -############################# -Upgrading from 3.1.4 to 3.1.5 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace all files and directories in your *system/* directory. - -.. note:: If you have any custom developed files in these directories, - please make copies of them first. diff --git a/user_guide_src/source/installation/upgrade_316.rst b/user_guide_src/source/installation/upgrade_316.rst deleted file mode 100644 index 1d86b5720..000000000 --- a/user_guide_src/source/installation/upgrade_316.rst +++ /dev/null @@ -1,28 +0,0 @@ -############################# -Upgrading from 3.1.5 to 3.1.6 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace all files and directories in your *system/* directory. - -.. note:: If you have any custom developed files in these directories, - please make copies of them first. - -Step 2: Remove usage of the APC Cache driver (deprecation) -========================================================== - -The :doc:`Cache Library <../libraries/caching>` APC driver is now -deprecated, as the APC extension is effectively dead, as explained in its -`PHP Manual page <https://secure.php.net/manual/en/intro.apc.php>`_. - -If your application happens to be using it, you can switch to another -cache driver, as APC support will be removed in a future CodeIgniter -version. - -.. note:: The driver is still available, but you're strongly encouraged - to remove its usage sooner rather than later. diff --git a/user_guide_src/source/installation/upgrade_317.rst b/user_guide_src/source/installation/upgrade_317.rst deleted file mode 100644 index dc1ee1868..000000000 --- a/user_guide_src/source/installation/upgrade_317.rst +++ /dev/null @@ -1,27 +0,0 @@ -############################# -Upgrading from 3.1.6 to 3.1.7 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace all files and directories in your *system/* directory. - -.. note:: If you have any custom developed files in these directories, - please make copies of them first. - -Step 2: Remove usage of CAPTCHA helper extra parameters (deprecation) -===================================================================== - -The :doc:`CAPTCHA Helper <../helpers/captcha_helper>` function -:php:func:`create_captcha()` allows passing of its ``img_path``, ``img_url`` -and ``font_path`` options as the 2nd, 3rd and 4th parameters respectively. - -This kind of usage is now deprecated and you should just pass the options -in question as part of the first parameter array. - -.. note:: The functionality in question is still available, but you're - strongly encouraged to remove its usage sooner rather than later. diff --git a/user_guide_src/source/installation/upgrade_318.rst b/user_guide_src/source/installation/upgrade_318.rst deleted file mode 100644 index 8b13f5c50..000000000 --- a/user_guide_src/source/installation/upgrade_318.rst +++ /dev/null @@ -1,14 +0,0 @@ -############################# -Upgrading from 3.1.7 to 3.1.8 -############################# - -Before performing an update you should take your site offline by -replacing the index.php file with a static one. - -Step 1: Update your CodeIgniter files -===================================== - -Replace all files and directories in your *system/* directory. - -.. note:: If you have any custom developed files in these directories, - please make copies of them first. diff --git a/user_guide_src/source/installation/upgrade_b11.rst b/user_guide_src/source/installation/upgrade_b11.rst deleted file mode 100644 index e70759be6..000000000 --- a/user_guide_src/source/installation/upgrade_b11.rst +++ /dev/null @@ -1,78 +0,0 @@ -################################### -Upgrading From Beta 1.0 to Beta 1.1 -################################### - -To upgrade to Beta 1.1 please perform the following steps: - -Step 1: Replace your index file -=============================== - -Replace your main index.php file with the new index.php file. Note: If -you have renamed your "system" folder you will need to edit this info in -the new file. - -Step 2: Relocate your config folder -=================================== - -This version of CodeIgniter now permits multiple sets of "applications" -to all share a common set of backend files. In order to enable each -application to have its own configuration values, the config directory -must now reside inside of your application folder, so please move it -there. - -Step 3: Replace directories -=========================== - -Replace the following directories with the new versions: - -- drivers -- helpers -- init -- libraries -- scaffolding - -Step 4: Add the calendar language file -====================================== - -There is a new language file corresponding to the new calendaring class -which must be added to your language folder. Add the following item to -your version: language/english/calendar_lang.php - -Step 5: Edit your config file -============================= - -The original application/config/config.php file has a typo in it Open -the file and look for the items related to cookies:: - - $conf['cookie_prefix'] = ""; - $conf['cookie_domain'] = ""; - $conf['cookie_path'] = "/"; - -Change the array name from $conf to $config, like this:: - - $config['cookie_prefix'] = ""; - $config['cookie_domain'] = ""; - $config['cookie_path'] = "/"; - -Lastly, add the following new item to the config file (and edit the -option if needed):: - - - /* - |------------------------------------------------ - | URI PROTOCOL - |------------------------------------------------ - | - | This item determines which server global - | should be used to retrieve the URI string. The - | default setting of "auto" works for most servers. - | If your links do not seem to work, try one of - | the other delicious flavors: - | - | 'auto' Default - auto detects - | 'path_info' Uses the PATH_INFO - | 'query_string' Uses the QUERY_STRING - */ - - $config['uri_protocol'] = "auto"; - diff --git a/user_guide_src/source/installation/upgrading.rst b/user_guide_src/source/installation/upgrading.rst deleted file mode 100644 index a51b128ec..000000000 --- a/user_guide_src/source/installation/upgrading.rst +++ /dev/null @@ -1,58 +0,0 @@ -################################# -Upgrading From a Previous Version -################################# - -Please read the upgrade notes corresponding to the version you are -upgrading from. - -.. toctree:: - :titlesonly: - - Upgrading from 3.1.7 to 3.1.8 <upgrade_318> - Upgrading from 3.1.6 to 3.1.7 <upgrade_317> - Upgrading from 3.1.5 to 3.1.6 <upgrade_316> - Upgrading from 3.1.4 to 3.1.5 <upgrade_315> - Upgrading from 3.1.3 to 3.1.4 <upgrade_314> - Upgrading from 3.1.2 to 3.1.3 <upgrade_313> - Upgrading from 3.1.1 to 3.1.2 <upgrade_312> - Upgrading from 3.1.0 to 3.1.1 <upgrade_311> - Upgrading from 3.0.6 to 3.1.0 <upgrade_310> - Upgrading from 3.0.5 to 3.0.6 <upgrade_306> - Upgrading from 3.0.4 to 3.0.5 <upgrade_305> - Upgrading from 3.0.3 to 3.0.4 <upgrade_304> - Upgrading from 3.0.2 to 3.0.3 <upgrade_303> - Upgrading from 3.0.1 to 3.0.2 <upgrade_302> - Upgrading from 3.0.0 to 3.0.1 <upgrade_301> - Upgrading from 2.2.x to 3.0.x <upgrade_300> - Upgrading from 2.2.2 to 2.2.3 <upgrade_223> - Upgrading from 2.2.1 to 2.2.2 <upgrade_222> - Upgrading from 2.2.0 to 2.2.1 <upgrade_221> - Upgrading from 2.1.4 to 2.2.x <upgrade_220> - Upgrading from 2.1.3 to 2.1.4 <upgrade_214> - Upgrading from 2.1.2 to 2.1.3 <upgrade_213> - Upgrading from 2.1.1 to 2.1.2 <upgrade_212> - Upgrading from 2.1.0 to 2.1.1 <upgrade_211> - Upgrading from 2.0.3 to 2.1.0 <upgrade_210> - Upgrading from 2.0.2 to 2.0.3 <upgrade_203> - Upgrading from 2.0.1 to 2.0.2 <upgrade_202> - Upgrading from 2.0 to 2.0.1 <upgrade_201> - Upgrading from 1.7.2 to 2.0 <upgrade_200> - Upgrading from 1.7.1 to 1.7.2 <upgrade_172> - Upgrading from 1.7.0 to 1.7.1 <upgrade_171> - Upgrading from 1.6.3 to 1.7.0 <upgrade_170> - Upgrading from 1.6.2 to 1.6.3 <upgrade_163> - Upgrading from 1.6.1 to 1.6.2 <upgrade_162> - Upgrading from 1.6.0 to 1.6.1 <upgrade_161> - Upgrading from 1.5.4 to 1.6.0 <upgrade_160> - Upgrading from 1.5.3 to 1.5.4 <upgrade_154> - Upgrading from 1.5.2 to 1.5.3 <upgrade_153> - Upgrading from 1.5.0 or 1.5.1 to 1.5.2 <upgrade_152> - Upgrading from 1.4.1 to 1.5.0 <upgrade_150> - Upgrading from 1.4.0 to 1.4.1 <upgrade_141> - Upgrading from 1.3.3 to 1.4.0 <upgrade_140> - Upgrading from 1.3.2 to 1.3.3 <upgrade_133> - Upgrading from 1.3.1 to 1.3.2 <upgrade_132> - Upgrading from 1.3 to 1.3.1 <upgrade_131> - Upgrading from 1.2 to 1.3 <upgrade_130> - Upgrading from 1.1 to 1.2 <upgrade_120> - Upgrading from Beta 1.0 to Beta 1.1 <upgrade_b11> diff --git a/user_guide_src/source/libraries/benchmark.rst b/user_guide_src/source/libraries/benchmark.rst deleted file mode 100644 index 8fc06be12..000000000 --- a/user_guide_src/source/libraries/benchmark.rst +++ /dev/null @@ -1,168 +0,0 @@ -################## -Benchmarking Class -################## - -CodeIgniter has a Benchmarking class that is always active, enabling the -time difference between any two marked points to be calculated. - -.. note:: This class is initialized automatically by the system so there - is no need to do it manually. - -In addition, the benchmark is always started the moment the framework is -invoked, and ended by the output class right before sending the final -view to the browser, enabling a very accurate timing of the entire -system execution to be shown. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -************************* -Using the Benchmark Class -************************* - -The Benchmark class can be used within your -:doc:`controllers </general/controllers>`, -:doc:`views </general/views>`, or your :doc:`models </general/models>`. -The process for usage is this: - -#. Mark a start point -#. Mark an end point -#. Run the "elapsed time" function to view the results - -Here's an example using real code:: - - $this->benchmark->mark('code_start'); - - // Some code happens here - - $this->benchmark->mark('code_end'); - - echo $this->benchmark->elapsed_time('code_start', 'code_end'); - -.. note:: The words "code_start" and "code_end" are arbitrary. They - are simply words used to set two markers. You can use any words you - want, and you can set multiple sets of markers. Consider this example:: - - $this->benchmark->mark('dog'); - - // Some code happens here - - $this->benchmark->mark('cat'); - - // More code happens here - - $this->benchmark->mark('bird'); - - echo $this->benchmark->elapsed_time('dog', 'cat'); - echo $this->benchmark->elapsed_time('cat', 'bird'); - echo $this->benchmark->elapsed_time('dog', 'bird'); - - -Profiling Your Benchmark Points -=============================== - -If you want your benchmark data to be available to the -:doc:`Profiler </general/profiling>` all of your marked points must -be set up in pairs, and each mark point name must end with _start and -_end. Each pair of points must otherwise be named identically. Example:: - - $this->benchmark->mark('my_mark_start'); - - // Some code happens here... - - $this->benchmark->mark('my_mark_end'); - - $this->benchmark->mark('another_mark_start'); - - // Some more code happens here... - - $this->benchmark->mark('another_mark_end'); - -Please read the :doc:`Profiler page </general/profiling>` for more -information. - -Displaying Total Execution Time -=============================== - -If you would like to display the total elapsed time from the moment -CodeIgniter starts to the moment the final output is sent to the -browser, simply place this in one of your view templates:: - - <?php echo $this->benchmark->elapsed_time();?> - -You'll notice that it's the same function used in the examples above to -calculate the time between two point, except you are **not** using any -parameters. When the parameters are absent, CodeIgniter does not stop -the benchmark until right before the final output is sent to the -browser. It doesn't matter where you use the function call, the timer -will continue to run until the very end. - -An alternate way to show your elapsed time in your view files is to use -this pseudo-variable, if you prefer not to use the pure PHP:: - - {elapsed_time} - -.. note:: If you want to benchmark anything within your controller - functions you must set your own start/end points. - -Displaying Memory Consumption -============================= - -If your PHP installation is configured with --enable-memory-limit, you -can display the amount of memory consumed by the entire system using the -following code in one of your view file:: - - <?php echo $this->benchmark->memory_usage();?> - -.. note:: This function can only be used in your view files. The consumption - will reflect the total memory used by the entire app. - -An alternate way to show your memory usage in your view files is to use -this pseudo-variable, if you prefer not to use the pure PHP:: - - {memory_usage} - - -*************** -Class Reference -*************** - -.. php:class:: CI_Benchmark - - .. php:method:: mark($name) - - :param string $name: the name you wish to assign to your marker - :rtype: void - - Sets a benchmark marker. - - .. php:method:: elapsed_time([$point1 = ''[, $point2 = ''[, $decimals = 4]]]) - - :param string $point1: a particular marked point - :param string $point2: a particular marked point - :param int $decimals: number of decimal places for precision - :returns: Elapsed time - :rtype: string - - Calculates and returns the time difference between two marked points. - - If the first parameter is empty this function instead returns the - ``{elapsed_time}`` pseudo-variable. This permits the full system - execution time to be shown in a template. The output class will - swap the real value for this variable. - - - .. php:method:: memory_usage() - - :returns: Memory usage info - :rtype: string - - Simply returns the ``{memory_usage}`` marker. - - This permits it to be put it anywhere in a template without the memory - being calculated until the end. The :doc:`Output Class <output>` will - swap the real value for this variable.
\ No newline at end of file diff --git a/user_guide_src/source/libraries/caching.rst b/user_guide_src/source/libraries/caching.rst deleted file mode 100644 index a7081ec6b..000000000 --- a/user_guide_src/source/libraries/caching.rst +++ /dev/null @@ -1,279 +0,0 @@ -############## -Caching Driver -############## - -CodeIgniter features wrappers around some of the most popular forms of -fast and dynamic caching. All but file-based caching require specific -server requirements, and a Fatal Exception will be thrown if server -requirements are not met. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -************* -Example Usage -************* - -The following example will load the cache driver, specify `APC <#alternative-php-cache-apc-caching>`_ -as the driver to use, and fall back to file-based caching if APC is not -available in the hosting environment. - -:: - - $this->load->driver('cache', array('adapter' => 'apc', 'backup' => 'file')); - - if ( ! $foo = $this->cache->get('foo')) - { - echo 'Saving to the cache!<br />'; - $foo = 'foobarbaz!'; - - // Save into the cache for 5 minutes - $this->cache->save('foo', $foo, 300); - } - - echo $foo; - -You can also prefix cache item names via the **key_prefix** setting, which is useful -to avoid collisions when you're running multiple applications on the same environment. - -:: - - $this->load->driver('cache', - array('adapter' => 'apc', 'backup' => 'file', 'key_prefix' => 'my_') - ); - - $this->cache->get('foo'); // Will get the cache entry named 'my_foo' - -*************** -Class Reference -*************** - -.. php:class:: CI_Cache - - .. php:method:: is_supported($driver) - - :param string $driver: the name of the caching driver - :returns: TRUE if supported, FALSE if not - :rtype: bool - - This method is automatically called when accessing drivers via - ``$this->cache->get()``. However, if the individual drivers are used, - make sure to call this method to ensure the driver is supported in the - hosting environment. - :: - - if ($this->cache->apc->is_supported()) - { - if ($data = $this->cache->apc->get('my_cache')) - { - // do things. - } - } - - .. php:method:: get($id) - - :param string $id: Cache item name - :returns: Item value or FALSE if not found - :rtype: mixed - - This method will attempt to fetch an item from the cache store. If the - item does not exist, the method will return FALSE. - :: - - $foo = $this->cache->get('my_cached_item'); - - .. php:method:: save($id, $data[, $ttl = 60[, $raw = FALSE]]) - - :param string $id: Cache item name - :param mixed $data: the data to save - :param int $ttl: Time To Live, in seconds (default 60) - :param bool $raw: Whether to store the raw value - :returns: TRUE on success, FALSE on failure - :rtype: string - - This method will save an item to the cache store. If saving fails, the - method will return FALSE. - :: - - $this->cache->save('cache_item_id', 'data_to_cache'); - - .. note:: The ``$raw`` parameter is only utilized by APC and Memcache, - in order to allow usage of ``increment()`` and ``decrement()``. - - .. php:method:: delete($id) - - :param string $id: name of cached item - :returns: TRUE on success, FALSE on failure - :rtype: bool - - This method will delete a specific item from the cache store. If item - deletion fails, the method will return FALSE. - :: - - $this->cache->delete('cache_item_id'); - - .. php:method:: increment($id[, $offset = 1]) - - :param string $id: Cache ID - :param int $offset: Step/value to add - :returns: New value on success, FALSE on failure - :rtype: mixed - - Performs atomic incrementation of a raw stored value. - :: - - // 'iterator' has a value of 2 - - $this->cache->increment('iterator'); // 'iterator' is now 3 - - $this->cache->increment('iterator', 3); // 'iterator' is now 6 - - .. php:method:: decrement($id[, $offset = 1]) - - :param string $id: Cache ID - :param int $offset: Step/value to reduce by - :returns: New value on success, FALSE on failure - :rtype: mixed - - Performs atomic decrementation of a raw stored value. - :: - - // 'iterator' has a value of 6 - - $this->cache->decrement('iterator'); // 'iterator' is now 5 - - $this->cache->decrement('iterator', 2); // 'iterator' is now 3 - - .. php:method:: clean() - - :returns: TRUE on success, FALSE on failure - :rtype: bool - - This method will 'clean' the entire cache. If the deletion of the - cache files fails, the method will return FALSE. - :: - - $this->cache->clean(); - - .. php:method:: cache_info() - - :returns: Information on the entire cache database - :rtype: mixed - - This method will return information on the entire cache. - :: - - var_dump($this->cache->cache_info()); - - .. note:: The information returned and the structure of the data is dependent - on which adapter is being used. - - .. php:method:: get_metadata($id) - - :param string $id: Cache item name - :returns: Metadata for the cached item - :rtype: mixed - - This method will return detailed information on a specific item in the - cache. - :: - - var_dump($this->cache->get_metadata('my_cached_item')); - - .. note:: The information returned and the structure of the data is dependent - on which adapter is being used. - -******* -Drivers -******* - -Alternative PHP Cache (APC) Caching -=================================== - -All of the methods listed above can be accessed without passing a -specific adapter to the driver loader as follows:: - - $this->load->driver('cache'); - $this->cache->apc->save('foo', 'bar', 10); - -For more information on APC, please see -`http://php.net/apc <http://php.net/apc>`_. - -File-based Caching -================== - -Unlike caching from the Output Class, the driver file-based caching -allows for pieces of view files to be cached. Use this with care, and -make sure to benchmark your application, as a point can come where disk -I/O will negate positive gains by caching. - -All of the methods listed above can be accessed without passing a -specific adapter to the driver loader as follows:: - - $this->load->driver('cache'); - $this->cache->file->save('foo', 'bar', 10); - -Memcached Caching -================= - -Multiple Memcached servers can be specified in the memcached.php -configuration file, located in the _application/config/* directory. - -All of the methods listed above can be accessed without passing a -specific adapter to the driver loader as follows:: - - $this->load->driver('cache'); - $this->cache->memcached->save('foo', 'bar', 10); - -For more information on Memcached, please see -`http://php.net/memcached <http://php.net/memcached>`_. - -WinCache Caching -================ - -Under Windows, you can also utilize the WinCache driver. - -All of the methods listed above can be accessed without passing a -specific adapter to the driver loader as follows:: - - $this->load->driver('cache'); - $this->cache->wincache->save('foo', 'bar', 10); - -For more information on WinCache, please see -`http://php.net/wincache <http://php.net/wincache>`_. - -Redis Caching -============= - -Redis is an in-memory key-value store which can operate in LRU cache mode. -To use it, you need `Redis server and phpredis PHP extension <https://github.com/phpredis/phpredis>`_. - -Config options to connect to redis server must be stored in the application/config/redis.php file. -Available options are:: - - $config['socket_type'] = 'tcp'; //`tcp` or `unix` - $config['socket'] = '/var/run/redis.sock'; // in case of `unix` socket type - $config['host'] = '127.0.0.1'; - $config['password'] = NULL; - $config['port'] = 6379; - $config['timeout'] = 0; - -All of the methods listed above can be accessed without passing a -specific adapter to the driver loader as follows:: - - $this->load->driver('cache'); - $this->cache->redis->save('foo', 'bar', 10); - -For more information on Redis, please see -`http://redis.io <http://redis.io>`_. - -Dummy Cache -=========== - -This is a caching backend that will always 'miss.' It stores no data, -but lets you keep your caching code in place in environments that don't -support your chosen cache.
\ No newline at end of file diff --git a/user_guide_src/source/libraries/calendar.rst b/user_guide_src/source/libraries/calendar.rst deleted file mode 100644 index 8fdacf1d7..000000000 --- a/user_guide_src/source/libraries/calendar.rst +++ /dev/null @@ -1,307 +0,0 @@ -################# -Calendaring Class -################# - -The Calendar class enables you to dynamically create calendars. Your -calendars can be formatted through the use of a calendar template, -allowing 100% control over every aspect of its design. In addition, you -can pass data to your calendar cells. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -*************************** -Using the Calendaring Class -*************************** - -Initializing the Class -====================== - -Like most other classes in CodeIgniter, the Calendar class is -initialized in your controller using the $this->load->library function:: - - $this->load->library('calendar'); - -Once loaded, the Calendar object will be available using:: - - $this->calendar - -Displaying a Calendar -===================== - -Here is a very simple example showing how you can display a calendar:: - - $this->load->library('calendar'); - echo $this->calendar->generate(); - -The above code will generate a calendar for the current month/year based -on your server time. To show a calendar for a specific month and year -you will pass this information to the calendar generating function:: - - $this->load->library('calendar'); - echo $this->calendar->generate(2006, 6); - -The above code will generate a calendar showing the month of June in -2006. The first parameter specifies the year, the second parameter -specifies the month. - -Passing Data to your Calendar Cells -=================================== - -To add data to your calendar cells involves creating an associative -array in which the keys correspond to the days you wish to populate and -the array value contains the data. The array is passed to the third -parameter of the calendar generating function. Consider this example:: - - $this->load->library('calendar'); - - $data = array( - 3 => 'http://example.com/news/article/2006/06/03/', - 7 => 'http://example.com/news/article/2006/06/07/', - 13 => 'http://example.com/news/article/2006/06/13/', - 26 => 'http://example.com/news/article/2006/06/26/' - ); - - echo $this->calendar->generate(2006, 6, $data); - -Using the above example, day numbers 3, 7, 13, and 26 will become links -pointing to the URLs you've provided. - -.. note:: By default it is assumed that your array will contain links. - In the section that explains the calendar template below you'll see how - you can customize how data passed to your cells is handled so you can - pass different types of information. - -Setting Display Preferences -=========================== - -There are seven preferences you can set to control various aspects of -the calendar. Preferences are set by passing an array of preferences in -the second parameter of the loading function. Here is an example:: - - $prefs = array( - 'start_day' => 'saturday', - 'month_type' => 'long', - 'day_type' => 'short' - ); - - $this->load->library('calendar', $prefs); - - echo $this->calendar->generate(); - -The above code would start the calendar on saturday, use the "long" -month heading, and the "short" day names. More information regarding -preferences below. - -====================== ================= ============================================ =================================================================== -Preference Default Options Description -====================== ================= ============================================ =================================================================== -**template** None None A string or array containing your calendar template. - See the template section below. -**local_time** time() None A Unix timestamp corresponding to the current time. -**start_day** sunday Any week day (sunday, monday, tuesday, etc.) Sets the day of the week the calendar should start on. -**month_type** long long, short Determines what version of the month name to use in the header. - long = January, short = Jan. -**day_type** abr long, short, abr Determines what version of the weekday names to use in - the column headers. long = Sunday, short = Sun, abr = Su. -**show_next_prev** FALSE TRUE/FALSE (boolean) Determines whether to display links allowing you to toggle - to next/previous months. See information on this feature below. -**next_prev_url** controller/method A URL Sets the basepath used in the next/previous calendar links. -**show_other_days** FALSE TRUE/FALSE (boolean) Determines whether to display days of other months that share the - first or last week of the calendar month. -====================== ================= ============================================ =================================================================== - - -Showing Next/Previous Month Links -================================= - -To allow your calendar to dynamically increment/decrement via the -next/previous links requires that you set up your calendar code similar -to this example:: - - $prefs = array( - 'show_next_prev' => TRUE, - 'next_prev_url' => 'http://example.com/index.php/calendar/show/' - ); - - $this->load->library('calendar', $prefs); - - echo $this->calendar->generate($this->uri->segment(3), $this->uri->segment(4)); - -You'll notice a few things about the above example: - -- You must set the "show_next_prev" to TRUE. -- You must supply the URL to the controller containing your calendar in - the "next_prev_url" preference. If you don't, it will be set to the current - *controller/method*. -- You must supply the "year" and "month" to the calendar generating - function via the URI segments where they appear (Note: The calendar - class automatically adds the year/month to the base URL you - provide.). - -Creating a Calendar Template -============================ - -By creating a calendar template you have 100% control over the design of -your calendar. Using the string method, each component of your calendar -will be placed within a pair of pseudo-variables as shown here:: - - $prefs['template'] = ' - - {table_open}<table border="0" cellpadding="0" cellspacing="0">{/table_open} - - {heading_row_start}<tr>{/heading_row_start} - - {heading_previous_cell}<th><a href="{previous_url}"><<</a></th>{/heading_previous_cell} - {heading_title_cell}<th colspan="{colspan}">{heading}</th>{/heading_title_cell} - {heading_next_cell}<th><a href="{next_url}">>></a></th>{/heading_next_cell} - - {heading_row_end}</tr>{/heading_row_end} - - {week_row_start}<tr>{/week_row_start} - {week_day_cell}<td>{week_day}</td>{/week_day_cell} - {week_row_end}</tr>{/week_row_end} - - {cal_row_start}<tr>{/cal_row_start} - {cal_cell_start}<td>{/cal_cell_start} - {cal_cell_start_today}<td>{/cal_cell_start_today} - {cal_cell_start_other}<td class="other-month">{/cal_cell_start_other} - - {cal_cell_content}<a href="{content}">{day}</a>{/cal_cell_content} - {cal_cell_content_today}<div class="highlight"><a href="{content}">{day}</a></div>{/cal_cell_content_today} - - {cal_cell_no_content}{day}{/cal_cell_no_content} - {cal_cell_no_content_today}<div class="highlight">{day}</div>{/cal_cell_no_content_today} - - {cal_cell_blank} {/cal_cell_blank} - - {cal_cell_other}{day}{/cal_cel_other} - - {cal_cell_end}</td>{/cal_cell_end} - {cal_cell_end_today}</td>{/cal_cell_end_today} - {cal_cell_end_other}</td>{/cal_cell_end_other} - {cal_row_end}</tr>{/cal_row_end} - - {table_close}</table>{/table_close} - '; - - $this->load->library('calendar', $prefs); - - echo $this->calendar->generate(); - -Using the array method, you will pass `key => value` pairs. You can pass as -many or as few values as you'd like. Omitted keys will use the default values -inherited in the calendar class. - -Example:: - - $prefs['template'] = array( - 'table_open' => '<table class="calendar">', - 'cal_cell_start' => '<td class="day">', - 'cal_cell_start_today' => '<td class="today">' - ); - - $this->load->library('calendar', $prefs); - - echo $this->calendar->generate(); - -*************** -Class Reference -*************** - -.. php:class:: CI_Calendar - - .. php:method:: initialize([$config = array()]) - - :param array $config: Configuration parameters - :returns: CI_Calendar instance (method chaining) - :rtype: CI_Calendar - - Initializes the Calendaring preferences. Accepts an associative array as input, containing display preferences. - - .. php:method:: generate([$year = ''[, $month = ''[, $data = array()]]]) - - :param int $year: Year - :param int $month: Month - :param array $data: Data to be shown in the calendar cells - :returns: HTML-formatted calendar - :rtype: string - - Generate the calendar. - - - .. php:method:: get_month_name($month) - - :param int $month: Month - :returns: Month name - :rtype: string - - Generates a textual month name based on the numeric month provided. - - .. php:method:: get_day_names($day_type = '') - - :param string $day_type: 'long', 'short', or 'abr' - :returns: Array of day names - :rtype: array - - Returns an array of day names (Sunday, Monday, etc.) based on the type - provided. Options: long, short, abr. If no ``$day_type`` is provided (or - if an invalid type is provided) this method will return the "abbreviated" - style. - - .. php:method:: adjust_date($month, $year) - - :param int $month: Month - :param int $year: Year - :returns: An associative array containing month and year - :rtype: array - - This method makes sure that you have a valid month/year. For example, if - you submit 13 as the month, the year will increment and the month will - become January:: - - print_r($this->calendar->adjust_date(13, 2014)); - - outputs:: - - Array - ( - [month] => '01' - [year] => '2015' - ) - - .. php:method:: get_total_days($month, $year) - - :param int $month: Month - :param int $year: Year - :returns: Count of days in the specified month - :rtype: int - - Total days in a given month:: - - echo $this->calendar->get_total_days(2, 2012); - // 29 - - .. note:: This method is an alias for :doc:`Date Helper - <../helpers/date_helper>` function :php:func:`days_in_month()`. - - .. php:method:: default_template() - - :returns: An array of template values - :rtype: array - - Sets the default template. This method is used when you have not created - your own template. - - - .. php:method:: parse_template() - - :returns: CI_Calendar instance (method chaining) - :rtype: CI_Calendar - - Harvests the data within the template ``{pseudo-variables}`` used to - display the calendar. diff --git a/user_guide_src/source/libraries/cart.rst b/user_guide_src/source/libraries/cart.rst deleted file mode 100644 index be343320d..000000000 --- a/user_guide_src/source/libraries/cart.rst +++ /dev/null @@ -1,398 +0,0 @@ -################### -Shopping Cart Class -################### - -The Cart Class permits items to be added to a session that stays active -while a user is browsing your site. These items can be retrieved and -displayed in a standard "shopping cart" format, allowing the user to -update the quantity or remove items from the cart. - -.. important:: The Cart library is DEPRECATED and should not be used. - It is currently only kept for backwards compatibility. - -Please note that the Cart Class ONLY provides the core "cart" -functionality. It does not provide shipping, credit card authorization, -or other processing components. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -******************** -Using the Cart Class -******************** - -Initializing the Shopping Cart Class -==================================== - -.. important:: The Cart class utilizes CodeIgniter's :doc:`Session - Class <sessions>` to save the cart information to a database, so - before using the Cart class you must set up a database table as - indicated in the :doc:`Session Documentation <sessions>`, and set the - session preferences in your application/config/config.php file to - utilize a database. - -To initialize the Shopping Cart Class in your controller constructor, -use the ``$this->load->library()`` method:: - - $this->load->library('cart'); - -Once loaded, the Cart object will be available using:: - - $this->cart - -.. note:: The Cart Class will load and initialize the Session Class - automatically, so unless you are using sessions elsewhere in your - application, you do not need to load the Session class. - -Adding an Item to The Cart -========================== - -To add an item to the shopping cart, simply pass an array with the -product information to the ``$this->cart->insert()`` method, as shown -below:: - - $data = array( - 'id' => 'sku_123ABC', - 'qty' => 1, - 'price' => 39.95, - 'name' => 'T-Shirt', - 'options' => array('Size' => 'L', 'Color' => 'Red') - ); - - $this->cart->insert($data); - -.. important:: The first four array indexes above (id, qty, price, and - name) are **required**. If you omit any of them the data will not be - saved to the cart. The fifth index (options) is optional. It is intended - to be used in cases where your product has options associated with it. - Use an array for options, as shown above. - -The five reserved indexes are: - -- **id** - Each product in your store must have a unique identifier. - Typically this will be an "sku" or other such identifier. -- **qty** - The quantity being purchased. -- **price** - The price of the item. -- **name** - The name of the item. -- **options** - Any additional attributes that are needed to identify - the product. These must be passed via an array. - -In addition to the five indexes above, there are two reserved words: -rowid and subtotal. These are used internally by the Cart class, so -please do NOT use those words as index names when inserting data into -the cart. - -Your array may contain additional data. Anything you include in your -array will be stored in the session. However, it is best to standardize -your data among all your products in order to make displaying the -information in a table easier. - -:: - - $data = array( - 'id' => 'sku_123ABC', - 'qty' => 1, - 'price' => 39.95, - 'name' => 'T-Shirt', - 'coupon' => 'XMAS-50OFF' - ); - - $this->cart->insert($data); - -The ``insert()`` method will return the $rowid if you successfully insert a -single item. - -Adding Multiple Items to The Cart -================================= - -By using a multi-dimensional array, as shown below, it is possible to -add multiple products to the cart in one action. This is useful in cases -where you wish to allow people to select from among several items on the -same page. - -:: - - $data = array( - array( - 'id' => 'sku_123ABC', - 'qty' => 1, - 'price' => 39.95, - 'name' => 'T-Shirt', - 'options' => array('Size' => 'L', 'Color' => 'Red') - ), - array( - 'id' => 'sku_567ZYX', - 'qty' => 1, - 'price' => 9.95, - 'name' => 'Coffee Mug' - ), - array( - 'id' => 'sku_965QRS', - 'qty' => 1, - 'price' => 29.95, - 'name' => 'Shot Glass' - ) - ); - - $this->cart->insert($data); - -Displaying the Cart -=================== - -To display the cart you will create a :doc:`view -file </general/views>` with code similar to the one shown below. - -Please note that this example uses the :doc:`form -helper </helpers/form_helper>`. - -:: - - <?php echo form_open('path/to/controller/update/method'); ?> - - <table cellpadding="6" cellspacing="1" style="width:100%" border="0"> - - <tr> - <th>QTY</th> - <th>Item Description</th> - <th style="text-align:right">Item Price</th> - <th style="text-align:right">Sub-Total</th> - </tr> - - <?php $i = 1; ?> - - <?php foreach ($this->cart->contents() as $items): ?> - - <?php echo form_hidden($i.'[rowid]', $items['rowid']); ?> - - <tr> - <td><?php echo form_input(array('name' => $i.'[qty]', 'value' => $items['qty'], 'maxlength' => '3', 'size' => '5')); ?></td> - <td> - <?php echo $items['name']; ?> - - <?php if ($this->cart->has_options($items['rowid']) == TRUE): ?> - - <p> - <?php foreach ($this->cart->product_options($items['rowid']) as $option_name => $option_value): ?> - - <strong><?php echo $option_name; ?>:</strong> <?php echo $option_value; ?><br /> - - <?php endforeach; ?> - </p> - - <?php endif; ?> - - </td> - <td style="text-align:right"><?php echo $this->cart->format_number($items['price']); ?></td> - <td style="text-align:right">$<?php echo $this->cart->format_number($items['subtotal']); ?></td> - </tr> - - <?php $i++; ?> - - <?php endforeach; ?> - - <tr> - <td colspan="2"> </td> - <td class="right"><strong>Total</strong></td> - <td class="right">$<?php echo $this->cart->format_number($this->cart->total()); ?></td> - </tr> - - </table> - - <p><?php echo form_submit('', 'Update your Cart'); ?></p> - -Updating The Cart -================= - -To update the information in your cart, you must pass an array -containing the Row ID and one or more pre-defined properties to the -``$this->cart->update()`` method. - -.. note:: If the quantity is set to zero, the item will be removed from - the cart. - -:: - - $data = array( - 'rowid' => 'b99ccdf16028f015540f341130b6d8ec', - 'qty' => 3 - ); - - $this->cart->update($data); - - // Or a multi-dimensional array - - $data = array( - array( - 'rowid' => 'b99ccdf16028f015540f341130b6d8ec', - 'qty' => 3 - ), - array( - 'rowid' => 'xw82g9q3r495893iajdh473990rikw23', - 'qty' => 4 - ), - array( - 'rowid' => 'fh4kdkkkaoe30njgoe92rkdkkobec333', - 'qty' => 2 - ) - ); - - $this->cart->update($data); - -You may also update any property you have previously defined when -inserting the item such as options, price or other custom fields. - -:: - - $data = array( - 'rowid' => 'b99ccdf16028f015540f341130b6d8ec', - 'qty' => 1, - 'price' => 49.95, - 'coupon' => NULL - ); - - $this->cart->update($data); - -What is a Row ID? -***************** - -The row ID is a unique identifier that is generated by the cart code -when an item is added to the cart. The reason a unique ID is created -is so that identical products with different options can be managed -by the cart. - -For example, let's say someone buys two identical t-shirts (same product -ID), but in different sizes. The product ID (and other attributes) will -be identical for both sizes because it's the same shirt. The only -difference will be the size. The cart must therefore have a means of -identifying this difference so that the two sizes of shirts can be -managed independently. It does so by creating a unique "row ID" based on -the product ID and any options associated with it. - -In nearly all cases, updating the cart will be something the user does -via the "view cart" page, so as a developer, it is unlikely that you -will ever have to concern yourself with the "row ID", other than making -sure your "view cart" page contains this information in a hidden form -field, and making sure it gets passed to the ``update()`` method when -the update form is submitted. Please examine the construction of the -"view cart" page above for more information. - - -*************** -Class Reference -*************** - -.. php:class:: CI_Cart - - .. attribute:: $product_id_rules = '\.a-z0-9_-' - - These are the regular expression rules that we use to validate the product - ID - alpha-numeric, dashes, underscores, or periods by default - - .. attribute:: $product_name_rules = '\w \-\.\:' - - These are the regular expression rules that we use to validate the product ID and product name - alpha-numeric, dashes, underscores, colons or periods by - default - - .. attribute:: $product_name_safe = TRUE - - Whether or not to only allow safe product names. Default TRUE. - - - .. php:method:: insert([$items = array()]) - - :param array $items: Items to insert into the cart - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Insert items into the cart and save it to the session table. Returns TRUE - on success and FALSE on failure. - - - .. php:method:: update([$items = array()]) - - :param array $items: Items to update in the cart - :returns: TRUE on success, FALSE on failure - :rtype: bool - - This method permits changing the properties of a given item. - Typically it is called from the "view cart" page if a user makes changes - to the quantity before checkout. That array must contain the rowid - for each item. - - .. php:method:: remove($rowid) - - :param int $rowid: ID of the item to remove from the cart - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Allows you to remove an item from the shopping cart by passing it the - ``$rowid``. - - .. php:method:: total() - - :returns: Total amount - :rtype: int - - Displays the total amount in the cart. - - - .. php:method:: total_items() - - :returns: Total amount of items in the cart - :rtype: int - - Displays the total number of items in the cart. - - - .. php:method:: contents([$newest_first = FALSE]) - - :param bool $newest_first: Whether to order the array with newest items first - :returns: An array of cart contents - :rtype: array - - Returns an array containing everything in the cart. You can sort the - order by which the array is returned by passing it TRUE where the contents - will be sorted from newest to oldest, otherwise it is sorted from oldest - to newest. - - .. php:method:: get_item($row_id) - - :param int $row_id: Row ID to retrieve - :returns: Array of item data - :rtype: array - - Returns an array containing data for the item matching the specified row - ID, or FALSE if no such item exists. - - .. php:method:: has_options($row_id = '') - - :param int $row_id: Row ID to inspect - :returns: TRUE if options exist, FALSE otherwise - :rtype: bool - - Returns TRUE (boolean) if a particular row in the cart contains options. - This method is designed to be used in a loop with ``contents()``, since - you must pass the rowid to this method, as shown in the Displaying - the Cart example above. - - .. php:method:: product_options([$row_id = '']) - - :param int $row_id: Row ID - :returns: Array of product options - :rtype: array - - Returns an array of options for a particular product. This method is - designed to be used in a loop with ``contents()``, since you - must pass the rowid to this method, as shown in the Displaying the - Cart example above. - - .. php:method:: destroy() - - :rtype: void - - Permits you to destroy the cart. This method will likely be called - when you are finished processing the customer's order.
\ No newline at end of file diff --git a/user_guide_src/source/libraries/config.rst b/user_guide_src/source/libraries/config.rst deleted file mode 100644 index fe2e0a99d..000000000 --- a/user_guide_src/source/libraries/config.rst +++ /dev/null @@ -1,252 +0,0 @@ -############ -Config Class -############ - -The Config class provides a means to retrieve configuration preferences. -These preferences can come from the default config file -(application/config/config.php) or from your own custom config files. - -.. note:: This class is initialized automatically by the system so there - is no need to do it manually. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -***************************** -Working with the Config Class -***************************** - -Anatomy of a Config File -======================== - -By default, CodeIgniter has one primary config file, located at -application/config/config.php. If you open the file using your text -editor you'll see that config items are stored in an array called -$config. - -You can add your own config items to this file, or if you prefer to keep -your configuration items separate (assuming you even need config items), -simply create your own file and save it in config folder. - -.. note:: If you do create your own config files use the same format as - the primary one, storing your items in an array called $config. - CodeIgniter will intelligently manage these files so there will be no - conflict even though the array has the same name (assuming an array - index is not named the same as another). - -Loading a Config File -===================== - -.. note:: - CodeIgniter automatically loads the primary config file - (application/config/config.php), so you will only need to load a config - file if you have created your own. - -There are two ways to load a config file: - -Manual Loading -************** - -To load one of your custom config files you will use the following -function within the :doc:`controller </general/controllers>` that -needs it:: - - $this->config->load('filename'); - -Where filename is the name of your config file, without the .php file -extension. - -If you need to load multiple config files normally they will be -merged into one master config array. Name collisions can occur, -however, if you have identically named array indexes in different -config files. To avoid collisions you can set the second parameter to -TRUE and each config file will be stored in an array index -corresponding to the name of the config file. Example:: - - // Stored in an array with this prototype: $this->config['blog_settings'] = $config - $this->config->load('blog_settings', TRUE); - -Please see the section entitled Fetching Config Items below to learn -how to retrieve config items set this way. - -The third parameter allows you to suppress errors in the event that a -config file does not exist:: - - $this->config->load('blog_settings', FALSE, TRUE); - -Auto-loading -************ - -If you find that you need a particular config file globally, you can -have it loaded automatically by the system. To do this, open the -**autoload.php** file, located at application/config/autoload.php, -and add your config file as indicated in the file. - - -Fetching Config Items -===================== - -To retrieve an item from your config file, use the following function:: - - $this->config->item('item_name'); - -Where item_name is the $config array index you want to retrieve. For -example, to fetch your language choice you'll do this:: - - $lang = $this->config->item('language'); - -The function returns NULL if the item you are trying to fetch -does not exist. - -If you are using the second parameter of the $this->config->load -function in order to assign your config items to a specific index you -can retrieve it by specifying the index name in the second parameter of -the $this->config->item() function. Example:: - - // Loads a config file named blog_settings.php and assigns it to an index named "blog_settings" - $this->config->load('blog_settings', TRUE); - - // Retrieve a config item named site_name contained within the blog_settings array - $site_name = $this->config->item('site_name', 'blog_settings'); - - // An alternate way to specify the same item: - $blog_config = $this->config->item('blog_settings'); - $site_name = $blog_config['site_name']; - -Setting a Config Item -===================== - -If you would like to dynamically set a config item or change an existing -one, you can do so using:: - - $this->config->set_item('item_name', 'item_value'); - -Where item_name is the $config array index you want to change, and -item_value is its value. - -.. _config-environments: - -Environments -============ - -You may load different configuration files depending on the current -environment. The ENVIRONMENT constant is defined in index.php, and is -described in detail in the :doc:`Handling -Environments </general/environments>` section. - -To create an environment-specific configuration file, create or copy a -configuration file in application/config/{ENVIRONMENT}/{FILENAME}.php - -For example, to create a production-only config.php, you would: - -#. Create the directory application/config/production/ -#. Copy your existing config.php into the above directory -#. Edit application/config/production/config.php so it contains your - production settings - -When you set the ENVIRONMENT constant to 'production', the settings for -your new production-only config.php will be loaded. - -You can place the following configuration files in environment-specific -folders: - -- Default CodeIgniter configuration files -- Your own custom configuration files - -.. note:: - CodeIgniter always loads the global config file first (i.e., the one in application/config/), - then tries to load the configuration files for the current environment. - This means you are not obligated to place **all** of your configuration files in an - environment folder. Only the files that change per environment. Additionally you don't - have to copy **all** the config items in the environment config file. Only the config items - that you wish to change for your environment. The config items declared in your environment - folders always overwrite those in your global config files. - - -*************** -Class Reference -*************** - -.. php:class:: CI_Config - - .. attribute:: $config - - Array of all loaded config values - - .. attribute:: $is_loaded - - Array of all loaded config files - - - .. php:method:: item($item[, $index='']) - - :param string $item: Config item name - :param string $index: Index name - :returns: Config item value or NULL if not found - :rtype: mixed - - Fetch a config file item. - - .. php:method:: set_item($item, $value) - - :param string $item: Config item name - :param string $value: Config item value - :rtype: void - - Sets a config file item to the specified value. - - .. php:method:: slash_item($item) - - :param string $item: config item name - :returns: Config item value with a trailing forward slash or NULL if not found - :rtype: mixed - - This method is identical to ``item()``, except it appends a forward - slash to the end of the item, if it exists. - - .. php:method:: load([$file = ''[, $use_sections = FALSE[, $fail_gracefully = FALSE]]]) - - :param string $file: Configuration file name - :param bool $use_sections: Whether config values should be loaded into their own section (index of the main config array) - :param bool $fail_gracefully: Whether to return FALSE or to display an error message - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Loads a configuration file. - - .. php:method:: site_url() - - :returns: Site URL - :rtype: string - - This method retrieves the URL to your site, along with the "index" value - you've specified in the config file. - - This method is normally accessed via the corresponding functions in the - :doc:`URL Helper </helpers/url_helper>`. - - .. php:method:: base_url() - - :returns: Base URL - :rtype: string - - This method retrieves the URL to your site, plus an optional path such - as to a stylesheet or image. - - This method is normally accessed via the corresponding functions in the - :doc:`URL Helper </helpers/url_helper>`. - - .. php:method:: system_url() - - :returns: URL pointing at your CI system/ directory - :rtype: string - - This method retrieves the URL to your CodeIgniter system/ directory. - - .. note:: This method is DEPRECATED because it encourages usage of - insecure coding practices. Your *system/* directory shouldn't - be publicly accessible.
\ No newline at end of file diff --git a/user_guide_src/source/libraries/email.rst b/user_guide_src/source/libraries/email.rst deleted file mode 100644 index 1be6e2adb..000000000 --- a/user_guide_src/source/libraries/email.rst +++ /dev/null @@ -1,405 +0,0 @@ -########### -Email Class -########### - -CodeIgniter's robust Email Class supports the following features: - -- Multiple Protocols: Mail, Sendmail, and SMTP -- TLS and SSL Encryption for SMTP -- Multiple recipients -- CC and BCCs -- HTML or Plaintext email -- Attachments -- Word wrapping -- Priorities -- BCC Batch Mode, enabling large email lists to be broken into small - BCC batches. -- Email Debugging tools - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -*********************** -Using the Email Library -*********************** - -Sending Email -============= - -Sending email is not only simple, but you can configure it on the fly or -set your preferences in a config file. - -Here is a basic example demonstrating how you might send email. Note: -This example assumes you are sending the email from one of your -:doc:`controllers <../general/controllers>`. - -:: - - $this->load->library('email'); - - $this->email->from('your@example.com', 'Your Name'); - $this->email->to('someone@example.com'); - $this->email->cc('another@another-example.com'); - $this->email->bcc('them@their-example.com'); - - $this->email->subject('Email Test'); - $this->email->message('Testing the email class.'); - - $this->email->send(); - -Setting Email Preferences -========================= - -There are 21 different preferences available to tailor how your email -messages are sent. You can either set them manually as described here, -or automatically via preferences stored in your config file, described -below: - -Preferences are set by passing an array of preference values to the -email initialize method. Here is an example of how you might set some -preferences:: - - $config['protocol'] = 'sendmail'; - $config['mailpath'] = '/usr/sbin/sendmail'; - $config['charset'] = 'iso-8859-1'; - $config['wordwrap'] = TRUE; - - $this->email->initialize($config); - -.. note:: Most of the preferences have default values that will be used - if you do not set them. - -Setting Email Preferences in a Config File ------------------------------------------- - -If you prefer not to set preferences using the above method, you can -instead put them into a config file. Simply create a new file called the -email.php, add the $config array in that file. Then save the file at -config/email.php and it will be used automatically. You will NOT need to -use the ``$this->email->initialize()`` method if you save your -preferences in a config file. - -Email Preferences -================= - -The following is a list of all the preferences that can be set when -sending email. - -=================== ====================== ============================ ======================================================================= -Preference Default Value Options Description -=================== ====================== ============================ ======================================================================= -**useragent** CodeIgniter None The "user agent". -**protocol** mail mail, sendmail, or smtp The mail sending protocol. -**mailpath** /usr/sbin/sendmail None The server path to Sendmail. -**smtp_host** No Default None SMTP Server Address. -**smtp_user** No Default None SMTP Username. -**smtp_pass** No Default None SMTP Password. -**smtp_port** 25 None SMTP Port. -**smtp_timeout** 5 None SMTP Timeout (in seconds). -**smtp_keepalive** FALSE TRUE or FALSE (boolean) Enable persistent SMTP connections. -**smtp_crypto** No Default tls or ssl SMTP Encryption -**wordwrap** TRUE TRUE or FALSE (boolean) Enable word-wrap. -**wrapchars** 76 Character count to wrap at. -**mailtype** text text or html Type of mail. If you send HTML email you must send it as a complete web - page. Make sure you don't have any relative links or relative image - paths otherwise they will not work. -**charset** ``$config['charset']`` Character set (utf-8, iso-8859-1, etc.). -**validate** FALSE TRUE or FALSE (boolean) Whether to validate the email address. -**priority** 3 1, 2, 3, 4, 5 Email Priority. 1 = highest. 5 = lowest. 3 = normal. -**crlf** \\n "\\r\\n" or "\\n" or "\\r" Newline character. (Use "\\r\\n" to comply with RFC 822). -**newline** \\n "\\r\\n" or "\\n" or "\\r" Newline character. (Use "\\r\\n" to comply with RFC 822). -**bcc_batch_mode** FALSE TRUE or FALSE (boolean) Enable BCC Batch Mode. -**bcc_batch_size** 200 None Number of emails in each BCC batch. -**dsn** FALSE TRUE or FALSE (boolean) Enable notify message from server -=================== ====================== ============================ ======================================================================= - -Overriding Word Wrapping -======================== - -If you have word wrapping enabled (recommended to comply with RFC 822) -and you have a very long link in your email it can get wrapped too, -causing it to become un-clickable by the person receiving it. -CodeIgniter lets you manually override word wrapping within part of your -message like this:: - - The text of your email that - gets wrapped normally. - - {unwrap}http://example.com/a_long_link_that_should_not_be_wrapped.html{/unwrap} - - More text that will be - wrapped normally. - - -Place the item you do not want word-wrapped between: {unwrap} {/unwrap} - -*************** -Class Reference -*************** - -.. php:class:: CI_Email - - .. php:method:: from($from[, $name = ''[, $return_path = NULL]]) - - :param string $from: "From" e-mail address - :param string $name: "From" display name - :param string $return_path: Optional email address to redirect undelivered e-mail to - :returns: CI_Email instance (method chaining) - :rtype: CI_Email - - Sets the email address and name of the person sending the email:: - - $this->email->from('you@example.com', 'Your Name'); - - You can also set a Return-Path, to help redirect undelivered mail:: - - $this->email->from('you@example.com', 'Your Name', 'returned_emails@example.com'); - - .. note:: Return-Path can't be used if you've configured 'smtp' as - your protocol. - - .. php:method:: reply_to($replyto[, $name = '']) - - :param string $replyto: E-mail address for replies - :param string $name: Display name for the reply-to e-mail address - :returns: CI_Email instance (method chaining) - :rtype: CI_Email - - Sets the reply-to address. If the information is not provided the - information in the :meth:from method is used. Example:: - - $this->email->reply_to('you@example.com', 'Your Name'); - - .. php:method:: to($to) - - :param mixed $to: Comma-delimited string or an array of e-mail addresses - :returns: CI_Email instance (method chaining) - :rtype: CI_Email - - Sets the email address(s) of the recipient(s). Can be a single e-mail, - a comma-delimited list or an array:: - - $this->email->to('someone@example.com'); - - :: - - $this->email->to('one@example.com, two@example.com, three@example.com'); - - :: - - $this->email->to( - array('one@example.com', 'two@example.com', 'three@example.com') - ); - - .. php:method:: cc($cc) - - :param mixed $cc: Comma-delimited string or an array of e-mail addresses - :returns: CI_Email instance (method chaining) - :rtype: CI_Email - - Sets the CC email address(s). Just like the "to", can be a single e-mail, - a comma-delimited list or an array. - - .. php:method:: bcc($bcc[, $limit = '']) - - :param mixed $bcc: Comma-delimited string or an array of e-mail addresses - :param int $limit: Maximum number of e-mails to send per batch - :returns: CI_Email instance (method chaining) - :rtype: CI_Email - - Sets the BCC email address(s). Just like the ``to()`` method, can be a single - e-mail, a comma-delimited list or an array. - - If ``$limit`` is set, "batch mode" will be enabled, which will send - the emails to batches, with each batch not exceeding the specified - ``$limit``. - - .. php:method:: subject($subject) - - :param string $subject: E-mail subject line - :returns: CI_Email instance (method chaining) - :rtype: CI_Email - - Sets the email subject:: - - $this->email->subject('This is my subject'); - - .. php:method:: message($body) - - :param string $body: E-mail message body - :returns: CI_Email instance (method chaining) - :rtype: CI_Email - - Sets the e-mail message body:: - - $this->email->message('This is my message'); - - .. php:method:: set_alt_message($str) - - :param string $str: Alternative e-mail message body - :returns: CI_Email instance (method chaining) - :rtype: CI_Email - - Sets the alternative e-mail message body:: - - $this->email->set_alt_message('This is the alternative message'); - - This is an optional message string which can be used if you send - HTML formatted email. It lets you specify an alternative message - with no HTML formatting which is added to the header string for - people who do not accept HTML email. If you do not set your own - message CodeIgniter will extract the message from your HTML email - and strip the tags. - - .. php:method:: set_header($header, $value) - - :param string $header: Header name - :param string $value: Header value - :returns: CI_Email instance (method chaining) - :rtype: CI_Email - - Appends additional headers to the e-mail:: - - $this->email->set_header('Header1', 'Value1'); - $this->email->set_header('Header2', 'Value2'); - - .. php:method:: clear([$clear_attachments = FALSE]) - - :param bool $clear_attachments: Whether or not to clear attachments - :returns: CI_Email instance (method chaining) - :rtype: CI_Email - - Initializes all the email variables to an empty state. This method - is intended for use if you run the email sending method in a loop, - permitting the data to be reset between cycles. - - :: - - foreach ($list as $name => $address) - { - $this->email->clear(); - - $this->email->to($address); - $this->email->from('your@example.com'); - $this->email->subject('Here is your info '.$name); - $this->email->message('Hi '.$name.' Here is the info you requested.'); - $this->email->send(); - } - - If you set the parameter to TRUE any attachments will be cleared as - well:: - - $this->email->clear(TRUE); - - .. php:method:: send([$auto_clear = TRUE]) - - :param bool $auto_clear: Whether to clear message data automatically - :returns: TRUE on success, FALSE on failure - :rtype: bool - - The e-mail sending method. Returns boolean TRUE or FALSE based on - success or failure, enabling it to be used conditionally:: - - if ( ! $this->email->send()) - { - // Generate error - } - - This method will automatically clear all parameters if the request was - successful. To stop this behaviour pass FALSE:: - - if ($this->email->send(FALSE)) - { - // Parameters won't be cleared - } - - .. note:: In order to use the ``print_debugger()`` method, you need - to avoid clearing the email parameters. - - .. php:method:: attach($filename[, $disposition = ''[, $newname = NULL[, $mime = '']]]) - - :param string $filename: File name - :param string $disposition: 'disposition' of the attachment. Most - email clients make their own decision regardless of the MIME - specification used here. https://www.iana.org/assignments/cont-disp/cont-disp.xhtml - :param string $newname: Custom file name to use in the e-mail - :param string $mime: MIME type to use (useful for buffered data) - :returns: CI_Email instance (method chaining) - :rtype: CI_Email - - Enables you to send an attachment. Put the file path/name in the first - parameter. For multiple attachments use the method multiple times. - For example:: - - $this->email->attach('/path/to/photo1.jpg'); - $this->email->attach('/path/to/photo2.jpg'); - $this->email->attach('/path/to/photo3.jpg'); - - To use the default disposition (attachment), leave the second parameter blank, - otherwise use a custom disposition:: - - $this->email->attach('image.jpg', 'inline'); - - You can also use a URL:: - - $this->email->attach('http://example.com/filename.pdf'); - - If you'd like to use a custom file name, you can use the third parameter:: - - $this->email->attach('filename.pdf', 'attachment', 'report.pdf'); - - If you need to use a buffer string instead of a real - physical - file you can - use the first parameter as buffer, the third parameter as file name and the fourth - parameter as mime-type:: - - $this->email->attach($buffer, 'attachment', 'report.pdf', 'application/pdf'); - - .. php:method:: attachment_cid($filename) - - :param string $filename: Existing attachment filename - :returns: Attachment Content-ID or FALSE if not found - :rtype: string - - Sets and returns an attachment's Content-ID, which enables your to embed an inline - (picture) attachment into HTML. First parameter must be the already attached file name. - :: - - $filename = '/img/photo1.jpg'; - $this->email->attach($filename); - foreach ($list as $address) - { - $this->email->to($address); - $cid = $this->email->attachment_cid($filename); - $this->email->message('<img src="cid:'. $cid .'" alt="photo1" />'); - $this->email->send(); - } - - .. note:: Content-ID for each e-mail must be re-created for it to be unique. - - .. php:method:: print_debugger([$include = array('headers', 'subject', 'body')]) - - :param array $include: Which parts of the message to print out - :returns: Formatted debug data - :rtype: string - - Returns a string containing any server messages, the email headers, and - the email message. Useful for debugging. - - You can optionally specify which parts of the message should be printed. - Valid options are: **headers**, **subject**, **body**. - - Example:: - - // You need to pass FALSE while sending in order for the email data - // to not be cleared - if that happens, print_debugger() would have - // nothing to output. - $this->email->send(FALSE); - - // Will only print the email headers, excluding the message subject and body - $this->email->print_debugger(array('headers')); - - .. note:: By default, all of the raw data will be printed.
\ No newline at end of file diff --git a/user_guide_src/source/libraries/encrypt.rst b/user_guide_src/source/libraries/encrypt.rst deleted file mode 100644 index 67e2a0190..000000000 --- a/user_guide_src/source/libraries/encrypt.rst +++ /dev/null @@ -1,198 +0,0 @@ -############# -Encrypt Class -############# - -The Encrypt Class provides two-way data encryption. It encrypted using -the Mcrypt PHP extension, which is required for the Encrypt Class to run. - -.. important:: This library has been DEPRECATED and is only kept for - backwards compatibility. Please use the new :doc:`Encryption Library - <encryption>`. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -************************* -Using the Encrypt Library -************************* - -Setting your Key -================ - -A *key* is a piece of information that controls the cryptographic -process and permits an encrypted string to be decoded. In fact, the key -you chose will provide the **only** means to decode data that was -encrypted with that key, so not only must you choose the key carefully, -you must never change it if you intend use it for persistent data. - -It goes without saying that you should guard your key carefully. Should -someone gain access to your key, the data will be easily decoded. If -your server is not totally under your control it's impossible to ensure -key security so you may want to think carefully before using it for -anything that requires high security, like storing credit card numbers. - -To take maximum advantage of the encryption algorithm, your key should -be 32 characters in length (256 bits). The key should be as random a -string as you can concoct, with numbers and uppercase and lowercase -letters. Your key should **not** be a simple text string. In order to be -cryptographically secure it needs to be as random as possible. - -Your key can be either stored in your **application/config/config.php**, or -you can design your own storage mechanism and pass the key dynamically -when encoding/decoding. - -To save your key to your **application/config/config.php**, open the file -and set:: - - $config['encryption_key'] = "YOUR KEY"; - -Message Length -============== - -It's important for you to know that the encoded messages the encryption -function generates will be approximately 2.6 times longer than the -original message. For example, if you encrypt the string "my super -secret data", which is 21 characters in length, you'll end up with an -encoded string that is roughly 55 characters (we say "roughly" because -the encoded string length increments in 64 bit clusters, so it's not -exactly linear). Keep this information in mind when selecting your data -storage mechanism. Cookies, for example, can only hold 4K of -information. - -Initializing the Class -====================== - -Like most other classes in CodeIgniter, the Encrypt class is -initialized in your controller using the ``$this->load->library()`` -method:: - - $this->load->library('encrypt'); - -Once loaded, the Encrypt library object will be available using:: - - $this->encrypt - -*************** -Class Reference -*************** - -.. php:class:: CI_Encrypt - - .. php:method:: encode($string[, $key = '']) - - :param string $string: Data to encrypt - :param string $key: Encryption key - :returns: Encrypted string - :rtype: string - - Performs the data encryption and returns it as a string. Example:: - - $msg = 'My secret message'; - - $encrypted_string = $this->encrypt->encode($msg); - - You can optionally pass your encryption key via the second parameter if - you don't want to use the one in your config file:: - - $msg = 'My secret message'; - $key = 'super-secret-key'; - - $encrypted_string = $this->encrypt->encode($msg, $key); - - .. php:method:: decode($string[, $key = '']) - - :param string $string: String to decrypt - :param string $key: Encryption key - :returns: Plain-text string - :rtype: string - - Decrypts an encoded string. Example:: - - $encrypted_string = 'APANtByIGI1BpVXZTJgcsAG8GZl8pdwwa84'; - - $plaintext_string = $this->encrypt->decode($encrypted_string); - - You can optionally pass your encryption key via the second parameter if - you don't want to use the one in your config file:: - - $msg = 'My secret message'; - $key = 'super-secret-key'; - - $encrypted_string = $this->encrypt->decode($msg, $key); - - .. php:method:: set_cipher($cipher) - - :param int $cipher: Valid PHP MCrypt cypher constant - :returns: CI_Encrypt instance (method chaining) - :rtype: CI_Encrypt - - Permits you to set an Mcrypt cipher. By default it uses - ``MCRYPT_RIJNDAEL_256``. Example:: - - $this->encrypt->set_cipher(MCRYPT_BLOWFISH); - - Please visit php.net for a list of `available ciphers <http://php.net/mcrypt>`_. - - If you'd like to manually test whether your server supports MCrypt you - can use:: - - echo extension_loaded('mcrypt') ? 'Yup' : 'Nope'; - - .. php:method:: set_mode($mode) - - :param int $mode: Valid PHP MCrypt mode constant - :returns: CI_Encrypt instance (method chaining) - :rtype: CI_Encrypt - - Permits you to set an Mcrypt mode. By default it uses **MCRYPT_MODE_CBC**. - Example:: - - $this->encrypt->set_mode(MCRYPT_MODE_CFB); - - Please visit php.net for a list of `available modes <http://php.net/mcrypt>`_. - - .. php:method:: encode_from_legacy($string[, $legacy_mode = MCRYPT_MODE_ECB[, $key = '']]) - - :param string $string: String to encrypt - :param int $legacy_mode: Valid PHP MCrypt cipher constant - :param string $key: Encryption key - :returns: Newly encrypted string - :rtype: string - - Enables you to re-encode data that was originally encrypted with - CodeIgniter 1.x to be compatible with the Encrypt library in - CodeIgniter 2.x. It is only necessary to use this method if you have - encrypted data stored permanently such as in a file or database and are - on a server that supports Mcrypt. "Light" use encryption such as - encrypted session data or transitory encrypted flashdata require no - intervention on your part. However, existing encrypted Sessions will be - destroyed since data encrypted prior to 2.x will not be decoded. - - .. important:: - **Why only a method to re-encode the data instead of maintaining legacy - methods for both encoding and decoding?** The algorithms in the - Encrypt library have improved in CodeIgniter 2.x both for performance - and security, and we do not wish to encourage continued use of the older - methods. You can of course extend the Encryption library if you wish and - replace the new methods with the old and retain seamless compatibility - with CodeIgniter 1.x encrypted data, but this a decision that a - developer should make cautiously and deliberately, if at all. - - :: - - $new_data = $this->encrypt->encode_from_legacy($old_encrypted_string); - - ====================== =============== ======================================================================= - Parameter Default Description - ====================== =============== ======================================================================= - **$orig_data** n/a The original encrypted data from CodeIgniter 1.x's Encryption library - **$legacy_mode** MCRYPT_MODE_ECB The Mcrypt mode that was used to generate the original encrypted data. - CodeIgniter 1.x's default was MCRYPT_MODE_ECB, and it will assume that - to be the case unless overridden by this parameter. - **$key** n/a The encryption key. This it typically specified in your config file as - outlined above. - ====================== =============== =======================================================================
\ No newline at end of file diff --git a/user_guide_src/source/libraries/encryption.rst b/user_guide_src/source/libraries/encryption.rst deleted file mode 100644 index b16511d4d..000000000 --- a/user_guide_src/source/libraries/encryption.rst +++ /dev/null @@ -1,585 +0,0 @@ -################## -Encryption Library -################## - -.. important:: DO NOT use this or any other *encryption* library for - user password storage! Passwords must be *hashed* instead, and you - should do that via PHP's own `Password Hashing extension - <http://php.net/password>`_. - -The Encryption Library provides two-way data encryption. To do so in -a cryptographically secure way, it utilizes PHP extensions that are -unfortunately not always available on all systems. -You must meet one of the following dependencies in order to use this -library: - -- `OpenSSL <http://php.net/openssl>`_ -- `MCrypt <http://php.net/mcrypt>`_ (and `MCRYPT_DEV_URANDOM` availability) - -If neither of the above dependencies is met, we simply cannot offer -you a good enough implementation to meet the high standards required -for proper cryptography. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -**************************** -Using the Encryption Library -**************************** - -Initializing the Class -====================== - -Like most other classes in CodeIgniter, the Encryption library is -initialized in your controller using the ``$this->load->library()`` -method:: - - $this->load->library('encryption'); - -Once loaded, the Encryption library object will be available using:: - - $this->encryption - -Default behavior -================ - -By default, the Encryption Library will use the AES-128 cipher in CBC -mode, using your configured *encryption_key* and SHA512 HMAC authentication. - -.. note:: AES-128 is chosen both because it is proven to be strong and - because of its wide availability across different cryptographic - software and programming languages' APIs. - -However, the *encryption_key* is not used as is. - -If you are somewhat familiar with cryptography, you should already know -that a HMAC also requires a secret key and using the same key for both -encryption and authentication is a bad practice. - -Because of that, two separate keys are derived from your already configured -*encryption_key*: one for encryption and one for authentication. This is -done via a technique called `HMAC-based Key Derivation Function -<http://en.wikipedia.org/wiki/HKDF>`_ (HKDF). - -Setting your encryption_key -=========================== - -An *encryption key* is a piece of information that controls the -cryptographic process and permits a plain-text string to be encrypted, -and afterwards - decrypted. It is the secret "ingredient" in the whole -process that allows you to be the only one who is able to decrypt data -that you've decided to hide from the eyes of the public. -After one key is used to encrypt data, that same key provides the **only** -means to decrypt it, so not only must you chose one carefully, but you -must not lose it or you will also lose access to the data. - -It must be noted that to ensure maximum security, such key *should* not -only be as strong as possible, but also often changed. Such behavior -however is rarely practical or possible to implement, and that is why -CodeIgniter gives you the ability to configure a single key that is to be -used (almost) every time. - -It goes without saying that you should guard your key carefully. Should -someone gain access to your key, the data will be easily decrypted. If -your server is not totally under your control it's impossible to ensure -key security so you may want to think carefully before using it for -anything that requires high security, like storing credit card numbers. - -Your encryption key **must** be as long as the encyption algorithm in use -allows. For AES-128, that's 128 bits or 16 bytes (charcters) long. -You will find a table below that shows the supported key lengths of -different ciphers. - -The key should be as random as possible and it **must not** be a regular -text string, nor the output of a hashing function, etc. In order to create -a proper key, you must use the Encryption library's ``create_key()`` method -:: - - // $key will be assigned a 16-byte (128-bit) random key - $key = $this->encryption->create_key(16); - -The key can be either stored in your *application/config/config.php*, or -you can design your own storage mechanism and pass the key dynamically -when encrypting/decrypting. - -To save your key to your *application/config/config.php*, open the file -and set:: - - $config['encryption_key'] = 'YOUR KEY'; - -You'll notice that the ``create_key()`` method outputs binary data, which -is hard to deal with (i.e. a copy-paste may damage it), so you may use -``bin2hex()``, ``hex2bin()`` or Base64-encoding to work with the key in -a more friendly manner. For example:: - - // Get a hex-encoded representation of the key: - $key = bin2hex($this->encryption->create_key(16)); - - // Put the same value in your config with hex2bin(), - // so that it is still passed as binary to the library: - $config['encryption_key'] = hex2bin(<your hex-encoded key>); - -.. _ciphers-and-modes: - -Supported encryption ciphers and modes -====================================== - -.. note:: The terms 'cipher' and 'encryption algorithm' are interchangeable. - -Portable ciphers ----------------- - -Because MCrypt and OpenSSL (also called drivers throughout this document) -each support different sets of encryption algorithms and often implement -them in different ways, our Encryption library is designed to use them in -a portable fashion, or in other words - it enables you to use them -interchangeably, at least for the ciphers supported by both drivers. - -It is also implemented in a way that aims to match the standard -implementations in other programming languages and libraries. - -Here's a list of the so called "portable" ciphers, where -"CodeIgniter name" is the string value that you'd have to pass to the -Encryption library to use that cipher: - -======================== ================== ============================ =============================== -Cipher name CodeIgniter name Key lengths (bits / bytes) Supported modes -======================== ================== ============================ =============================== -AES-128 / Rijndael-128 aes-128 128 / 16 CBC, CTR, CFB, CFB8, OFB, ECB -AES-192 aes-192 192 / 24 CBC, CTR, CFB, CFB8, OFB, ECB -AES-256 aes-256 256 / 32 CBC, CTR, CFB, CFB8, OFB, ECB -DES des 56 / 7 CBC, CFB, CFB8, OFB, ECB -TripleDES tripledes 56 / 7, 112 / 14, 168 / 21 CBC, CFB, CFB8, OFB -Blowfish blowfish 128-448 / 16-56 CBC, CFB, OFB, ECB -CAST5 / CAST-128 cast5 88-128 / 11-16 CBC, CFB, OFB, ECB -RC4 / ARCFour rc4 40-2048 / 5-256 Stream -======================== ================== ============================ =============================== - -.. important:: Because of how MCrypt works, if you fail to provide a key - with the appropriate length, you might end up using a different - algorithm than the one configured, so be really careful with that! - -.. note:: In case it isn't clear from the above table, Blowfish, CAST5 - and RC4 support variable length keys. That is, any number in the - shown ranges is valid, although in bit terms that only happens - in 8-bit increments. - -.. note:: Even though CAST5 supports key lengths lower than 128 bits - (16 bytes), in fact they will just be zero-padded to the - maximum length, as specified in `RFC 2144 - <http://tools.ietf.org/rfc/rfc2144.txt>`_. - -.. note:: Blowfish supports key lengths as small as 32 bits (4 bytes), but - our tests have shown that only lengths of 128 bits (16 bytes) or - higher are properly supported by both MCrypt and OpenSSL. It is - also a bad practice to use such low-length keys anyway. - -Driver-specific ciphers ------------------------ - -As noted above, MCrypt and OpenSSL support different sets of encryption -ciphers. For portability reasons and because we haven't tested them -properly, we do not advise you to use the ones that are driver-specific, -but regardless, here's a list of most of them: - - -============== ========= ============================== ========================================= -Cipher name Driver Key lengths (bits / bytes) Supported modes -============== ========= ============================== ========================================= -AES-128 OpenSSL 128 / 16 CBC, CTR, CFB, CFB8, OFB, ECB, XTS -AES-192 OpenSSL 192 / 24 CBC, CTR, CFB, CFB8, OFB, ECB, XTS -AES-256 OpenSSL 256 / 32 CBC, CTR, CFB, CFB8, OFB, ECB, XTS -Rijndael-128 MCrypt 128 / 16, 192 / 24, 256 / 32 CBC, CTR, CFB, CFB8, OFB, OFB8, ECB -Rijndael-192 MCrypt 128 / 16, 192 / 24, 256 / 32 CBC, CTR, CFB, CFB8, OFB, OFB8, ECB -Rijndael-256 MCrypt 128 / 16, 192 / 24, 256 / 32 CBC, CTR, CFB, CFB8, OFB, OFB8, ECB -GOST MCrypt 256 / 32 CBC, CTR, CFB, CFB8, OFB, OFB8, ECB -Twofish MCrypt 128 / 16, 192 / 24, 256 / 32 CBC, CTR, CFB, CFB8, OFB, OFB8, ECB -CAST-128 MCrypt 40-128 / 5-16 CBC, CTR, CFB, CFB8, OFB, OFB8, ECB -CAST-256 MCrypt 128 / 16, 192 / 24, 256 / 32 CBC, CTR, CFB, CFB8, OFB, OFB8, ECB -Loki97 MCrypt 128 / 16, 192 / 24, 256 / 32 CBC, CTR, CFB, CFB8, OFB, OFB8, ECB -SaferPlus MCrypt 128 / 16, 192 / 24, 256 / 32 CBC, CTR, CFB, CFB8, OFB, OFB8, ECB -Serpent MCrypt 128 / 16, 192 / 24, 256 / 32 CBC, CTR, CFB, CFB8, OFB, OFB8, ECB -XTEA MCrypt 128 / 16 CBC, CTR, CFB, CFB8, OFB, OFB8, ECB -RC2 MCrypt 8-1024 / 1-128 CBC, CTR, CFB, CFB8, OFB, OFB8, ECB -RC2 OpenSSL 8-1024 / 1-128 CBC, CFB, OFB, ECB -Camellia-128 OpenSSL 128 / 16 CBC, CFB, CFB8, OFB, ECB -Camellia-192 OpenSSL 192 / 24 CBC, CFB, CFB8, OFB, ECB -Camellia-256 OpenSSL 256 / 32 CBC, CFB, CFB8, OFB, ECB -Seed OpenSSL 128 / 16 CBC, CFB, OFB, ECB -============== ========= ============================== ========================================= - -.. note:: If you wish to use one of those ciphers, you'd have to pass - its name in lower-case to the Encryption library. - -.. note:: You've probably noticed that all AES cipers (and Rijndael-128) - are also listed in the portable ciphers list. This is because - drivers support different modes for these ciphers. Also, it is - important to note that AES-128 and Rijndael-128 are actually - the same cipher, but **only** when used with a 128-bit key. - -.. note:: CAST-128 / CAST-5 is also listed in both the portable and - driver-specific ciphers list. This is because OpenSSL's - implementation doesn't appear to be working correctly with - key sizes of 80 bits and lower. - -.. note:: RC2 is listed as supported by both MCrypt and OpenSSL. - However, both drivers implement them differently and they - are not portable. It is probably worth noting that we only - found one obscure source confirming that it is MCrypt that - is not properly implementing it. - -.. _encryption-modes: - -Encryption modes ----------------- - -Different modes of encryption have different characteristics and serve -for different purposes. Some are stronger than others, some are faster -and some offer extra features. -We are not going in depth into that here, we'll leave that to the -cryptography experts. The table below is to provide brief informational -reference to our more experienced users. If you are a beginner, just -stick to the CBC mode - it is widely accepted as strong and secure for -general purposes. - -=========== ================== ================= =================================================================================================================================================== -Mode name CodeIgniter name Driver support Additional info -=========== ================== ================= =================================================================================================================================================== -CBC cbc MCrypt, OpenSSL A safe default choice -CTR ctr MCrypt, OpenSSL Considered as theoretically better than CBC, but not as widely available -CFB cfb MCrypt, OpenSSL N/A -CFB8 cfb8 MCrypt, OpenSSL Same as CFB, but operates in 8-bit mode (not recommended). -OFB ofb MCrypt, OpenSSL N/A -OFB8 ofb8 MCrypt Same as OFB, but operates in 8-bit mode (not recommended). -ECB ecb MCrypt, OpenSSL Ignores IV (not recommended). -XTS xts OpenSSL Usually used for encrypting random access data such as RAM or hard-disk storage. -Stream stream MCrypt, OpenSSL This is not actually a mode, it just says that a stream cipher is being used. Required because of the general cipher+mode initialization process. -=========== ================== ================= =================================================================================================================================================== - -Message Length -============== - -It's probably important for you to know that an encrypted string is usually -longer than the original, plain-text string (depending on the cipher). - -This is influenced by the cipher algorithm itself, the IV prepended to the -cipher-text and the HMAC authentication message that is also prepended. -Furthermore, the encrypted message is also Base64-encoded so that it is safe -for storage and transmission, regardless of a possible character set in use. - -Keep this information in mind when selecting your data storage mechanism. -Cookies, for example, can only hold 4K of information. - -.. _configuration: - -Configuring the library -======================= - -For usability, performance, but also historical reasons tied to our old -:doc:`Encrypt Class <encrypt>`, the Encryption library is designed to -use repeatedly the same driver, encryption cipher, mode and key. - -As noted in the "Default behavior" section above, this means using an -auto-detected driver (OpenSSL has a higher priority), the AES-128 ciper -in CBC mode, and your ``$config['encryption_key']`` value. - -If you wish to change that however, you need to use the ``initialize()`` -method. It accepts an associative array of parameters, all of which are -optional: - -======== =============================================== -Option Possible values -======== =============================================== -driver 'mcrypt', 'openssl' -cipher Cipher name (see :ref:`ciphers-and-modes`) -mode Encryption mode (see :ref:`encryption-modes`) -key Encryption key -======== =============================================== - -For example, if you were to change the encryption algorithm and -mode to AES-256 in CTR mode, this is what you should do:: - - $this->encryption->initialize( - array( - 'cipher' => 'aes-256', - 'mode' => 'ctr', - 'key' => '<a 32-character random string>' - ) - ); - -Note that we only mentioned that you want to change the ciper and mode, -but we also included a key in the example. As previously noted, it is -important that you choose a key with a proper size for the used algorithm. - -There's also the ability to change the driver, if for some reason you -have both, but want to use MCrypt instead of OpenSSL:: - - // Switch to the MCrypt driver - $this->encryption->initialize(array('driver' => 'mcrypt')); - - // Switch back to the OpenSSL driver - $this->encryption->initialize(array('driver' => 'openssl')); - -Encrypting and decrypting data -============================== - -Encrypting and decrypting data with the already configured library -settings is simple. As simple as just passing the string to the -``encrypt()`` and/or ``decrypt()`` methods:: - - $plain_text = 'This is a plain-text message!'; - $ciphertext = $this->encryption->encrypt($plain_text); - - // Outputs: This is a plain-text message! - echo $this->encryption->decrypt($ciphertext); - -And that's it! The Encryption library will do everything necessary -for the whole process to be cryptographically secure out-of-the-box. -You don't need to worry about it. - -.. important:: Both methods will return FALSE in case of an error. - While for ``encrypt()`` this can only mean incorrect - configuration, you should always check the return value - of ``decrypt()`` in production code. - -How it works ------------- - -If you must know how the process works, here's what happens under -the hood: - -- ``$this->encryption->encrypt($plain_text)`` - - #. Derive an encryption key and a HMAC key from your configured - *encryption_key* via HKDF, using the SHA-512 digest algorithm. - - #. Generate a random initialization vector (IV). - - #. Encrypt the data via AES-128 in CBC mode (or another previously - configured cipher and mode), using the above-mentioned derived - encryption key and IV. - - #. Prepend said IV to the resulting cipher-text. - - #. Base64-encode the resulting string, so that it can be safely - stored or transferred without worrying about character sets. - - #. Create a SHA-512 HMAC authentication message using the derived - HMAC key to ensure data integrity and prepend it to the Base64 - string. - -- ``$this->encryption->decrypt($ciphertext)`` - - #. Derive an encryption key and a HMAC key from your configured - *encryption_key* via HKDF, using the SHA-512 digest algorithm. - Because your configured *encryption_key* is the same, this - will produce the same result as in the ``encrypt()`` method - above - otherwise you won't be able to decrypt it. - - #. Check if the string is long enough, separate the HMAC out of - it and validate if it is correct (this is done in a way that - prevents timing attacks against it). Return FALSE if either of - the checks fails. - - #. Base64-decode the string. - - #. Separate the IV out of the cipher-text and decrypt the said - cipher-text using that IV and the derived encryption key. - -.. _custom-parameters: - -Using custom parameters ------------------------ - -Let's say you have to interact with another system that is out -of your control and uses another method to encrypt data. A -method that will most certainly not match the above-described -sequence and probably not use all of the steps either. - -The Encryption library allows you to change how its encryption -and decryption processes work, so that you can easily tailor a -custom solution for such situations. - -.. note:: It is possible to use the library in this way, without - setting an *encryption_key* in your configuration file. - -All you have to do is to pass an associative array with a few -parameters to either the ``encrypt()`` or ``decrypt()`` method. -Here's an example:: - - // Assume that we have $ciphertext, $key and $hmac_key - // from on outside source - - $message = $this->encryption->decrypt( - $ciphertext, - array( - 'cipher' => 'blowfish', - 'mode' => 'cbc', - 'key' => $key, - 'hmac_digest' => 'sha256', - 'hmac_key' => $hmac_key - ) - ); - -In the above example, we are decrypting a message that was encrypted -using the Blowfish cipher in CBC mode and authenticated via a SHA-256 -HMAC. - -.. important:: Note that both 'key' and 'hmac_key' are used in this - example. When using custom parameters, encryption and HMAC keys - are not derived like the default behavior of the library is. - -Below is a list of the available options. - -However, unless you really need to and you know what you are doing, -we advise you to not change the encryption process as this could -impact security, so please do so with caution. - -============= =============== ============================= ====================================================== -Option Default value Mandatory / Optional Description -============= =============== ============================= ====================================================== -cipher N/A Yes Encryption algorithm (see :ref:`ciphers-and-modes`). -mode N/A Yes Encryption mode (see :ref:`encryption-modes`). -key N/A Yes Encryption key. -hmac TRUE No Whether to use a HMAC. - Boolean. If set to FALSE, then *hmac_digest* and - *hmac_key* will be ignored. -hmac_digest sha512 No HMAC message digest algorithm (see :ref:`digests`). -hmac_key N/A Yes, unless *hmac* is FALSE HMAC key. -raw_data FALSE No Whether the cipher-text should be raw. - Boolean. If set to TRUE, then Base64 encoding and - decoding will not be performed and HMAC will not - be a hexadecimal string. -============= =============== ============================= ====================================================== - -.. important:: ``encrypt()`` and ``decrypt()`` will return FALSE if - a mandatory parameter is not provided or if a provided - value is incorrect. This includes *hmac_key*, unless *hmac* - is set to FALSE. - -.. _digests: - -Supported HMAC authentication algorithms ----------------------------------------- - -For HMAC message authentication, the Encryption library supports -usage of the SHA-2 family of algorithms: - -=========== ==================== ============================ -Algorithm Raw length (bytes) Hex-encoded length (bytes) -=========== ==================== ============================ -sha512 64 128 -sha384 48 96 -sha256 32 64 -sha224 28 56 -=========== ==================== ============================ - -The reason for not including other popular algorithms, such as -MD5 or SHA1 is that they are no longer considered secure enough -and as such, we don't want to encourage their usage. -If you absolutely need to use them, it is easy to do so via PHP's -native `hash_hmac() <http://php.net/manual/en/function.hash-hmac.php>`_ function. - -Stronger algorithms of course will be added in the future as they -appear and become widely available. - -*************** -Class Reference -*************** - -.. php:class:: CI_Encryption - - .. php:method:: initialize($params) - - :param array $params: Configuration parameters - :returns: CI_Encryption instance (method chaining) - :rtype: CI_Encryption - - Initializes (configures) the library to use a different - driver, cipher, mode or key. - - Example:: - - $this->encryption->initialize( - array('mode' => 'ctr') - ); - - Please refer to the :ref:`configuration` section for detailed info. - - .. php:method:: encrypt($data[, $params = NULL]) - - :param string $data: Data to encrypt - :param array $params: Optional parameters - :returns: Encrypted data or FALSE on failure - :rtype: string - - Encrypts the input data and returns its ciphertext. - - Example:: - - $ciphertext = $this->encryption->encrypt('My secret message'); - - Please refer to the :ref:`custom-parameters` section for information - on the optional parameters. - - .. php:method:: decrypt($data[, $params = NULL]) - - :param string $data: Data to decrypt - :param array $params: Optional parameters - :returns: Decrypted data or FALSE on failure - :rtype: string - - Decrypts the input data and returns it in plain-text. - - Example:: - - echo $this->encryption->decrypt($ciphertext); - - Please refer to the :ref:`custom-parameters` secrion for information - on the optional parameters. - - .. php:method:: create_key($length) - - :param int $length: Output length - :returns: A pseudo-random cryptographic key with the specified length, or FALSE on failure - :rtype: string - - Creates a cryptographic key by fetching random data from - the operating system's sources (i.e. /dev/urandom). - - .. php:method:: hkdf($key[, $digest = 'sha512'[, $salt = NULL[, $length = NULL[, $info = '']]]]) - - :param string $key: Input key material - :param string $digest: A SHA-2 family digest algorithm - :param string $salt: Optional salt - :param int $length: Optional output length - :param string $info: Optional context/application-specific info - :returns: A pseudo-random key or FALSE on failure - :rtype: string - - Derives a key from another, presumably weaker key. - - This method is used internally to derive an encryption and HMAC key - from your configured *encryption_key*. - - It is publicly available due to its otherwise general purpose. It is - described in `RFC 5869 <https://tools.ietf.org/rfc/rfc5869.txt>`_. - - However, as opposed to the description in RFC 5869, this implementation - doesn't support SHA1. - - Example:: - - $hmac_key = $this->encryption->hkdf( - $key, - 'sha512', - NULL, - NULL, - 'authentication' - ); - - // $hmac_key is a pseudo-random key with a length of 64 bytes
\ No newline at end of file diff --git a/user_guide_src/source/libraries/file_uploading.rst b/user_guide_src/source/libraries/file_uploading.rst deleted file mode 100644 index 6d2106be8..000000000 --- a/user_guide_src/source/libraries/file_uploading.rst +++ /dev/null @@ -1,355 +0,0 @@ -#################### -File Uploading Class -#################### - -CodeIgniter's File Uploading Class permits files to be uploaded. You can -set various preferences, restricting the type and size of the files. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -*********** -The Process -*********** - -Uploading a file involves the following general process: - -- An upload form is displayed, allowing a user to select a file and - upload it. -- When the form is submitted, the file is uploaded to the destination - you specify. -- Along the way, the file is validated to make sure it is allowed to be - uploaded based on the preferences you set. -- Once uploaded, the user will be shown a success message. - -To demonstrate this process here is brief tutorial. Afterward you'll -find reference information. - -Creating the Upload Form -======================== - -Using a text editor, create a form called upload_form.php. In it, place -this code and save it to your **application/views/** directory:: - - <html> - <head> - <title>Upload Form</title> - </head> - <body> - - <?php echo $error;?> - - <?php echo form_open_multipart('upload/do_upload');?> - - <input type="file" name="userfile" size="20" /> - - <br /><br /> - - <input type="submit" value="upload" /> - - </form> - - </body> - </html> - -You'll notice we are using a form helper to create the opening form tag. -File uploads require a multipart form, so the helper creates the proper -syntax for you. You'll also notice we have an $error variable. This is -so we can show error messages in the event the user does something -wrong. - -The Success Page -================ - -Using a text editor, create a form called upload_success.php. In it, -place this code and save it to your **application/views/** directory:: - - <html> - <head> - <title>Upload Form</title> - </head> - <body> - - <h3>Your file was successfully uploaded!</h3> - - <ul> - <?php foreach ($upload_data as $item => $value):?> - <li><?php echo $item;?>: <?php echo $value;?></li> - <?php endforeach; ?> - </ul> - - <p><?php echo anchor('upload', 'Upload Another File!'); ?></p> - - </body> - </html> - -The Controller -============== - -Using a text editor, create a controller called Upload.php. In it, place -this code and save it to your **application/controllers/** directory:: - - <?php - - class Upload extends CI_Controller { - - public function __construct() - { - parent::__construct(); - $this->load->helper(array('form', 'url')); - } - - public function index() - { - $this->load->view('upload_form', array('error' => ' ' )); - } - - public function do_upload() - { - $config['upload_path'] = './uploads/'; - $config['allowed_types'] = 'gif|jpg|png'; - $config['max_size'] = 100; - $config['max_width'] = 1024; - $config['max_height'] = 768; - - $this->load->library('upload', $config); - - if ( ! $this->upload->do_upload('userfile')) - { - $error = array('error' => $this->upload->display_errors()); - - $this->load->view('upload_form', $error); - } - else - { - $data = array('upload_data' => $this->upload->data()); - - $this->load->view('upload_success', $data); - } - } - } - ?> - -The Upload Directory -==================== - -You'll need a destination directory for your uploaded images. Create a -directory at the root of your CodeIgniter installation called uploads -and set its file permissions to 777. - -Try it! -======= - -To try your form, visit your site using a URL similar to this one:: - - example.com/index.php/upload/ - -You should see an upload form. Try uploading an image file (either a -jpg, gif, or png). If the path in your controller is correct it should -work. - -*************** -Reference Guide -*************** - -Initializing the Upload Class -============================= - -Like most other classes in CodeIgniter, the Upload class is initialized -in your controller using the ``$this->load->library()`` method:: - - $this->load->library('upload'); - -Once the Upload class is loaded, the object will be available using: -$this->upload - -Setting Preferences -=================== - -Similar to other libraries, you'll control what is allowed to be upload -based on your preferences. In the controller you built above you set the -following preferences:: - - $config['upload_path'] = './uploads/'; - $config['allowed_types'] = 'gif|jpg|png'; - $config['max_size'] = '100'; - $config['max_width'] = '1024'; - $config['max_height'] = '768'; - - $this->load->library('upload', $config); - - // Alternately you can set preferences by calling the ``initialize()`` method. Useful if you auto-load the class: - $this->upload->initialize($config); - -The above preferences should be fairly self-explanatory. Below is a -table describing all available preferences. - -Preferences -=========== - -The following preferences are available. The default value indicates -what will be used if you do not specify that preference. - -============================ ================= ======================= ====================================================================== -Preference Default Value Options Description -============================ ================= ======================= ====================================================================== -**upload_path** None None The path to the directory where the upload should be placed. The - directory must be writable and the path can be absolute or relative. -**allowed_types** None None The mime types corresponding to the types of files you allow to be - uploaded. Usually the file extension can be used as the mime type. - Can be either an array or a pipe-separated string. -**file_name** None Desired file name If set CodeIgniter will rename the uploaded file to this name. The - extension provided in the file name must also be an allowed file type. - If no extension is provided in the original file_name will be used. -**file_ext_tolower** FALSE TRUE/FALSE (boolean) If set to TRUE, the file extension will be forced to lower case -**overwrite** FALSE TRUE/FALSE (boolean) If set to true, if a file with the same name as the one you are - uploading exists, it will be overwritten. If set to false, a number will - be appended to the filename if another with the same name exists. -**max_size** 0 None The maximum size (in kilobytes) that the file can be. Set to zero for no - limit. Note: Most PHP installations have their own limit, as specified - in the php.ini file. Usually 2 MB (or 2048 KB) by default. -**max_width** 0 None The maximum width (in pixels) that the image can be. Set to zero for no - limit. -**max_height** 0 None The maximum height (in pixels) that the image can be. Set to zero for no - limit. -**min_width** 0 None The minimum width (in pixels) that the image can be. Set to zero for no - limit. -**min_height** 0 None The minimum height (in pixels) that the image can be. Set to zero for no - limit. -**max_filename** 0 None The maximum length that a file name can be. Set to zero for no limit. -**max_filename_increment** 100 None When overwrite is set to FALSE, use this to set the maximum filename - increment for CodeIgniter to append to the filename. -**encrypt_name** FALSE TRUE/FALSE (boolean) If set to TRUE the file name will be converted to a random encrypted - string. This can be useful if you would like the file saved with a name - that can not be discerned by the person uploading it. -**remove_spaces** TRUE TRUE/FALSE (boolean) If set to TRUE, any spaces in the file name will be converted to - underscores. This is recommended. -**detect_mime** TRUE TRUE/FALSE (boolean) If set to TRUE, a server side detection of the file type will be - performed to avoid code injection attacks. DO NOT disable this option - unless you have no other option as that would cause a security risk. -**mod_mime_fix** TRUE TRUE/FALSE (boolean) If set to TRUE, multiple filename extensions will be suffixed with an - underscore in order to avoid triggering `Apache mod_mime - <http://httpd.apache.org/docs/2.0/mod/mod_mime.html#multipleext>`_. - DO NOT turn off this option if your upload directory is public, as this - is a security risk. -============================ ================= ======================= ====================================================================== - -Setting preferences in a config file -==================================== - -If you prefer not to set preferences using the above method, you can -instead put them into a config file. Simply create a new file called the -upload.php, add the $config array in that file. Then save the file in: -**config/upload.php** and it will be used automatically. You will NOT -need to use the ``$this->upload->initialize()`` method if you save your -preferences in a config file. - -*************** -Class Reference -*************** - -.. php:class:: CI_Upload - - .. php:method:: initialize([array $config = array()[, $reset = TRUE]]) - - :param array $config: Preferences - :param bool $reset: Whether to reset preferences (that are not provided in $config) to their defaults - :returns: CI_Upload instance (method chaining) - :rtype: CI_Upload - - .. php:method:: do_upload([$field = 'userfile']) - - :param string $field: Name of the form field - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Performs the upload based on the preferences you've set. - - .. note:: By default the upload routine expects the file to come from - a form field called userfile, and the form must be of type - "multipart". - - :: - - <form method="post" action="some_action" enctype="multipart/form-data" /> - - If you would like to set your own field name simply pass its value to - the ``do_upload()`` method:: - - $field_name = "some_field_name"; - $this->upload->do_upload($field_name); - - .. php:method:: display_errors([$open = '<p>'[, $close = '</p>']]) - - :param string $open: Opening markup - :param string $close: Closing markup - :returns: Formatted error message(s) - :rtype: string - - Retrieves any error messages if the ``do_upload()`` method returned - false. The method does not echo automatically, it returns the data so - you can assign it however you need. - - **Formatting Errors** - - By default the above method wraps any errors within <p> tags. You can - set your own delimiters like this:: - - $this->upload->display_errors('<p>', '</p>'); - - - .. php:method:: data([$index = NULL]) - - :param string $data: Element to return instead of the full array - :returns: Information about the uploaded file - :rtype: mixed - - This is a helper method that returns an array containing all of the - data related to the file you uploaded. Here is the array prototype:: - - Array - ( - [file_name] => mypic.jpg - [file_type] => image/jpeg - [file_path] => /path/to/your/upload/ - [full_path] => /path/to/your/upload/jpg.jpg - [raw_name] => mypic - [orig_name] => mypic.jpg - [client_name] => mypic.jpg - [file_ext] => .jpg - [file_size] => 22.2 - [is_image] => 1 - [image_width] => 800 - [image_height] => 600 - [image_type] => jpeg - [image_size_str] => width="800" height="200" - ) - - To return one element from the array:: - - $this->upload->data('file_name'); // Returns: mypic.jpg - - Here's a table explaining the above-displayed array items: - - ================ ==================================================================================================== - Item Description - ================ ==================================================================================================== - file_name Name of the file that was uploaded, including the filename extension - file_type File MIME type identifier - file_path Absolute server path to the file - full_path Absolute server path, including the file name - raw_name File name, without the extension - orig_name Original file name. This is only useful if you use the encrypted name option. - client_name File name as supplied by the client user agent, prior to any file name preparation or incrementing - file_ext Filename extension, period included - file_size File size in kilobytes - is_image Whether the file is an image or not. 1 = image. 0 = not. - image_width Image width - image_height Image height - image_type Image type (usually the file name extension without the period) - image_size_str A string containing the width and height (useful to put into an image tag) - ================ ==================================================================================================== diff --git a/user_guide_src/source/libraries/form_validation.rst b/user_guide_src/source/libraries/form_validation.rst deleted file mode 100644 index 88cda1686..000000000 --- a/user_guide_src/source/libraries/form_validation.rst +++ /dev/null @@ -1,1143 +0,0 @@ -############### -Form Validation -############### - -CodeIgniter provides a comprehensive form validation and data prepping -class that helps minimize the amount of code you'll write. - -.. contents:: Page Contents - -******** -Overview -******** - -Before explaining CodeIgniter's approach to data validation, let's -describe the ideal scenario: - -#. A form is displayed. -#. You fill it in and submit it. -#. If you submitted something invalid, or perhaps missed a required - item, the form is redisplayed containing your data along with an - error message describing the problem. -#. This process continues until you have submitted a valid form. - -On the receiving end, the script must: - -#. Check for required data. -#. Verify that the data is of the correct type, and meets the correct - criteria. For example, if a username is submitted it must be - validated to contain only permitted characters. It must be of a - minimum length, and not exceed a maximum length. The username can't - be someone else's existing username, or perhaps even a reserved word. - Etc. -#. Sanitize the data for security. -#. Pre-format the data if needed (Does the data need to be trimmed? HTML - encoded? Etc.) -#. Prep the data for insertion in the database. - -Although there is nothing terribly complex about the above process, it -usually requires a significant amount of code, and to display error -messages, various control structures are usually placed within the form -HTML. Form validation, while simple to create, is generally very messy -and tedious to implement. - -************************ -Form Validation Tutorial -************************ - -What follows is a "hands on" tutorial for implementing CodeIgniters Form -Validation. - -In order to implement form validation you'll need three things: - -#. A :doc:`View <../general/views>` file containing a form. -#. A View file containing a "success" message to be displayed upon - successful submission. -#. A :doc:`controller <../general/controllers>` method to receive and - process the submitted data. - -Let's create those three things, using a member sign-up form as the -example. - -The Form -======== - -Using a text editor, create a form called myform.php. In it, place this -code and save it to your application/views/ folder:: - - <html> - <head> - <title>My Form</title> - </head> - <body> - - <?php echo validation_errors(); ?> - - <?php echo form_open('form'); ?> - - <h5>Username</h5> - <input type="text" name="username" value="" size="50" /> - - <h5>Password</h5> - <input type="text" name="password" value="" size="50" /> - - <h5>Password Confirm</h5> - <input type="text" name="passconf" value="" size="50" /> - - <h5>Email Address</h5> - <input type="text" name="email" value="" size="50" /> - - <div><input type="submit" value="Submit" /></div> - - </form> - - </body> - </html> - -The Success Page -================ - -Using a text editor, create a form called formsuccess.php. In it, place -this code and save it to your application/views/ folder:: - - <html> - <head> - <title>My Form</title> - </head> - <body> - - <h3>Your form was successfully submitted!</h3> - - <p><?php echo anchor('form', 'Try it again!'); ?></p> - - </body> - </html> - -The Controller -============== - -Using a text editor, create a controller called Form.php. In it, place -this code and save it to your application/controllers/ folder:: - - <?php - - class Form extends CI_Controller { - - public function index() - { - $this->load->helper(array('form', 'url')); - - $this->load->library('form_validation'); - - if ($this->form_validation->run() == FALSE) - { - $this->load->view('myform'); - } - else - { - $this->load->view('formsuccess'); - } - } - } - -Try it! -======= - -To try your form, visit your site using a URL similar to this one:: - - example.com/index.php/form/ - -If you submit the form you should simply see the form reload. That's -because you haven't set up any validation rules yet. - -**Since you haven't told the Form Validation class to validate anything -yet, it returns FALSE (boolean false) by default. ``The run()`` method -only returns TRUE if it has successfully applied your rules without any -of them failing.** - -Explanation -=========== - -You'll notice several things about the above pages: - -The form (myform.php) is a standard web form with a couple exceptions: - -#. It uses a form helper to create the form opening. Technically, this - isn't necessary. You could create the form using standard HTML. - However, the benefit of using the helper is that it generates the - action URL for you, based on the URL in your config file. This makes - your application more portable in the event your URLs change. -#. At the top of the form you'll notice the following function call: - :: - - <?php echo validation_errors(); ?> - - This function will return any error messages sent back by the - validator. If there are no messages it returns an empty string. - -The controller (Form.php) has one method: ``index()``. This method -initializes the validation class and loads the form helper and URL -helper used by your view files. It also runs the validation routine. -Based on whether the validation was successful it either presents the -form or the success page. - -.. _setting-validation-rules: - -Setting Validation Rules -======================== - -CodeIgniter lets you set as many validation rules as you need for a -given field, cascading them in order, and it even lets you prep and -pre-process the field data at the same time. To set validation rules you -will use the ``set_rules()`` method:: - - $this->form_validation->set_rules(); - -The above method takes **three** parameters as input: - -#. The field name - the exact name you've given the form field. -#. A "human" name for this field, which will be inserted into the error - message. For example, if your field is named "user" you might give it - a human name of "Username". -#. The validation rules for this form field. -#. (optional) Set custom error messages on any rules given for current field. If not provided will use the default one. - -.. note:: If you would like the field name to be stored in a language - file, please see :ref:`translating-field-names`. - -Here is an example. In your controller (Form.php), add this code just -below the validation initialization method:: - - $this->form_validation->set_rules('username', 'Username', 'required'); - $this->form_validation->set_rules('password', 'Password', 'required'); - $this->form_validation->set_rules('passconf', 'Password Confirmation', 'required'); - $this->form_validation->set_rules('email', 'Email', 'required'); - -Your controller should now look like this:: - - <?php - - class Form extends CI_Controller { - - public function index() - { - $this->load->helper(array('form', 'url')); - - $this->load->library('form_validation'); - - $this->form_validation->set_rules('username', 'Username', 'required'); - $this->form_validation->set_rules('password', 'Password', 'required', - array('required' => 'You must provide a %s.') - ); - $this->form_validation->set_rules('passconf', 'Password Confirmation', 'required'); - $this->form_validation->set_rules('email', 'Email', 'required'); - - if ($this->form_validation->run() == FALSE) - { - $this->load->view('myform'); - } - else - { - $this->load->view('formsuccess'); - } - } - } - -Now submit the form with the fields blank and you should see the error -messages. If you submit the form with all the fields populated you'll -see your success page. - -.. note:: The form fields are not yet being re-populated with the data - when there is an error. We'll get to that shortly. - -Setting Rules Using an Array -============================ - -Before moving on it should be noted that the rule setting method can -be passed an array if you prefer to set all your rules in one action. If -you use this approach, you must name your array keys as indicated:: - - $config = array( - array( - 'field' => 'username', - 'label' => 'Username', - 'rules' => 'required' - ), - array( - 'field' => 'password', - 'label' => 'Password', - 'rules' => 'required', - 'errors' => array( - 'required' => 'You must provide a %s.', - ), - ), - array( - 'field' => 'passconf', - 'label' => 'Password Confirmation', - 'rules' => 'required' - ), - array( - 'field' => 'email', - 'label' => 'Email', - 'rules' => 'required' - ) - ); - - $this->form_validation->set_rules($config); - -Cascading Rules -=============== - -CodeIgniter lets you pipe multiple rules together. Let's try it. Change -your rules in the third parameter of rule setting method, like this:: - - $this->form_validation->set_rules( - 'username', 'Username', - 'required|min_length[5]|max_length[12]|is_unique[users.username]', - array( - 'required' => 'You have not provided %s.', - 'is_unique' => 'This %s already exists.' - ) - ); - $this->form_validation->set_rules('password', 'Password', 'required'); - $this->form_validation->set_rules('passconf', 'Password Confirmation', 'required|matches[password]'); - $this->form_validation->set_rules('email', 'Email', 'required|valid_email|is_unique[users.email]'); - -The above code sets the following rules: - -#. The username field be no shorter than 5 characters and no longer than - 12. -#. The password field must match the password confirmation field. -#. The email field must contain a valid email address. - -Give it a try! Submit your form without the proper data and you'll see -new error messages that correspond to your new rules. There are numerous -rules available which you can read about in the validation reference. - -.. note:: You can also pass an array of rules to ``set_rules()``, - instead of a string. Example:: - - $this->form_validation->set_rules('username', 'Username', array('required', 'min_length[5]')); - -Prepping Data -============= - -In addition to the validation method like the ones we used above, you -can also prep your data in various ways. For example, you can set up -rules like this:: - - $this->form_validation->set_rules('username', 'Username', 'trim|required|min_length[5]|max_length[12]'); - $this->form_validation->set_rules('password', 'Password', 'trim|required|min_length[8]'); - $this->form_validation->set_rules('passconf', 'Password Confirmation', 'trim|required|matches[password]'); - $this->form_validation->set_rules('email', 'Email', 'trim|required|valid_email'); - -In the above example, we are "trimming" the fields, checking for length -where necessary and making sure that both password fields match. - -**Any native PHP function that accepts one parameter can be used as a -rule, like ``htmlspecialchars()``, ``trim()``, etc.** - -.. note:: You will generally want to use the prepping functions - **after** the validation rules so if there is an error, the - original data will be shown in the form. - -Re-populating the form -====================== - -Thus far we have only been dealing with errors. It's time to repopulate -the form field with the submitted data. CodeIgniter offers several -helper functions that permit you to do this. The one you will use most -commonly is:: - - set_value('field name') - -Open your myform.php view file and update the **value** in each field -using the :php:func:`set_value()` function: - -**Don't forget to include each field name in the :php:func:`set_value()` -function calls!** - -:: - - <html> - <head> - <title>My Form</title> - </head> - <body> - - <?php echo validation_errors(); ?> - - <?php echo form_open('form'); ?> - - <h5>Username</h5> - <input type="text" name="username" value="<?php echo set_value('username'); ?>" size="50" /> - - <h5>Password</h5> - <input type="text" name="password" value="<?php echo set_value('password'); ?>" size="50" /> - - <h5>Password Confirm</h5> - <input type="text" name="passconf" value="<?php echo set_value('passconf'); ?>" size="50" /> - - <h5>Email Address</h5> - <input type="text" name="email" value="<?php echo set_value('email'); ?>" size="50" /> - - <div><input type="submit" value="Submit" /></div> - - </form> - - </body> - </html> - -Now reload your page and submit the form so that it triggers an error. -Your form fields should now be re-populated - -.. note:: The :ref:`class-reference` section below - contains methods that permit you to re-populate <select> menus, - radio buttons, and checkboxes. - -.. important:: If you use an array as the name of a form field, you - must supply it as an array to the function. Example:: - - <input type="text" name="colors[]" value="<?php echo set_value('colors[]'); ?>" size="50" /> - -For more info please see the :ref:`using-arrays-as-field-names` section below. - -Callbacks: Your own Validation Methods -====================================== - -The validation system supports callbacks to your own validation -methods. This permits you to extend the validation class to meet your -needs. For example, if you need to run a database query to see if the -user is choosing a unique username, you can create a callback method -that does that. Let's create an example of this. - -In your controller, change the "username" rule to this:: - - $this->form_validation->set_rules('username', 'Username', 'callback_username_check'); - -Then add a new method called ``username_check()`` to your controller. -Here's how your controller should now look:: - - <?php - - class Form extends CI_Controller { - - public function index() - { - $this->load->helper(array('form', 'url')); - - $this->load->library('form_validation'); - - $this->form_validation->set_rules('username', 'Username', 'callback_username_check'); - $this->form_validation->set_rules('password', 'Password', 'required'); - $this->form_validation->set_rules('passconf', 'Password Confirmation', 'required'); - $this->form_validation->set_rules('email', 'Email', 'required|is_unique[users.email]'); - - if ($this->form_validation->run() == FALSE) - { - $this->load->view('myform'); - } - else - { - $this->load->view('formsuccess'); - } - } - - public function username_check($str) - { - if ($str == 'test') - { - $this->form_validation->set_message('username_check', 'The {field} field can not be the word "test"'); - return FALSE; - } - else - { - return TRUE; - } - } - - } - -Reload your form and submit it with the word "test" as the username. You -can see that the form field data was passed to your callback method -for you to process. - -To invoke a callback just put the method name in a rule, with -"callback\_" as the rule **prefix**. If you need to receive an extra -parameter in your callback method, just add it normally after the -method name between square brackets, as in: ``callback_foo[bar]``, -then it will be passed as the second argument of your callback method. - -.. note:: You can also process the form data that is passed to your - callback and return it. If your callback returns anything other than a - boolean TRUE/FALSE it is assumed that the data is your newly processed - form data. - -Callable: Use anything as a rule -================================ - -If callback rules aren't good enough for you (for example, because they are -limited to your controller), don't get disappointed, there's one more way -to create custom rules: anything that ``is_callable()`` would return TRUE for. - -Consider the following example:: - - $this->form_validation->set_rules( - 'username', 'Username', - array( - 'required', - array($this->users_model, 'valid_username') - ) - ); - -The above code would use the ``valid_username()`` method from your -``Users_model`` object. - -This is just an example of course, and callbacks aren't limited to models. -You can use any object/method that accepts the field value as its' first -parameter. You can also use an anonymous function:: - - $this->form_validation->set_rules( - 'username', 'Username', - array( - 'required', - function($value) - { - // Check $value - } - ) - ); - -Of course, since a Callable rule by itself is not a string, it isn't -a rule name either. That is a problem when you want to set error messages -for them. In order to get around that problem, you can put such rules as -the second element of an array, with the first one being the rule name:: - - $this->form_validation->set_rules( - 'username', 'Username', - array( - 'required', - array('username_callable', array($this->users_model, 'valid_username')) - ) - ); - -Anonymous function version:: - - $this->form_validation->set_rules( - 'username', 'Username', - array( - 'required', - array( - 'username_callable', - function($str) - { - // Check validity of $str and return TRUE or FALSE - } - ) - ) - ); - -.. _setting-error-messages: - -Setting Error Messages -====================== - -All of the native error messages are located in the following language -file: **system/language/english/form_validation_lang.php** - -To set your own global custom message for a rule, you can either -extend/override the language file by creating your own in -**application/language/english/form_validation_lang.php** (read more -about this in the :doc:`Language Class <language>` documentation), -or use the following method:: - - $this->form_validation->set_message('rule', 'Error Message'); - -If you need to set a custom error message for a particular field on -some particular rule, use the set_rules() method:: - - $this->form_validation->set_rules('field_name', 'Field Label', 'rule1|rule2|rule3', - array('rule2' => 'Error Message on rule2 for this field_name') - ); - -Where rule corresponds to the name of a particular rule, and Error -Message is the text you would like displayed. - -If you'd like to include a field's "human" name, or the optional -parameter some rules allow for (such as max_length), you can add the -**{field}** and **{param}** tags to your message, respectively:: - - $this->form_validation->set_message('min_length', '{field} must have at least {param} characters.'); - -On a field with the human name Username and a rule of min_length[5], an -error would display: "Username must have at least 5 characters." - -.. note:: The old `sprintf()` method of using **%s** in your error messages - will still work, however it will override the tags above. You should - use one or the other. - -In the callback rule example above, the error message was set by passing -the name of the method (without the "callback\_" prefix):: - - $this->form_validation->set_message('username_check') - -.. _translating-field-names: - -Translating Field Names -======================= - -If you would like to store the "human" name you passed to the -``set_rules()`` method in a language file, and therefore make the name -able to be translated, here's how: - -First, prefix your "human" name with **lang:**, as in this example:: - - $this->form_validation->set_rules('first_name', 'lang:first_name', 'required'); - -Then, store the name in one of your language file arrays (without the -prefix):: - - $lang['first_name'] = 'First Name'; - -.. note:: If you store your array item in a language file that is not - loaded automatically by CI, you'll need to remember to load it in your - controller using:: - - $this->lang->load('file_name'); - -See the :doc:`Language Class <language>` page for more info regarding -language files. - -.. _changing-delimiters: - -Changing the Error Delimiters -============================= - -By default, the Form Validation class adds a paragraph tag (<p>) around -each error message shown. You can either change these delimiters -globally, individually, or change the defaults in a config file. - -#. **Changing delimiters Globally** - To globally change the error delimiters, in your controller method, - just after loading the Form Validation class, add this:: - - $this->form_validation->set_error_delimiters('<div class="error">', '</div>'); - - In this example, we've switched to using div tags. - -#. **Changing delimiters Individually** - Each of the two error generating functions shown in this tutorial can - be supplied their own delimiters as follows:: - - <?php echo form_error('field name', '<div class="error">', '</div>'); ?> - - Or:: - - <?php echo validation_errors('<div class="error">', '</div>'); ?> - -#. **Set delimiters in a config file** - You can add your error delimiters in application/config/form_validation.php as follows:: - - $config['error_prefix'] = '<div class="error_prefix">'; - $config['error_suffix'] = '</div>'; - -Showing Errors Individually -=========================== - -If you prefer to show an error message next to each form field, rather -than as a list, you can use the :php:func:`form_error()` function. - -Try it! Change your form so that it looks like this:: - - <h5>Username</h5> - <?php echo form_error('username'); ?> - <input type="text" name="username" value="<?php echo set_value('username'); ?>" size="50" /> - - <h5>Password</h5> - <?php echo form_error('password'); ?> - <input type="text" name="password" value="<?php echo set_value('password'); ?>" size="50" /> - - <h5>Password Confirm</h5> - <?php echo form_error('passconf'); ?> - <input type="text" name="passconf" value="<?php echo set_value('passconf'); ?>" size="50" /> - - <h5>Email Address</h5> - <?php echo form_error('email'); ?> - <input type="text" name="email" value="<?php echo set_value('email'); ?>" size="50" /> - -If there are no errors, nothing will be shown. If there is an error, the -message will appear. - -.. important:: If you use an array as the name of a form field, you - must supply it as an array to the function. Example:: - - <?php echo form_error('options[size]'); ?> - <input type="text" name="options[size]" value="<?php echo set_value("options[size]"); ?>" size="50" /> - -For more info please see the :ref:`using-arrays-as-field-names` section below. - -Validating an Array (other than $_POST) -======================================= - -Sometimes you may want to validate an array that does not originate from ``$_POST`` data. - -In this case, you can specify the array to be validated:: - - $data = array( - 'username' => 'johndoe', - 'password' => 'mypassword', - 'passconf' => 'mypassword' - ); - - $this->form_validation->set_data($data); - -Creating validation rules, running the validation, and retrieving error -messages works the same whether you are validating ``$_POST`` data or -another array of your choice. - -.. important:: You have to call the ``set_data()`` method *before* defining - any validation rules. - -.. important:: If you want to validate more than one array during a single - execution, then you should call the ``reset_validation()`` method - before setting up rules and validating the new array. - -For more info please see the :ref:`class-reference` section below. - -.. _saving-groups: - -************************************************ -Saving Sets of Validation Rules to a Config File -************************************************ - -A nice feature of the Form Validation class is that it permits you to -store all your validation rules for your entire application in a config -file. You can organize these rules into "groups". These groups can -either be loaded automatically when a matching controller/method is -called, or you can manually call each set as needed. - -How to save your rules -====================== - -To store your validation rules, simply create a file named -form_validation.php in your application/config/ folder. In that file -you will place an array named $config with your rules. As shown earlier, -the validation array will have this prototype:: - - $config = array( - array( - 'field' => 'username', - 'label' => 'Username', - 'rules' => 'required' - ), - array( - 'field' => 'password', - 'label' => 'Password', - 'rules' => 'required' - ), - array( - 'field' => 'passconf', - 'label' => 'Password Confirmation', - 'rules' => 'required' - ), - array( - 'field' => 'email', - 'label' => 'Email', - 'rules' => 'required' - ) - ); - -Your validation rule file will be loaded automatically and used when you -call the ``run()`` method. - -Please note that you MUST name your ``$config`` array. - -Creating Sets of Rules -====================== - -In order to organize your rules into "sets" requires that you place them -into "sub arrays". Consider the following example, showing two sets of -rules. We've arbitrarily called these two rules "signup" and "email". -You can name your rules anything you want:: - - $config = array( - 'signup' => array( - array( - 'field' => 'username', - 'label' => 'Username', - 'rules' => 'required' - ), - array( - 'field' => 'password', - 'label' => 'Password', - 'rules' => 'required' - ), - array( - 'field' => 'passconf', - 'label' => 'Password Confirmation', - 'rules' => 'required' - ), - array( - 'field' => 'email', - 'label' => 'Email', - 'rules' => 'required' - ) - ), - 'email' => array( - array( - 'field' => 'emailaddress', - 'label' => 'EmailAddress', - 'rules' => 'required|valid_email' - ), - array( - 'field' => 'name', - 'label' => 'Name', - 'rules' => 'required|alpha' - ), - array( - 'field' => 'title', - 'label' => 'Title', - 'rules' => 'required' - ), - array( - 'field' => 'message', - 'label' => 'MessageBody', - 'rules' => 'required' - ) - ) - ); - -Calling a Specific Rule Group -============================= - -In order to call a specific group, you will pass its name to the ``run()`` -method. For example, to call the signup rule you will do this:: - - if ($this->form_validation->run('signup') == FALSE) - { - $this->load->view('myform'); - } - else - { - $this->load->view('formsuccess'); - } - -Associating a Controller Method with a Rule Group -================================================= - -An alternate (and more automatic) method of calling a rule group is to -name it according to the controller class/method you intend to use it -with. For example, let's say you have a controller named Member and a -method named signup. Here's what your class might look like:: - - <?php - - class Member extends CI_Controller { - - public function signup() - { - $this->load->library('form_validation'); - - if ($this->form_validation->run() == FALSE) - { - $this->load->view('myform'); - } - else - { - $this->load->view('formsuccess'); - } - } - } - -In your validation config file, you will name your rule group -member/signup:: - - $config = array( - 'member/signup' => array( - array( - 'field' => 'username', - 'label' => 'Username', - 'rules' => 'required' - ), - array( - 'field' => 'password', - 'label' => 'Password', - 'rules' => 'required' - ), - array( - 'field' => 'passconf', - 'label' => 'PasswordConfirmation', - 'rules' => 'required' - ), - array( - 'field' => 'email', - 'label' => 'Email', - 'rules' => 'required' - ) - ) - ); - -When a rule group is named identically to a controller class/method it -will be used automatically when the ``run()`` method is invoked from that -class/method. - -.. _using-arrays-as-field-names: - -*************************** -Using Arrays as Field Names -*************************** - -The Form Validation class supports the use of arrays as field names. -Consider this example:: - - <input type="text" name="options[]" value="" size="50" /> - -If you do use an array as a field name, you must use the EXACT array -name in the :ref:`Helper Functions <helper-functions>` that require the -field name, and as your Validation Rule field name. - -For example, to set a rule for the above field you would use:: - - $this->form_validation->set_rules('options[]', 'Options', 'required'); - -Or, to show an error for the above field you would use:: - - <?php echo form_error('options[]'); ?> - -Or to re-populate the field you would use:: - - <input type="text" name="options[]" value="<?php echo set_value('options[]'); ?>" size="50" /> - -You can use multidimensional arrays as field names as well. For example:: - - <input type="text" name="options[size]" value="" size="50" /> - -Or even:: - - <input type="text" name="sports[nba][basketball]" value="" size="50" /> - -As with our first example, you must use the exact array name in the -helper functions:: - - <?php echo form_error('sports[nba][basketball]'); ?> - -If you are using checkboxes (or other fields) that have multiple -options, don't forget to leave an empty bracket after each option, so -that all selections will be added to the POST array:: - - <input type="checkbox" name="options[]" value="red" /> - <input type="checkbox" name="options[]" value="blue" /> - <input type="checkbox" name="options[]" value="green" /> - -Or if you use a multidimensional array:: - - <input type="checkbox" name="options[color][]" value="red" /> - <input type="checkbox" name="options[color][]" value="blue" /> - <input type="checkbox" name="options[color][]" value="green" /> - -When you use a helper function you'll include the bracket as well:: - - <?php echo form_error('options[color][]'); ?> - - -************** -Rule Reference -************** - -The following is a list of all the native rules that are available to -use: - -========================= ========== ============================================================================================= ======================= -Rule Parameter Description Example -========================= ========== ============================================================================================= ======================= -**required** No Returns FALSE if the form element is empty. -**matches** Yes Returns FALSE if the form element does not match the one in the parameter. matches[form_item] -**regex_match** Yes Returns FALSE if the form element does not match the regular expression. regex_match[/regex/] -**differs** Yes Returns FALSE if the form element does not differ from the one in the parameter. differs[form_item] -**is_unique** Yes Returns FALSE if the form element is not unique to the table and field name in the is_unique[table.field] - parameter. Note: This rule requires :doc:`Query Builder <../database/query_builder>` to be - enabled in order to work. -**min_length** Yes Returns FALSE if the form element is shorter than the parameter value. min_length[3] -**max_length** Yes Returns FALSE if the form element is longer than the parameter value. max_length[12] -**exact_length** Yes Returns FALSE if the form element is not exactly the parameter value. exact_length[8] -**greater_than** Yes Returns FALSE if the form element is less than or equal to the parameter value or not greater_than[8] - numeric. -**greater_than_equal_to** Yes Returns FALSE if the form element is less than the parameter value, greater_than_equal_to[8] - or not numeric. -**less_than** Yes Returns FALSE if the form element is greater than or equal to the parameter value or less_than[8] - not numeric. -**less_than_equal_to** Yes Returns FALSE if the form element is greater than the parameter value, less_than_equal_to[8] - or not numeric. -**in_list** Yes Returns FALSE if the form element is not within a predetermined list. in_list[red,blue,green] -**alpha** No Returns FALSE if the form element contains anything other than alphabetical characters. -**alpha_numeric** No Returns FALSE if the form element contains anything other than alpha-numeric characters. -**alpha_numeric_spaces** No Returns FALSE if the form element contains anything other than alpha-numeric characters - or spaces. Should be used after trim to avoid spaces at the beginning or end. -**alpha_dash** No Returns FALSE if the form element contains anything other than alpha-numeric characters, - underscores or dashes. -**numeric** No Returns FALSE if the form element contains anything other than numeric characters. -**integer** No Returns FALSE if the form element contains anything other than an integer. -**decimal** No Returns FALSE if the form element contains anything other than a decimal number. -**is_natural** No Returns FALSE if the form element contains anything other than a natural number: - 0, 1, 2, 3, etc. -**is_natural_no_zero** No Returns FALSE if the form element contains anything other than a natural - number, but not zero: 1, 2, 3, etc. -**valid_url** No Returns FALSE if the form element does not contain a valid URL. -**valid_email** No Returns FALSE if the form element does not contain a valid email address. -**valid_emails** No Returns FALSE if any value provided in a comma separated list is not a valid email. -**valid_ip** Yes Returns FALSE if the supplied IP address is not valid. - Accepts an optional parameter of 'ipv4' or 'ipv6' to specify an IP format. -**valid_base64** No Returns FALSE if the supplied string contains anything other than valid Base64 characters. -========================= ========== ============================================================================================= ======================= - -.. note:: These rules can also be called as discrete methods. For - example:: - - $this->form_validation->required($string); - -.. note:: You can also use any native PHP functions that permit up - to two parameters, where at least one is required (to pass - the field data). - -****************** -Prepping Reference -****************** - -The following is a list of all the prepping methods that are available -to use: - -==================== ========= ============================================================================================================== -Name Parameter Description -==================== ========= ============================================================================================================== -**prep_for_form** No DEPRECATED: Converts special characters so that HTML data can be shown in a form field without breaking it. -**prep_url** No Adds "\http://" to URLs if missing. -**strip_image_tags** No Strips the HTML from image tags leaving the raw URL. -**encode_php_tags** No Converts PHP tags to entities. -==================== ========= ============================================================================================================== - -.. note:: You can also use any native PHP functions that permits one - parameter, like ``trim()``, ``htmlspecialchars()``, ``urldecode()``, - etc. - -.. _class-reference: - -*************** -Class Reference -*************** - -.. php:class:: CI_Form_validation - - .. php:method:: set_rules($field[, $label = ''[, $rules = ''[, $errors = array()]]]) - - :param string $field: Field name - :param string $label: Field label - :param mixed $rules: Validation rules, as a string list separated by a pipe "|", or as an array or rules - :param array $errors: A list of custom error messages - :returns: CI_Form_validation instance (method chaining) - :rtype: CI_Form_validation - - Permits you to set validation rules, as described in the tutorial - sections above: - - - :ref:`setting-validation-rules` - - :ref:`saving-groups` - - .. php:method:: run([$group = '']) - - :param string $group: The name of the validation group to run - :returns: TRUE on success, FALSE if validation failed - :rtype: bool - - Runs the validation routines. Returns boolean TRUE on success and FALSE - on failure. You can optionally pass the name of the validation group via - the method, as described in: :ref:`saving-groups` - - .. php:method:: set_message($lang[, $val = '']) - - :param string $lang: The rule the message is for - :param string $val: The message - :returns: CI_Form_validation instance (method chaining) - :rtype: CI_Form_validation - - Permits you to set custom error messages. See :ref:`setting-error-messages` - - .. php:method:: set_error_delimiters([$prefix = '<p>'[, $suffix = '</p>']]) - - :param string $prefix: Error message prefix - :param string $suffix: Error message suffix - :returns: CI_Form_validation instance (method chaining) - :rtype: CI_Form_validation - - Sets the default prefix and suffix for error messages. - - .. php:method:: set_data($data) - - :param array $data: Array of data validate - :returns: CI_Form_validation instance (method chaining) - :rtype: CI_Form_validation - - Permits you to set an array for validation, instead of using the default - ``$_POST`` array. - - .. php:method:: reset_validation() - - :returns: CI_Form_validation instance (method chaining) - :rtype: CI_Form_validation - - Permits you to reset the validation when you validate more than one array. - This method should be called before validating each new array. - - .. php:method:: error_array() - - :returns: Array of error messages - :rtype: array - - Returns the error messages as an array. - - .. php:method:: error_string([$prefix = ''[, $suffix = '']]) - - :param string $prefix: Error message prefix - :param string $suffix: Error message suffix - :returns: Error messages as a string - :rtype: string - - Returns all error messages (as returned from error_array()) formatted as a - string and separated by a newline character. - - .. php:method:: error($field[, $prefix = ''[, $suffix = '']]) - - :param string $field: Field name - :param string $prefix: Optional prefix - :param string $suffix: Optional suffix - :returns: Error message string - :rtype: string - - Returns the error message for a specific field, optionally adding a - prefix and/or suffix to it (usually HTML tags). - - .. php:method:: has_rule($field) - - :param string $field: Field name - :returns: TRUE if the field has rules set, FALSE if not - :rtype: bool - - Checks to see if there is a rule set for the specified field. - -.. _helper-functions: - -**************** -Helper Reference -**************** - -Please refer to the :doc:`Form Helper <../helpers/form_helper>` manual for -the following functions: - -- :php:func:`form_error()` -- :php:func:`validation_errors()` -- :php:func:`set_value()` -- :php:func:`set_select()` -- :php:func:`set_checkbox()` -- :php:func:`set_radio()` - -Note that these are procedural functions, so they **do not** require you -to prepend them with ``$this->form_validation``. diff --git a/user_guide_src/source/libraries/ftp.rst b/user_guide_src/source/libraries/ftp.rst deleted file mode 100644 index 2a015256d..000000000 --- a/user_guide_src/source/libraries/ftp.rst +++ /dev/null @@ -1,306 +0,0 @@ -######### -FTP Class -######### - -CodeIgniter's FTP Class permits files to be transferred to a remote -server. Remote files can also be moved, renamed, and deleted. The FTP -class also includes a "mirroring" function that permits an entire local -directory to be recreated remotely via FTP. - -.. note:: SFTP and SSL FTP protocols are not supported, only standard - FTP. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -************************** -Working with the FTP Class -************************** - -Initializing the Class -====================== - -Like most other classes in CodeIgniter, the FTP class is initialized in -your controller using the $this->load->library function:: - - $this->load->library('ftp'); - -Once loaded, the FTP object will be available using: $this->ftp - -Usage Examples -============== - -In this example a connection is opened to the FTP server, and a local -file is read and uploaded in ASCII mode. The file permissions are set to -755. -:: - - $this->load->library('ftp'); - - $config['hostname'] = 'ftp.example.com'; - $config['username'] = 'your-username'; - $config['password'] = 'your-password'; - $config['debug'] = TRUE; - - $this->ftp->connect($config); - - $this->ftp->upload('/local/path/to/myfile.html', '/public_html/myfile.html', 'ascii', 0775); - - $this->ftp->close(); - -In this example a list of files is retrieved from the server. -:: - - $this->load->library('ftp'); - - $config['hostname'] = 'ftp.example.com'; - $config['username'] = 'your-username'; - $config['password'] = 'your-password'; - $config['debug'] = TRUE; - - $this->ftp->connect($config); - - $list = $this->ftp->list_files('/public_html/'); - - print_r($list); - - $this->ftp->close(); - -In this example a local directory is mirrored on the server. -:: - - $this->load->library('ftp'); - - $config['hostname'] = 'ftp.example.com'; - $config['username'] = 'your-username'; - $config['password'] = 'your-password'; - $config['debug'] = TRUE; - - $this->ftp->connect($config); - - $this->ftp->mirror('/path/to/myfolder/', '/public_html/myfolder/'); - - $this->ftp->close(); - -*************** -Class Reference -*************** - -.. php:class:: CI_FTP - - .. php:method:: connect([$config = array()]) - - :param array $config: Connection values - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Connects and logs into to the FTP server. Connection preferences are set - by passing an array to the function, or you can store them in a config - file. - - Here is an example showing how you set preferences manually:: - - $this->load->library('ftp'); - - $config['hostname'] = 'ftp.example.com'; - $config['username'] = 'your-username'; - $config['password'] = 'your-password'; - $config['port'] = 21; - $config['passive'] = FALSE; - $config['debug'] = TRUE; - - $this->ftp->connect($config); - - **Setting FTP Preferences in a Config File** - - If you prefer you can store your FTP preferences in a config file. - Simply create a new file called the ftp.php, add the $config array in - that file. Then save the file at *application/config/ftp.php* and it - will be used automatically. - - **Available connection options** - - ============== =============== ============================================================================= - Option name Default value Description - ============== =============== ============================================================================= - **hostname** n/a FTP hostname (usually something like: ftp.example.com) - **username** n/a FTP username - **password** n/a FTP password - **port** 21 FTP server port number - **debug** FALSE TRUE/FALSE (boolean): Whether to enable debugging to display error messages - **passive** TRUE TRUE/FALSE (boolean): Whether to use passive mode - ============== =============== ============================================================================= - - .. php:method:: upload($locpath, $rempath[, $mode = 'auto'[, $permissions = NULL]]) - - :param string $locpath: Local file path - :param string $rempath: Remote file path - :param string $mode: FTP mode, defaults to 'auto' (options are: 'auto', 'binary', 'ascii') - :param int $permissions: File permissions (octal) - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Uploads a file to your server. You must supply the local path and the - remote path, and you can optionally set the mode and permissions. - Example:: - - $this->ftp->upload('/local/path/to/myfile.html', '/public_html/myfile.html', 'ascii', 0775); - - If 'auto' mode is used it will base the mode on the file extension of the source file. - - If set, permissions have to be passed as an octal value. - - .. php:method:: download($rempath, $locpath[, $mode = 'auto']) - - :param string $rempath: Remote file path - :param string $locpath: Local file path - :param string $mode: FTP mode, defaults to 'auto' (options are: 'auto', 'binary', 'ascii') - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Downloads a file from your server. You must supply the remote path and - the local path, and you can optionally set the mode. Example:: - - $this->ftp->download('/public_html/myfile.html', '/local/path/to/myfile.html', 'ascii'); - - If 'auto' mode is used it will base the mode on the file extension of the source file. - - Returns FALSE if the download does not execute successfully - (including if PHP does not have permission to write the local file). - - .. php:method:: rename($old_file, $new_file[, $move = FALSE]) - - :param string $old_file: Old file name - :param string $new_file: New file name - :param bool $move: Whether a move is being performed - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Permits you to rename a file. Supply the source file name/path and the new file name/path. - :: - - // Renames green.html to blue.html - $this->ftp->rename('/public_html/foo/green.html', '/public_html/foo/blue.html'); - - .. php:method:: move($old_file, $new_file) - - :param string $old_file: Old file name - :param string $new_file: New file name - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Lets you move a file. Supply the source and destination paths:: - - // Moves blog.html from "joe" to "fred" - $this->ftp->move('/public_html/joe/blog.html', '/public_html/fred/blog.html'); - - .. note:: If the destination file name is different the file will be renamed. - - .. php:method:: delete_file($filepath) - - :param string $filepath: Path to file to delete - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Lets you delete a file. Supply the source path with the file name. - :: - - $this->ftp->delete_file('/public_html/joe/blog.html'); - - .. php:method:: delete_dir($filepath) - - :param string $filepath: Path to directory to delete - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Lets you delete a directory and everything it contains. Supply the - source path to the directory with a trailing slash. - - .. important:: Be VERY careful with this method! - It will recursively delete **everything** within the supplied path, - including sub-folders and all files. Make absolutely sure your path - is correct. Try using ``list_files()`` first to verify that your path is correct. - - :: - - $this->ftp->delete_dir('/public_html/path/to/folder/'); - - .. php:method:: list_files([$path = '.']) - - :param string $path: Directory path - :returns: An array list of files or FALSE on failure - :rtype: array - - Permits you to retrieve a list of files on your server returned as an - array. You must supply the path to the desired directory. - :: - - $list = $this->ftp->list_files('/public_html/'); - print_r($list); - - .. php:method:: mirror($locpath, $rempath) - - :param string $locpath: Local path - :param string $rempath: Remote path - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Recursively reads a local folder and everything it contains (including - sub-folders) and creates a mirror via FTP based on it. Whatever the - directory structure of the original file path will be recreated on the - server. You must supply a source path and a destination path:: - - $this->ftp->mirror('/path/to/myfolder/', '/public_html/myfolder/'); - - .. php:method:: mkdir($path[, $permissions = NULL]) - - :param string $path: Path to directory to create - :param int $permissions: Permissions (octal) - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Lets you create a directory on your server. Supply the path ending in - the folder name you wish to create, with a trailing slash. - - Permissions can be set by passing an octal value in the second parameter. - :: - - // Creates a folder named "bar" - $this->ftp->mkdir('/public_html/foo/bar/', 0755); - - .. php:method:: chmod($path, $perm) - - :param string $path: Path to alter permissions for - :param int $perm: Permissions (octal) - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Permits you to set file permissions. Supply the path to the file or - directory you wish to alter permissions on:: - - // Chmod "bar" to 755 - $this->ftp->chmod('/public_html/foo/bar/', 0755); - - .. php:method:: changedir($path[, $suppress_debug = FALSE]) - - :param string $path: Directory path - :param bool $suppress_debug: Whether to turn off debug messages for this command - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Changes the current working directory to the specified path. - - The ``$suppress_debug`` parameter is useful in case you want to use this method - as an ``is_dir()`` alternative for FTP. - - .. php:method:: close() - - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Closes the connection to your server. It's recommended that you use this - when you are finished uploading.
\ No newline at end of file diff --git a/user_guide_src/source/libraries/image_lib.rst b/user_guide_src/source/libraries/image_lib.rst deleted file mode 100644 index 22407962f..000000000 --- a/user_guide_src/source/libraries/image_lib.rst +++ /dev/null @@ -1,475 +0,0 @@ -######################## -Image Manipulation Class -######################## - -CodeIgniter's Image Manipulation class lets you perform the following -actions: - -- Image Resizing -- Thumbnail Creation -- Image Cropping -- Image Rotating -- Image Watermarking - -All three major image libraries are supported: GD/GD2, NetPBM, and -ImageMagick - -.. note:: Watermarking is only available using the GD/GD2 library. In - addition, even though other libraries are supported, GD is required in - order for the script to calculate the image properties. The image - processing, however, will be performed with the library you specify. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -********************** -Initializing the Class -********************** - -Like most other classes in CodeIgniter, the image class is initialized -in your controller using the $this->load->library function:: - - $this->load->library('image_lib'); - -Once the library is loaded it will be ready for use. The image library -object you will use to call all functions is: ``$this->image_lib`` - -Processing an Image -=================== - -Regardless of the type of processing you would like to perform -(resizing, cropping, rotation, or watermarking), the general process is -identical. You will set some preferences corresponding to the action you -intend to perform, then call one of four available processing functions. -For example, to create an image thumbnail you'll do this:: - - $config['image_library'] = 'gd2'; - $config['source_image'] = '/path/to/image/mypic.jpg'; - $config['create_thumb'] = TRUE; - $config['maintain_ratio'] = TRUE; - $config['width'] = 75; - $config['height'] = 50; - - $this->load->library('image_lib', $config); - - $this->image_lib->resize(); - -The above code tells the image_resize function to look for an image -called *mypic.jpg* located in the source_image folder, then create a -thumbnail that is 75 X 50 pixels using the GD2 image_library. Since the -maintain_ratio option is enabled, the thumb will be as close to the -target width and height as possible while preserving the original aspect -ratio. The thumbnail will be called *mypic_thumb.jpg* and located at -the same level as *source_image*. - -.. note:: In order for the image class to be allowed to do any - processing, the folder containing the image files must have write - permissions. - -.. note:: Image processing can require a considerable amount of server - memory for some operations. If you are experiencing out of memory errors - while processing images you may need to limit their maximum size, and/or - adjust PHP memory limits. - -Processing Methods -================== - -There are four available processing methods: - -- $this->image_lib->resize() -- $this->image_lib->crop() -- $this->image_lib->rotate() -- $this->image_lib->watermark() - -These methods return boolean TRUE upon success and FALSE for failure. -If they fail you can retrieve the error message using this function:: - - echo $this->image_lib->display_errors(); - -A good practice is to use the processing function conditionally, showing an -error upon failure, like this:: - - if ( ! $this->image_lib->resize()) - { - echo $this->image_lib->display_errors(); - } - -.. note:: You can optionally specify the HTML formatting to be applied to - the errors, by submitting the opening/closing tags in the function, - like this:: - - $this->image_lib->display_errors('<p>', '</p>'); - -.. _processing-preferences: - -Preferences -=========== - -The preferences described below allow you to tailor the image processing -to suit your needs. - -Note that not all preferences are available for every function. For -example, the x/y axis preferences are only available for image cropping. -Likewise, the width and height preferences have no effect on cropping. -The "availability" column indicates which functions support a given -preference. - -Availability Legend: - -- R - Image Resizing -- C - Image Cropping -- X - Image Rotation -- W - Image Watermarking - -======================= ======================= =============================== =========================================================================== ============= -Preference Default Value Options Description Availability -======================= ======================= =============================== =========================================================================== ============= -**image_library** GD2 GD, GD2, ImageMagick, NetPBM Sets the image library to be used. R, C, X, W -**library_path** None None Sets the server path to your ImageMagick or NetPBM library. If you use R, C, X - either of those libraries you must supply the path. R, C, S, W -**source_image** None None Sets the source image name/path. The path must be a relative or absolute - server path, not a URL. -**dynamic_output** FALSE TRUE/FALSE (boolean) Determines whether the new image file should be written to disk or R, C, X, W - generated dynamically. Note: If you choose the dynamic setting, only one - image can be shown at a time, and it can't be positioned on the page. It - simply outputs the raw image dynamically to your browser, along with - image headers. -**file_permissions** 0644 (integer) File system permissions to apply on the resulting image file, R, C, X, W - writing it to the disk. WARNING: Use octal integer notation! -**quality** 90% 1 - 100% Sets the quality of the image. The higher the quality the larger the R, C, X, W - file size. -**new_image** None None Sets the destination image name/path. You'll use this preference when R, C, X, W - creating an image copy. The path must be a relative or absolute server - path, not a URL. -**width** None None Sets the width you would like the image set to. R, C -**height** None None Sets the height you would like the image set to. R, C -**create_thumb** FALSE TRUE/FALSE (boolean) Tells the image processing function to create a thumb. R -**thumb_marker** _thumb None Specifies the thumbnail indicator. It will be inserted just before the R - file extension, so mypic.jpg would become mypic_thumb.jpg -**maintain_ratio** TRUE TRUE/FALSE (boolean) Specifies whether to maintain the original aspect ratio when resizing or R, C - use hard values. -**master_dim** auto auto, width, height Specifies what to use as the master axis when resizing or creating R - thumbs. For example, let's say you want to resize an image to 100 X 75 - pixels. If the source image size does not allow perfect resizing to - those dimensions, this setting determines which axis should be used as - the hard value. "auto" sets the axis automatically based on whether the - image is taller than wider, or vice versa. -**rotation_angle** None 90, 180, 270, vrt, hor Specifies the angle of rotation when rotating images. Note that PHP X - rotates counter-clockwise, so a 90 degree rotation to the right must be - specified as 270. -**x_axis** None None Sets the X coordinate in pixels for image cropping. For example, a C - setting of 30 will crop an image 30 pixels from the left. -**y_axis** None None Sets the Y coordinate in pixels for image cropping. For example, a C - setting of 30 will crop an image 30 pixels from the top. -======================= ======================= =============================== =========================================================================== ============= - -Setting preferences in a config file -==================================== - -If you prefer not to set preferences using the above method, you can -instead put them into a config file. Simply create a new file called -image_lib.php, add the $config array in that file. Then save the file -in *config/image_lib.php* and it will be used automatically. You will -NOT need to use the ``$this->image_lib->initialize()`` method if you save -your preferences in a config file. - -****************** -Image Watermarking -****************** - -The Watermarking feature requires the GD/GD2 library. - -Two Types of Watermarking -========================= - -There are two types of watermarking that you can use: - -- **Text**: The watermark message will be generated using text, either - with a True Type font that you specify, or using the native text - output that the GD library supports. If you use the True Type version - your GD installation must be compiled with True Type support (most - are, but not all). -- **Overlay**: The watermark message will be generated by overlaying an - image (usually a transparent PNG or GIF) containing your watermark - over the source image. - -.. _watermarking: - -Watermarking an Image -===================== - -Just as with the other methods (resizing, cropping, and rotating) the -general process for watermarking involves setting the preferences -corresponding to the action you intend to perform, then calling the -watermark function. Here is an example:: - - $config['source_image'] = '/path/to/image/mypic.jpg'; - $config['wm_text'] = 'Copyright 2006 - John Doe'; - $config['wm_type'] = 'text'; - $config['wm_font_path'] = './system/fonts/texb.ttf'; - $config['wm_font_size'] = '16'; - $config['wm_font_color'] = 'ffffff'; - $config['wm_vrt_alignment'] = 'bottom'; - $config['wm_hor_alignment'] = 'center'; - $config['wm_padding'] = '20'; - - $this->image_lib->initialize($config); - - $this->image_lib->watermark(); - -The above example will use a 16 pixel True Type font to create the text -"Copyright 2006 - John Doe". The watermark will be positioned at the -bottom/center of the image, 20 pixels from the bottom of the image. - -.. note:: In order for the image class to be allowed to do any - processing, the image file must have "write" file permissions - For example, 777. - -Watermarking Preferences -======================== - -This table shows the preferences that are available for both types of -watermarking (text or overlay) - -======================= =================== ======================= ========================================================================== -Preference Default Value Options Description -======================= =================== ======================= ========================================================================== -**wm_type** text text, overlay Sets the type of watermarking that should be used. -**source_image** None None Sets the source image name/path. The path must be a relative or absolute - server path, not a URL. -**dynamic_output** FALSE TRUE/FALSE (boolean) Determines whether the new image file should be written to disk or - generated dynamically. Note: If you choose the dynamic setting, only one - image can be shown at a time, and it can't be positioned on the page. It - simply outputs the raw image dynamically to your browser, along with - image headers. -**quality** 90% 1 - 100% Sets the quality of the image. The higher the quality the larger the - file size. -**wm_padding** None A number The amount of padding, set in pixels, that will be applied to the - watermark to set it away from the edge of your images. -**wm_vrt_alignment** bottom top, middle, bottom Sets the vertical alignment for the watermark image. -**wm_hor_alignment** center left, center, right Sets the horizontal alignment for the watermark image. -**wm_hor_offset** None None You may specify a horizontal offset (in pixels) to apply to the - watermark position. The offset normally moves the watermark to the - right, except if you have your alignment set to "right" then your offset - value will move the watermark toward the left of the image. -**wm_vrt_offset** None None You may specify a vertical offset (in pixels) to apply to the watermark - position. The offset normally moves the watermark down, except if you - have your alignment set to "bottom" then your offset value will move the - watermark toward the top of the image. -======================= =================== ======================= ========================================================================== - -Text Preferences ----------------- - -This table shows the preferences that are available for the text type of -watermarking. - -======================= =================== =================== ========================================================================== -Preference Default Value Options Description -======================= =================== =================== ========================================================================== -**wm_text** None None The text you would like shown as the watermark. Typically this will be a - copyright notice. -**wm_font_path** None None The server path to the True Type Font you would like to use. If you do - not use this option, the native GD font will be used. -**wm_font_size** 16 None The size of the text. Note: If you are not using the True Type option - above, the number is set using a range of 1 - 5. Otherwise, you can use - any valid pixel size for the font you're using. -**wm_font_color** ffffff None The font color, specified in hex. Both the full 6-length (ie, 993300) and - the short three character abbreviated version (ie, fff) are supported. -**wm_shadow_color** None None The color of the drop shadow, specified in hex. If you leave this blank - a drop shadow will not be used. Both the full 6-length (ie, 993300) and - the short three character abbreviated version (ie, fff) are supported. -**wm_shadow_distance** 3 None The distance (in pixels) from the font that the drop shadow should - appear. -======================= =================== =================== ========================================================================== - -Overlay Preferences -------------------- - -This table shows the preferences that are available for the overlay type -of watermarking. - -======================= =================== =================== ========================================================================== -Preference Default Value Options Description -======================= =================== =================== ========================================================================== -**wm_overlay_path** None None The server path to the image you wish to use as your watermark. Required - only if you are using the overlay method. -**wm_opacity** 50 1 - 100 Image opacity. You may specify the opacity (i.e. transparency) of your - watermark image. This allows the watermark to be faint and not - completely obscure the details from the original image behind it. A 50% - opacity is typical. -**wm_x_transp** 4 A number If your watermark image is a PNG or GIF image, you may specify a color - on the image to be "transparent". This setting (along with the next) - will allow you to specify that color. This works by specifying the "X" - and "Y" coordinate pixel (measured from the upper left) within the image - that corresponds to a pixel representative of the color you want to be - transparent. -**wm_y_transp** 4 A number Along with the previous setting, this allows you to specify the - coordinate to a pixel representative of the color you want to be - transparent. -======================= =================== =================== ========================================================================== - -*************** -Class Reference -*************** - -.. php:class:: CI_Image_lib - - .. php:method:: initialize([$props = array()]) - - :param array $props: Image processing preferences - :returns: TRUE on success, FALSE in case of invalid settings - :rtype: bool - - Initializes the class for processing an image. - - .. php:method:: resize() - - :returns: TRUE on success, FALSE on failure - :rtype: bool - - The image resizing method lets you resize the original image, create a - copy (with or without resizing), or create a thumbnail image. - - For practical purposes there is no difference between creating a copy - and creating a thumbnail except a thumb will have the thumbnail marker - as part of the name (i.e. mypic_thumb.jpg). - - All preferences listed in the :ref:`processing-preferences` table are available for this - method except these three: *rotation_angle*, *x_axis* and *y_axis*. - - **Creating a Thumbnail** - - The resizing method will create a thumbnail file (and preserve the - original) if you set this preference to TRUE:: - - $config['create_thumb'] = TRUE; - - This single preference determines whether a thumbnail is created or not. - - **Creating a Copy** - - The resizing method will create a copy of the image file (and preserve - the original) if you set a path and/or a new filename using this - preference:: - - $config['new_image'] = '/path/to/new_image.jpg'; - - Notes regarding this preference: - - - If only the new image name is specified it will be placed in the same - folder as the original - - If only the path is specified, the new image will be placed in the - destination with the same name as the original. - - If both the path and image name are specified it will placed in its - own destination and given the new name. - - **Resizing the Original Image** - - If neither of the two preferences listed above (create_thumb, and - new_image) are used, the resizing method will instead target the - original image for processing. - - .. php:method:: crop() - - :returns: TRUE on success, FALSE on failure - :rtype: bool - - The cropping method works nearly identically to the resizing function - except it requires that you set preferences for the X and Y axis (in - pixels) specifying where to crop, like this:: - - $config['x_axis'] = 100; - $config['y_axis'] = 40; - - All preferences listed in the :ref:`processing-preferences` table are available for this - method except these: *rotation_angle*, *create_thumb* and *new_image*. - - Here's an example showing how you might crop an image:: - - $config['image_library'] = 'imagemagick'; - $config['library_path'] = '/usr/X11R6/bin/'; - $config['source_image'] = '/path/to/image/mypic.jpg'; - $config['x_axis'] = 100; - $config['y_axis'] = 60; - - $this->image_lib->initialize($config); - - if ( ! $this->image_lib->crop()) - { - echo $this->image_lib->display_errors(); - } - - .. note:: Without a visual interface it is difficult to crop images, so this - method is not very useful unless you intend to build such an - interface. That's exactly what we did using for the photo gallery module - in ExpressionEngine, the CMS we develop. We added a JavaScript UI that - lets the cropping area be selected. - - .. php:method:: rotate() - - :returns: TRUE on success, FALSE on failure - :rtype: bool - - The image rotation method requires that the angle of rotation be set - via its preference:: - - $config['rotation_angle'] = '90'; - - There are 5 rotation options: - - #. 90 - rotates counter-clockwise by 90 degrees. - #. 180 - rotates counter-clockwise by 180 degrees. - #. 270 - rotates counter-clockwise by 270 degrees. - #. hor - flips the image horizontally. - #. vrt - flips the image vertically. - - Here's an example showing how you might rotate an image:: - - $config['image_library'] = 'netpbm'; - $config['library_path'] = '/usr/bin/'; - $config['source_image'] = '/path/to/image/mypic.jpg'; - $config['rotation_angle'] = 'hor'; - - $this->image_lib->initialize($config); - - if ( ! $this->image_lib->rotate()) - { - echo $this->image_lib->display_errors(); - } - - .. php:method:: watermark() - - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Creates a watermark over an image, please refer to the :ref:`watermarking` - section for more info. - - .. php:method:: clear() - - :rtype: void - - The clear method resets all of the values used when processing an - image. You will want to call this if you are processing images in a - loop. - - :: - - $this->image_lib->clear(); - - .. php:method:: display_errors([$open = '<p>[, $close = '</p>']]) - - :param string $open: Error message opening tag - :param string $close: Error message closing tag - :returns: Error messages - :rtype: string - - Returns all detected errors formatted as a string. - :: - - echo $this->image_lib->display_errors(); diff --git a/user_guide_src/source/libraries/index.rst b/user_guide_src/source/libraries/index.rst deleted file mode 100644 index 678b633dd..000000000 --- a/user_guide_src/source/libraries/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -######### -Libraries -######### - -.. toctree:: - :glob: - :titlesonly: - - *
\ No newline at end of file diff --git a/user_guide_src/source/libraries/input.rst b/user_guide_src/source/libraries/input.rst deleted file mode 100644 index 300f47112..000000000 --- a/user_guide_src/source/libraries/input.rst +++ /dev/null @@ -1,474 +0,0 @@ -########### -Input Class -########### - -The Input Class serves two purposes: - -#. It pre-processes global input data for security. -#. It provides some helper methods for fetching input data and pre-processing it. - -.. note:: This class is initialized automatically by the system so there - is no need to do it manually. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -*************** -Input Filtering -*************** - -Security Filtering -================== - -The security filtering method is called automatically when a new -:doc:`controller <../general/controllers>` is invoked. It does the -following: - -- If ``$config['allow_get_array']`` is FALSE (default is TRUE), destroys - the global GET array. -- Destroys all global variables in the event register_globals is - turned on. -- Filters the GET/POST/COOKIE array keys, permitting only alpha-numeric - (and a few other) characters. -- Provides XSS (Cross-site Scripting Hacks) filtering. This can be - enabled globally, or upon request. -- Standardizes newline characters to ``PHP_EOL`` (\\n in UNIX-based OSes, - \\r\\n under Windows). This is configurable. - -XSS Filtering -============= - -The Input class has the ability to filter input automatically to prevent -cross-site scripting attacks. If you want the filter to run -automatically every time it encounters POST or COOKIE data you can -enable it by opening your *application/config/config.php* file and setting -this:: - - $config['global_xss_filtering'] = TRUE; - -Please refer to the :doc:`Security class <security>` documentation for -information on using XSS Filtering in your application. - -.. important:: The 'global_xss_filtering' setting is DEPRECATED and kept - solely for backwards-compatibility purposes. XSS escaping should - be performed on *output*, not *input*! - -******************* -Accessing form data -******************* - -Using POST, GET, COOKIE, or SERVER Data -======================================= - -CodeIgniter comes with helper methods that let you fetch POST, GET, -COOKIE or SERVER items. The main advantage of using the provided -methods rather than fetching an item directly (``$_POST['something']``) -is that the methods will check to see if the item is set and return -NULL if not. This lets you conveniently use data without -having to test whether an item exists first. In other words, normally -you might do something like this:: - - $something = isset($_POST['something']) ? $_POST['something'] : NULL; - -With CodeIgniter's built in methods you can simply do this:: - - $something = $this->input->post('something'); - -The main methods are: - -- ``$this->input->post()`` -- ``$this->input->get()`` -- ``$this->input->cookie()`` -- ``$this->input->server()`` - -Using the php://input stream -============================ - -If you want to utilize the PUT, DELETE, PATCH or other exotic request -methods, they can only be accessed via a special input stream, that -can only be read once. This isn't as easy as just reading from e.g. -the ``$_POST`` array, because it will always exist and you can try -and access multiple variables without caring that you might only have -one shot at all of the POST data. - -CodeIgniter will take care of that for you, and you can read the data -from the **php://input** stream at any time, just by using the -``$raw_input_stream`` property:: - - $this->input->raw_input_stream; - -Additionally if the input stream is form-encoded like $_POST you can -access its values by calling the -``input_stream()`` method:: - - $this->input->input_stream('key'); - -Similar to other methods such as ``get()`` and ``post()``, if the -requested data is not found, it will return NULL and you can also -decide whether to run the data through ``xss_clean()`` by passing -a boolean value as the second parameter:: - - $this->input->input_stream('key', TRUE); // XSS Clean - $this->input->input_stream('key', FALSE); // No XSS filter - -.. note:: You can utilize ``method()`` in order to know if you're reading - PUT, DELETE or PATCH data. - -*************** -Class Reference -*************** - -.. php:class:: CI_Input - - .. attribute:: $raw_input_stream - - Read only property that will return php://input data as is. - - The property can be read multiple times. - - .. php:method:: post([$index = NULL[, $xss_clean = NULL]]) - - :param mixed $index: POST parameter name - :param bool $xss_clean: Whether to apply XSS filtering - :returns: $_POST if no parameters supplied, otherwise the POST value if found or NULL if not - :rtype: mixed - - The first parameter will contain the name of the POST item you are - looking for:: - - $this->input->post('some_data'); - - The method returns NULL if the item you are attempting to retrieve - does not exist. - - The second optional parameter lets you run the data through the XSS - filter. It's enabled by setting the second parameter to boolean TRUE - or by setting your ``$config['global_xss_filtering']`` to TRUE. - :: - - $this->input->post('some_data', TRUE); - - To return an array of all POST items call without any parameters. - - To return all POST items and pass them through the XSS filter set the - first parameter NULL while setting the second parameter to boolean TRUE. - :: - - $this->input->post(NULL, TRUE); // returns all POST items with XSS filter - $this->input->post(NULL, FALSE); // returns all POST items without XSS filter - - To return an array of multiple POST parameters, pass all the required keys - as an array. - :: - - $this->input->post(array('field1', 'field2')); - - Same rule applied here, to retrieve the parameters with XSS filtering enabled, set the - second parameter to boolean TRUE. - :: - - $this->input->post(array('field1', 'field2'), TRUE); - - .. php:method:: get([$index = NULL[, $xss_clean = NULL]]) - - :param mixed $index: GET parameter name - :param bool $xss_clean: Whether to apply XSS filtering - :returns: $_GET if no parameters supplied, otherwise the GET value if found or NULL if not - :rtype: mixed - - This method is identical to ``post()``, only it fetches GET data. - :: - - $this->input->get('some_data', TRUE); - - To return an array of all GET items call without any parameters. - - To return all GET items and pass them through the XSS filter set the - first parameter NULL while setting the second parameter to boolean TRUE. - :: - - $this->input->get(NULL, TRUE); // returns all GET items with XSS filter - $this->input->get(NULL, FALSE); // returns all GET items without XSS filtering - - To return an array of multiple GET parameters, pass all the required keys - as an array. - :: - - $this->input->get(array('field1', 'field2')); - - Same rule applied here, to retrieve the parameters with XSS filtering enabled, set the - second parameter to boolean TRUE. - :: - - $this->input->get(array('field1', 'field2'), TRUE); - - .. php:method:: post_get($index[, $xss_clean = NULL]) - - :param string $index: POST/GET parameter name - :param bool $xss_clean: Whether to apply XSS filtering - :returns: POST/GET value if found, NULL if not - :rtype: mixed - - This method works pretty much the same way as ``post()`` and ``get()``, - only combined. It will search through both POST and GET streams for data, - looking in POST first, and then in GET:: - - $this->input->post_get('some_data', TRUE); - - .. php:method:: get_post($index[, $xss_clean = NULL]) - - :param string $index: GET/POST parameter name - :param bool $xss_clean: Whether to apply XSS filtering - :returns: GET/POST value if found, NULL if not - :rtype: mixed - - This method works the same way as ``post_get()`` only it looks for GET - data first. - - $this->input->get_post('some_data', TRUE); - - .. note:: This method used to act EXACTLY like ``post_get()``, but it's - behavior has changed in CodeIgniter 3.0. - - .. php:method:: cookie([$index = NULL[, $xss_clean = NULL]]) - - :param mixed $index: COOKIE name - :param bool $xss_clean: Whether to apply XSS filtering - :returns: $_COOKIE if no parameters supplied, otherwise the COOKIE value if found or NULL if not - :rtype: mixed - - This method is identical to ``post()`` and ``get()``, only it fetches cookie - data:: - - $this->input->cookie('some_cookie'); - $this->input->cookie('some_cookie', TRUE); // with XSS filter - - To return an array of multiple cookie values, pass all the required keys - as an array. - :: - - $this->input->cookie(array('some_cookie', 'some_cookie2')); - - .. note:: Unlike the :doc:`Cookie Helper <../helpers/cookie_helper>` - function :php:func:`get_cookie()`, this method does NOT prepend - your configured ``$config['cookie_prefix']`` value. - - .. php:method:: server($index[, $xss_clean = NULL]) - - :param mixed $index: Value name - :param bool $xss_clean: Whether to apply XSS filtering - :returns: $_SERVER item value if found, NULL if not - :rtype: mixed - - This method is identical to the ``post()``, ``get()`` and ``cookie()`` - methods, only it fetches server data (``$_SERVER``):: - - $this->input->server('some_data'); - - To return an array of multiple ``$_SERVER`` values, pass all the required keys - as an array. - :: - - $this->input->server(array('SERVER_PROTOCOL', 'REQUEST_URI')); - - .. php:method:: input_stream([$index = NULL[, $xss_clean = NULL]]) - - :param mixed $index: Key name - :param bool $xss_clean: Whether to apply XSS filtering - :returns: Input stream array if no parameters supplied, otherwise the specified value if found or NULL if not - :rtype: mixed - - This method is identical to ``get()``, ``post()`` and ``cookie()``, - only it fetches the *php://input* stream data. - - .. php:method:: set_cookie($name = ''[, $value = ''[, $expire = ''[, $domain = ''[, $path = '/'[, $prefix = ''[, $secure = NULL[, $httponly = NULL]]]]]]]) - - :param mixed $name: Cookie name or an array of parameters - :param string $value: Cookie value - :param int $expire: Cookie expiration time in seconds - :param string $domain: Cookie domain - :param string $path: Cookie path - :param string $prefix: Cookie name prefix - :param bool $secure: Whether to only transfer the cookie through HTTPS - :param bool $httponly: Whether to only make the cookie accessible for HTTP requests (no JavaScript) - :rtype: void - - - Sets a cookie containing the values you specify. There are two ways to - pass information to this method so that a cookie can be set: Array - Method, and Discrete Parameters: - - **Array Method** - - Using this method, an associative array is passed to the first - parameter:: - - $cookie = array( - 'name' => 'The Cookie Name', - 'value' => 'The Value', - 'expire' => '86500', - 'domain' => '.some-domain.com', - 'path' => '/', - 'prefix' => 'myprefix_', - 'secure' => TRUE - ); - - $this->input->set_cookie($cookie); - - **Notes** - - Only the name and value are required. To delete a cookie set it with the - expiration blank. - - The expiration is set in **seconds**, which will be added to the current - time. Do not include the time, but rather only the number of seconds - from *now* that you wish the cookie to be valid. If the expiration is - set to zero the cookie will only last as long as the browser is open. - - For site-wide cookies regardless of how your site is requested, add your - URL to the **domain** starting with a period, like this: - .your-domain.com - - The path is usually not needed since the method sets a root path. - - The prefix is only needed if you need to avoid name collisions with - other identically named cookies for your server. - - The *httponly* and *secure* flags, when omitted, will default to your - ``$config['cookie_httponly']`` and ``$config['cookie_secure']`` settings. - - **Discrete Parameters** - - If you prefer, you can set the cookie by passing data using individual - parameters:: - - $this->input->set_cookie($name, $value, $expire, $domain, $path, $prefix, $secure); - - .. php:method:: ip_address() - - :returns: Visitor's IP address or '0.0.0.0' if not valid - :rtype: string - - Returns the IP address for the current user. If the IP address is not - valid, the method will return '0.0.0.0':: - - echo $this->input->ip_address(); - - .. important:: This method takes into account the ``$config['proxy_ips']`` - setting and will return the reported HTTP_X_FORWARDED_FOR, - HTTP_CLIENT_IP, HTTP_X_CLIENT_IP or HTTP_X_CLUSTER_CLIENT_IP - address for the allowed IP addresses. - - .. php:method:: valid_ip($ip[, $which = '']) - - :param string $ip: IP address - :param string $which: IP protocol ('ipv4' or 'ipv6') - :returns: TRUE if the address is valid, FALSE if not - :rtype: bool - - Takes an IP address as input and returns TRUE or FALSE (boolean) depending - on whether it is valid or not. - - .. note:: The $this->input->ip_address() method above automatically - validates the IP address. - - :: - - if ( ! $this->input->valid_ip($ip)) - { - echo 'Not Valid'; - } - else - { - echo 'Valid'; - } - - Accepts an optional second string parameter of 'ipv4' or 'ipv6' to specify - an IP format. The default checks for both formats. - - .. php:method:: user_agent([$xss_clean = NULL]) - - :returns: User agent string or NULL if not set - :param bool $xss_clean: Whether to apply XSS filtering - :rtype: mixed - - Returns the user agent string (web browser) being used by the current user, - or NULL if it's not available. - :: - - echo $this->input->user_agent(); - - See the :doc:`User Agent Class <user_agent>` for methods which extract - information from the user agent string. - - .. php:method:: request_headers([$xss_clean = FALSE]) - - :param bool $xss_clean: Whether to apply XSS filtering - :returns: An array of HTTP request headers - :rtype: array - - Returns an array of HTTP request headers. - Useful if running in a non-Apache environment where - `apache_request_headers() <http://php.net/apache_request_headers>`_ - will not be supported. - :: - - $headers = $this->input->request_headers(); - - .. php:method:: get_request_header($index[, $xss_clean = FALSE]) - - :param string $index: HTTP request header name - :param bool $xss_clean: Whether to apply XSS filtering - :returns: An HTTP request header or NULL if not found - :rtype: string - - Returns a single member of the request headers array or NULL - if the searched header is not found. - :: - - $this->input->get_request_header('some-header', TRUE); - - .. php:method:: is_ajax_request() - - :returns: TRUE if it is an Ajax request, FALSE if not - :rtype: bool - - Checks to see if the HTTP_X_REQUESTED_WITH server header has been - set, and returns boolean TRUE if it is or FALSE if not. - - .. php:method:: is_cli_request() - - :returns: TRUE if it is a CLI request, FALSE if not - :rtype: bool - - Checks to see if the application was run from the command-line - interface. - - .. note:: This method checks both the PHP SAPI name currently in use - and if the ``STDIN`` constant is defined, which is usually a - failsafe way to see if PHP is being run via the command line. - - :: - - $this->input->is_cli_request() - - .. note:: This method is DEPRECATED and is now just an alias for the - :func:`is_cli()` function. - - .. php:method:: method([$upper = FALSE]) - - :param bool $upper: Whether to return the request method name in upper or lower case - :returns: HTTP request method - :rtype: string - - Returns the ``$_SERVER['REQUEST_METHOD']``, with the option to set it - in uppercase or lowercase. - :: - - echo $this->input->method(TRUE); // Outputs: POST - echo $this->input->method(FALSE); // Outputs: post - echo $this->input->method(); // Outputs: post diff --git a/user_guide_src/source/libraries/javascript.rst b/user_guide_src/source/libraries/javascript.rst deleted file mode 100644 index e91b9ad78..000000000 --- a/user_guide_src/source/libraries/javascript.rst +++ /dev/null @@ -1,322 +0,0 @@ -################ -Javascript Class -################ - -CodeIgniter provides a library to help you with certain common functions -that you may want to use with Javascript. Please note that CodeIgniter -does not require the jQuery library to run, and that any scripting -library will work equally well. The jQuery library is simply presented -as a convenience if you choose to use it. - -.. important:: This library is DEPRECATED and should not be used. It has always - been with an 'experimental' status and is now no longer supported. - Currently only kept for backwards compatibility. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -************************** -Using the Javascript Class -************************** - -Initializing the Class -====================== - -To initialize the Javascript class manually in your controller -constructor, use the ``$this->load->library()`` method. Currently, -the only available library is jQuery, which will automatically be -loaded like this:: - - $this->load->library('javascript'); - -The Javascript class also accepts parameters: - -- js_library_driver (string) *default: 'jquery'* -- autoload (bool) *default: TRUE* - -You may override the defaults by sending an associative array:: - - $this->load->library( - 'javascript', - array( - 'js_library_driver' => 'scripto', - 'autoload' => FALSE - ) - ); - -Again, presently only 'jquery' is available. You may wish to set -autoload to FALSE, though, if you do not want the jQuery library to -automatically include a script tag for the main jQuery script file. This -is useful if you are loading it from a location outside of CodeIgniter, -or already have the script tag in your markup. - -Once loaded, the jQuery library object will be available using: - - $this->javascript - -Setup and Configuration -======================= - -Set these variables in your view --------------------------------- - -As a Javascript library, your files must be available to your -application. - -As Javascript is a client side language, the library must be able to -write content into your final output. This generally means a view. -You'll need to include the following variables in the ``<head>`` -sections of your output. - -:: - - <?php echo $library_src;?> - <?php echo $script_head;?> - - -``$library_src``, is where the actual library file will be loaded, as -well as any subsequent plugin script calls; $script_head is where -specific events, functions and other commands will be rendered. - -Set the path to the librarys with config items ----------------------------------------------- - -There are some configuration items in Javascript library. These can -either be set in *application/config.php*, within its own -*config/javascript.php* file, or within any controller usings the -``set_item()`` function. - -An image to be used as an "ajax loader", or progress indicator. Without -one, the simple text message of "loading" will appear when Ajax calls -need to be made. - -:: - - $config['javascript_location'] = 'http://localhost/codeigniter/themes/js/jquery/'; - $config['javascript_ajax_img'] = 'images/ajax-loader.gif'; - -If you keep your files in the same directories they were downloaded -from, then you need not set this configuration items. - -The jQuery Class -================ - -To initialize the jQuery class manually in your controller constructor, -use the ``$this->load->library()`` method:: - - $this->load->library('javascript/jquery'); - -You may send an optional parameter to determine whether or not a script -tag for the main jQuery file will be automatically included when loading -the library. It will be created by default. To prevent this, load the -library as follows:: - - $this->load->library('javascript/jquery', FALSE); - -Once loaded, the jQuery library object will be available using: - - $this->jquery - -jQuery Events -============= - -Events are set using the following syntax. -:: - - $this->jquery->event('element_path', code_to_run()); - -In the above example: - -- "event" is any of blur, change, click, dblclick, error, focus, hover, - keydown, keyup, load, mousedown, mouseup, mouseover, mouseup, resize, - scroll, or unload. -- "element_path" is any valid `jQuery selector - <http://api.jquery.com/category/selectors/>`_. Due to jQuery's unique - selector syntax, this is usually an element id, or CSS selector. For - example "#notice_area" would effect ``<div id="notice_area">``, and - "#content a.notice" would effect all anchors with a class of "notice" - in the div with id "content". -- "``code_to_run()``" is script your write yourself, or an action such as - an effect from the jQuery library below. - -Effects -======= - -The query library supports a powerful -`Effects <http://api.jquery.com/category/effects/>`_ repertoire. Before an effect -can be used, it must be loaded:: - - $this->jquery->effect([optional path] plugin name); // for example $this->jquery->effect('bounce'); - - -hide() / show() ---------------- - -Each of this functions will affect the visibility of an item on your -page. hide() will set an item invisible, show() will reveal it. - -:: - - $this->jquery->hide(target, optional speed, optional extra information); - $this->jquery->show(target, optional speed, optional extra information); - - -- "target" will be any valid jQuery selector or selectors. -- "speed" is optional, and is set to either slow, normal, fast, or - alternatively a number of milliseconds. -- "extra information" is optional, and could include a callback, or - other additional information. - -toggle() --------- - -toggle() will change the visibility of an item to the opposite of its -current state, hiding visible elements, and revealing hidden ones. - -:: - - $this->jquery->toggle(target); - - -- "target" will be any valid jQuery selector or selectors. - -animate() ---------- - -:: - - $this->jquery->animate(target, parameters, optional speed, optional extra information); - - -- "target" will be any valid jQuery selector or selectors. -- "parameters" in jQuery would generally include a series of CSS - properties that you wish to change. -- "speed" is optional, and is set to either slow, normal, fast, or - alternatively a number of milliseconds. -- "extra information" is optional, and could include a callback, or - other additional information. - -For a full summary, see -`http://api.jquery.com/animate/ <http://api.jquery.com/animate/>`_ - -Here is an example of an animate() called on a div with an id of "note", -and triggered by a click using the jQuery library's click() event. - -:: - - $params = array( - 'height' => 80, - 'width' => '50%', - 'marginLeft' => 125 - ); - $this->jquery->click('#trigger', $this->jquery->animate('#note', $params, 'normal')); - -fadeIn() / fadeOut() --------------------- - -:: - - $this->jquery->fadeIn(target, optional speed, optional extra information); - $this->jquery->fadeOut(target, optional speed, optional extra information); - - -- "target" will be any valid jQuery selector or selectors. -- "speed" is optional, and is set to either slow, normal, fast, or - alternatively a number of milliseconds. -- "extra information" is optional, and could include a callback, or - other additional information. - -toggleClass() -------------- - -This function will add or remove a CSS class to its target. - -:: - - $this->jquery->toggleClass(target, class) - - -- "target" will be any valid jQuery selector or selectors. -- "class" is any CSS classname. Note that this class must be defined - and available in a CSS that is already loaded. - -fadeIn() / fadeOut() --------------------- - -These effects cause an element(s) to disappear or reappear over time. - -:: - - $this->jquery->fadeIn(target, optional speed, optional extra information); - $this->jquery->fadeOut(target, optional speed, optional extra information); - - -- "target" will be any valid jQuery selector or selectors. -- "speed" is optional, and is set to either slow, normal, fast, or - alternatively a number of milliseconds. -- "extra information" is optional, and could include a callback, or - other additional information. - -slideUp() / slideDown() / slideToggle() ---------------------------------------- - -These effects cause an element(s) to slide. - -:: - - $this->jquery->slideUp(target, optional speed, optional extra information); - $this->jquery->slideDown(target, optional speed, optional extra information); - $this->jquery->slideToggle(target, optional speed, optional extra information); - - -- "target" will be any valid jQuery selector or selectors. -- "speed" is optional, and is set to either slow, normal, fast, or - alternatively a number of milliseconds. -- "extra information" is optional, and could include a callback, or - other additional information. - -Plugins -======= - -Some select jQuery plugins are made available using this library. - -corner() --------- - -Used to add distinct corners to page elements. For full details see -`http://malsup.com/jquery/corner/ <http://malsup.com/jquery/corner/>`_ - -:: - - $this->jquery->corner(target, corner_style); - - -- "target" will be any valid jQuery selector or selectors. -- "corner_style" is optional, and can be set to any valid style such - as round, sharp, bevel, bite, dog, etc. Individual corners can be set - by following the style with a space and using "tl" (top left), "tr" - (top right), "bl" (bottom left), or "br" (bottom right). - -:: - - $this->jquery->corner("#note", "cool tl br"); - - -tablesorter() -------------- - -description to come - -modal() -------- - -description to come - -calendar() ----------- - -description to come
\ No newline at end of file diff --git a/user_guide_src/source/libraries/language.rst b/user_guide_src/source/libraries/language.rst deleted file mode 100644 index de17c8288..000000000 --- a/user_guide_src/source/libraries/language.rst +++ /dev/null @@ -1,210 +0,0 @@ -############## -Language Class -############## - -The Language Class provides functions to retrieve language files and -lines of text for purposes of internationalization. - -In your CodeIgniter **system** folder, you will find a **language** sub-directory -containing a set of language files for the **english** idiom. -The files in this directory (**system/language/english/**) define the regular messages, -error messages, and other generally output terms or expressions, for the different parts -of the CodeIgniter framework. - -You can create or incorporate your own language files, as needed, in order to provide -application-specific error and other messages, or to provide translations of the core -messages into other languages. These translations or additional messages would go inside -your **application/language/** directory, with separate sub-directories for each idiom -(for instance, 'french' or 'german'). - -The CodeIgniter framework comes with a set of language files for the "english" idiom. -Additional approved translations for different idioms may be found in the -`CodeIgniter 3 Translations repositories <https://github.com/bcit-ci/codeigniter3-translations>`_. -Each repository deals with a single idiom. - -When CodeIgniter loads language files, it will load the one in **system/language/** -first and will then look for an override in your **application/language/** directory. - -.. note:: Each language should be stored in its own folder. For example, - the English files are located at: system/language/english - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -*************************** -Handling Multiple Languages -*************************** - -If you want to support multiple languages in your application, you would provide folders inside -your **application/language/** directory for each of them, and you would specify the default -language in your **application/config/config.php**. - -The **application/language/english/** directory would contain any additional language files -needed by your application, for instance for error messages. - -Each of the other idiom-specific directories would contain the core language files that you -obtained from the translations repositories, or that you translated yourself, as well as -any additional ones needed by your application. - -You would store the language you are currently using, for instance in a session variable. - -Sample Language Files -===================== - -:: - - system/ - language/ - english/ - ... - email_lang.php - form_validation_lang.php - ... - - application/ - language/ - english/ - error_messages_lang.php - french/ - ... - email_lang.php - error_messages_lang.php - form_validation_lang.php - ... - -Example of switching languages -============================== - -:: - - $idiom = $this->session->get_userdata('language'); - $this->lang->load('error_messages', $idiom); - $oops = $this->lang->line('message_key'); - -******************** -Internationalization -******************** - -The Language class in CodeIgniter is meant to provide an easy and lightweight -way to support multiplelanguages in your application. It is not meant to be a -full implementation of what is commonly called `internationalization and localization -<http://en.wikipedia.org/wiki/Internationalization_and_localization>`_. - -We use the term "idiom" to refer to a language using its common name, -rather than using any of the international standards, such as "en", "en-US", -or "en-CA-x-ca" for English and some of its variants. - -.. note:: There is nothing to prevent you from using those abbreviations in your application! - -************************ -Using the Language Class -************************ - -Creating Language Files -======================= - -Language files must be named with **_lang.php** as the filename extension. -For example, let's say you want to create a file containing error messages. -You might name it: error_lang.php - -Within the file you will assign each line of text to an array called -``$lang`` with this prototype:: - - $lang['language_key'] = 'The actual message to be shown'; - -.. note:: It's a good practice to use a common prefix for all messages - in a given file to avoid collisions with similarly named items in other - files. For example, if you are creating error messages you might prefix - them with error\_ - -:: - - $lang['error_email_missing'] = 'You must submit an email address'; - $lang['error_url_missing'] = 'You must submit a URL'; - $lang['error_username_missing'] = 'You must submit a username'; - -Loading A Language File -======================= - -In order to fetch a line from a particular file you must load the file -first. Loading a language file is done with the following code:: - - $this->lang->load('filename', 'language'); - -Where filename is the name of the file you wish to load (without the -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 -======================= - -Once your desired language file is loaded you can access any line of -text using this function:: - - $this->lang->line('language_key'); - -Where *language_key* is the array key corresponding to the line you wish -to show. - -You can optionally pass FALSE as the second argument of that method to -disable error logging, in case you're not sure if the line exists:: - - $this->lang->line('misc_key', FALSE); - -.. note:: This method simply returns the line. It does not echo it. - -Using language lines as form labels ------------------------------------ - -This feature has been deprecated from the language library and moved to -the :php:func:`lang()` function of the :doc:`Language Helper -<../helpers/language_helper>`. - -Auto-loading Languages -====================== - -If you find that you need a particular language globally throughout your -application, you can tell CodeIgniter to :doc:`auto-load -<../general/autoloader>` it during system initialization. This is done -by opening the **application/config/autoload.php** file and adding the -language(s) to the autoload array. - -*************** -Class Reference -*************** - -.. php:class:: CI_Lang - - .. php:method:: load($langfile[, $idiom = ''[, $return = FALSE[, $add_suffix = TRUE[, $alt_path = '']]]]) - - :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 - :param string $alt_path: An alternative path to look in for the language file - :returns: Array of language lines if $return is set to TRUE, otherwise void - :rtype: mixed - - Loads a language file. - - .. php:method:: line($line[, $log_errors = TRUE]) - - :param string $line: Language line key name - :param bool $log_errors: Whether to log an error if the line isn't found - :returns: Language line string or FALSE on failure - :rtype: string - - Fetches a single translation line from the already loaded language files, - based on the line's name.
\ No newline at end of file diff --git a/user_guide_src/source/libraries/loader.rst b/user_guide_src/source/libraries/loader.rst deleted file mode 100644 index 22abb4586..000000000 --- a/user_guide_src/source/libraries/loader.rst +++ /dev/null @@ -1,461 +0,0 @@ -############ -Loader Class -############ - -Loader, as the name suggests, is used to load elements. These elements -can be libraries (classes) :doc:`View files <../general/views>`, -:doc:`Drivers <../general/drivers>`, -:doc:`Helpers <../general/helpers>`, -:doc:`Models <../general/models>`, or your own files. - -.. note:: This class is initialized automatically by the system so there - is no need to do it manually. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -********************** -Application "Packages" -********************** - -An application package allows for the easy distribution of complete sets -of resources in a single directory, complete with its own libraries, -models, helpers, config, and language files. It is recommended that -these packages be placed in the application/third_party directory. Below -is a sample map of an package directory. - -The following is an example of a directory for an application package -named "Foo Bar". - -:: - - /application/third_party/foo_bar - - config/ - helpers/ - language/ - libraries/ - models/ - -Whatever the purpose of the "Foo Bar" application package, it has its -own config files, helpers, language files, libraries, and models. To use -these resources in your controllers, you first need to tell the Loader -that you are going to be loading resources from a package, by adding the -package path via the ``add_package_path()`` method. - -Package view files ------------------- - -By Default, package view files paths are set when ``add_package_path()`` -is called. View paths are looped through, and once a match is -encountered that view is loaded. - -In this instance, it is possible for view naming collisions within -packages to occur, and possibly the incorrect package being loaded. To -ensure against this, set an optional second parameter of FALSE when -calling ``add_package_path()``. - -:: - - $this->load->add_package_path(APPPATH.'my_app', FALSE); - $this->load->view('my_app_index'); // Loads - $this->load->view('welcome_message'); // Will not load the default welcome_message b/c the second param to add_package_path is FALSE - - // Reset things - $this->load->remove_package_path(APPPATH.'my_app'); - - // Again without the second parameter: - $this->load->add_package_path(APPPATH.'my_app'); - $this->load->view('my_app_index'); // Loads - $this->load->view('welcome_message'); // Loads - -*************** -Class Reference -*************** - -.. php:class:: CI_Loader - - .. php:method:: library($library[, $params = NULL[, $object_name = NULL]]) - - :param mixed $library: Library name as a string or an array with multiple libraries - :param array $params: Optional array of parameters to pass to the loaded library's constructor - :param string $object_name: Optional object name to assign the library to - :returns: CI_Loader instance (method chaining) - :rtype: CI_Loader - - This method is used to load core classes. - - .. note:: We use the terms "class" and "library" interchangeably. - - For example, if you would like to send email with CodeIgniter, the first - step is to load the email class within your controller:: - - $this->load->library('email'); - - Once loaded, the library will be ready for use, using ``$this->email``. - - Library files can be stored in subdirectories within the main - "libraries" directory, or within your personal *application/libraries* - directory. To load a file located in a subdirectory, simply include the - path, relative to the "libraries" directory. For example, if you have - file located at:: - - libraries/flavors/Chocolate.php - - You will load it using:: - - $this->load->library('flavors/chocolate'); - - You may nest the file in as many subdirectories as you want. - - Additionally, multiple libraries can be loaded at the same time by - passing an array of libraries to the load method. - :: - - $this->load->library(array('email', 'table')); - - **Setting options** - - The second (optional) parameter allows you to optionally pass - configuration setting. You will typically pass these as an array:: - - $config = array ( - 'mailtype' => 'html', - 'charset' => 'utf-8', - 'priority' => '1' - ); - - $this->load->library('email', $config); - - Config options can usually also be set via a config file. Each library - is explained in detail in its own page, so please read the information - regarding each one you would like to use. - - Please take note, when multiple libraries are supplied in an array for - the first parameter, each will receive the same parameter information. - - **Assigning a Library to a different object name** - - If the third (optional) parameter is blank, the library will usually be - assigned to an object with the same name as the library. For example, if - the library is named Calendar, it will be assigned to a variable named - ``$this->calendar``. - - If you prefer to set your own class names you can pass its value to the - third parameter:: - - $this->load->library('calendar', NULL, 'my_calendar'); - - // Calendar class is now accessed using: - $this->my_calendar - - Please take note, when multiple libraries are supplied in an array for - the first parameter, this parameter is discarded. - - .. php:method:: driver($library[, $params = NULL[, $object_name]]) - - :param mixed $library: Library name as a string or an array with multiple libraries - :param array $params: Optional array of parameters to pass to the loaded library's constructor - :param string $object_name: Optional object name to assign the library to - :returns: CI_Loader instance (method chaining) - :rtype: CI_Loader - - This method is used to load driver libraries, acts very much like the - ``library()`` method. - - As an example, if you would like to use sessions with CodeIgniter, the first - step is to load the session driver within your controller:: - - $this->load->driver('session'); - - Once loaded, the library will be ready for use, using ``$this->session``. - - Driver files must be stored in a subdirectory within the main - "libraries" directory, or within your personal *application/libraries* - directory. The subdirectory must match the parent class name. Read the - :doc:`Drivers <../general/drivers>` description for details. - - Additionally, multiple driver libraries can be loaded at the same time by - passing an array of drivers to the load method. - :: - - $this->load->driver(array('session', 'cache')); - - **Setting options** - - The second (optional) parameter allows you to optionally pass - configuration settings. You will typically pass these as an array:: - - $config = array( - 'sess_driver' => 'cookie', - 'sess_encrypt_cookie' => true, - 'encryption_key' => 'mysecretkey' - ); - - $this->load->driver('session', $config); - - Config options can usually also be set via a config file. Each library - is explained in detail in its own page, so please read the information - regarding each one you would like to use. - - **Assigning a Driver to a different object name** - - If the third (optional) parameter is blank, the library will be assigned - to an object with the same name as the parent class. For example, if - the library is named Session, it will be assigned to a variable named - ``$this->session``. - - If you prefer to set your own class names you can pass its value to the - third parameter:: - - $this->load->library('session', '', 'my_session'); - - // Session class is now accessed using: - $this->my_session - - .. php:method:: view($view[, $vars = array()[, return = FALSE]]) - - :param string $view: View name - :param array $vars: An associative array of variables - :param bool $return: Whether to return the loaded view - :returns: View content string if $return is set to TRUE, otherwise CI_Loader instance (method chaining) - :rtype: mixed - - This method is used to load your View files. If you haven't read the - :doc:`Views <../general/views>` section of the user guide it is - recommended that you do since it shows you how this method is - typically used. - - The first parameter is required. It is the name of the view file you - would like to load. - - .. note:: The .php file extension does not need to be specified unless - you use something other than .php. - - The second **optional** parameter can take an associative array or an - object as input, which it runs through the PHP - `extract() <http://php.net/extract>`_ function to convert to variables - that can be used in your view files. Again, read the - :doc:`Views <../general/views>` page to learn how this might be useful. - - The third **optional** parameter lets you change the behavior of the - method so that it returns data as a string rather than sending it to - your browser. This can be useful if you want to process the data in some - way. If you set the parameter to TRUE (boolean) it will return data. The - default behavior is FALSE, which sends it to your browser. Remember to - assign it to a variable if you want the data returned:: - - $string = $this->load->view('myfile', '', TRUE); - - .. php:method:: vars($vars[, $val = '']) - - :param mixed $vars: An array of variables or a single variable name - :param mixed $val: Optional variable value - :returns: CI_Loader instance (method chaining) - :rtype: CI_Loader - - This method takes an associative array as input and generates - variables using the PHP `extract() <http://php.net/extract>`_ - function. This method produces the same result as using the second - parameter of the ``$this->load->view()`` method above. The reason you - might want to use this method independently is if you would like to - set some global variables in the constructor of your controller and have - them become available in any view file loaded from any method. You can - have multiple calls to this method. The data get cached and merged - into one array for conversion to variables. - - .. php:method:: get_var($key) - - :param string $key: Variable name key - :returns: Value if key is found, NULL if not - :rtype: mixed - - This method checks the associative array of variables available to - your views. This is useful if for any reason a var is set in a library - or another controller method using ``$this->load->vars()``. - - .. php:method:: get_vars() - - :returns: An array of all assigned view variables - :rtype: array - - This method retrieves all variables available to your views. - - .. php:method:: clear_vars() - - :returns: CI_Loader instance (method chaining) - :rtype: CI_Loader - - Clears cached view variables. - - .. php:method:: model($model[, $name = ''[, $db_conn = FALSE]]) - - :param mixed $model: Model name or an array containing multiple models - :param string $name: Optional object name to assign the model to - :param string $db_conn: Optional database configuration group to load - :returns: CI_Loader instance (method chaining) - :rtype: CI_Loader - - :: - - $this->load->model('model_name'); - - - If your model is located in a subdirectory, include the relative path - from your models directory. For example, if you have a model located at - *application/models/blog/Queries.php* you'll load it using:: - - $this->load->model('blog/queries'); - - If you would like your model assigned to a different object name you can - specify it via the second parameter of the loading method:: - - $this->load->model('model_name', 'fubar'); - $this->fubar->method(); - - .. php:method:: database([$params = ''[, $return = FALSE[, $query_builder = NULL]]]) - - :param mixed $params: Database group name or configuration options - :param bool $return: Whether to return the loaded database object - :param bool $query_builder: Whether to load the Query Builder - :returns: Loaded CI_DB instance or FALSE on failure if $return is set to TRUE, otherwise CI_Loader instance (method chaining) - :rtype: mixed - - This method lets you load the database class. The two parameters are - **optional**. Please see the :doc:`database <../database/index>` - section for more info. - - .. php:method:: dbforge([$db = NULL[, $return = FALSE]]) - - :param object $db: Database object - :param bool $return: Whether to return the Database Forge instance - :returns: Loaded CI_DB_forge instance if $return is set to TRUE, otherwise CI_Loader instance (method chaining) - :rtype: mixed - - Loads the :doc:`Database Forge <../database/forge>` class, please refer - to that manual for more info. - - .. php:method:: dbutil([$db = NULL[, $return = FALSE]]) - - :param object $db: Database object - :param bool $return: Whether to return the Database Utilities instance - :returns: Loaded CI_DB_utility instance if $return is set to TRUE, otherwise CI_Loader instance (method chaining) - :rtype: mixed - - Loads the :doc:`Database Utilities <../database/utilities>` class, please - refer to that manual for more info. - - .. php:method:: helper($helpers) - - :param mixed $helpers: Helper name as a string or an array containing multiple helpers - :returns: CI_Loader instance (method chaining) - :rtype: CI_Loader - - This method loads helper files, where file_name is the name of the - file, without the _helper.php extension. - - .. php:method:: file($path[, $return = FALSE]) - - :param string $path: File path - :param bool $return: Whether to return the loaded file - :returns: File contents if $return is set to TRUE, otherwise CI_Loader instance (method chaining) - :rtype: mixed - - This is a generic file loading method. Supply the filepath and name in - the first parameter and it will open and read the file. By default the - data is sent to your browser, just like a View file, but if you set the - second parameter to boolean TRUE it will instead return the data as a - string. - - .. php:method:: language($files[, $lang = '']) - - :param mixed $files: Language file name or an array of multiple language files - :param string $lang: Language name - :returns: CI_Loader instance (method chaining) - :rtype: CI_Loader - - This method is an alias of the :doc:`language loading - method <language>`: ``$this->lang->load()``. - - .. php:method:: config($file[, $use_sections = FALSE[, $fail_gracefully = FALSE]]) - - :param string $file: Configuration file name - :param bool $use_sections: Whether configuration values should be loaded into their own section - :param bool $fail_gracefully: Whether to just return FALSE in case of failure - :returns: TRUE on success, FALSE on failure - :rtype: bool - - This method is an alias of the :doc:`config file loading - method <config>`: ``$this->config->load()`` - - .. php:method:: is_loaded($class) - - :param string $class: Class name - :returns: Singleton property name if found, FALSE if not - :rtype: mixed - - Allows you to check if a class has already been loaded or not. - - .. note:: The word "class" here refers to libraries and drivers. - - If the requested class has been loaded, the method returns its assigned - name in the CI Super-object and FALSE if it's not:: - - $this->load->library('form_validation'); - $this->load->is_loaded('Form_validation'); // returns 'form_validation' - - $this->load->is_loaded('Nonexistent_library'); // returns FALSE - - .. important:: If you have more than one instance of a class (assigned to - different properties), then the first one will be returned. - - :: - - $this->load->library('form_validation', $config, 'fv'); - $this->load->library('form_validation'); - - $this->load->is_loaded('Form_validation'); // returns 'fv' - - .. php:method:: add_package_path($path[, $view_cascade = TRUE]) - - :param string $path: Path to add - :param bool $view_cascade: Whether to use cascading views - :returns: CI_Loader instance (method chaining) - :rtype: CI_Loader - - Adding a package path instructs the Loader class to prepend a given path - for subsequent requests for resources. As an example, the "Foo Bar" - application package above has a library named Foo_bar.php. In our - controller, we'd do the following:: - - $this->load->add_package_path(APPPATH.'third_party/foo_bar/') - ->library('foo_bar'); - - .. php:method:: remove_package_path([$path = '']) - - :param string $path: Path to remove - :returns: CI_Loader instance (method chaining) - :rtype: CI_Loader - - When your controller is finished using resources from an application - package, and particularly if you have other application packages you - want to work with, you may wish to remove the package path so the Loader - no longer looks in that directory for resources. To remove the last path - added, simply call the method with no parameters. - - Or to remove a specific package path, specify the same path previously - given to ``add_package_path()`` for a package.:: - - $this->load->remove_package_path(APPPATH.'third_party/foo_bar/'); - - .. php:method:: get_package_paths([$include_base = TRUE]) - - :param bool $include_base: Whether to include BASEPATH - :returns: An array of package paths - :rtype: array - - Returns all currently available package paths.
\ No newline at end of file diff --git a/user_guide_src/source/libraries/migration.rst b/user_guide_src/source/libraries/migration.rst deleted file mode 100644 index 97c72303c..000000000 --- a/user_guide_src/source/libraries/migration.rst +++ /dev/null @@ -1,184 +0,0 @@ -################ -Migrations Class -################ - -Migrations are a convenient way for you to alter your database in a -structured and organized manner. You could edit fragments of SQL by hand -but you would then be responsible for telling other developers that they -need to go and run them. You would also have to keep track of which changes -need to be run against the production machines next time you deploy. - -The database table **migration** tracks which migrations have already been -run so all you have to do is update your application files and -call ``$this->migration->current()`` to work out which migrations should be run. -The current version is found in **application/config/migration.php**. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -******************** -Migration file names -******************** - -Each Migration is run in numeric order forward or backwards depending on the -method taken. Two numbering styles are available: - -* **Sequential:** each migration is numbered in sequence, starting with **001**. - Each number must be three digits, and there must not be any gaps in the - sequence. (This was the numbering scheme prior to CodeIgniter 3.0.) -* **Timestamp:** each migration is numbered using the timestamp when the migration - was created, in **YYYYMMDDHHIISS** format (e.g. **20121031100537**). This - helps prevent numbering conflicts when working in a team environment, and is - the preferred scheme in CodeIgniter 3.0 and later. - -The desired style may be selected using the ``$config['migration_type']`` -setting in your *application/config/migration.php* file. - -Regardless of which numbering style you choose to use, prefix your migration -files with the migration number followed by an underscore and a descriptive -name for the migration. For example: - -* 001_add_blog.php (sequential numbering) -* 20121031100537_add_blog.php (timestamp numbering) - -****************** -Create a Migration -****************** - -This will be the first migration for a new site which has a blog. All -migrations go in the **application/migrations/** directory and have names such -as *20121031100537_add_blog.php*. -:: - - <?php - - defined('BASEPATH') OR exit('No direct script access allowed'); - - class Migration_Add_blog extends CI_Migration { - - public function up() - { - $this->dbforge->add_field(array( - 'blog_id' => array( - 'type' => 'INT', - 'constraint' => 5, - 'unsigned' => TRUE, - 'auto_increment' => TRUE - ), - 'blog_title' => array( - 'type' => 'VARCHAR', - 'constraint' => '100', - ), - 'blog_description' => array( - 'type' => 'TEXT', - 'null' => TRUE, - ), - )); - $this->dbforge->add_key('blog_id', TRUE); - $this->dbforge->create_table('blog'); - } - - public function down() - { - $this->dbforge->drop_table('blog'); - } - } - -Then in **application/config/migration.php** set ``$config['migration_version'] = 20121031100537;``. - -************* -Usage Example -************* - -In this example some simple code is placed in **application/controllers/Migrate.php** -to update the schema.:: - - <?php - - class Migrate extends CI_Controller - { - - public function index() - { - $this->load->library('migration'); - - if ($this->migration->current() === FALSE) - { - show_error($this->migration->error_string()); - } - } - - } - -********************* -Migration Preferences -********************* - -The following is a table of all the config options for migrations. - -========================== ====================== ========================== ============================================= -Preference Default Options Description -========================== ====================== ========================== ============================================= -**migration_enabled** FALSE TRUE / FALSE Enable or disable migrations. -**migration_path** APPPATH.'migrations/' None The path to your migrations folder. -**migration_version** 0 None The current version your database should use. -**migration_table** migrations None The table name for storing the schema - version number. -**migration_auto_latest** FALSE TRUE / FALSE Enable or disable automatically - running migrations. -**migration_type** 'timestamp' 'timestamp' / 'sequential' The type of numeric identifier used to name - migration files. -========================== ====================== ========================== ============================================= - -*************** -Class Reference -*************** - -.. php:class:: CI_Migration - - .. php:method:: current() - - :returns: TRUE if no migrations are found, current version string on success, FALSE on failure - :rtype: mixed - - Migrates up to the current version (whatever is set for - ``$config['migration_version']`` in *application/config/migration.php*). - - .. php:method:: error_string() - - :returns: Error messages - :rtype: string - - This returns a string of errors that were detected while performing a migration. - - .. php:method:: find_migrations() - - :returns: An array of migration files - :rtype: array - - An array of migration filenames are returned that are found in the **migration_path** property. - - .. php:method:: latest() - - :returns: Current version string on success, FALSE on failure - :rtype: mixed - - This works much the same way as ``current()`` but instead of looking for - the ``$config['migration_version']`` the Migration class will use the very - newest migration found in the filesystem. - - .. php:method:: version($target_version) - - :param mixed $target_version: Migration version to process - :returns: TRUE if no migrations are found, current version string on success, FALSE on failure - :rtype: mixed - - Version can be used to roll back changes or step forwards programmatically to - specific versions. It works just like ``current()`` but ignores ``$config['migration_version']``. - :: - - $this->migration->version(5); diff --git a/user_guide_src/source/libraries/output.rst b/user_guide_src/source/libraries/output.rst deleted file mode 100644 index 92060f66a..000000000 --- a/user_guide_src/source/libraries/output.rst +++ /dev/null @@ -1,233 +0,0 @@ -############ -Output Class -############ - -The Output class is a core class with one main function: To send the -finalized web page to the requesting browser. It is also responsible for -:doc:`caching <../general/caching>` your web pages, if you use that -feature. - -.. note:: This class is initialized automatically by the system so there - is no need to do it manually. - -Under normal circumstances you won't even notice the Output class since -it works transparently without your intervention. For example, when you -use the :doc:`Loader <../libraries/loader>` class to load a view file, -it's automatically passed to the Output class, which will be called -automatically by CodeIgniter at the end of system execution. It is -possible, however, for you to manually intervene with the output if you -need to. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -*************** -Class Reference -*************** - -.. php:class:: CI_Output - - .. attribute:: $parse_exec_vars = TRUE; - - Enables/disables parsing of the {elapsed_time} and {memory_usage} pseudo-variables. - - CodeIgniter will parse those tokens in your output by default. To disable this, set - this property to FALSE in your controller. - :: - - $this->output->parse_exec_vars = FALSE; - - .. php:method:: set_output($output) - - :param string $output: String to set the output to - :returns: CI_Output instance (method chaining) - :rtype: CI_Output - - Permits you to manually set the final output string. Usage example:: - - $this->output->set_output($data); - - .. important:: If you do set your output manually, it must be the last thing done - in the function you call it from. For example, if you build a page in one - of your controller methods, don't set the output until the end. - - .. php:method:: set_content_type($mime_type[, $charset = NULL]) - - :param string $mime_type: MIME Type idenitifer string - :param string $charset: Character set - :returns: CI_Output instance (method chaining) - :rtype: CI_Output - - Permits you to set the mime-type of your page so you can serve JSON data, JPEG's, XML, etc easily. - :: - - $this->output - ->set_content_type('application/json') - ->set_output(json_encode(array('foo' => 'bar'))); - - $this->output - ->set_content_type('jpeg') // You could also use ".jpeg" which will have the full stop removed before looking in config/mimes.php - ->set_output(file_get_contents('files/something.jpg')); - - .. important:: Make sure any non-mime string you pass to this method - exists in *application/config/mimes.php* or it will have no effect. - - You can also set the character set of the document, by passing a second argument:: - - $this->output->set_content_type('css', 'utf-8'); - - .. php:method:: get_content_type() - - :returns: Content-Type string - :rtype: string - - Returns the Content-Type HTTP header that's currently in use, excluding the character set value. - :: - - $mime = $this->output->get_content_type(); - - .. note:: If not set, the default return value is 'text/html'. - - .. php:method:: get_header($header) - - :param string $header: HTTP header name - :returns: HTTP response header or NULL if not found - :rtype: mixed - - Returns the requested HTTP header value, or NULL if the requested header is not set. - Example:: - - $this->output->set_content_type('text/plain', 'UTF-8'); - echo $this->output->get_header('content-type'); - // Outputs: text/plain; charset=utf-8 - - .. note:: The header name is compared in a case-insensitive manner. - - .. note:: Raw headers sent via PHP's native ``header()`` function are also detected. - - .. php:method:: get_output() - - :returns: Output string - :rtype: string - - Permits you to manually retrieve any output that has been sent for - storage in the output class. Usage example:: - - $string = $this->output->get_output(); - - Note that data will only be retrievable from this function if it has - been previously sent to the output class by one of the CodeIgniter - functions like ``$this->load->view()``. - - .. php:method:: append_output($output) - - :param string $output: Additional output data to append - :returns: CI_Output instance (method chaining) - :rtype: CI_Output - - Appends data onto the output string. - :: - - $this->output->append_output($data); - - .. php:method:: set_header($header[, $replace = TRUE]) - - :param string $header: HTTP response header - :param bool $replace: Whether to replace the old header value, if it is already set - :returns: CI_Output instance (method chaining) - :rtype: CI_Output - - Permits you to manually set server headers, which the output class will - send for you when outputting the final rendered display. Example:: - - $this->output->set_header('HTTP/1.0 200 OK'); - $this->output->set_header('HTTP/1.1 200 OK'); - $this->output->set_header('Last-Modified: '.gmdate('D, d M Y H:i:s', $last_update).' GMT'); - $this->output->set_header('Cache-Control: no-store, no-cache, must-revalidate'); - $this->output->set_header('Cache-Control: post-check=0, pre-check=0'); - $this->output->set_header('Pragma: no-cache'); - - .. php:method:: set_status_header([$code = 200[, $text = '']]) - - :param int $code: HTTP status code - :param string $text: Optional message - :returns: CI_Output instance (method chaining) - :rtype: CI_Output - - Permits you to manually set a server status header. Example:: - - $this->output->set_status_header(401); - // Sets the header as: Unauthorized - - `See here <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html>`_ for a full list of headers. - - .. note:: This method is an alias for :doc:`Common function <../general/common_functions>` - :func:`set_status_header()`. - - .. php:method:: enable_profiler([$val = TRUE]) - - :param bool $val: Whether to enable or disable the Profiler - :returns: CI_Output instance (method chaining) - :rtype: CI_Output - - Permits you to enable/disable the :doc:`Profiler <../general/profiling>`, which will display benchmark - and other data at the bottom of your pages for debugging and optimization purposes. - - To enable the profiler place the following line anywhere within your - :doc:`Controller <../general/controllers>` methods:: - - $this->output->enable_profiler(TRUE); - - When enabled a report will be generated and inserted at the bottom of your pages. - - To disable the profiler you would use:: - - $this->output->enable_profiler(FALSE); - - .. php:method:: set_profiler_sections($sections) - - :param array $sections: Profiler sections - :returns: CI_Output instance (method chaining) - :rtype: CI_Output - - Permits you to enable/disable specific sections of the Profiler when it is enabled. - Please refer to the :doc:`Profiler <../general/profiling>` documentation for further information. - - .. php:method:: cache($time) - - :param int $time: Cache expiration time in minutes - :returns: CI_Output instance (method chaining) - :rtype: CI_Output - - Caches the current page for the specified amount of minutes. - - For more information, please see the :doc:`caching documentation <../general/caching>`. - - .. php:method:: _display([$output = '']) - - :param string $output: Output data override - :returns: void - :rtype: void - - Sends finalized output data to the browser along with any server headers. It also stops benchmark - timers. - - .. note:: This method is called automatically at the end of script execution, you won't need to - call it manually unless you are aborting script execution using ``exit()`` or ``die()`` in your code. - - Example:: - - $response = array('status' => 'OK'); - - $this->output - ->set_status_header(200) - ->set_content_type('application/json', 'utf-8') - ->set_output(json_encode($response, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES)) - ->_display(); - exit; - - .. note:: Calling this method manually without aborting script execution will result in duplicated output. diff --git a/user_guide_src/source/libraries/pagination.rst b/user_guide_src/source/libraries/pagination.rst deleted file mode 100644 index fbc75ea56..000000000 --- a/user_guide_src/source/libraries/pagination.rst +++ /dev/null @@ -1,314 +0,0 @@ -################ -Pagination Class -################ - -CodeIgniter's Pagination class is very easy to use, and it is 100% -customizable, either dynamically or via stored preferences. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -If you are not familiar with the term "pagination", it refers to links -that allows you to navigate from page to page, like this:: - - « First < 1 2 3 4 5 > Last » - -******* -Example -******* - -Here is a simple example showing how to create pagination in one of your -:doc:`controller <../general/controllers>` methods:: - - $this->load->library('pagination'); - - $config['base_url'] = 'http://example.com/index.php/test/page/'; - $config['total_rows'] = 200; - $config['per_page'] = 20; - - $this->pagination->initialize($config); - - echo $this->pagination->create_links(); - -Notes -===== - -The ``$config`` array contains your configuration variables. It is passed to -the ``$this->pagination->initialize()`` method as shown above. Although -there are some twenty items you can configure, at minimum you need the -three shown. Here is a description of what those items represent: - -- **base_url** This is the full URL to the controller class/function - containing your pagination. In the example above, it is pointing to a - controller called "Test" and a function called "page". Keep in mind - that you can :doc:`re-route your URI <../general/routing>` if you - need a different structure. -- **total_rows** This number represents the total rows in the result - set you are creating pagination for. Typically this number will be - the total rows that your database query returned. -- **per_page** The number of items you intend to show per page. In the - above example, you would be showing 20 items per page. - -The ``create_links()`` method returns an empty string when there is no -pagination to show. - -Setting preferences in a config file -==================================== - -If you prefer not to set preferences using the above method, you can -instead put them into a config file. Simply create a new file called -pagination.php, add the ``$config`` array in that file. Then save the file -in *application/config/pagination.php* and it will be used automatically. -You will NOT need to use ``$this->pagination->initialize()`` if you save -your preferences in a config file. - -************************** -Customizing the Pagination -************************** - -The following is a list of all the preferences you can pass to the -initialization function to tailor the display. - -**$config['uri_segment'] = 3;** - -The pagination function automatically determines which segment of your -URI contains the page number. If you need something different you can -specify it. - -**$config['num_links'] = 2;** - -The number of "digit" links you would like before and after the selected -page number. For example, the number 2 will place two digits on either -side, as in the example links at the very top of this page. - -**$config['use_page_numbers'] = TRUE;** - -By default, the URI segment will use the starting index for the items -you are paginating. If you prefer to show the the actual page number, -set this to TRUE. - -**$config['page_query_string'] = TRUE;** - -By default, the pagination library assume you are using :doc:`URI -Segments <../general/urls>`, and constructs your links something -like:: - - http://example.com/index.php/test/page/20 - -If you have ``$config['enable_query_strings']`` set to TRUE your links -will automatically be re-written using Query Strings. This option can -also be explicitly set. Using ``$config['page_query_string']`` set to TRUE, -the pagination link will become:: - - http://example.com/index.php?c=test&m=page&per_page=20 - -Note that "per_page" is the default query string passed, however can be -configured using ``$config['query_string_segment'] = 'your_string'`` - -**$config['reuse_query_string'] = FALSE;** - -By default your Query String arguments (nothing to do with other -query string options) will be ignored. Setting this config to -TRUE will add existing query string arguments back into the -URL after the URI segment and before the suffix.:: - - http://example.com/index.php/test/page/20?query=search%term - -This helps you mix together normal :doc:`URI Segments <../general/urls>` -as well as query string arguments, which until 3.0 was not possible. - -**$config['prefix'] = '';** - -A custom prefix added to the path. The prefix value will be right before -the offset segment. - -**$config['suffix'] = '';** - -A custom suffix added to the path. The suffix value will be right after -the offset segment. - -**$config['use_global_url_suffix'] = FALSE;** - -When set to TRUE, it will **override** the ``$config['suffix']`` value and -instead set it to the one that you have in ``$config['url_suffix']`` in -your **application/config/config.php** file. - -*********************** -Adding Enclosing Markup -*********************** - -If you would like to surround the entire pagination with some markup you -can do it with these two preferences: - -**$config['full_tag_open'] = '<p>';** - -The opening tag placed on the left side of the entire result. - -**$config['full_tag_close'] = '</p>';** - -The closing tag placed on the right side of the entire result. - -************************** -Customizing the First Link -************************** - -**$config['first_link'] = 'First';** - -The text you would like shown in the "first" link on the left. If you do -not want this link rendered, you can set its value to FALSE. - -.. note:: This value can also be translated via a language file. - -**$config['first_tag_open'] = '<div>';** - -The opening tag for the "first" link. - -**$config['first_tag_close'] = '</div>';** - -The closing tag for the "first" link. - -**$config['first_url'] = '';** - -An alternative URL to use for the "first page" link. - -************************* -Customizing the Last Link -************************* - -**$config['last_link'] = 'Last';** - -The text you would like shown in the "last" link on the right. If you do -not want this link rendered, you can set its value to FALSE. - -.. note:: This value can also be translated via a language file. - -**$config['last_tag_open'] = '<div>';** - -The opening tag for the "last" link. - -**$config['last_tag_close'] = '</div>';** - -The closing tag for the "last" link. - -*************************** -Customizing the "Next" Link -*************************** - -**$config['next_link'] = '>';** - -The text you would like shown in the "next" page link. If you do not -want this link rendered, you can set its value to FALSE. - -.. note:: This value can also be translated via a language file. - -**$config['next_tag_open'] = '<div>';** - -The opening tag for the "next" link. - -**$config['next_tag_close'] = '</div>';** - -The closing tag for the "next" link. - -******************************* -Customizing the "Previous" Link -******************************* - -**$config['prev_link'] = '<';** - -The text you would like shown in the "previous" page link. If you do not -want this link rendered, you can set its value to FALSE. - -.. note:: This value can also be translated via a language file. - -**$config['prev_tag_open'] = '<div>';** - -The opening tag for the "previous" link. - -**$config['prev_tag_close'] = '</div>';** - -The closing tag for the "previous" link. - -*********************************** -Customizing the "Current Page" Link -*********************************** - -**$config['cur_tag_open'] = '<b>';** - -The opening tag for the "current" link. - -**$config['cur_tag_close'] = '</b>';** - -The closing tag for the "current" link. - -**************************** -Customizing the "Digit" Link -**************************** - -**$config['num_tag_open'] = '<div>';** - -The opening tag for the "digit" link. - -**$config['num_tag_close'] = '</div>';** - -The closing tag for the "digit" link. - -**************** -Hiding the Pages -**************** - -If you wanted to not list the specific pages (for example, you only want -"next" and "previous" links), you can suppress their rendering by -adding:: - - $config['display_pages'] = FALSE; - -**************************** -Adding attributes to anchors -**************************** - -If you want to add an extra attribute to be added to every link rendered -by the pagination class, you can set them as key/value pairs in the -"attributes" config:: - - // Produces: class="myclass" - $config['attributes'] = array('class' => 'myclass'); - -.. note:: Usage of the old method of setting classes via "anchor_class" - is deprecated. - -***************************** -Disabling the "rel" attribute -***************************** - -By default the rel attribute is dynamically generated and appended to -the appropriate anchors. If for some reason you want to turn it off, -you can pass boolean FALSE as a regular attribute - -:: - - $config['attributes']['rel'] = FALSE; - -*************** -Class Reference -*************** - -.. php:class:: CI_Pagination - - .. php:method:: initialize([$params = array()]) - - :param array $params: Configuration parameters - :returns: CI_Pagination instance (method chaining) - :rtype: CI_Pagination - - Initializes the Pagination class with your preferred options. - - .. php:method:: create_links() - - :returns: HTML-formatted pagination - :rtype: string - - Returns a "pagination" bar, containing the generated links or an empty string if there's just a single page. diff --git a/user_guide_src/source/libraries/parser.rst b/user_guide_src/source/libraries/parser.rst deleted file mode 100644 index 6c9d28959..000000000 --- a/user_guide_src/source/libraries/parser.rst +++ /dev/null @@ -1,309 +0,0 @@ -##################### -Template Parser Class -##################### - -The Template Parser Class can perform simple text substitution for -pseudo-variables contained within your view files. -It can parse simple variables or variable tag pairs. - -If you've never used a template engine, -pseudo-variable names are enclosed in braces, like this:: - - <html> - <head> - <title>{blog_title}</title> - </head> - <body> - <h3>{blog_heading}</h3> - - {blog_entries} - <h5>{title}</h5> - <p>{body}</p> - {/blog_entries} - - </body> - </html> - -These variables are not actual PHP variables, but rather plain text -representations that allow you to eliminate PHP from your templates -(view files). - -.. note:: CodeIgniter does **not** require you to use this class since - using pure PHP in your view pages lets them run a little faster. - However, some developers prefer to use a template engine if - they work with designers who they feel would find some - confusion working with PHP. - -.. important:: The Template Parser Class is **not** a full-blown - template parsing solution. We've kept it very lean on purpose in order - to maintain maximum performance. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -******************************* -Using the Template Parser Class -******************************* - -Initializing the Class -====================== - -Like most other classes in CodeIgniter, the Parser class is initialized -in your controller using the ``$this->load->library()`` method:: - - $this->load->library('parser'); - -Once loaded, the Parser library object will be available using: -$this->parser - -Parsing templates -================= - -You can use the ``parse()`` method to parse (or render) simple templates, -like this:: - - $data = array( - 'blog_title' => 'My Blog Title', - 'blog_heading' => 'My Blog Heading' - ); - - $this->parser->parse('blog_template', $data); - -The first parameter contains the name of the :doc:`view -file <../general/views>` (in this example the file would be called -blog_template.php), and the second parameter contains an associative -array of data to be replaced in the template. In the above example, the -template would contain two variables: {blog_title} and {blog_heading} - -There is no need to "echo" or do something with the data returned by -$this->parser->parse(). It is automatically passed to the output class -to be sent to the browser. However, if you do want the data returned -instead of sent to the output class you can pass TRUE (boolean) as the -third parameter:: - - $string = $this->parser->parse('blog_template', $data, TRUE); - -Variable Pairs -============== - -The above example code allows simple variables to be replaced. What if -you would like an entire block of variables to be repeated, with each -iteration containing new values? Consider the template example we showed -at the top of the page:: - - <html> - <head> - <title>{blog_title}</title> - </head> - <body> - <h3>{blog_heading}</h3> - - {blog_entries} - <h5>{title}</h5> - <p>{body}</p> - {/blog_entries} - - </body> - </html> - -In the above code you'll notice a pair of variables: {blog_entries} -data... {/blog_entries}. In a case like this, the entire chunk of data -between these pairs would be repeated multiple times, corresponding to -the number of rows in the "blog_entries" element of the parameters array. - -Parsing variable pairs is done using the identical code shown above to -parse single variables, except, you will add a multi-dimensional array -corresponding to your variable pair data. Consider this example:: - - $this->load->library('parser'); - - $data = array( - 'blog_title' => 'My Blog Title', - 'blog_heading' => 'My Blog Heading', - 'blog_entries' => array( - array('title' => 'Title 1', 'body' => 'Body 1'), - array('title' => 'Title 2', 'body' => 'Body 2'), - array('title' => 'Title 3', 'body' => 'Body 3'), - array('title' => 'Title 4', 'body' => 'Body 4'), - array('title' => 'Title 5', 'body' => 'Body 5') - ) - ); - - $this->parser->parse('blog_template', $data); - -If your "pair" data is coming from a database result, which is already a -multi-dimensional array, you can simply use the database ``result_array()`` -method:: - - $query = $this->db->query("SELECT * FROM blog"); - - $this->load->library('parser'); - - $data = array( - 'blog_title' => 'My Blog Title', - 'blog_heading' => 'My Blog Heading', - 'blog_entries' => $query->result_array() - ); - - $this->parser->parse('blog_template', $data); - -Usage Notes -=========== - -If you include substitution parameters that are not referenced in your -template, they are ignored:: - - $template = 'Hello, {firstname} {lastname}'; - $data = array( - 'title' => 'Mr', - 'firstname' => 'John', - 'lastname' => 'Doe' - ); - $this->parser->parse_string($template, $data); - - // Result: Hello, John Doe - -If you do not include a substitution parameter that is referenced in your -template, the original pseudo-variable is shown in the result:: - - $template = 'Hello, {firstname} {initials} {lastname}'; - $data = array( - 'title' => 'Mr', - 'firstname' => 'John', - 'lastname' => 'Doe' - ); - $this->parser->parse_string($template, $data); - - // Result: Hello, John {initials} Doe - -If you provide a string substitution parameter when an array is expected, -i.e. for a variable pair, the substitution is done for the opening variable -pair tag, but the closing variable pair tag is not rendered properly:: - - $template = 'Hello, {firstname} {lastname} ({degrees}{degree} {/degrees})'; - $data = array( - 'degrees' => 'Mr', - 'firstname' => 'John', - 'lastname' => 'Doe', - 'titles' => array( - array('degree' => 'BSc'), - array('degree' => 'PhD') - ) - ); - $this->parser->parse_string($template, $data); - - // Result: Hello, John Doe (Mr{degree} {/degrees}) - -If you name one of your individual substitution parameters the same as one -used inside a variable pair, the results may not be as expected:: - - $template = 'Hello, {firstname} {lastname} ({degrees}{degree} {/degrees})'; - $data = array( - 'degree' => 'Mr', - 'firstname' => 'John', - 'lastname' => 'Doe', - 'degrees' => array( - array('degree' => 'BSc'), - array('degree' => 'PhD') - ) - ); - $this->parser->parse_string($template, $data); - - // Result: Hello, John Doe (Mr Mr ) - -View Fragments -============== - -You do not have to use variable pairs to get the effect of iteration in -your views. It is possible to use a view fragment for what would be inside -a variable pair, and to control the iteration in your controller instead -of in the view. - -An example with the iteration controlled in the view:: - - $template = '<ul>{menuitems} - <li><a href="{link}">{title}</a></li> - {/menuitems}</ul>'; - - $data = array( - 'menuitems' => array( - array('title' => 'First Link', 'link' => '/first'), - array('title' => 'Second Link', 'link' => '/second'), - ) - ); - $this->parser->parse_string($template, $data); - -Result:: - - <ul> - <li><a href="/first">First Link</a></li> - <li><a href="/second">Second Link</a></li> - </ul> - -An example with the iteration controlled in the controller, -using a view fragment:: - - $temp = ''; - $template1 = '<li><a href="{link}">{title}</a></li>'; - $data1 = array( - array('title' => 'First Link', 'link' => '/first'), - array('title' => 'Second Link', 'link' => '/second'), - ); - - foreach ($data1 as $menuitem) - { - $temp .= $this->parser->parse_string($template1, $menuitem, TRUE); - } - - $template = '<ul>{menuitems}</ul>'; - $data = array( - 'menuitems' => $temp - ); - $this->parser->parse_string($template, $data); - -Result:: - - <ul> - <li><a href="/first">First Link</a></li> - <li><a href="/second">Second Link</a></li> - </ul> - -*************** -Class Reference -*************** - -.. php:class:: CI_Parser - - .. php:method:: parse($template, $data[, $return = FALSE]) - - :param string $template: Path to view file - :param array $data: Variable data - :param bool $return: Whether to only return the parsed template - :returns: Parsed template string - :rtype: string - - Parses a template from the provided path and variables. - - .. php:method:: parse_string($template, $data[, $return = FALSE]) - - :param string $template: Path to view file - :param array $data: Variable data - :param bool $return: Whether to only return the parsed template - :returns: Parsed template string - :rtype: string - - This method works exactly like ``parse()``, only it accepts - the template as a string instead of loading a view file. - - .. php:method:: set_delimiters([$l = '{'[, $r = '}']]) - - :param string $l: Left delimiter - :param string $r: Right delimiter - :rtype: void - - Sets the delimiters (opening and closing) for a - pseudo-variable "tag" in a template.
\ No newline at end of file diff --git a/user_guide_src/source/libraries/security.rst b/user_guide_src/source/libraries/security.rst deleted file mode 100644 index 868112684..000000000 --- a/user_guide_src/source/libraries/security.rst +++ /dev/null @@ -1,172 +0,0 @@ -############## -Security Class -############## - -The Security Class contains methods that help you create a secure -application, processing input data for security. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -************* -XSS Filtering -************* - -CodeIgniter comes with a Cross Site Scripting prevention filter, which -looks for commonly used techniques to trigger JavaScript or other types -of code that attempt to hijack cookies or do other malicious things. -If anything disallowed is encountered it is rendered safe by converting -the data to character entities. - -To filter data through the XSS filter use the ``xss_clean()`` method:: - - $data = $this->security->xss_clean($data); - -An optional second parameter, *is_image*, allows this function to be used -to test images for potential XSS attacks, useful for file upload -security. When this second parameter is set to TRUE, instead of -returning an altered string, the function returns TRUE if the image is -safe, and FALSE if it contained potentially malicious information that a -browser may attempt to execute. - -:: - - if ($this->security->xss_clean($file, TRUE) === FALSE) - { - // file failed the XSS test - } - -.. important:: If you want to filter HTML attribute values, use - :php:func:`html_escape()` instead! - -********************************* -Cross-site request forgery (CSRF) -********************************* - -You can enable CSRF protection by altering your **application/config/config.php** -file in the following way:: - - $config['csrf_protection'] = TRUE; - -If you use the :doc:`form helper <../helpers/form_helper>`, then -:func:`form_open()` will automatically insert a hidden csrf field in -your forms. If not, then you can use ``get_csrf_token_name()`` -and ``get_csrf_hash()`` -:: - - $csrf = array( - 'name' => $this->security->get_csrf_token_name(), - 'hash' => $this->security->get_csrf_hash() - ); - - ... - - <input type="hidden" name="<?=$csrf['name'];?>" value="<?=$csrf['hash'];?>" /> - -Tokens may be either regenerated on every submission (default) or -kept the same throughout the life of the CSRF cookie. The default -regeneration of tokens provides stricter security, but may result -in usability concerns as other tokens become invalid (back/forward -navigation, multiple tabs/windows, asynchronous actions, etc). You -may alter this behavior by editing the following config parameter - -:: - - $config['csrf_regenerate'] = TRUE; - -Select URIs can be whitelisted from csrf protection (for example API -endpoints expecting externally POSTed content). You can add these URIs -by editing the 'csrf_exclude_uris' config parameter:: - - $config['csrf_exclude_uris'] = array('api/person/add'); - -Regular expressions are also supported (case-insensitive):: - - $config['csrf_exclude_uris'] = array( - 'api/record/[0-9]+', - 'api/title/[a-z]+' - ); - -*************** -Class Reference -*************** - -.. php:class:: CI_Security - - .. php:method:: xss_clean($str[, $is_image = FALSE]) - - :param mixed $str: Input string or an array of strings - :returns: XSS-clean data - :rtype: mixed - - Tries to remove XSS exploits from the input data and returns the cleaned string. - If the optional second parameter is set to true, it will return boolean TRUE if - the image is safe to use and FALSE if malicious data was detected in it. - - .. important:: This method is not suitable for filtering HTML attribute values! - Use :php:func:`html_escape()` for that instead. - - .. php:method:: sanitize_filename($str[, $relative_path = FALSE]) - - :param string $str: File name/path - :param bool $relative_path: Whether to preserve any directories in the file path - :returns: Sanitized file name/path - :rtype: string - - Tries to sanitize filenames in order to prevent directory traversal attempts - and other security threats, which is particularly useful for files that were supplied via user input. - :: - - $filename = $this->security->sanitize_filename($this->input->post('filename')); - - If it is acceptable for the user input to include relative paths, e.g. - *file/in/some/approved/folder.txt*, you can set the second optional parameter, ``$relative_path`` to TRUE. - :: - - $filename = $this->security->sanitize_filename($this->input->post('filename'), TRUE); - - .. php:method:: get_csrf_token_name() - - :returns: CSRF token name - :rtype: string - - Returns the CSRF token name (the ``$config['csrf_token_name']`` value). - - .. php:method:: get_csrf_hash() - - :returns: CSRF hash - :rtype: string - - Returns the CSRF hash value. Useful in combination with ``get_csrf_token_name()`` - for manually building forms or sending valid AJAX POST requests. - - .. php:method:: entity_decode($str[, $charset = NULL]) - - :param string $str: Input string - :param string $charset: Character set of the input string - :returns: Entity-decoded string - :rtype: string - - This method acts a lot like PHP's own native ``html_entity_decode()`` function in ENT_COMPAT mode, only - it tries to detect HTML entities that don't end in a semicolon because some browsers allow that. - - If the ``$charset`` parameter is left empty, then your configured ``$config['charset']`` value will be used. - - .. php:method:: get_random_bytes($length) - - :param int $length: Output length - :returns: A binary stream of random bytes or FALSE on failure - :rtype: string - - A convenience method for getting proper random bytes via ``mcrypt_create_iv()``, - ``/dev/urandom`` or ``openssl_random_pseudo_bytes()`` (in that order), if one - of them is available. - - Used for generating CSRF and XSS tokens. - - .. note:: The output is NOT guaranteed to be cryptographically secure, - just the best attempt at that. diff --git a/user_guide_src/source/libraries/sessions.rst b/user_guide_src/source/libraries/sessions.rst deleted file mode 100644 index 994dc2e08..000000000 --- a/user_guide_src/source/libraries/sessions.rst +++ /dev/null @@ -1,1062 +0,0 @@ -############### -Session Library -############### - -The Session class permits you maintain a user's "state" and track their -activity while they browse your site. - -CodeIgniter comes with a few session storage drivers: - - - files (default; file-system based) - - database - - redis - - memcached - -In addition, you may create your own, custom session drivers based on other -kinds of storage, while still taking advantage of the features of the -Session class. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -*********************** -Using the Session Class -*********************** - -Initializing a Session -====================== - -Sessions will typically run globally with each page load, so the Session -class should either be initialized in your :doc:`controller -<../general/controllers>` constructors, or it can be :doc:`auto-loaded -<../general/autoloader>` by the system. -For the most part the session class will run unattended in the background, -so simply initializing the class will cause it to read, create, and update -sessions when necessary. - -To initialize the Session class manually in your controller constructor, -use the ``$this->load->library()`` method:: - - $this->load->library('session'); - -Once loaded, the Sessions library object will be available using:: - - $this->session - -.. important:: Because the :doc:`Loader Class </libraries/loader>` is instantiated - by CodeIgniter's base controller, make sure to call - ``parent::__construct()`` before trying to load a library from - inside a controller constructor. - -How do Sessions work? -===================== - -When a page is loaded, the session class will check to see if valid -session cookie is sent by the user's browser. If a sessions cookie does -**not** exist (or if it doesn't match one stored on the server or has -expired) a new session will be created and saved. - -If a valid session does exist, its information will be updated. With each -update, the session ID may be regenerated if configured to do so. - -It's important for you to understand that once initialized, the Session -class runs automatically. There is nothing you need to do to cause the -above behavior to happen. You can, as you'll see below, work with session -data, but the process of reading, writing, and updating a session is -automatic. - -.. note:: Under CLI, the Session library will automatically halt itself, - as this is a concept based entirely on the HTTP protocol. - -A note about concurrency ------------------------- - -Unless you're developing a website with heavy AJAX usage, you can skip this -section. If you are, however, and if you're experiencing performance -issues, then this note is exactly what you're looking for. - -Sessions in previous versions of CodeIgniter didn't implement locking, -which meant that two HTTP requests using the same session could run exactly -at the same time. To use a more appropriate technical term - requests were -non-blocking. - -However, non-blocking requests in the context of sessions also means -unsafe, because modifications to session data (or session ID regeneration) -in one request can interfere with the execution of a second, concurrent -request. This detail was at the root of many issues and the main reason why -CodeIgniter 3.0 has a completely re-written Session library. - -Why are we telling you this? Because it is likely that after trying to -find the reason for your performance issues, you may conclude that locking -is the issue and therefore look into how to remove the locks ... - -DO NOT DO THAT! Removing locks would be **wrong** and it will cause you -more problems! - -Locking is not the issue, it is a solution. Your issue is that you still -have the session open, while you've already processed it and therefore no -longer need it. So, what you need is to close the session for the -current request after you no longer need it. - -Long story short - call ``session_write_close()`` once you no longer need -anything to do with session variables. - -What is Session Data? -===================== - -Session data is simply an array associated with a particular session ID -(cookie). - -If you've used sessions in PHP before, you should be familiar with PHP's -`$_SESSION superglobal <http://php.net/manual/en/reserved.variables.session.php>`_ -(if not, please read the content on that link). - -CodeIgniter gives access to its session data through the same means, as it -uses the session handlers' mechanism provided by PHP. Using session data is -as simple as manipulating (read, set and unset values) the ``$_SESSION`` -array. - -In addition, CodeIgniter also provides 2 special types of session data -that are further explained below: flashdata and tempdata. - -.. note:: In previous versions, regular session data in CodeIgniter was - referred to as 'userdata'. Have this in mind if that term is used - elsewhere in the manual. Most of it is written to explain how - the custom 'userdata' methods work. - -Retrieving Session Data -======================= - -Any piece of information from the session array is available through the -``$_SESSION`` superglobal:: - - $_SESSION['item'] - -Or through the magic getter:: - - $this->session->item - -And for backwards compatibility, through the ``userdata()`` method:: - - $this->session->userdata('item'); - -Where item is the array key corresponding to the item you wish to fetch. -For example, to assign a previously stored 'name' item to the ``$name`` -variable, you will do this:: - - $name = $_SESSION['name']; - - // or: - - $name = $this->session->name - - // or: - - $name = $this->session->userdata('name'); - -.. note:: The ``userdata()`` method returns NULL if the item you are trying - to access does not exist. - -If you want to retrieve all of the existing userdata, you can simply -omit the item key (magic getter only works for properties):: - - $_SESSION - - // or: - - $this->session->userdata(); - -Adding Session Data -=================== - -Let's say a particular user logs into your site. Once authenticated, you -could add their username and e-mail address to the session, making that -data globally available to you without having to run a database query when -you need it. - -You can simply assign data to the ``$_SESSION`` array, as with any other -variable. Or as a property of ``$this->session``. - -Alternatively, the old method of assigning it as "userdata" is also -available. That however passing an array containing your new data to the -``set_userdata()`` method:: - - $this->session->set_userdata($array); - -Where ``$array`` is an associative array containing your new data. Here's -an example:: - - $newdata = array( - 'username' => 'johndoe', - 'email' => 'johndoe@some-site.com', - 'logged_in' => TRUE - ); - - $this->session->set_userdata($newdata); - -If you want to add userdata one value at a time, ``set_userdata()`` also -supports this syntax:: - - $this->session->set_userdata('some_name', 'some_value'); - -If you want to verify that a session value exists, simply check with -``isset()``:: - - // returns FALSE if the 'some_name' item doesn't exist or is NULL, - // TRUE otherwise: - isset($_SESSION['some_name']) - -Or you can call ``has_userdata()``:: - - $this->session->has_userdata('some_name'); - -Removing Session Data -===================== - -Just as with any other variable, unsetting a value in ``$_SESSION`` can be -done through ``unset()``:: - - unset($_SESSION['some_name']); - - // or multiple values: - - unset( - $_SESSION['some_name'], - $_SESSION['another_name'] - ); - -Also, just as ``set_userdata()`` can be used to add information to a -session, ``unset_userdata()`` can be used to remove it, by passing the -session key. For example, if you wanted to remove 'some_name' from your -session data array:: - - $this->session->unset_userdata('some_name'); - -This method also accepts an array of item keys to unset:: - - $array_items = array('username', 'email'); - - $this->session->unset_userdata($array_items); - -.. note:: In previous versions, the ``unset_userdata()`` method used - to accept an associative array of ``key => 'dummy value'`` - pairs. This is no longer supported. - -Flashdata -========= - -CodeIgniter supports "flashdata", or session data that will only be -available for the next request, and is then automatically cleared. - -This can be very useful, especially for one-time informational, error or -status messages (for example: "Record 2 deleted"). - -It should be noted that flashdata variables are regular session vars, -only marked in a specific way under the '__ci_vars' key (please don't touch -that one, you've been warned). - -To mark an existing item as "flashdata":: - - $this->session->mark_as_flash('item'); - -If you want to mark multiple items as flashdata, simply pass the keys as an -array:: - - $this->session->mark_as_flash(array('item', 'item2')); - -To add flashdata:: - - $_SESSION['item'] = 'value'; - $this->session->mark_as_flash('item'); - -Or alternatively, using the ``set_flashdata()`` method:: - - $this->session->set_flashdata('item', 'value'); - -You can also pass an array to ``set_flashdata()``, in the same manner as -``set_userdata()``. - -Reading flashdata variables is the same as reading regular session data -through ``$_SESSION``:: - - $_SESSION['item'] - -.. important:: The ``userdata()`` method will NOT return flashdata items. - -However, if you want to be sure that you're reading "flashdata" (and not -any other kind), you can also use the ``flashdata()`` method:: - - $this->session->flashdata('item'); - -Or to get an array with all flashdata, simply omit the key parameter:: - - $this->session->flashdata(); - -.. note:: The ``flashdata()`` method returns NULL if the item cannot be - found. - -If you find that you need to preserve a flashdata variable through an -additional request, you can do so using the ``keep_flashdata()`` method. -You can either pass a single item or an array of flashdata items to keep. - -:: - - $this->session->keep_flashdata('item'); - $this->session->keep_flashdata(array('item1', 'item2', 'item3')); - -Tempdata -======== - -CodeIgniter also supports "tempdata", or session data with a specific -expiration time. After the value expires, or the session expires or is -deleted, the value is automatically removed. - -Similarly to flashdata, tempdata variables are regular session vars that -are marked in a specific way under the '__ci_vars' key (again, don't touch -that one). - -To mark an existing item as "tempdata", simply pass its key and expiry time -(in seconds!) to the ``mark_as_temp()`` method:: - - // 'item' will be erased after 300 seconds - $this->session->mark_as_temp('item', 300); - -You can mark multiple items as tempdata in two ways, depending on whether -you want them all to have the same expiry time or not:: - - // Both 'item' and 'item2' will expire after 300 seconds - $this->session->mark_as_temp(array('item', 'item2'), 300); - - // 'item' will be erased after 300 seconds, while 'item2' - // will do so after only 240 seconds - $this->session->mark_as_temp(array( - 'item' => 300, - 'item2' => 240 - )); - -To add tempdata:: - - $_SESSION['item'] = 'value'; - $this->session->mark_as_temp('item', 300); // Expire in 5 minutes - -Or alternatively, using the ``set_tempdata()`` method:: - - $this->session->set_tempdata('item', 'value', 300); - -You can also pass an array to ``set_tempdata()``:: - - $tempdata = array('newuser' => TRUE, 'message' => 'Thanks for joining!'); - - $this->session->set_tempdata($tempdata, NULL, $expire); - -.. note:: If the expiration is omitted or set to 0, the default - time-to-live value of 300 seconds (or 5 minutes) will be used. - -To read a tempdata variable, again you can just access it through the -``$_SESSION`` superglobal array:: - - $_SESSION['item'] - -.. important:: The ``userdata()`` method will NOT return tempdata items. - -Or if you want to be sure that you're reading "tempdata" (and not any -other kind), you can also use the ``tempdata()`` method:: - - $this->session->tempdata('item'); - -And of course, if you want to retrieve all existing tempdata:: - - $this->session->tempdata(); - -.. note:: The ``tempdata()`` method returns NULL if the item cannot be - found. - -If you need to remove a tempdata value before it expires, you can directly -unset it from the ``$_SESSION`` array:: - - unset($_SESSION['item']); - -However, this won't remove the marker that makes this specific item to be -tempdata (it will be invalidated on the next HTTP request), so if you -intend to reuse that same key in the same request, you'd want to use -``unset_tempdata()``:: - - $this->session->unset_tempdata('item'); - -Destroying a Session -==================== - -To clear the current session (for example, during a logout), you may -simply use either PHP's `session_destroy() <http://php.net/session_destroy>`_ -function, or the ``sess_destroy()`` method. Both will work in exactly the -same way:: - - session_destroy(); - - // or - - $this->session->sess_destroy(); - -.. note:: This must be the last session-related operation that you do - during the same request. All session data (including flashdata and - tempdata) will be destroyed permanently and functions will be - unusable during the same request after you destroy the session. - -Accessing session metadata -========================== - -In previous CodeIgniter versions, the session data array included 4 items -by default: 'session_id', 'ip_address', 'user_agent', 'last_activity'. - -This was due to the specifics of how sessions worked, but is now no longer -necessary with our new implementation. However, it may happen that your -application relied on these values, so here are alternative methods of -accessing them: - - - session_id: ``session_id()`` - - ip_address: ``$_SERVER['REMOTE_ADDR']`` - - user_agent: ``$this->input->user_agent()`` (unused by sessions) - - last_activity: Depends on the storage, no straightforward way. Sorry! - -Session Preferences -=================== - -CodeIgniter will usually make everything work out of the box. However, -Sessions are a very sensitive component of any application, so some -careful configuration must be done. Please take your time to consider -all of the options and their effects. - -You'll find the following Session related preferences in your -**application/config/config.php** file: - -============================ =============== ======================================== ============================================================================================ -Preference Default Options Description -============================ =============== ======================================== ============================================================================================ -**sess_driver** files files/database/redis/memcached/*custom* The session storage driver to use. -**sess_cookie_name** ci_session [A-Za-z\_-] characters only The name used for the session cookie. -**sess_expiration** 7200 (2 hours) Time in seconds (integer) The number of seconds you would like the session to last. - If you would like a non-expiring session (until browser is closed) set the value to zero: 0 -**sess_save_path** NULL None Specifies the storage location, depends on the driver being used. -**sess_match_ip** FALSE TRUE/FALSE (boolean) Whether to validate the user's IP address when reading the session cookie. - Note that some ISPs dynamically changes the IP, so if you want a non-expiring session you - will likely set this to FALSE. -**sess_time_to_update** 300 Time in seconds (integer) This option controls how often the session class will regenerate itself and create a new - session ID. Setting it to 0 will disable session ID regeneration. -**sess_regenerate_destroy** FALSE TRUE/FALSE (boolean) Whether to destroy session data associated with the old session ID when auto-regenerating - the session ID. When set to FALSE, the data will be later deleted by the garbage collector. -============================ =============== ======================================== ============================================================================================ - -.. note:: As a last resort, the Session library will try to fetch PHP's - session related INI settings, as well as legacy CI settings such as - 'sess_expire_on_close' when any of the above is not configured. - However, you should never rely on this behavior as it can cause - unexpected results or be changed in the future. Please configure - everything properly. - -In addition to the values above, the cookie and native drivers apply the -following configuration values shared by the :doc:`Input <input>` and -:doc:`Security <security>` classes: - -================== =============== =========================================================================== -Preference Default Description -================== =============== =========================================================================== -**cookie_domain** '' The domain for which the session is applicable -**cookie_path** / The path to which the session is applicable -**cookie_secure** FALSE Whether to create the session cookie only on encrypted (HTTPS) connections -================== =============== =========================================================================== - -.. note:: The 'cookie_httponly' setting doesn't have an effect on sessions. - Instead the HttpOnly parameter is always enabled, for security - reasons. Additionally, the 'cookie_prefix' setting is completely - ignored. - -Session Drivers -=============== - -As already mentioned, the Session library comes with 4 drivers, or storage -engines, that you can use: - - - files - - database - - redis - - memcached - -By default, the `Files Driver`_ will be used when a session is initialized, -because it is the most safe choice and is expected to work everywhere -(virtually every environment has a file system). - -However, any other driver may be selected via the ``$config['sess_driver']`` -line in your **application/config/config.php** file, if you chose to do so. -Have it in mind though, every driver has different caveats, so be sure to -get yourself familiar with them (below) before you make that choice. - -In addition, you may also create and use `Custom Drivers`_, if the ones -provided by default don't satisfy your use case. - -.. note:: In previous CodeIgniter versions, a different, "cookie driver" - was the only option and we have received negative feedback on not - providing that option. While we do listen to feedback from the - community, we want to warn you that it was dropped because it is - **unsafe** and we advise you NOT to try to replicate it via a - custom driver. - -Files Driver ------------- - -The 'files' driver uses your file system for storing session data. - -It can safely be said that it works exactly like PHP's own default session -implementation, but in case this is an important detail for you, have it -mind that it is in fact not the same code and it has some limitations -(and advantages). - -To be more specific, it doesn't support PHP's `directory level and mode -formats used in session.save_path -<http://php.net/manual/en/session.configuration.php#ini.session.save-path>`_, -and it has most of the options hard-coded for safety. Instead, only -absolute paths are supported for ``$config['sess_save_path']``. - -Another important thing that you should know, is to make sure that you -don't use a publicly-readable or shared directory for storing your session -files. Make sure that *only you* have access to see the contents of your -chosen *sess_save_path* directory. Otherwise, anybody who can do that, can -also steal any of the current sessions (also known as "session fixation" -attack). - -On UNIX-like operating systems, this is usually achieved by setting the -0700 mode permissions on that directory via the `chmod` command, which -allows only the directory's owner to perform read and write operations on -it. But be careful because the system user *running* the script is usually -not your own, but something like 'www-data' instead, so only setting those -permissions will probable break your application. - -Instead, you should do something like this, depending on your environment -:: - - mkdir /<path to your application directory>/sessions/ - chmod 0700 /<path to your application directory>/sessions/ - chown www-data /<path to your application directory>/sessions/ - -Bonus Tip -^^^^^^^^^ - -Some of you will probably opt to choose another session driver because -file storage is usually slower. This is only half true. - -A very basic test will probably trick you into believing that an SQL -database is faster, but in 99% of the cases, this is only true while you -only have a few current sessions. As the sessions count and server loads -increase - which is the time when it matters - the file system will -consistently outperform almost all relational database setups. - -In addition, if performance is your only concern, you may want to look -into using `tmpfs <http://eddmann.com/posts/storing-php-sessions-file-caches-in-memory-using-tmpfs/>`_, -(warning: external resource), which can make your sessions blazing fast. - -Database Driver ---------------- - -The 'database' driver uses a relational database such as MySQL or -PostgreSQL to store sessions. This is a popular choice among many users, -because it allows the developer easy access to the session data within -an application - it is just another table in your database. - -However, there are some conditions that must be met: - - - Only your **default** database connection (or the one that you access - as ``$this->db`` from your controllers) can be used. - - You must have the :doc:`Query Builder </database/query_builder>` - enabled. - - You can NOT use a persistent connection. - - You can NOT use a connection with the *cache_on* setting enabled. - -In order to use the 'database' session driver, you must also create this -table that we already mentioned and then set it as your -``$config['sess_save_path']`` value. -For example, if you would like to use 'ci_sessions' as your table name, -you would do this:: - - $config['sess_driver'] = 'database'; - $config['sess_save_path'] = 'ci_sessions'; - -.. note:: If you've upgraded from a previous version of CodeIgniter and - you don't have 'sess_save_path' configured, then the Session - library will look for the old 'sess_table_name' setting and use - it instead. Please don't rely on this behavior as it will get - removed in the future. - -And then of course, create the database table ... - -For MySQL:: - - CREATE TABLE IF NOT EXISTS `ci_sessions` ( - `id` varchar(128) NOT NULL, - `ip_address` varchar(45) NOT NULL, - `timestamp` int(10) unsigned DEFAULT 0 NOT NULL, - `data` blob NOT NULL, - KEY `ci_sessions_timestamp` (`timestamp`) - ); - -For PostgreSQL:: - - CREATE TABLE "ci_sessions" ( - "id" varchar(128) NOT NULL, - "ip_address" varchar(45) NOT NULL, - "timestamp" bigint DEFAULT 0 NOT NULL, - "data" text DEFAULT '' NOT NULL - ); - - CREATE INDEX "ci_sessions_timestamp" ON "ci_sessions" ("timestamp"); - -You will also need to add a PRIMARY KEY **depending on your 'sess_match_ip' -setting**. The examples below work both on MySQL and PostgreSQL:: - - // When sess_match_ip = TRUE - ALTER TABLE ci_sessions ADD PRIMARY KEY (id, ip_address); - - // When sess_match_ip = FALSE - ALTER TABLE ci_sessions ADD PRIMARY KEY (id); - - // To drop a previously created primary key (use when changing the setting) - ALTER TABLE ci_sessions DROP PRIMARY KEY; - - -.. important:: Only MySQL and PostgreSQL databases are officially - supported, due to lack of advisory locking mechanisms on other - platforms. Using sessions without locks can cause all sorts of - problems, especially with heavy usage of AJAX, and we will not - support such cases. Use ``session_write_close()`` after you've - done processing session data if you're having performance - issues. - -Redis Driver ------------- - -.. note:: Since Redis doesn't have a locking mechanism exposed, locks for - this driver are emulated by a separate value that is kept for up - to 300 seconds. - -Redis is a storage engine typically used for caching and popular because -of its high performance, which is also probably your reason to use the -'redis' session driver. - -The downside is that it is not as ubiquitous as relational databases and -requires the `phpredis <https://github.com/phpredis/phpredis>`_ PHP -extension to be installed on your system, and that one doesn't come -bundled with PHP. -Chances are, you're only be using the 'redis' driver only if you're already -both familiar with Redis and using it for other purposes. - -Just as with the 'files' and 'database' drivers, you must also configure -the storage location for your sessions via the -``$config['sess_save_path']`` setting. -The format here is a bit different and complicated at the same time. It is -best explained by the *phpredis* extension's README file, so we'll simply -link you to it: - - https://github.com/phpredis/phpredis#php-session-handler - -.. warning:: CodeIgniter's Session library does NOT use the actual 'redis' - ``session.save_handler``. Take note **only** of the path format in - the link above. - -For the most common case however, a simple ``host:port`` pair should be -sufficient:: - - $config['sess_driver'] = 'redis'; - $config['sess_save_path'] = 'tcp://localhost:6379'; - -Memcached Driver ----------------- - -.. note:: Since Memcache doesn't have a locking mechanism exposed, locks - for this driver are emulated by a separate value that is kept for - up to 300 seconds. - -The 'memcached' driver is very similar to the 'redis' one in all of its -properties, except perhaps for availability, because PHP's `Memcached -<http://php.net/memcached>`_ extension is distributed via PECL and some -Linux distrubutions make it available as an easy to install package. - -Other than that, and without any intentional bias towards Redis, there's -not much different to be said about Memcached - it is also a popular -product that is usually used for caching and famed for its speed. - -However, it is worth noting that the only guarantee given by Memcached -is that setting value X to expire after Y seconds will result in it being -deleted after Y seconds have passed (but not necessarily that it won't -expire earlier than that time). This happens very rarely, but should be -considered as it may result in loss of sessions. - -The ``$config['sess_save_path']`` format is fairly straightforward here, -being just a ``host:port`` pair:: - - $config['sess_driver'] = 'memcached'; - $config['sess_save_path'] = 'localhost:11211'; - -Bonus Tip -^^^^^^^^^ - -Multi-server configuration with an optional *weight* parameter as the -third colon-separated (``:weight``) value is also supported, but we have -to note that we haven't tested if that is reliable. - -If you want to experiment with this feature (on your own risk), simply -separate the multiple server paths with commas:: - - // localhost will be given higher priority (5) here, - // compared to 192.0.2.1 with a weight of 1. - $config['sess_save_path'] = 'localhost:11211:5,192.0.2.1:11211:1'; - -Custom Drivers --------------- - -You may also create your own, custom session drivers. However, have it in -mind that this is typically not an easy task, as it takes a lot of -knowledge to do it properly. - -You need to know not only how sessions work in general, but also how they -work specifically in PHP, how the underlying storage mechanism works, how -to handle concurrency, avoid deadlocks (but NOT through lack of locks) and -last but not least - how to handle the potential security issues, which -is far from trivial. - -Long story short - if you don't know how to do that already in raw PHP, -you shouldn't be trying to do it within CodeIgniter either. You've been -warned. - -If you only want to add some extra functionality to your sessions, just -extend the base Session class, which is a lot more easier. Read the -:doc:`Creating Libraries <../general/creating_libraries>` article to -learn how to do that. - -Now, to the point - there are three general rules that you must follow -when creating a session driver for CodeIgniter: - - - Put your driver's file under **application/libraries/Session/drivers/** - and follow the naming conventions used by the Session class. - - For example, if you were to create a 'dummy' driver, you would have - a ``Session_dummy_driver`` class name, that is declared in - *application/libraries/Session/drivers/Session_dummy_driver.php*. - - - Extend the ``CI_Session_driver`` class. - - This is just a basic class with a few internal helper methods. It is - also extendable like any other library, if you really need to do that, - but we are not going to explain how ... if you're familiar with how - class extensions/overrides work in CI, then you already know how to do - it. If not, well, you shouldn't be doing it in the first place. - - - - Implement the `SessionHandlerInterface - <http://php.net/sessionhandlerinterface>`_ interface. - - .. note:: You may notice that ``SessionHandlerInterface`` is provided - by PHP since version 5.4.0. CodeIgniter will automatically declare - the same interface if you're running an older PHP version. - - The link will explain why and how. - -So, based on our 'dummy' driver example above, you'd end up with something -like this:: - - // application/libraries/Session/drivers/Session_dummy_driver.php: - - class CI_Session_dummy_driver extends CI_Session_driver implements SessionHandlerInterface - { - - public function __construct(&$params) - { - // DO NOT forget this - parent::__construct($params); - - // Configuration & other initializations - } - - public function open($save_path, $name) - { - // Initialize storage mechanism (connection) - } - - public function read($session_id) - { - // Read session data (if exists), acquire locks - } - - public function write($session_id, $session_data) - { - // Create / update session data (it might not exist!) - } - - public function close() - { - // Free locks, close connections / streams / etc. - } - - public function destroy($session_id) - { - // Call close() method & destroy data for current session (order may differ) - } - - public function gc($maxlifetime) - { - // Erase data for expired sessions - } - - } - -If you've done everything properly, you can now set your *sess_driver* -configuration value to 'dummy' and use your own driver. Congratulations! - -*************** -Class Reference -*************** - -.. php:class:: CI_Session - - .. php:method:: userdata([$key = NULL]) - - :param mixed $key: Session item key or NULL - :returns: Value of the specified item key, or an array of all userdata - :rtype: mixed - - Gets the value for a specific ``$_SESSION`` item, or an - array of all "userdata" items if not key was specified. - - .. note:: This is a legacy method kept only for backwards - compatibility with older applications. You should - directly access ``$_SESSION`` instead. - - .. php:method:: all_userdata() - - :returns: An array of all userdata - :rtype: array - - Returns an array containing all "userdata" items. - - .. note:: This method is DEPRECATED. Use ``userdata()`` - with no parameters instead. - - .. php:method:: &get_userdata() - - :returns: A reference to ``$_SESSION`` - :rtype: array - - Returns a reference to the ``$_SESSION`` array. - - .. note:: This is a legacy method kept only for backwards - compatibility with older applications. - - .. php:method:: has_userdata($key) - - :param string $key: Session item key - :returns: TRUE if the specified key exists, FALSE if not - :rtype: bool - - Checks if an item exists in ``$_SESSION``. - - .. note:: This is a legacy method kept only for backwards - compatibility with older applications. It is just - an alias for ``isset($_SESSION[$key])`` - please - use that instead. - - .. php:method:: set_userdata($data[, $value = NULL]) - - :param mixed $data: An array of key/value pairs to set as session data, or the key for a single item - :param mixed $value: The value to set for a specific session item, if $data is a key - :rtype: void - - Assigns data to the ``$_SESSION`` superglobal. - - .. note:: This is a legacy method kept only for backwards - compatibility with older applications. - - .. php:method:: unset_userdata($key) - - :param mixed $key: Key for the session data item to unset, or an array of multiple keys - :rtype: void - - Unsets the specified key(s) from the ``$_SESSION`` - superglobal. - - .. note:: This is a legacy method kept only for backwards - compatibility with older applications. It is just - an alias for ``unset($_SESSION[$key])`` - please - use that instead. - - .. php:method:: mark_as_flash($key) - - :param mixed $key: Key to mark as flashdata, or an array of multiple keys - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Marks a ``$_SESSION`` item key (or multiple ones) as - "flashdata". - - .. php:method:: get_flash_keys() - - :returns: Array containing the keys of all "flashdata" items. - :rtype: array - - Gets a list of all ``$_SESSION`` that have been marked as - "flashdata". - - .. php:method:: unmark_flash($key) - - :param mixed $key: Key to be un-marked as flashdata, or an array of multiple keys - :rtype: void - - Unmarks a ``$_SESSION`` item key (or multiple ones) as - "flashdata". - - .. php:method:: flashdata([$key = NULL]) - - :param mixed $key: Flashdata item key or NULL - :returns: Value of the specified item key, or an array of all flashdata - :rtype: mixed - - Gets the value for a specific ``$_SESSION`` item that has - been marked as "flashdata", or an array of all "flashdata" - items if no key was specified. - - .. note:: This is a legacy method kept only for backwards - compatibility with older applications. You should - directly access ``$_SESSION`` instead. - - .. php:method:: keep_flashdata($key) - - :param mixed $key: Flashdata key to keep, or an array of multiple keys - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Retains the specified session data key(s) as "flashdata" - through the next request. - - .. note:: This is a legacy method kept only for backwards - compatibility with older applications. It is just - an alias for the ``mark_as_flash()`` method. - - .. php:method:: set_flashdata($data[, $value = NULL]) - - :param mixed $data: An array of key/value pairs to set as flashdata, or the key for a single item - :param mixed $value: The value to set for a specific session item, if $data is a key - :rtype: void - - Assigns data to the ``$_SESSION`` superglobal and marks it - as "flashdata". - - .. note:: This is a legacy method kept only for backwards - compatibility with older applications. - - .. php:method:: mark_as_temp($key[, $ttl = 300]) - - :param mixed $key: Key to mark as tempdata, or an array of multiple keys - :param int $ttl: Time-to-live value for the tempdata, in seconds - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Marks a ``$_SESSION`` item key (or multiple ones) as - "tempdata". - - .. php:method:: get_temp_keys() - - :returns: Array containing the keys of all "tempdata" items. - :rtype: array - - Gets a list of all ``$_SESSION`` that have been marked as - "tempdata". - - .. php:method:: unmark_temp($key) - - :param mixed $key: Key to be un-marked as tempdata, or an array of multiple keys - :rtype: void - - Unmarks a ``$_SESSION`` item key (or multiple ones) as - "tempdata". - - .. php:method:: tempdata([$key = NULL]) - - :param mixed $key: Tempdata item key or NULL - :returns: Value of the specified item key, or an array of all tempdata - :rtype: mixed - - Gets the value for a specific ``$_SESSION`` item that has - been marked as "tempdata", or an array of all "tempdata" - items if no key was specified. - - .. note:: This is a legacy method kept only for backwards - compatibility with older applications. You should - directly access ``$_SESSION`` instead. - - .. php:method:: set_tempdata($data[, $value = NULL]) - - :param mixed $data: An array of key/value pairs to set as tempdata, or the key for a single item - :param mixed $value: The value to set for a specific session item, if $data is a key - :param int $ttl: Time-to-live value for the tempdata item(s), in seconds - :rtype: void - - Assigns data to the ``$_SESSION`` superglobal and marks it - as "tempdata". - - .. note:: This is a legacy method kept only for backwards - compatibility with older applications. - - .. php:method:: sess_regenerate([$destroy = FALSE]) - - :param bool $destroy: Whether to destroy session data - :rtype: void - - Regenerate session ID, optionally destroying the current - session's data. - - .. note:: This method is just an alias for PHP's native - `session_regenerate_id() - <http://php.net/session_regenerate_id>`_ function. - - .. php:method:: sess_destroy() - - :rtype: void - - Destroys the current session. - - .. note:: This must be the *last* session-related function - that you call. All session data will be lost after - you do that. - - .. note:: This method is just an alias for PHP's native - `session_destroy() - <http://php.net/session_destroy>`_ function. - - .. php:method:: __get($key) - - :param string $key: Session item key - :returns: The requested session data item, or NULL if it doesn't exist - :rtype: mixed - - A magic method that allows you to use - ``$this->session->item`` instead of ``$_SESSION['item']``, - if that's what you prefer. - - It will also return the session ID by calling - ``session_id()`` if you try to access - ``$this->session->session_id``. - - .. php:method:: __set($key, $value) - - :param string $key: Session item key - :param mixed $value: Value to assign to the session item key - :returns: void - - A magic method that allows you to assign items to - ``$_SESSION`` by accessing them as ``$this->session`` - properties:: - - $this->session->foo = 'bar'; - - // Results in: - // $_SESSION['foo'] = 'bar'; diff --git a/user_guide_src/source/libraries/table.rst b/user_guide_src/source/libraries/table.rst deleted file mode 100644 index 91ae1ae8d..000000000 --- a/user_guide_src/source/libraries/table.rst +++ /dev/null @@ -1,297 +0,0 @@ -################ -HTML Table Class -################ - -The Table Class provides functions that enable you to auto-generate HTML -tables from arrays or database result sets. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -********************* -Using the Table Class -********************* - -Initializing the Class -====================== - -Like most other classes in CodeIgniter, the Table class is initialized -in your controller using the ``$this->load->library()`` method:: - - $this->load->library('table'); - -Once loaded, the Table library object will be available using:: - - $this->table - -Examples -======== - -Here is an example showing how you can create a table from a -multi-dimensional array. Note that the first array index will become the -table heading (or you can set your own headings using the ``set_heading()`` -method described in the function reference below). - -:: - - $this->load->library('table'); - - $data = array( - array('Name', 'Color', 'Size'), - array('Fred', 'Blue', 'Small'), - array('Mary', 'Red', 'Large'), - array('John', 'Green', 'Medium') - ); - - echo $this->table->generate($data); - -Here is an example of a table created from a database query result. The -table class will automatically generate the headings based on the table -names (or you can set your own headings using the ``set_heading()`` -method described in the class reference below). - -:: - - $this->load->library('table'); - - $query = $this->db->query('SELECT * FROM my_table'); - - echo $this->table->generate($query); - -Here is an example showing how you might create a table using discrete -parameters:: - - $this->load->library('table'); - - $this->table->set_heading('Name', 'Color', 'Size'); - - $this->table->add_row('Fred', 'Blue', 'Small'); - $this->table->add_row('Mary', 'Red', 'Large'); - $this->table->add_row('John', 'Green', 'Medium'); - - echo $this->table->generate(); - -Here is the same example, except instead of individual parameters, -arrays are used:: - - $this->load->library('table'); - - $this->table->set_heading(array('Name', 'Color', 'Size')); - - $this->table->add_row(array('Fred', 'Blue', 'Small')); - $this->table->add_row(array('Mary', 'Red', 'Large')); - $this->table->add_row(array('John', 'Green', 'Medium')); - - echo $this->table->generate(); - -Changing the Look of Your Table -=============================== - -The Table Class permits you to set a table template with which you can -specify the design of your layout. Here is the template prototype:: - - $template = array( - 'table_open' => '<table border="0" cellpadding="4" cellspacing="0">', - - 'thead_open' => '<thead>', - 'thead_close' => '</thead>', - - 'heading_row_start' => '<tr>', - 'heading_row_end' => '</tr>', - 'heading_cell_start' => '<th>', - 'heading_cell_end' => '</th>', - - 'tbody_open' => '<tbody>', - 'tbody_close' => '</tbody>', - - 'row_start' => '<tr>', - 'row_end' => '</tr>', - 'cell_start' => '<td>', - 'cell_end' => '</td>', - - 'row_alt_start' => '<tr>', - 'row_alt_end' => '</tr>', - 'cell_alt_start' => '<td>', - 'cell_alt_end' => '</td>', - - 'table_close' => '</table>' - ); - - $this->table->set_template($template); - -.. note:: You'll notice there are two sets of "row" blocks in the - template. These permit you to create alternating row colors or design - elements that alternate with each iteration of the row data. - -You are NOT required to submit a complete template. If you only need to -change parts of the layout you can simply submit those elements. In this -example, only the table opening tag is being changed:: - - $template = array( - 'table_open' => '<table border="1" cellpadding="2" cellspacing="1" class="mytable">' - ); - - $this->table->set_template($template); - -You can also set defaults for these in a config file. - -*************** -Class Reference -*************** - -.. php:class:: CI_Table - - .. attribute:: $function = NULL - - Allows you to specify a native PHP function or a valid function array object to be applied to all cell data. - :: - - $this->load->library('table'); - - $this->table->set_heading('Name', 'Color', 'Size'); - $this->table->add_row('Fred', '<strong>Blue</strong>', 'Small'); - - $this->table->function = 'htmlspecialchars'; - echo $this->table->generate(); - - In the above example, all cell data would be ran through PHP's :php:func:`htmlspecialchars()` function, resulting in:: - - <td>Fred</td><td><strong>Blue</strong></td><td>Small</td> - - .. php:method:: generate([$table_data = NULL]) - - :param mixed $table_data: Data to populate the table rows with - :returns: HTML table - :rtype: string - - Returns a string containing the generated table. Accepts an optional parameter which can be an array or a database result object. - - .. php:method:: set_caption($caption) - - :param string $caption: Table caption - :returns: CI_Table instance (method chaining) - :rtype: CI_Table - - Permits you to add a caption to the table. - :: - - $this->table->set_caption('Colors'); - - .. php:method:: set_heading([$args = array()[, ...]]) - - :param mixed $args: An array or multiple strings containing the table column titles - :returns: CI_Table instance (method chaining) - :rtype: CI_Table - - Permits you to set the table heading. You can submit an array or discrete params:: - - $this->table->set_heading('Name', 'Color', 'Size'); - - $this->table->set_heading(array('Name', 'Color', 'Size')); - - .. php:method:: add_row([$args = array()[, ...]]) - - :param mixed $args: An array or multiple strings containing the row values - :returns: CI_Table instance (method chaining) - :rtype: CI_Table - - Permits you to add a row to your table. You can submit an array or discrete params:: - - $this->table->add_row('Blue', 'Red', 'Green'); - - $this->table->add_row(array('Blue', 'Red', 'Green')); - - If you would like to set an individual cell's tag attributes, you can use an associative array for that cell. - The associative key **data** defines the cell's data. Any other key => val pairs are added as key='val' attributes to the tag:: - - $cell = array('data' => 'Blue', 'class' => 'highlight', 'colspan' => 2); - $this->table->add_row($cell, 'Red', 'Green'); - - // generates - // <td class='highlight' colspan='2'>Blue</td><td>Red</td><td>Green</td> - - .. php:method:: make_columns([$array = array()[, $col_limit = 0]]) - - :param array $array: An array containing multiple rows' data - :param int $col_limit: Count of columns in the table - :returns: An array of HTML table columns - :rtype: array - - This method takes a one-dimensional array as input and creates a multi-dimensional array with a depth equal to the number of columns desired. - This allows a single array with many elements to be displayed in a table that has a fixed column count. Consider this example:: - - $list = array('one', 'two', 'three', 'four', 'five', 'six', 'seven', 'eight', 'nine', 'ten', 'eleven', 'twelve'); - - $new_list = $this->table->make_columns($list, 3); - - $this->table->generate($new_list); - - // Generates a table with this prototype - - <table border="0" cellpadding="4" cellspacing="0"> - <tr> - <td>one</td><td>two</td><td>three</td> - </tr><tr> - <td>four</td><td>five</td><td>six</td> - </tr><tr> - <td>seven</td><td>eight</td><td>nine</td> - </tr><tr> - <td>ten</td><td>eleven</td><td>twelve</td></tr> - </table> - - - .. php:method:: set_template($template) - - :param array $template: An associative array containing template values - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Permits you to set your template. You can submit a full or partial template. - :: - - $template = array( - 'table_open' => '<table border="1" cellpadding="2" cellspacing="1" class="mytable">' - ); - - $this->table->set_template($template); - - .. php:method:: set_empty($value) - - :param mixed $value: Value to put in empty cells - :returns: CI_Table instance (method chaining) - :rtype: CI_Table - - Lets you set a default value for use in any table cells that are empty. - You might, for example, set a non-breaking space:: - - $this->table->set_empty(" "); - - .. php:method:: clear() - - :returns: CI_Table instance (method chaining) - :rtype: CI_Table - - Lets you clear the table heading and row data. If you need to show multiple tables with different data you should to call this method - after each table has been generated to clear the previous table information. Example:: - - $this->load->library('table'); - - $this->table->set_heading('Name', 'Color', 'Size'); - $this->table->add_row('Fred', 'Blue', 'Small'); - $this->table->add_row('Mary', 'Red', 'Large'); - $this->table->add_row('John', 'Green', 'Medium'); - - echo $this->table->generate(); - - $this->table->clear(); - - $this->table->set_heading('Name', 'Day', 'Delivery'); - $this->table->add_row('Fred', 'Wednesday', 'Express'); - $this->table->add_row('Mary', 'Monday', 'Air'); - $this->table->add_row('John', 'Saturday', 'Overnight'); - - echo $this->table->generate(); diff --git a/user_guide_src/source/libraries/trackback.rst b/user_guide_src/source/libraries/trackback.rst deleted file mode 100644 index dc4477e9f..000000000 --- a/user_guide_src/source/libraries/trackback.rst +++ /dev/null @@ -1,339 +0,0 @@ -############### -Trackback Class -############### - -The Trackback Class provides functions that enable you to send and -receive Trackback data. - -If you are not familiar with Trackbacks you'll find more information -`here <http://en.wikipedia.org/wiki/Trackback>`_. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -************************* -Using the Trackback Class -************************* - -Initializing the Class -====================== - -Like most other classes in CodeIgniter, the Trackback class is -initialized in your controller using the ``$this->load->library()`` method:: - - $this->load->library('trackback'); - -Once loaded, the Trackback library object will be available using:: - - $this->trackback - -Sending Trackbacks -================== - -A Trackback can be sent from any of your controller functions using code -similar to this example:: - - $this->load->library('trackback'); - - $tb_data = array( - 'ping_url' => 'http://example.com/trackback/456', - 'url' => 'http://www.my-example.com/blog/entry/123', - 'title' => 'The Title of My Entry', - 'excerpt' => 'The entry content.', - 'blog_name' => 'My Blog Name', - 'charset' => 'utf-8' - ); - - if ( ! $this->trackback->send($tb_data)) - { - echo $this->trackback->display_errors(); - } - else - { - echo 'Trackback was sent!'; - } - -Description of array data: - -- **ping_url** - The URL of the site you are sending the Trackback to. - You can send Trackbacks to multiple URLs by separating each URL with a comma. -- **url** - The URL to YOUR site where the weblog entry can be seen. -- **title** - The title of your weblog entry. -- **excerpt** - The content of your weblog entry. -- **blog_name** - The name of your weblog. -- **charset** - The character encoding your weblog is written in. If omitted, UTF-8 will be used. - -.. note:: The Trackback class will automatically send only the first 500 characters of your - entry. It will also strip all HTML. - -The Trackback sending method returns TRUE/FALSE (boolean) on success -or failure. If it fails, you can retrieve the error message using:: - - $this->trackback->display_errors(); - -Receiving Trackbacks -==================== - -Before you can receive Trackbacks you must create a weblog. If you don't -have a blog yet there's no point in continuing. - -Receiving Trackbacks is a little more complex than sending them, only -because you will need a database table in which to store them, and you -will need to validate the incoming trackback data. You are encouraged to -implement a thorough validation process to guard against spam and -duplicate data. You may also want to limit the number of Trackbacks you -allow from a particular IP within a given span of time to further -curtail spam. The process of receiving a Trackback is quite simple; the -validation is what takes most of the effort. - -Your Ping URL -============= - -In order to accept Trackbacks you must display a Trackback URL next to -each one of your weblog entries. This will be the URL that people will -use to send you Trackbacks (we will refer to this as your "Ping URL"). - -Your Ping URL must point to a controller function where your Trackback -receiving code is located, and the URL must contain the ID number for -each particular entry, so that when the Trackback is received you'll be -able to associate it with a particular entry. - -For example, if your controller class is called Trackback, and the -receiving function is called receive, your Ping URLs will look something -like this:: - - http://example.com/index.php/trackback/receive/entry_id - -Where entry_id represents the individual ID number for each of your -entries. - -Creating a Trackback Table -========================== - -Before you can receive Trackbacks you must create a table in which to -store them. Here is a basic prototype for such a table:: - - CREATE TABLE trackbacks ( - tb_id int(10) unsigned NOT NULL auto_increment, - entry_id int(10) unsigned NOT NULL default 0, - url varchar(200) NOT NULL, - title varchar(100) NOT NULL, - excerpt text NOT NULL, - blog_name varchar(100) NOT NULL, - tb_date int(10) NOT NULL, - ip_address varchar(45) NOT NULL, - PRIMARY KEY `tb_id` (`tb_id`), - KEY `entry_id` (`entry_id`) - ); - -The Trackback specification only requires four pieces of information to -be sent in a Trackback (url, title, excerpt, blog_name), but to make -the data more useful we've added a few more fields in the above table -schema (date, IP address, etc.). - -Processing a Trackback -====================== - -Here is an example showing how you will receive and process a Trackback. -The following code is intended for use within the controller function -where you expect to receive Trackbacks.:: - - $this->load->library('trackback'); - $this->load->database(); - - if ($this->uri->segment(3) == FALSE) - { - $this->trackback->send_error('Unable to determine the entry ID'); - } - - if ( ! $this->trackback->receive()) - { - $this->trackback->send_error('The Trackback did not contain valid data'); - } - - $data = array( - 'tb_id' => '', - 'entry_id' => $this->uri->segment(3), - 'url' => $this->trackback->data('url'), - 'title' => $this->trackback->data('title'), - 'excerpt' => $this->trackback->data('excerpt'), - 'blog_name' => $this->trackback->data('blog_name'), - 'tb_date' => time(), - 'ip_address' => $this->input->ip_address() - ); - - $sql = $this->db->insert_string('trackbacks', $data); - $this->db->query($sql); - - $this->trackback->send_success(); - -Notes: -^^^^^^ - -The entry ID number is expected in the third segment of your URL. This -is based on the URI example we gave earlier:: - - http://example.com/index.php/trackback/receive/entry_id - -Notice the entry_id is in the third URI segment, which you can retrieve -using:: - - $this->uri->segment(3); - -In our Trackback receiving code above, if the third segment is missing, -we will issue an error. Without a valid entry ID, there's no reason to -continue. - -The $this->trackback->receive() function is simply a validation function -that looks at the incoming data and makes sure it contains the four -pieces of data that are required (url, title, excerpt, blog_name). It -returns TRUE on success and FALSE on failure. If it fails you will issue -an error message. - -The incoming Trackback data can be retrieved using this function:: - - $this->trackback->data('item') - -Where item represents one of these four pieces of info: url, title, -excerpt, or blog_name - -If the Trackback data is successfully received, you will issue a success -message using:: - - $this->trackback->send_success(); - -.. note:: The above code contains no data validation, which you are - encouraged to add. - -*************** -Class Reference -*************** - -.. php:class:: CI_Trackback - - .. attribute:: $data = array('url' => '', 'title' => '', 'excerpt' => '', 'blog_name' => '', 'charset' => '') - - Trackback data array. - - .. attribute:: $convert_ascii = TRUE - - Whether to convert high ASCII and MS Word characters to HTML entities. - - .. php:method:: send($tb_data) - - :param array $tb_data: Trackback data - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Send trackback. - - .. php:method:: receive() - - :returns: TRUE on success, FALSE on failure - :rtype: bool - - This method simply validates the incoming TB data, returning TRUE on success and FALSE on failure. - If the data is valid it is set to the ``$this->data`` array so that it can be inserted into a database. - - .. php:method:: send_error([$message = 'Incomplete information']) - - :param string $message: Error message - :rtype: void - - Responses to a trackback request with an error message. - - .. note:: This method will terminate script execution. - - .. php:method:: send_success() - - :rtype: void - - Responses to a trackback request with a success message. - - .. note:: This method will terminate script execution. - - .. php:method:: data($item) - - :param string $item: Data key - :returns: Data value or empty string if not found - :rtype: string - - Returns a single item from the response data array. - - .. php:method:: process($url, $data) - - :param string $url: Target url - :param string $data: Raw POST data - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Opens a socket connection and passes the data to the server, returning TRUE on success and FALSE on failure. - - .. php:method:: extract_urls($urls) - - :param string $urls: Comma-separated URL list - :returns: Array of URLs - :rtype: array - - This method lets multiple trackbacks to be sent. It takes a string of URLs (separated by comma or space) and puts each URL into an array. - - .. php:method:: validate_url(&$url) - - :param string $url: Trackback URL - :rtype: void - - Simply adds the *http://* prefix it it's not already present in the URL. - - .. php:method:: get_id($url) - - :param string $url: Trackback URL - :returns: URL ID or FALSE on failure - :rtype: string - - Find and return a trackback URL's ID or FALSE on failure. - - .. php:method:: convert_xml($str) - - :param string $str: Input string - :returns: Converted string - :rtype: string - - Converts reserved XML characters to entities. - - .. php:method:: limit_characters($str[, $n = 500[, $end_char = '…']]) - - :param string $str: Input string - :param int $n: Max characters number - :param string $end_char: Character to put at end of string - :returns: Shortened string - :rtype: string - - Limits the string based on the character count. Will preserve complete words. - - .. php:method:: convert_ascii($str) - - :param string $str: Input string - :returns: Converted string - :rtype: string - - Converts high ASCII text and MS Word special characterss to HTML entities. - - .. php:method:: set_error($msg) - - :param string $msg: Error message - :rtype: void - - Set an log an error message. - - .. php:method:: display_errors([$open = '<p>'[, $close = '</p>']]) - - :param string $open: Open tag - :param string $close: Close tag - :returns: HTML formatted error messages - :rtype: string - - Returns error messages formatted in HTML or an empty string if there are no errors.
\ No newline at end of file diff --git a/user_guide_src/source/libraries/typography.rst b/user_guide_src/source/libraries/typography.rst deleted file mode 100644 index 9e1386835..000000000 --- a/user_guide_src/source/libraries/typography.rst +++ /dev/null @@ -1,107 +0,0 @@ -################ -Typography Class -################ - -The Typography Class provides methods that help you format text. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -************************** -Using the Typography Class -************************** - -Initializing the Class -====================== - -Like most other classes in CodeIgniter, the Typography class is -initialized in your controller using the ``$this->load->library()`` method:: - - $this->load->library('typography'); - -Once loaded, the Typography library object will be available using:: - - $this->typography - -*************** -Class Reference -*************** - -.. php:class:: CI_Typography - - .. attribute:: $protect_braced_quotes = FALSE - - When using the Typography library in conjunction with the :doc:`Template Parser library <parser>` - it can often be desirable to protect single and double quotes within curly braces. - To enable this, set the ``protect_braced_quotes`` class property to TRUE. - - Usage example:: - - $this->load->library('typography'); - $this->typography->protect_braced_quotes = TRUE; - - .. php:method:: auto_typography($str[, $reduce_linebreaks = FALSE]) - - :param string $str: Input string - :param bool $reduce_linebreaks: Whether to reduce consequitive linebreaks - :returns: HTML typography-safe string - :rtype: string - - Formats text so that it is semantically and typographically correct HTML. - Takes a string as input and returns it with the following formatting: - - - Surrounds paragraphs within <p></p> (looks for double line breaks to identify paragraphs). - - Single line breaks are converted to <br />, except those that appear within <pre> tags. - - Block level elements, like <div> tags, are not wrapped within paragraphs, but their contained text is if it contains paragraphs. - - Quotes are converted to correctly facing curly quote entities, except those that appear within tags. - - Apostrophes are converted to curly apostrophe entities. - - Double dashes (either like -- this or like--this) are converted to em—dashes. - - Three consecutive periods either preceding or following a word are converted to ellipsis (…). - - Double spaces following sentences are converted to non-breaking spaces to mimic double spacing. - - Usage example:: - - $string = $this->typography->auto_typography($string); - - There is one optional parameter that determines whether the parser should reduce more than two consecutive line breaks down to two. - Pass boolean TRUE to enable reducing line breaks:: - - $string = $this->typography->auto_typography($string, TRUE); - - .. note:: Typographic formatting can be processor intensive, particularly if you have a lot of content being formatted. - If you choose to use this method you may want to consider :doc:`caching <../general/caching>` your pages. - - .. php:method:: format_characters($str) - - :param string $str: Input string - :returns: Formatted string - :rtype: string - - This method is similar to ``auto_typography()`` above, except that it only does character conversion: - - - Quotes are converted to correctly facing curly quote entities, except those that appear within tags. - - Apostrophes are converted to curly apostrophe entities. - - Double dashes (either like -- this or like--this) are converted to em—dashes. - - Three consecutive periods either preceding or following a word are converted to ellipsis (…). - - Double spaces following sentences are converted to non-breaking spaces to mimic double spacing. - - Usage example:: - - $string = $this->typography->format_characters($string); - - .. php:method:: nl2br_except_pre($str) - - :param string $str: Input string - :returns: Formatted string - :rtype: string - - Converts newlines to <br /> tags unless they appear within <pre> tags. - This method is identical to the native PHP :php:func:`nl2br()` function, except that it ignores <pre> tags. - - Usage example:: - - $string = $this->typography->nl2br_except_pre($string); diff --git a/user_guide_src/source/libraries/unit_testing.rst b/user_guide_src/source/libraries/unit_testing.rst deleted file mode 100644 index 57934cba3..000000000 --- a/user_guide_src/source/libraries/unit_testing.rst +++ /dev/null @@ -1,245 +0,0 @@ -################## -Unit Testing Class -################## - -Unit testing is an approach to software development in which tests are -written for each function in your application. If you are not familiar -with the concept you might do a little googling on the subject. - -CodeIgniter's Unit Test class is quite simple, consisting of an -evaluation function and two result functions. It's not intended to be a -full-blown test suite but rather a simple mechanism to evaluate your -code to determine if it is producing the correct data type and result. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -****************************** -Using the Unit Testing Library -****************************** - -Initializing the Class -====================== - -Like most other classes in CodeIgniter, the Unit Test class is -initialized in your controller using the $this->load->library function:: - - $this->load->library('unit_test'); - -Once loaded, the Unit Test object will be available using ``$this->unit`` - -Running Tests -============= - -Running a test involves supplying a test and an expected result in the -following way: - - $this->unit->run('test', 'expected result', 'test name', 'notes'); - -Where test is the result of the code you wish to test, expected result -is the data type you expect, test name is an optional name you can give -your test, and notes are optional notes. Example:: - - $test = 1 + 1; - - $expected_result = 2; - - $test_name = 'Adds one plus one'; - - $this->unit->run($test, $expected_result, $test_name); - -The expected result you supply can either be a literal match, or a data -type match. Here's an example of a literal:: - - $this->unit->run('Foo', 'Foo'); - -Here is an example of a data type match:: - - $this->unit->run('Foo', 'is_string'); - -Notice the use of "is_string" in the second parameter? This tells the -function to evaluate whether your test is producing a string as the -result. Here is a list of allowed comparison types: - -- is_object -- is_string -- is_bool -- is_true -- is_false -- is_int -- is_numeric -- is_float -- is_double -- is_array -- is_null -- is_resource - -Generating Reports -================== - -You can either display results after each test, or your can run several -tests and generate a report at the end. To show a report directly simply -echo or return the run function:: - - echo $this->unit->run($test, $expected_result); - -To run a full report of all tests, use this:: - - echo $this->unit->report(); - -The report will be formatted in an HTML table for viewing. If you prefer -the raw data you can retrieve an array using:: - - echo $this->unit->result(); - -Strict Mode -=========== - -By default the unit test class evaluates literal matches loosely. -Consider this example:: - - $this->unit->run(1, TRUE); - -The test is evaluating an integer, but the expected result is a boolean. -PHP, however, due to it's loose data-typing will evaluate the above code -as TRUE using a normal equality test:: - - if (1 == TRUE) echo 'This evaluates as true'; - -If you prefer, you can put the unit test class in to strict mode, which -will compare the data type as well as the value:: - - if (1 === TRUE) echo 'This evaluates as FALSE'; - -To enable strict mode use this:: - - $this->unit->use_strict(TRUE); - -Enabling/Disabling Unit Testing -=============================== - -If you would like to leave some testing in place in your scripts, but -not have it run unless you need it, you can disable unit testing using:: - - $this->unit->active(FALSE); - -Unit Test Display -================= - -When your unit test results display, the following items show by -default: - -- Test Name (test_name) -- Test Datatype (test_datatype) -- Expected Datatype (res_datatype) -- Result (result) -- File Name (file) -- Line Number (line) -- Any notes you entered for the test (notes) - -You can customize which of these items get displayed by using -$this->unit->set_test_items(). For example, if you only wanted the test name -and the result displayed: - -Customizing displayed tests ---------------------------- - -:: - - $this->unit->set_test_items(array('test_name', 'result')); - -Creating a Template -------------------- - -If you would like your test results formatted differently then the -default you can set your own template. Here is an example of a simple -template. Note the required pseudo-variables:: - - $str = ' - <table border="0" cellpadding="4" cellspacing="1"> - {rows} - <tr> - <td>{item}</td> - <td>{result}</td> - </tr> - {/rows} - </table>'; - - $this->unit->set_template($str); - -.. note:: Your template must be declared **before** running the unit - test process. - -*************** -Class Reference -*************** - -.. php:class:: CI_Unit_test - - .. php:method:: set_test_items($items) - - :param array $items: List of visible test items - :returns: void - - Sets a list of items that should be visible in tests. - Valid options are: - - - test_name - - test_datatype - - res_datatype - - result - - file - - line - - notes - - .. php:method:: run($test[, $expected = TRUE[, $test_name = 'undefined'[, $notes = '']]]) - - :param mixed $test: Test data - :param mixed $expected: Expected result - :param string $test_name: Test name - :param string $notes: Any notes to be attached to the test - :returns: Test report - :rtype: string - - Runs unit tests. - - .. php:method:: report([$result = array()]) - - :param array $result: Array containing tests results - :returns: Test report - :rtype: string - - Generates a report about already complete tests. - - .. php:method:: use_strict([$state = TRUE]) - - :param bool $state: Strict state flag - :rtype: void - - Enables/disables strict type comparison in tests. - - .. php:method:: active([$state = TRUE]) - - :param bool $state: Whether to enable testing - :rtype: void - - Enables/disables unit testing. - - .. php:method:: result([$results = array()]) - - :param array $results: Tests results list - :returns: Array of raw result data - :rtype: array - - Returns raw tests results data. - - .. php:method:: set_template($template) - - :param string $template: Test result template - :rtype: void - - Sets the template for displaying tests results.
\ No newline at end of file diff --git a/user_guide_src/source/libraries/uri.rst b/user_guide_src/source/libraries/uri.rst deleted file mode 100644 index 4d38c1d22..000000000 --- a/user_guide_src/source/libraries/uri.rst +++ /dev/null @@ -1,233 +0,0 @@ -######### -URI Class -######### - -The URI Class provides methods that help you retrieve information from -your URI strings. If you use URI routing, you can also retrieve -information about the re-routed segments. - -.. note:: This class is initialized automatically by the system so there - is no need to do it manually. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -*************** -Class Reference -*************** - -.. php:class:: CI_URI - - .. php:method:: segment($n[, $no_result = NULL]) - - :param int $n: Segment index number - :param mixed $no_result: What to return if the searched segment is not found - :returns: Segment value or $no_result value if not found - :rtype: mixed - - Permits you to retrieve a specific segment. Where n is the segment - number you wish to retrieve. Segments are numbered from left to right. - For example, if your full URL is this:: - - http://example.com/index.php/news/local/metro/crime_is_up - - The segment numbers would be this: - - #. news - #. local - #. metro - #. crime_is_up - - The optional second parameter defaults to NULL and allows you to set the return value - of this method when the requested URI segment is missing. - For example, this would tell the method to return the number zero in the event of failure:: - - $product_id = $this->uri->segment(3, 0); - - It helps avoid having to write code like this:: - - if ($this->uri->segment(3) === FALSE) - { - $product_id = 0; - } - else - { - $product_id = $this->uri->segment(3); - } - - .. php:method:: rsegment($n[, $no_result = NULL]) - - :param int $n: Segment index number - :param mixed $no_result: What to return if the searched segment is not found - :returns: Routed segment value or $no_result value if not found - :rtype: mixed - - This method is identical to ``segment()``, except that it lets you retrieve - a specific segment from your re-routed URI in the event you are - using CodeIgniter's :doc:`URI Routing <../general/routing>` feature. - - .. php:method:: slash_segment($n[, $where = 'trailing']) - - :param int $n: Segment index number - :param string $where: Where to add the slash ('trailing' or 'leading') - :returns: Segment value, prepended/suffixed with a forward slash, or a slash if not found - :rtype: string - - This method is almost identical to ``segment()``, except it - adds a trailing and/or leading slash based on the second parameter. - If the parameter is not used, a trailing slash added. Examples:: - - $this->uri->slash_segment(3); - $this->uri->slash_segment(3, 'leading'); - $this->uri->slash_segment(3, 'both'); - - Returns: - - #. segment/ - #. /segment - #. /segment/ - - .. php:method:: slash_rsegment($n[, $where = 'trailing']) - - :param int $n: Segment index number - :param string $where: Where to add the slash ('trailing' or 'leading') - :returns: Routed segment value, prepended/suffixed with a forward slash, or a slash if not found - :rtype: string - - This method is identical to ``slash_segment()``, except that it lets you - add slashes a specific segment from your re-routed URI in the event you - are using CodeIgniter's :doc:`URI Routing <../general/routing>` - feature. - - .. php:method:: uri_to_assoc([$n = 3[, $default = array()]]) - - :param int $n: Segment index number - :param array $default: Default values - :returns: Associative URI segments array - :rtype: array - - This method lets you turn URI segments into an associative array of - key/value pairs. Consider this URI:: - - index.php/user/search/name/joe/location/UK/gender/male - - Using this method you can turn the URI into an associative array with - this prototype:: - - [array] - ( - 'name' => 'joe' - 'location' => 'UK' - 'gender' => 'male' - ) - - The first parameter lets you set an offset, which defaults to 3 since your - URI will normally contain a controller/method pair in the first and second segments. - Example:: - - $array = $this->uri->uri_to_assoc(3); - echo $array['name']; - - The second parameter lets you set default key names, so that the array - returned will always contain expected indexes, even if missing from the URI. - Example:: - - $default = array('name', 'gender', 'location', 'type', 'sort'); - $array = $this->uri->uri_to_assoc(3, $default); - - If the URI does not contain a value in your default, an array index will - be set to that name, with a value of NULL. - - Lastly, if a corresponding value is not found for a given key (if there - is an odd number of URI segments) the value will be set to NULL. - - .. php:method:: ruri_to_assoc([$n = 3[, $default = array()]]) - - :param int $n: Segment index number - :param array $default: Default values - :returns: Associative routed URI segments array - :rtype: array - - This method is identical to ``uri_to_assoc()``, except that it creates - an associative array using the re-routed URI in the event you are using - CodeIgniter's :doc:`URI Routing <../general/routing>` feature. - - .. php:method:: assoc_to_uri($array) - - :param array $array: Input array of key/value pairs - :returns: URI string - :rtype: string - - Takes an associative array as input and generates a URI string from it. - The array keys will be included in the string. Example:: - - $array = array('product' => 'shoes', 'size' => 'large', 'color' => 'red'); - $str = $this->uri->assoc_to_uri($array); - - // Produces: product/shoes/size/large/color/red - - .. php:method:: uri_string() - - :returns: URI string - :rtype: string - - Returns a string with the complete URI. For example, if this is your full URL:: - - http://example.com/index.php/news/local/345 - - The method would return this:: - - news/local/345 - - .. php:method:: ruri_string() - - :returns: Routed URI string - :rtype: string - - This method is identical to ``uri_string()``, except that it returns - the re-routed URI in the event you are using CodeIgniter's :doc:`URI - Routing <../general/routing>` feature. - - .. php:method:: total_segments() - - :returns: Count of URI segments - :rtype: int - - Returns the total number of segments. - - .. php:method:: total_rsegments() - - :returns: Count of routed URI segments - :rtype: int - - This method is identical to ``total_segments()``, except that it returns - the total number of segments in your re-routed URI in the event you are - using CodeIgniter's :doc:`URI Routing <../general/routing>` feature. - - .. php:method:: segment_array() - - :returns: URI segments array - :rtype: array - - Returns an array containing the URI segments. For example:: - - $segs = $this->uri->segment_array(); - - foreach ($segs as $segment) - { - echo $segment; - echo '<br />'; - } - - .. php:method:: rsegment_array() - - :returns: Routed URI segments array - :rtype: array - - This method is identical to ``segment_array()``, except that it returns - the array of segments in your re-routed URI in the event you are using - CodeIgniter's :doc:`URI Routing <../general/routing>` feature. diff --git a/user_guide_src/source/libraries/user_agent.rst b/user_guide_src/source/libraries/user_agent.rst deleted file mode 100644 index a1d969abf..000000000 --- a/user_guide_src/source/libraries/user_agent.rst +++ /dev/null @@ -1,248 +0,0 @@ -################ -User Agent Class -################ - -The User Agent Class provides functions that help identify information -about the browser, mobile device, or robot visiting your site. In -addition you can get referrer information as well as language and -supported character-set information. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -************************** -Using the User Agent Class -************************** - -Initializing the Class -====================== - -Like most other classes in CodeIgniter, the User Agent class is -initialized in your controller using the $this->load->library function:: - - $this->load->library('user_agent'); - -Once loaded, the object will be available using: ``$this->agent`` - -User Agent Definitions -====================== - -The user agent name definitions are located in a config file located at: -application/config/user_agents.php. You may add items to the various -user agent arrays if needed. - -Example -======= - -When the User Agent class is initialized it will attempt to determine -whether the user agent browsing your site is a web browser, a mobile -device, or a robot. It will also gather the platform information if it -is available. - -:: - - $this->load->library('user_agent'); - - if ($this->agent->is_browser()) - { - $agent = $this->agent->browser().' '.$this->agent->version(); - } - elseif ($this->agent->is_robot()) - { - $agent = $this->agent->robot(); - } - elseif ($this->agent->is_mobile()) - { - $agent = $this->agent->mobile(); - } - else - { - $agent = 'Unidentified User Agent'; - } - - echo $agent; - - echo $this->agent->platform(); // Platform info (Windows, Linux, Mac, etc.) - -*************** -Class Reference -*************** - -.. php:class:: CI_User_agent - - .. php:method:: is_browser([$key = NULL]) - - :param string $key: Optional browser name - :returns: TRUE if the user agent is a (specified) browser, FALSE if not - :rtype: bool - - Returns TRUE/FALSE (boolean) if the user agent is a known web browser. - :: - - if ($this->agent->is_browser('Safari')) - { - echo 'You are using Safari.'; - } - elseif ($this->agent->is_browser()) - { - echo 'You are using a browser.'; - } - - .. note:: The string "Safari" in this example is an array key in the list of browser definitions. - You can find this list in **application/config/user_agents.php** if you want to add new - browsers or change the stings. - - .. php:method:: is_mobile([$key = NULL]) - - :param string $key: Optional mobile device name - :returns: TRUE if the user agent is a (specified) mobile device, FALSE if not - :rtype: bool - - Returns TRUE/FALSE (boolean) if the user agent is a known mobile device. - :: - - if ($this->agent->is_mobile('iphone')) - { - $this->load->view('iphone/home'); - } - elseif ($this->agent->is_mobile()) - { - $this->load->view('mobile/home'); - } - else - { - $this->load->view('web/home'); - } - - .. php:method:: is_robot([$key = NULL]) - - :param string $key: Optional robot name - :returns: TRUE if the user agent is a (specified) robot, FALSE if not - :rtype: bool - - Returns TRUE/FALSE (boolean) if the user agent is a known robot. - - .. note:: The user agent library only contains the most common robot definitions. It is not a complete list of bots. - There are hundreds of them so searching for each one would not be very efficient. If you find that some bots - that commonly visit your site are missing from the list you can add them to your - **application/config/user_agents.php** file. - - .. php:method:: is_referral() - - :returns: TRUE if the user agent is a referral, FALSE if not - :rtype: bool - - Returns TRUE/FALSE (boolean) if the user agent was referred from another site. - - .. php:method:: browser() - - :returns: Detected browser or an empty string - :rtype: string - - Returns a string containing the name of the web browser viewing your site. - - .. php:method:: version() - - :returns: Detected browser version or an empty string - :rtype: string - - Returns a string containing the version number of the web browser viewing your site. - - .. php:method:: mobile() - - :returns: Detected mobile device brand or an empty string - :rtype: string - - Returns a string containing the name of the mobile device viewing your site. - - .. php:method:: robot() - - :returns: Detected robot name or an empty string - :rtype: string - - Returns a string containing the name of the robot viewing your site. - - .. php:method:: platform() - - :returns: Detected operating system or an empty string - :rtype: string - - Returns a string containing the platform viewing your site (Linux, Windows, OS X, etc.). - - .. php:method:: referrer() - - :returns: Detected referrer or an empty string - :rtype: string - - The referrer, if the user agent was referred from another site. Typically you'll test for this as follows:: - - if ($this->agent->is_referral()) - { - echo $this->agent->referrer(); - } - - .. php:method:: agent_string() - - :returns: Full user agent string or an empty string - :rtype: string - - Returns a string containing the full user agent string. Typically it will be something like this:: - - Mozilla/5.0 (Macintosh; U; Intel Mac OS X; en-US; rv:1.8.0.4) Gecko/20060613 Camino/1.0.2 - - .. php:method:: accept_lang([$lang = 'en']) - - :param string $lang: Language key - :returns: TRUE if provided language is accepted, FALSE if not - :rtype: bool - - Lets you determine if the user agent accepts a particular language. Example:: - - if ($this->agent->accept_lang('en')) - { - echo 'You accept English!'; - } - - .. note:: This method is not typically very reliable since some browsers do not provide language info, - and even among those that do, it is not always accurate. - - .. php:method:: languages() - - :returns: An array list of accepted languages - :rtype: array - - Returns an array of languages supported by the user agent. - - .. php:method:: accept_charset([$charset = 'utf-8']) - - :param string $charset: Character set - :returns: TRUE if the character set is accepted, FALSE if not - :rtype: bool - - Lets you determine if the user agent accepts a particular character set. Example:: - - if ($this->agent->accept_charset('utf-8')) - { - echo 'You browser supports UTF-8!'; - } - - .. note:: This method is not typically very reliable since some browsers do not provide character-set info, - and even among those that do, it is not always accurate. - - .. php:method:: charsets() - - :returns: An array list of accepted character sets - :rtype: array - - Returns an array of character sets accepted by the user agent. - - .. php:method:: parse($string) - - :param string $string: A custom user-agent string - :rtype: void - - Parses a custom user-agent string, different from the one reported by the current visitor.
\ No newline at end of file diff --git a/user_guide_src/source/libraries/xmlrpc.rst b/user_guide_src/source/libraries/xmlrpc.rst deleted file mode 100644 index 2fe07c49d..000000000 --- a/user_guide_src/source/libraries/xmlrpc.rst +++ /dev/null @@ -1,582 +0,0 @@ -################################## -XML-RPC and XML-RPC Server Classes -################################## - -CodeIgniter's XML-RPC classes permit you to send requests to another -server, or set up your own XML-RPC server to receive requests. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -**************** -What is XML-RPC? -**************** - -Quite simply it is a way for two computers to communicate over the -internet using XML. One computer, which we will call the client, sends -an XML-RPC **request** to another computer, which we will call the -server. Once the server receives and processes the request it will send -back a **response** to the client. - -For example, using the MetaWeblog API, an XML-RPC Client (usually a -desktop publishing tool) will send a request to an XML-RPC Server -running on your site. This request might be a new weblog entry being -sent for publication, or it could be a request for an existing entry for -editing. When the XML-RPC Server receives this request it will examine -it to determine which class/method should be called to process the -request. Once processed, the server will then send back a response -message. - -For detailed specifications, you can visit the `XML-RPC <http://www.xmlrpc.com/>`_ site. - -*********************** -Using the XML-RPC Class -*********************** - -Initializing the Class -====================== - -Like most other classes in CodeIgniter, the XML-RPC and XML-RPCS classes -are initialized in your controller using the $this->load->library -function: - -To load the XML-RPC class you will use:: - - $this->load->library('xmlrpc'); - -Once loaded, the xml-rpc library object will be available using: -$this->xmlrpc - -To load the XML-RPC Server class you will use:: - - $this->load->library('xmlrpc'); - $this->load->library('xmlrpcs'); - -Once loaded, the xml-rpcs library object will be available using: -$this->xmlrpcs - -.. note:: When using the XML-RPC Server class you must load BOTH the - XML-RPC class and the XML-RPC Server class. - -Sending XML-RPC Requests -======================== - -To send a request to an XML-RPC server you must specify the following -information: - -- The URL of the server -- The method on the server you wish to call -- The *request* data (explained below). - -Here is a basic example that sends a simple Weblogs.com ping to the -`Ping-o-Matic <http://pingomatic.com/>`_ - -:: - - $this->load->library('xmlrpc'); - - $this->xmlrpc->server('http://rpc.pingomatic.com/', 80); - $this->xmlrpc->method('weblogUpdates.ping'); - - $request = array('My Photoblog', 'http://www.my-site.com/photoblog/'); - $this->xmlrpc->request($request); - - if ( ! $this->xmlrpc->send_request()) - { - echo $this->xmlrpc->display_error(); - } - -Explanation ------------ - -The above code initializes the XML-RPC class, sets the server URL and -method to be called (weblogUpdates.ping). The request (in this case, the -title and URL of your site) is placed into an array for transportation, -and compiled using the request() function. Lastly, the full request is -sent. If the send_request() method returns false we will display the -error message sent back from the XML-RPC Server. - -Anatomy of a Request -==================== - -An XML-RPC request is simply the data you are sending to the XML-RPC -server. Each piece of data in a request is referred to as a request -parameter. The above example has two parameters: The URL and title of -your site. When the XML-RPC server receives your request, it will look -for parameters it requires. - -Request parameters must be placed into an array for transportation, and -each parameter can be one of seven data types (strings, numbers, dates, -etc.). If your parameters are something other than strings you will have -to include the data type in the request array. - -Here is an example of a simple array with three parameters:: - - $request = array('John', 'Doe', 'www.some-site.com'); - $this->xmlrpc->request($request); - -If you use data types other than strings, or if you have several -different data types, you will place each parameter into its own array, -with the data type in the second position:: - - $request = array( - array('John', 'string'), - array('Doe', 'string'), - array(FALSE, 'boolean'), - array(12345, 'int') - ); - $this->xmlrpc->request($request); - -The `Data Types <#datatypes>`_ section below has a full list of data -types. - -Creating an XML-RPC Server -========================== - -An XML-RPC Server acts as a traffic cop of sorts, waiting for incoming -requests and redirecting them to the appropriate functions for -processing. - -To create your own XML-RPC server involves initializing the XML-RPC -Server class in your controller where you expect the incoming request to -appear, then setting up an array with mapping instructions so that -incoming requests can be sent to the appropriate class and method for -processing. - -Here is an example to illustrate:: - - $this->load->library('xmlrpc'); - $this->load->library('xmlrpcs'); - - $config['functions']['new_post'] = array('function' => 'My_blog.new_entry'); - $config['functions']['update_post'] = array('function' => 'My_blog.update_entry'); - $config['object'] = $this; - - $this->xmlrpcs->initialize($config); - $this->xmlrpcs->serve(); - -The above example contains an array specifying two method requests that -the Server allows. The allowed methods are on the left side of the -array. When either of those are received, they will be mapped to the -class and method on the right. - -The 'object' key is a special key that you pass an instantiated class -object with, which is necessary when the method you are mapping to is -not part of the CodeIgniter super object. - -In other words, if an XML-RPC Client sends a request for the new_post -method, your server will load the My_blog class and call the new_entry -function. If the request is for the update_post method, your server -will load the My_blog class and call the ``update_entry()`` method. - -The function names in the above example are arbitrary. You'll decide -what they should be called on your server, or if you are using -standardized APIs, like the Blogger or MetaWeblog API, you'll use their -function names. - -There are two additional configuration keys you may make use of when -initializing the server class: debug can be set to TRUE in order to -enable debugging, and xss_clean may be set to FALSE to prevent sending -data through the Security library's ``xss_clean()`` method. - -Processing Server Requests -========================== - -When the XML-RPC Server receives a request and loads the class/method -for processing, it will pass an object to that method containing the -data sent by the client. - -Using the above example, if the new_post method is requested, the -server will expect a class to exist with this prototype:: - - class My_blog extends CI_Controller { - - public function new_post($request) - { - - } - } - -The $request variable is an object compiled by the Server, which -contains the data sent by the XML-RPC Client. Using this object you will -have access to the *request parameters* enabling you to process the -request. When you are done you will send a Response back to the Client. - -Below is a real-world example, using the Blogger API. One of the methods -in the Blogger API is ``getUserInfo()``. Using this method, an XML-RPC -Client can send the Server a username and password, in return the Server -sends back information about that particular user (nickname, user ID, -email address, etc.). Here is how the processing function might look:: - - class My_blog extends CI_Controller { - - public function getUserInfo($request) - { - $username = 'smitty'; - $password = 'secretsmittypass'; - - $this->load->library('xmlrpc'); - - $parameters = $request->output_parameters(); - - if ($parameters[1] != $username && $parameters[2] != $password) - { - return $this->xmlrpc->send_error_message('100', 'Invalid Access'); - } - - $response = array( - array( - 'nickname' => array('Smitty', 'string'), - 'userid' => array('99', 'string'), - 'url' => array('http://yoursite.com', 'string'), - 'email' => array('jsmith@yoursite.com', 'string'), - 'lastname' => array('Smith', 'string'), - 'firstname' => array('John', 'string') - ), - 'struct' - ); - - return $this->xmlrpc->send_response($response); - } - } - -Notes: ------- - -The ``output_parameters()`` method retrieves an indexed array -corresponding to the request parameters sent by the client. In the above -example, the output parameters will be the username and password. - -If the username and password sent by the client were not valid, and -error message is returned using ``send_error_message()``. - -If the operation was successful, the client will be sent back a response -array containing the user's info. - -Formatting a Response -===================== - -Similar to *Requests*, *Responses* must be formatted as an array. -However, unlike requests, a response is an array **that contains a -single item**. This item can be an array with several additional arrays, -but there can be only one primary array index. In other words, the basic -prototype is this:: - - $response = array('Response data', 'array'); - -Responses, however, usually contain multiple pieces of information. In -order to accomplish this we must put the response into its own array so -that the primary array continues to contain a single piece of data. -Here's an example showing how this might be accomplished:: - - $response = array( - array( - 'first_name' => array('John', 'string'), - 'last_name' => array('Doe', 'string'), - 'member_id' => array(123435, 'int'), - 'todo_list' => array(array('clean house', 'call mom', 'water plants'), 'array'), - ), - 'struct' - ); - -Notice that the above array is formatted as a struct. This is the most -common data type for responses. - -As with Requests, a response can be one of the seven data types listed -in the `Data Types <#datatypes>`_ section. - -Sending an Error Response -========================= - -If you need to send the client an error response you will use the -following:: - - return $this->xmlrpc->send_error_message('123', 'Requested data not available'); - -The first parameter is the error number while the second parameter is -the error message. - -Creating Your Own Client and Server -=================================== - -To help you understand everything we've covered thus far, let's create a -couple controllers that act as XML-RPC Client and Server. You'll use the -Client to send a request to the Server and receive a response. - -The Client ----------- - -Using a text editor, create a controller called Xmlrpc_client.php. In -it, place this code and save it to your application/controllers/ -folder:: - - <?php - - class Xmlrpc_client extends CI_Controller { - - public function index() - { - $this->load->helper('url'); - $server_url = site_url('xmlrpc_server'); - - $this->load->library('xmlrpc'); - - $this->xmlrpc->server($server_url, 80); - $this->xmlrpc->method('Greetings'); - - $request = array('How is it going?'); - $this->xmlrpc->request($request); - - if ( ! $this->xmlrpc->send_request()) - { - echo $this->xmlrpc->display_error(); - } - else - { - echo '<pre>'; - print_r($this->xmlrpc->display_response()); - echo '</pre>'; - } - } - } - ?> - -.. note:: In the above code we are using a "url helper". You can find more - information in the :doc:`Helpers Functions <../general/helpers>` page. - -The Server ----------- - -Using a text editor, create a controller called Xmlrpc_server.php. In -it, place this code and save it to your application/controllers/ -folder:: - - <?php - - class Xmlrpc_server extends CI_Controller { - - public function index() - { - $this->load->library('xmlrpc'); - $this->load->library('xmlrpcs'); - - $config['functions']['Greetings'] = array('function' => 'Xmlrpc_server.process'); - - $this->xmlrpcs->initialize($config); - $this->xmlrpcs->serve(); - } - - - public function process($request) - { - $parameters = $request->output_parameters(); - - $response = array( - array( - 'you_said' => $parameters[0], - 'i_respond' => 'Not bad at all.' - ), - 'struct' - ); - - return $this->xmlrpc->send_response($response); - } - } - - -Try it! -------- - -Now visit the your site using a URL similar to this:: - - example.com/index.php/xmlrpc_client/ - -You should now see the message you sent to the server, and its response -back to you. - -The client you created sends a message ("How's is going?") to the -server, along with a request for the "Greetings" method. The Server -receives the request and maps it to the ``process()`` method, where a -response is sent back. - -Using Associative Arrays In a Request Parameter -=============================================== - -If you wish to use an associative array in your method parameters you -will need to use a struct datatype:: - - $request = array( - array( - // Param 0 - array('name' => 'John'), - 'struct' - ), - array( - // Param 1 - array( - 'size' => 'large', - 'shape'=>'round' - ), - 'struct' - ) - ); - - $this->xmlrpc->request($request); - -You can retrieve the associative array when processing the request in -the Server. - -:: - - $parameters = $request->output_parameters(); - $name = $parameters[0]['name']; - $size = $parameters[1]['size']; - $shape = $parameters[1]['shape']; - -Data Types -========== - -According to the `XML-RPC spec <http://www.xmlrpc.com/spec>`_ there are -seven types of values that you can send via XML-RPC: - -- *int* or *i4* -- *boolean* -- *string* -- *double* -- *dateTime.iso8601* -- *base64* -- *struct* (contains array of values) -- *array* (contains array of values) - -*************** -Class Reference -*************** - -.. php:class:: CI_Xmlrpc - - .. php:method:: initialize([$config = array()]) - - :param array $config: Configuration data - :rtype: void - - Initializes the XML-RPC library. Accepts an associative array containing your settings. - - .. php:method:: server($url[, $port = 80[, $proxy = FALSE[, $proxy_port = 8080]]]) - - :param string $url: XML-RPC server URL - :param int $port: Server port - :param string $proxy: Optional proxy - :param int $proxy_port: Proxy listening port - :rtype: void - - Sets the URL and port number of the server to which a request is to be sent:: - - $this->xmlrpc->server('http://www.sometimes.com/pings.php', 80); - - Basic HTTP authentication is also supported, simply add it to the server URL:: - - $this->xmlrpc->server('http://user:pass@localhost/', 80); - - .. php:method:: timeout($seconds = 5) - - :param int $seconds: Timeout in seconds - :rtype: void - - Set a time out period (in seconds) after which the request will be canceled:: - - $this->xmlrpc->timeout(6); - - This timeout period will be used both for an initial connection to - the remote server, as well as for getting a response from it. - Make sure you set the timeout before calling ``send_request()``. - - .. php:method:: method($function) - - :param string $function: Method name - :rtype: void - - Sets the method that will be requested from the XML-RPC server:: - - $this->xmlrpc->method('method'); - - Where method is the name of the method. - - .. php:method:: request($incoming) - - :param array $incoming: Request data - :rtype: void - - Takes an array of data and builds request to be sent to XML-RPC server:: - - $request = array(array('My Photoblog', 'string'), 'http://www.yoursite.com/photoblog/'); - $this->xmlrpc->request($request); - - .. php:method:: send_request() - - :returns: TRUE on success, FALSE on failure - :rtype: bool - - The request sending method. Returns boolean TRUE or FALSE based on success for failure, enabling it to be used conditionally. - - .. method set_debug($flag = TRUE) - - :param bool $flag: Debug status flag - :rtype: void - - Enables or disables debugging, which will display a variety of information and error data helpful during development. - - .. php:method:: display_error() - - :returns: Error message string - :rtype: string - - Returns an error message as a string if your request failed for some reason. - :: - - echo $this->xmlrpc->display_error(); - - .. php:method:: display_response() - - :returns: Response - :rtype: mixed - - Returns the response from the remote server once request is received. The response will typically be an associative array. - :: - - $this->xmlrpc->display_response(); - - .. php:method:: send_error_message($number, $message) - - :param int $number: Error number - :param string $message: Error message - :returns: XML_RPC_Response instance - :rtype: XML_RPC_Response - - This method lets you send an error message from your server to the client. - First parameter is the error number while the second parameter is the error message. - :: - - return $this->xmlrpc->send_error_message(123, 'Requested data not available'); - - .. method send_response($response) - - :param array $response: Response data - :returns: XML_RPC_Response instance - :rtype: XML_RPC_Response - - Lets you send the response from your server to the client. An array of valid data values must be sent with this method. - :: - - $response = array( - array( - 'flerror' => array(FALSE, 'boolean'), - 'message' => "Thanks for the ping!" - ), - 'struct' - ); - - return $this->xmlrpc->send_response($response); diff --git a/user_guide_src/source/libraries/zip.rst b/user_guide_src/source/libraries/zip.rst deleted file mode 100644 index 9704d5b1d..000000000 --- a/user_guide_src/source/libraries/zip.rst +++ /dev/null @@ -1,243 +0,0 @@ -################## -Zip Encoding Class -################## - -CodeIgniter's Zip Encoding Class permits you to create Zip archives. -Archives can be downloaded to your desktop or saved to a directory. - -.. contents:: - :local: - -.. raw:: html - - <div class="custom-index container"></div> - -**************************** -Using the Zip Encoding Class -**************************** - -Initializing the Class -====================== - -Like most other classes in CodeIgniter, the Zip class is initialized in -your controller using the $this->load->library function:: - - $this->load->library('zip'); - -Once loaded, the Zip library object will be available using:: - - $this->zip - -Usage Example -============= - -This example demonstrates how to compress a file, save it to a folder on -your server, and download it to your desktop. - -:: - - $name = 'mydata1.txt'; - $data = 'A Data String!'; - - $this->zip->add_data($name, $data); - - // Write the zip file to a folder on your server. Name it "my_backup.zip" - $this->zip->archive('/path/to/directory/my_backup.zip'); - - // Download the file to your desktop. Name it "my_backup.zip" - $this->zip->download('my_backup.zip'); - -*************** -Class Reference -*************** - -.. php:class:: CI_Zip - - .. attribute:: $compression_level = 2 - - The compression level to use. - - It can range from 0 to 9, with 9 being the highest and 0 effectively disabling compression:: - - $this->zip->compression_level = 0; - - .. php:method:: add_data($filepath[, $data = NULL]) - - :param mixed $filepath: A single file path or an array of file => data pairs - :param array $data: File contents (ignored if $filepath is an array) - :rtype: void - - Adds data to the Zip archive. Can work both in single and multiple files mode. - - When adding a single file, the first parameter must contain the name you would - like given to the file and the second must contain the file contents:: - - $name = 'mydata1.txt'; - $data = 'A Data String!'; - $this->zip->add_data($name, $data); - - $name = 'mydata2.txt'; - $data = 'Another Data String!'; - $this->zip->add_data($name, $data); - - When adding multiple files, the first parameter must contain *file => contents* pairs - and the second parameter is ignored:: - - $data = array( - 'mydata1.txt' => 'A Data String!', - 'mydata2.txt' => 'Another Data String!' - ); - - $this->zip->add_data($data); - - If you would like your compressed data organized into sub-directories, simply include - the path as part of the filename(s):: - - $name = 'personal/my_bio.txt'; - $data = 'I was born in an elevator...'; - - $this->zip->add_data($name, $data); - - The above example will place my_bio.txt inside a folder called personal. - - .. php:method:: add_dir($directory) - - :param mixed $directory: Directory name string or an array of multiple directories - :rtype: void - - Permits you to add a directory. Usually this method is unnecessary since you can place - your data into directories when using ``$this->zip->add_data()``, but if you would like - to create an empty directory you can do so:: - - $this->zip->add_dir('myfolder'); // Creates a directory called "myfolder" - - .. php:method:: read_file($path[, $archive_filepath = FALSE]) - - :param string $path: Path to file - :param mixed $archive_filepath: New file name/path (string) or (boolean) whether to maintain the original filepath - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Permits you to compress a file that already exists somewhere on your server. - Supply a file path and the zip class will read it and add it to the archive:: - - $path = '/path/to/photo.jpg'; - - $this->zip->read_file($path); - - // Download the file to your desktop. Name it "my_backup.zip" - $this->zip->download('my_backup.zip'); - - If you would like the Zip archive to maintain the directory structure of - the file in it, pass TRUE (boolean) in the second parameter. Example:: - - $path = '/path/to/photo.jpg'; - - $this->zip->read_file($path, TRUE); - - // Download the file to your desktop. Name it "my_backup.zip" - $this->zip->download('my_backup.zip'); - - In the above example, photo.jpg will be placed into the *path/to/* directory. - - You can also specify a new name (path included) for the added file on the fly:: - - $path = '/path/to/photo.jpg'; - $new_path = '/new/path/some_photo.jpg'; - - $this->zip->read_file($path, $new_path); - - // Download ZIP archive containing /new/path/some_photo.jpg - $this->zip->download('my_archive.zip'); - - .. php:method:: read_dir($path[, $preserve_filepath = TRUE[, $root_path = NULL]]) - - :param string $path: Path to directory - :param bool $preserve_filepath: Whether to maintain the original path - :param string $root_path: Part of the path to exclude from the archive directory - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Permits you to compress a directory (and its contents) that already exists somewhere on your server. - Supply a path to the directory and the zip class will recursively read and recreate it as a Zip archive. - All files contained within the supplied path will be encoded, as will any sub-directories contained within it. Example:: - - $path = '/path/to/your/directory/'; - - $this->zip->read_dir($path); - - // Download the file to your desktop. Name it "my_backup.zip" - $this->zip->download('my_backup.zip'); - - By default the Zip archive will place all directories listed in the first parameter - inside the zip. If you want the tree preceding the target directory to be ignored, - you can pass FALSE (boolean) in the second parameter. Example:: - - $path = '/path/to/your/directory/'; - - $this->zip->read_dir($path, FALSE); - - This will create a ZIP with a directory named "directory" inside, then all sub-directories - stored correctly inside that, but will not include the */path/to/your* part of the path. - - .. php:method:: archive($filepath) - - :param string $filepath: Path to target zip archive - :returns: TRUE on success, FALSE on failure - :rtype: bool - - Writes the Zip-encoded file to a directory on your server. Submit a valid server path - ending in the file name. Make sure the directory is writable (755 is usually OK). - Example:: - - $this->zip->archive('/path/to/folder/myarchive.zip'); // Creates a file named myarchive.zip - - .. php:method:: download($filename = 'backup.zip') - - :param string $filename: Archive file name - :rtype: void - - Causes the Zip file to be downloaded from your server. - You must pass the name you would like the zip file called. Example:: - - $this->zip->download('latest_stuff.zip'); // File will be named "latest_stuff.zip" - - .. note:: Do not display any data in the controller in which you call - this method since it sends various server headers that cause the - download to happen and the file to be treated as binary. - - .. php:method:: get_zip() - - :returns: Zip file content - :rtype: string - - Returns the Zip-compressed file data. Generally you will not need this method unless you - want to do something unique with the data. Example:: - - $name = 'my_bio.txt'; - $data = 'I was born in an elevator...'; - - $this->zip->add_data($name, $data); - - $zip_file = $this->zip->get_zip(); - - .. php:method:: clear_data() - - :rtype: void - - The Zip class caches your zip data so that it doesn't need to recompile the Zip archive - for each method you use above. If, however, you need to create multiple Zip archives, - each with different data, you can clear the cache between calls. Example:: - - $name = 'my_bio.txt'; - $data = 'I was born in an elevator...'; - - $this->zip->add_data($name, $data); - $zip_file = $this->zip->get_zip(); - - $this->zip->clear_data(); - - $name = 'photo.jpg'; - $this->zip->read_file("/path/to/photo.jpg"); // Read the file's contents - - $this->zip->download('myphotos.zip'); diff --git a/user_guide_src/source/license.rst b/user_guide_src/source/license.rst deleted file mode 100644 index d65b56431..000000000 --- a/user_guide_src/source/license.rst +++ /dev/null @@ -1,23 +0,0 @@ -##################### -The MIT License (MIT) -##################### - -Copyright (c) 2014 - 2018, 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/overview/appflow.rst b/user_guide_src/source/overview/appflow.rst deleted file mode 100644 index bb15130d2..000000000 --- a/user_guide_src/source/overview/appflow.rst +++ /dev/null @@ -1,23 +0,0 @@ -###################### -Application Flow Chart -###################### - -The following graphic illustrates how data flows throughout the system: - -|CodeIgniter application flow| - -#. The index.php serves as the front controller, initializing the base - resources needed to run CodeIgniter. -#. The Router examines the HTTP request to determine what should be done - with it. -#. If a cache file exists, it is sent directly to the browser, bypassing - the normal system execution. -#. Security. Before the application controller is loaded, the HTTP - request and any user submitted data is filtered for security. -#. The Controller loads the model, core libraries, helpers, and any - other resources needed to process the specific request. -#. The finalized View is rendered then sent to the web browser to be - seen. If caching is enabled, the view is cached first so that on - subsequent requests it can be served. - -.. |CodeIgniter application flow| image:: ../images/appflowchart.gif diff --git a/user_guide_src/source/overview/at_a_glance.rst b/user_guide_src/source/overview/at_a_glance.rst deleted file mode 100644 index 742d7bd0e..000000000 --- a/user_guide_src/source/overview/at_a_glance.rst +++ /dev/null @@ -1,114 +0,0 @@ -####################### -CodeIgniter at a Glance -####################### - -CodeIgniter is an Application Framework -======================================= - -CodeIgniter is a toolkit for people who build web applications using -PHP. Its goal is to enable you to develop projects much faster than you -could if you were writing code from scratch, by providing a rich set of -libraries for commonly needed tasks, as well as a simple interface and -logical structure to access these libraries. CodeIgniter lets you -creatively focus on your project by minimizing the amount of code needed -for a given task. - -CodeIgniter is Free -=================== - -CodeIgniter is licensed under the MIT license so you can use it however -you please. For more information please read the -:doc:`license agreement <../license>`. - -CodeIgniter is Light Weight -=========================== - -Truly light weight. The core system requires only a few very small -libraries. This is in stark contrast to many frameworks that require -significantly more resources. Additional libraries are loaded -dynamically upon request, based on your needs for a given process, so -the base system is very lean and quite fast. - -CodeIgniter is Fast -=================== - -Really fast. We challenge you to find a framework that has better -performance than CodeIgniter. - -CodeIgniter Uses M-V-C -====================== - -CodeIgniter uses the Model-View-Controller approach, which allows great -separation between logic and presentation. This is particularly good for -projects in which designers are working with your template files, as the -code these files contain will be minimized. We describe MVC in more -detail on its own page. - -CodeIgniter Generates Clean URLs -================================ - -The URLs generated by CodeIgniter are clean and search-engine friendly. -Rather than using the standard "query string" approach to URLs that is -synonymous with dynamic systems, CodeIgniter uses a segment-based -approach:: - - example.com/news/article/345 - -.. note:: By default the *index.php* file is included in the URL but it can - be removed using a simple *.htaccess* file. - -CodeIgniter Packs a Punch -========================= - -CodeIgniter comes with full-range of libraries that enable the most -commonly needed web development tasks, like accessing a database, -sending email, validating form data, maintaining sessions, manipulating -images, working with XML-RPC data and much more. - -CodeIgniter is Extensible -========================= - -The system can be easily extended through the use of your own libraries, -helpers, or through class extensions or system hooks. - -CodeIgniter Does Not Require a Template Engine -============================================== - -Although CodeIgniter *does* come with a simple template parser that can -be optionally used, it does not force you to use one. Template engines -simply can not match the performance of native PHP, and the syntax that -must be learned to use a template engine is usually only marginally -easier than learning the basics of PHP. Consider this block of PHP code:: - - <ul> - <?php foreach ($addressbook as $name):?> - <li><?=$name?></li> - <?php endforeach; ?> - </ul> - -Contrast this with the pseudo-code used by a template engine:: - - <ul> - {foreach from=$addressbook item="name"} - <li>{$name}</li> - {/foreach} - </ul> - -Yes, the template engine example is a bit cleaner, but it comes at the -price of performance, as the pseudo-code must be converted back into PHP -to run. Since one of our goals is *maximum performance*, we opted to not -require the use of a template engine. - -CodeIgniter is Thoroughly Documented -==================================== - -Programmers love to code and hate to write documentation. We're no -different, of course, but since documentation is **as important** as the -code itself, we are committed to doing it. Our source code is extremely -clean and well commented as well. - -CodeIgniter has a Friendly Community of Users -============================================= - -Our growing community of users can be seen actively participating in our -`Community Forums <http://forum.codeigniter.com/>`_. diff --git a/user_guide_src/source/overview/features.rst b/user_guide_src/source/overview/features.rst deleted file mode 100644 index f62546b61..000000000 --- a/user_guide_src/source/overview/features.rst +++ /dev/null @@ -1,46 +0,0 @@ -#################### -CodeIgniter Features -#################### - -Features in and of themselves are a very poor way to judge an -application since they tell you nothing about the user experience, or -how intuitively or intelligently it is designed. Features don't reveal -anything about the quality of the code, or the performance, or the -attention to detail, or security practices. The only way to really judge -an app is to try it and get to know the code. -:doc:`Installing <../installation/index>` CodeIgniter is child's play so -we encourage you to do just that. In the mean time here's a list of -CodeIgniter's main features. - -- Model-View-Controller Based System -- Extremely Light Weight -- Full Featured database classes with support for several platforms. -- Query Builder Database Support -- Form and Data Validation -- Security and XSS Filtering -- Session Management -- Email Sending Class. Supports Attachments, HTML/Text email, multiple - protocols (sendmail, SMTP, and Mail) and more. -- Image Manipulation Library (cropping, resizing, rotating, etc.). - Supports GD, ImageMagick, and NetPBM -- File Uploading Class -- FTP Class -- Localization -- Pagination -- Data Encryption -- Benchmarking -- Full Page Caching -- Error Logging -- Application Profiling -- Calendaring Class -- User Agent Class -- Zip Encoding Class -- Template Engine Class -- Trackback Class -- XML-RPC Library -- Unit Testing Class -- Search-engine Friendly URLs -- Flexible URI Routing -- Support for Hooks and Class Extensions -- Large library of "helper" functions - diff --git a/user_guide_src/source/overview/getting_started.rst b/user_guide_src/source/overview/getting_started.rst deleted file mode 100644 index 04ee50df7..000000000 --- a/user_guide_src/source/overview/getting_started.rst +++ /dev/null @@ -1,24 +0,0 @@ -################################ -Getting Started With CodeIgniter -################################ - -Any software application requires some effort to learn. We've done our -best to minimize the learning curve while making the process as -enjoyable as possible. - -The first step is to :doc:`install <../installation/index>` -CodeIgniter, then read all the topics in the **Introduction** section of -the Table of Contents. - -Next, read each of the **General Topics** pages in order. Each topic -builds on the previous one, and includes code examples that you are -encouraged to try. - -Once you understand the basics you'll be ready to explore the **Class -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://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/overview/goals.rst b/user_guide_src/source/overview/goals.rst deleted file mode 100644 index ac581807f..000000000 --- a/user_guide_src/source/overview/goals.rst +++ /dev/null @@ -1,32 +0,0 @@ -############################## -Design and Architectural Goals -############################## - -Our goal for CodeIgniter is maximum performance, capability, and -flexibility in the smallest, lightest possible package. - -To meet this goal we are committed to benchmarking, re-factoring, and -simplifying at every step of the development process, rejecting anything -that doesn't further the stated objective. - -From a technical and architectural standpoint, CodeIgniter was created -with the following objectives: - -- **Dynamic Instantiation.** In CodeIgniter, components are loaded and - routines executed only when requested, rather than globally. No - assumptions are made by the system regarding what may be needed - beyond the minimal core resources, so the system is very light-weight - by default. The events, as triggered by the HTTP request, and the - controllers and views you design will determine what is invoked. -- **Loose Coupling.** Coupling is the degree to which components of a - system rely on each other. The less components depend on each other - the more reusable and flexible the system becomes. Our goal was a - very loosely coupled system. -- **Component Singularity.** Singularity is the degree to which - components have a narrowly focused purpose. In CodeIgniter, each - class and its functions are highly autonomous in order to allow - maximum usefulness. - -CodeIgniter is a dynamically instantiated, loosely coupled system with -high component singularity. It strives for simplicity, flexibility, and -high performance in a small footprint package. diff --git a/user_guide_src/source/overview/index.rst b/user_guide_src/source/overview/index.rst deleted file mode 100644 index d48a0bbe4..000000000 --- a/user_guide_src/source/overview/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -#################### -CodeIgniter Overview -#################### - -The following pages describe the broad concepts behind CodeIgniter: - -.. toctree:: - :titlesonly: - - Getting Started <getting_started> - CodeIgniter at a Glance <at_a_glance> - Supported Features <features> - Application Flow Chart <appflow> - Model-View-Controller <mvc> - Architectural Goals <goals>
\ No newline at end of file diff --git a/user_guide_src/source/overview/mvc.rst b/user_guide_src/source/overview/mvc.rst deleted file mode 100644 index 996745d65..000000000 --- a/user_guide_src/source/overview/mvc.rst +++ /dev/null @@ -1,27 +0,0 @@ -##################### -Model-View-Controller -##################### - -CodeIgniter is based on the Model-View-Controller development pattern. -MVC is a software approach that separates application logic from -presentation. In practice, it permits your web pages to contain minimal -scripting since the presentation is separate from the PHP scripting. - -- The **Model** represents your data structures. Typically your model - classes will contain functions that help you retrieve, insert, and - update information in your database. -- The **View** is the information that is being presented to a user. A - View will normally be a web page, but in CodeIgniter, a view can also - be a page fragment like a header or footer. It can also be an RSS - page, or any other type of "page". -- The **Controller** serves as an *intermediary* between the Model, the - View, and any other resources needed to process the HTTP request and - generate a web page. - -CodeIgniter has a fairly loose approach to MVC since Models are not -required. If you don't need the added separation, or find that -maintaining models requires more complexity than you want, you can -ignore them and build your application minimally using Controllers and -Views. CodeIgniter also enables you to incorporate your own existing -scripts, or even develop core libraries for the system, enabling you to -work in a way that makes the most sense to you. diff --git a/user_guide_src/source/tutorial/conclusion.rst b/user_guide_src/source/tutorial/conclusion.rst deleted file mode 100644 index 0d90cde6f..000000000 --- a/user_guide_src/source/tutorial/conclusion.rst +++ /dev/null @@ -1,26 +0,0 @@ -########## -Conclusion -########## - -This tutorial did not cover all of the things you might expect of a -full-fledged content management system, but it introduced you to the -more important topics of routing, writing controllers, and models. We -hope this tutorial gave you an insight into some of CodeIgniter's basic -design patterns, which you can expand upon. - -Now that you've completed this tutorial, we recommend you check out the -rest of the documentation. CodeIgniter is often praised because of its -comprehensive documentation. Use this to your advantage and read the -"Introduction" and "General Topics" sections thoroughly. You should read -the class and helper references when needed. - -Every intermediate PHP programmer should be able to get the hang of -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://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/>`_ - diff --git a/user_guide_src/source/tutorial/create_news_items.rst b/user_guide_src/source/tutorial/create_news_items.rst deleted file mode 100644 index cde52fde8..000000000 --- a/user_guide_src/source/tutorial/create_news_items.rst +++ /dev/null @@ -1,153 +0,0 @@ -################# -Create news items -################# - -You now know how you can read data from a database using CodeIgniter, but -you haven't written any information to the database yet. In this section -you'll expand your news controller and model created earlier to include -this functionality. - -Create a form -------------- - -To input data into the database you need to create a form where you can -input the information to be stored. This means you'll be needing a form -with two fields, one for the title and one for the text. You'll derive -the slug from our title in the model. Create the new view at -*application/views/news/create.php*. - -:: - - <h2><?php echo $title; ?></h2> - - <?php echo validation_errors(); ?> - - <?php echo form_open('news/create'); ?> - - <label for="title">Title</label> - <input type="input" name="title" /><br /> - - <label for="text">Text</label> - <textarea name="text"></textarea><br /> - - <input type="submit" name="submit" value="Create news item" /> - - </form> - -There are only two things here that probably look unfamiliar to you: the -``form_open()`` function and the ``validation_errors()`` function. - -The first function is provided by the :doc:`form -helper <../helpers/form_helper>` and renders the form element and -adds extra functionality, like adding a hidden :doc:`CSRF prevention -field <../libraries/security>`. The latter is used to report -errors related to form validation. - -Go back to your news controller. You're going to do two things here, -check whether the form was submitted and whether the submitted data -passed the validation rules. You'll use the :doc:`form -validation <../libraries/form_validation>` library to do this. - -:: - - public function create() - { - $this->load->helper('form'); - $this->load->library('form_validation'); - - $data['title'] = 'Create a news item'; - - $this->form_validation->set_rules('title', 'Title', 'required'); - $this->form_validation->set_rules('text', 'Text', 'required'); - - if ($this->form_validation->run() === FALSE) - { - $this->load->view('templates/header', $data); - $this->load->view('news/create'); - $this->load->view('templates/footer'); - - } - else - { - $this->news_model->set_news(); - $this->load->view('news/success'); - } - } - -The code above adds a lot of functionality. The first few lines load the -form helper and the form validation library. After that, rules for the -form validation are set. The ``set_rules()`` method takes three arguments; -the name of the input field, the name to be used in error messages, and -the rule. In this case the title and text fields are required. - -CodeIgniter has a powerful form validation library as demonstrated -above. You can read :doc:`more about this library -here <../libraries/form_validation>`. - -Continuing down, you can see a condition that checks whether the form -validation ran successfully. If it did not, the form is displayed, if it -was submitted **and** passed all the rules, the model is called. After -this, a view is loaded to display a success message. Create a view at -*application/views/news/success.php* and write a success message. - -Model ------ - -The only thing that remains is writing a method that writes the data to -the database. You'll use the Query Builder class to insert the -information and use the input library to get the posted data. Open up -the model created earlier and add the following: - -:: - - public function set_news() - { - $this->load->helper('url'); - - $slug = url_title($this->input->post('title'), 'dash', TRUE); - - $data = array( - 'title' => $this->input->post('title'), - 'slug' => $slug, - 'text' => $this->input->post('text') - ); - - return $this->db->insert('news', $data); - } - -This new method takes care of inserting the news item into the database. -The third line contains a new function, url\_title(). This function - -provided by the :doc:`URL helper <../helpers/url_helper>` - strips down -the string you pass it, replacing all spaces by dashes (-) and makes -sure everything is in lowercase characters. This leaves you with a nice -slug, perfect for creating URIs. - -Let's continue with preparing the record that is going to be inserted -later, inside the ``$data`` array. Each element corresponds with a column in -the database table created earlier. You might notice a new method here, -namely the ``post()`` method from the :doc:`input -library <../libraries/input>`. This method makes sure the data is -sanitized, protecting you from nasty attacks from others. The input -library is loaded by default. At last, you insert our ``$data`` array into -our database. - -Routing -------- - -Before you can start adding news items into your CodeIgniter application -you have to add an extra rule to *config/routes.php* file. Make sure your -file contains the following. This makes sure CodeIgniter sees 'create' -as a method instead of a news item's slug. - -:: - - $route['news/create'] = 'news/create'; - $route['news/(:any)'] = 'news/view/$1'; - $route['news'] = 'news'; - $route['(:any)'] = 'pages/view/$1'; - $route['default_controller'] = 'pages/view'; - -Now point your browser to your local development environment where you -installed CodeIgniter and add index.php/news/create to the URL. -Congratulations, you just created your first CodeIgniter application! -Add some news and check out the different pages you made. diff --git a/user_guide_src/source/tutorial/index.rst b/user_guide_src/source/tutorial/index.rst deleted file mode 100644 index 91f99c7cd..000000000 --- a/user_guide_src/source/tutorial/index.rst +++ /dev/null @@ -1,46 +0,0 @@ -######## -Tutorial -######## - -This tutorial is intended to introduce you to the CodeIgniter framework -and the basic principles of MVC architecture. It will show you how a -basic CodeIgniter application is constructed in step-by-step fashion. - -In this tutorial, you will be creating a **basic news application**. You -will begin by writing the code that can load static pages. Next, you -will create a news section that reads news items from a database. -Finally, you'll add a form to create news items in the database. - -This tutorial will primarily focus on: - -- Model-View-Controller basics -- Routing basics -- Form validation -- Performing basic database queries using "Query Builder" - -The entire tutorial is split up over several pages, each explaining a -small part of the functionality of the CodeIgniter framework. You'll go -through the following pages: - -- Introduction, this page, which gives you an overview of what to - expect. -- :doc:`Static pages <static_pages>`, which will teach you the basics - of controllers, views and routing. -- :doc:`News section <news_section>`, where you'll start using models - and will be doing some basic database operations. -- :doc:`Create news items <create_news_items>`, which will introduce - more advanced database operations and form validation. -- :doc:`Conclusion <conclusion>`, which will give you some pointers on - further reading and other resources. - -Enjoy your exploration of the CodeIgniter framework. - -.. toctree:: - :glob: - :hidden: - :titlesonly: - - static_pages - news_section - create_news_items - conclusion
\ No newline at end of file diff --git a/user_guide_src/source/tutorial/news_section.rst b/user_guide_src/source/tutorial/news_section.rst deleted file mode 100644 index 286d620dc..000000000 --- a/user_guide_src/source/tutorial/news_section.rst +++ /dev/null @@ -1,218 +0,0 @@ -############ -News section -############ - -In the last section, we went over some basic concepts of the framework -by writing a class that includes static pages. We cleaned up the URI by -adding custom routing rules. Now it's time to introduce dynamic content -and start using a database. - -Setting up your model ---------------------- - -Instead of writing database operations right in the controller, queries -should be placed in a model, so they can easily be reused later. Models -are the place where you retrieve, insert, and update information in your -database or other data stores. They represent your data. - -Open up the *application/models/* directory and create a new file called -*News_model.php* and add the following code. Make sure you've configured -your database properly as described :doc:`here <../database/configuration>`. - -:: - - <?php - class News_model extends CI_Model { - - public function __construct() - { - $this->load->database(); - } - } - -This code looks similar to the controller code that was used earlier. It -creates a new model by extending ``CI_Model`` and loads the database -library. This will make the database class available through the -``$this->db`` object. - -Before querying the database, a database schema has to be created. -Connect to your database and run the SQL command below (MySQL). -Also add some seed records. - -:: - - CREATE TABLE news ( - id int(11) NOT NULL AUTO_INCREMENT, - title varchar(128) NOT NULL, - slug varchar(128) NOT NULL, - text text NOT NULL, - PRIMARY KEY (id), - KEY slug (slug) - ); - -Now that the database and a model have been set up, you'll need a method -to get all of our posts from our database. To do this, the database -abstraction layer that is included with CodeIgniter — -:doc:`Query Builder <../database/query_builder>` — is used. This makes it -possible to write your 'queries' once and make them work on :doc:`all -supported database systems <../general/requirements>`. Add the -following code to your model. - -:: - - public function get_news($slug = FALSE) - { - if ($slug === FALSE) - { - $query = $this->db->get('news'); - return $query->result_array(); - } - - $query = $this->db->get_where('news', array('slug' => $slug)); - return $query->row_array(); - } - -With this code you can perform two different queries. You can get all -news records, or get a news item by its `slug <#>`_. You might have -noticed that the ``$slug`` variable wasn't sanitized before running the -query; :doc:`Query Builder <../database/query_builder>` does this for you. - -Display the news ----------------- - -Now that the queries are written, the model should be tied to the views -that are going to display the news items to the user. This could be done -in our ``Pages`` controller created earlier, but for the sake of clarity, -a new ``News`` controller is defined. Create the new controller at -*application/controllers/News.php*. - -:: - - <?php - class News extends CI_Controller { - - public function __construct() - { - parent::__construct(); - $this->load->model('news_model'); - $this->load->helper('url_helper'); - } - - public function index() - { - $data['news'] = $this->news_model->get_news(); - } - - public function view($slug = NULL) - { - $data['news_item'] = $this->news_model->get_news($slug); - } - } - -Looking at the code, you may see some similarity with the files we -created earlier. First, the ``__construct()`` method: it calls the -constructor of its parent class (``CI_Controller``) and loads the model, -so it can be used in all other methods in this controller. -It also loads a collection of :doc:`URL Helper <../helpers/url_helper>` -functions, because we'll use one of them in a view later. - -Next, there are two methods to view all news items and one for a specific -news item. You can see that the ``$slug`` variable is passed to the model's -method in the second method. The model is using this slug to identify the -news item to be returned. - -Now the data is retrieved by the controller through our model, but -nothing is displayed yet. The next thing to do is passing this data to -the views. - -:: - - public function index() - { - $data['news'] = $this->news_model->get_news(); - $data['title'] = 'News archive'; - - $this->load->view('templates/header', $data); - $this->load->view('news/index', $data); - $this->load->view('templates/footer'); - } - -The code above gets all news records from the model and assigns it to a -variable. The value for the title is also assigned to the ``$data['title']`` -element and all data is passed to the views. You now need to create a -view to render the news items. Create *application/views/news/index.php* -and add the next piece of code. - -:: - - <h2><?php echo $title; ?></h2> - - <?php foreach ($news as $news_item): ?> - - <h3><?php echo $news_item['title']; ?></h3> - <div class="main"> - <?php echo $news_item['text']; ?> - </div> - <p><a href="<?php echo site_url('news/'.$news_item['slug']); ?>">View article</a></p> - - <?php endforeach; ?> - -Here, each news item is looped and displayed to the user. You can see we -wrote our template in PHP mixed with HTML. If you prefer to use a template -language, you can use CodeIgniter's :doc:`Template -Parser <../libraries/parser>` class or a third party parser. - -The news overview page is now done, but a page to display individual -news items is still absent. The model created earlier is made in such -way that it can easily be used for this functionality. You only need to -add some code to the controller and create a new view. Go back to the -``News`` controller and update ``view()`` with the following: - -:: - - public function view($slug = NULL) - { - $data['news_item'] = $this->news_model->get_news($slug); - - if (empty($data['news_item'])) - { - show_404(); - } - - $data['title'] = $data['news_item']['title']; - - $this->load->view('templates/header', $data); - $this->load->view('news/view', $data); - $this->load->view('templates/footer'); - } - -Instead of calling the ``get_news()`` method without a parameter, the -``$slug`` variable is passed, so it will return the specific news item. -The only things left to do is create the corresponding view at -*application/views/news/view.php*. Put the following code in this file. - -:: - - <?php - echo '<h2>'.$news_item['title'].'</h2>'; - echo $news_item['text']; - -Routing -------- - -Because of the wildcard routing rule created earlier, you need an extra -route to view the controller that you just made. Modify your routing file -(*application/config/routes.php*) so it looks as follows. -This makes sure the requests reaches the ``News`` controller instead of -going directly to the ``Pages`` controller. The first line routes URI's -with a slug to the ``view()`` method in the ``News`` controller. - -:: - - $route['news/(:any)'] = 'news/view/$1'; - $route['news'] = 'news'; - $route['(:any)'] = 'pages/view/$1'; - $route['default_controller'] = 'pages/view'; - -Point your browser to your document root, followed by index.php/news and -watch your news page. diff --git a/user_guide_src/source/tutorial/static_pages.rst b/user_guide_src/source/tutorial/static_pages.rst deleted file mode 100644 index 5daaa958f..000000000 --- a/user_guide_src/source/tutorial/static_pages.rst +++ /dev/null @@ -1,170 +0,0 @@ -############ -Static pages -############ - -**Note:** This tutorial assumes you've downloaded CodeIgniter and -:doc:`installed the framework <../installation/index>` in your -development environment. - -The first thing you're going to do is set up a **controller** to handle -static pages. A controller is simply a class that helps delegate work. -It is the glue of your web application. - -For example, when a call is made to: - - http://example.com/news/latest/10 - -We might imagine that there is a controller named "news". The method -being called on news would be "latest". The news method's job could be to -grab 10 news items, and render them on the page. Very often in MVC, -you'll see URL patterns that match: - - http://example.com/[controller-class]/[controller-method]/[arguments] - -As URL schemes become more complex, this may change. But for now, this -is all we will need to know. - -Create a file at *application/controllers/Pages.php* with the following -code. - -:: - - <?php - class Pages extends CI_Controller { - - public function view($page = 'home') - { - } - } - -You have created a class named ``Pages``, with a view method that accepts -one argument named ``$page``. The ``Pages`` class is extending the -``CI_Controller`` class. This means that the new pages class can access the -methods and variables defined in the ``CI_Controller`` class -(*system/core/Controller.php*). - -The **controller is what will become the center of every request** to -your web application. In very technical CodeIgniter discussions, it may -be referred to as the *super object*. Like any php class, you refer to -it within your controllers as ``$this``. Referring to ``$this`` is how -you will load libraries, views, and generally command the framework. - -Now you've created your first method, it's time to make some basic page -templates. We will be creating two "views" (page templates) that act as -our page footer and header. - -Create the header at *application/views/templates/header.php* and add -the following code: - -:: - - <html> - <head> - <title>CodeIgniter Tutorial</title> - </head> - <body> - - <h1><?php echo $title; ?></h1> - -The header contains the basic HTML code that you'll want to display -before loading the main view, together with a heading. It will also -output the ``$title`` variable, which we'll define later in the controller. -Now, create a footer at *application/views/templates/footer.php* that -includes the following code: - -:: - - <em>© 2015</em> - </body> - </html> - -Adding logic to the controller ------------------------------- - -Earlier you set up a controller with a ``view()`` method. The method -accepts one parameter, which is the name of the page to be loaded. The -static page templates will be located in the *application/views/pages/* -directory. - -In that directory, create two files named *home.php* and *about.php*. -Within those files, type some text − anything you'd like − and save them. -If you like to be particularly un-original, try "Hello World!". - -In order to load those pages, you'll have to check whether the requested -page actually exists: - -:: - - public function view($page = 'home') - { - if ( ! file_exists(APPPATH.'views/pages/'.$page.'.php')) - { - // Whoops, we don't have a page for that! - show_404(); - } - - $data['title'] = ucfirst($page); // Capitalize the first letter - - $this->load->view('templates/header', $data); - $this->load->view('pages/'.$page, $data); - $this->load->view('templates/footer', $data); - } - -Now, when the page does exist, it is loaded, including the header and -footer, and displayed to the user. If the page doesn't exist, a "404 -Page not found" error is shown. - -The first line in this method checks whether the page actually exists. -PHP's native ``file_exists()`` function is used to check whether the file -is where it's expected to be. ``show_404()`` is a built-in CodeIgniter -function that renders the default error page. - -In the header template, the ``$title`` variable was used to customize the -page title. The value of title is defined in this method, but instead of -assigning the value to a variable, it is assigned to the title element -in the ``$data`` array. - -The last thing that has to be done is loading the views in the order -they should be displayed. The second parameter in the ``view()`` method is -used to pass values to the view. Each value in the ``$data`` array is -assigned to a variable with the name of its key. So the value of -``$data['title']`` in the controller is equivalent to ``$title`` in the -view. - -Routing -------- - -The controller is now functioning! Point your browser to -``[your-site-url]index.php/pages/view`` to see your page. When you visit -``index.php/pages/view/about`` you'll see the about page, again including -the header and footer. - -Using custom routing rules, you have the power to map any URI to any -controller and method, and break free from the normal convention: -``http://example.com/[controller-class]/[controller-method]/[arguments]`` - -Let's do that. Open the routing file located at -*application/config/routes.php* and add the following two lines. -Remove all other code that sets any element in the ``$route`` array. - -:: - - $route['default_controller'] = 'pages/view'; - $route['(:any)'] = 'pages/view/$1'; - -CodeIgniter reads its routing rules from top to bottom and routes the -request to the first matching rule. Each rule is a regular expression -(left-side) mapped to a controller and method name separated by slashes -(right-side). When a request comes in, CodeIgniter looks for the first -match, and calls the appropriate controller and method, possibly with -arguments. - -More information about routing can be found in the URI Routing -:doc:`documentation <../general/routing>`. - -Here, the second rule in the ``$routes`` array matches **any** request -using the wildcard string ``(:any)``. and passes the parameter to the -``view()`` method of the ``Pages`` class. - -Now visit ``index.php/about``. Did it get routed correctly to the ``view()`` -method in the pages controller? Awesome! |
