Incoviba/money
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Vendor lock

Browse Source
This commit is contained in:
Aldarien
2023-06-16 02:08:47 +00:00
parent 7933e70e90
commit 3351b92dd6
4099 changed files with 345789 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

153
vendor/j4mie/paris/docs/Makefile vendored Normal file
View File

@ -0,0 +1,153 @@
# 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) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
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 " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@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/Paris.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Paris.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/Paris"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Paris"
@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."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
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."

279
vendor/j4mie/paris/docs/associations.rst vendored Normal file
View File

@ -0,0 +1,279 @@
Associations
============
Paris provides a simple API for one-to-one, one-to-many and many-to-many
relationships (associations) between models. It takes a different
approach to many other ORMs, which use associative arrays to add
configuration metadata about relationships to model classes. These
arrays can often be deeply nested and complex, and are therefore quite
error-prone.
Instead, Paris treats the act of querying across a relationship as a
*behaviour*, and supplies a family of helper methods to help generate
such queries. These helper methods should be called from within
*methods* on your model classes which are named to describe the
relationship. These methods return ORM instances (rather than actual
Model instances) and so, if necessary, the relationship query can be
modified and added to before it is run.
Summary
^^^^^^^
The following list summarises the associations provided by Paris, and
explains which helper method supports each type of association:
One-to-one
''''''''''
Use ``has_one`` in the base, and ``belongs_to`` in the associated model.
One-to-many
'''''''''''
Use ``has_many`` in the base, and ``belongs_to`` in the associated
model.
Many-to-many
''''''''''''
Use ``has_many_through`` in both the base and associated models.
Below, each association helper method is discussed in detail.
Has-one
^^^^^^^
One-to-one relationships are implemented using the ``has_one`` method.
For example, say we have a ``User`` model. Each user has a single
``Profile``, and so the ``user`` table should be associated with the
``profile`` table. To be able to find the profile for a particular user,
we should add a method called ``profile`` to the ``User`` class (note
that the method name here is arbitrary, but should describe the
relationship). This method calls the protected ``has_one`` method
provided by Paris, passing in the class name of the related object. The
``profile`` method should return an ORM instance ready for (optional)
further filtering.
.. code-block:: php
<?php
class Profile extends Model {
}
class User extends Model {
public function profile() {
return $this->has_one('Profile');
}
}
The API for this method works as follows:
.. code-block:: php
<?php
// Select a particular user from the database
$user = Model::factory('User')->find_one($user_id);
// Find the profile associated with the user
$profile = $user->profile()->find_one();
By default, Paris assumes that the foreign key column on the related
table has the same name as the current (base) table, with ``_id``
appended. In the example above, Paris will look for a foreign key column
called ``user_id`` on the table used by the ``Profile`` class. To
override this behaviour, add a second argument to your ``has_one`` call,
passing the name of the column to use.
In addition, Paris assumes that the foreign key column in the current (base)
table is the primary key column of the base table. In the example above,
Paris will use the column called ``user_id`` (assuming ``user_id`` is the
primary key for the user table) in the base table (in this case the user table)
as the foreign key column in the base table. To override this behaviour,
add a third argument to your ``has_one call``, passing the name of the column
you intend to use as the foreign key column in the base table.
Has many
^^^^^^^^
One-to-many relationships are implemented using the ``has_many`` method.
For example, say we have a ``User`` model. Each user has several
``Post`` objects. The ``user`` table should be associated with the
``post`` table. To be able to find the posts for a particular user, we
should add a method called ``posts`` to the ``User`` class (note that
the method name here is arbitrary, but should describe the
relationship). This method calls the protected ``has_many`` method
provided by Paris, passing in the class name of the related objects.
**Pass the model class name literally, not a pluralised version**. The
``posts`` method should return an ORM instance ready for (optional)
further filtering.
.. code-block:: php
<?php
class Post extends Model {
}
class User extends Model {
public function posts() {
return $this->has_many('Post'); // Note we use the model name literally - not a pluralised version
}
}
The API for this method works as follows:
.. code-block:: php
<?php
// Select a particular user from the database
$user = Model::factory('User')->find_one($user_id);
// Find the posts associated with the user
$posts = $user->posts()->find_many();
By default, Paris assumes that the foreign key column on the related
table has the same name as the current (base) table, with ``_id``
appended. In the example above, Paris will look for a foreign key column
called ``user_id`` on the table used by the ``Post`` class. To override
this behaviour, add a second argument to your ``has_many`` call, passing
the name of the column to use.
In addition, Paris assumes that the foreign key column in the current (base)
table is the primary key column of the base table. In the example above, Paris
will use the column called ``user_id`` (assuming ``user_id`` is the primary key
for the user table) in the base table (in this case the user table) as the
foreign key column in the base table. To override this behaviour, add a third
argument to your ``has_many call``, passing the name of the column you intend
to use as the foreign key column in the base table.
Belongs to
^^^^^^^^^^
The ‘other side’ of ``has_one`` and ``has_many`` is ``belongs_to``. This
method call takes identical parameters as these methods, but assumes the
foreign key is on the *current* (base) table, not the related table.
.. code-block:: php
<?php
class Profile extends Model {
public function user() {
return $this->belongs_to('User');
}
}
class User extends Model {
}
The API for this method works as follows:
.. code-block:: php
<?php
// Select a particular profile from the database
$profile = Model::factory('Profile')->find_one($profile_id);
// Find the user associated with the profile
$user = $profile->user()->find_one();
Again, Paris makes an assumption that the foreign key on the current
(base) table has the same name as the related table with ``_id``
appended. In the example above, Paris will look for a column named
``user_id``. To override this behaviour, pass a second argument to the
``belongs_to`` method, specifying the name of the column on the current
(base) table to use.
Paris also makes an assumption that the foreign key in the associated (related)
table is the primary key column of the related table. In the example above,
Paris will look for a column named ``user_id`` in the user table (the related
table in this example). To override this behaviour, pass a third argument to
the belongs_to method, specifying the name of the column in the related table
to use as the foreign key column in the related table.
Has many through
^^^^^^^^^^^^^^^^
Many-to-many relationships are implemented using the
``has_many_through`` method. This method has only one required argument:
the name of the related model. Supplying further arguments allows us to
override default behaviour of the method.
For example, say we have a ``Book`` model. Each ``Book`` may have
several ``Author`` objects, and each ``Author`` may have written several
``Books``. To be able to find the authors for a particular book, we
should first create an intermediary model. The name for this model
should be constructed by concatenating the names of the two related
classes, in alphabetical order. In this case, our classes are called
``Author`` and ``Book``, so the intermediate model should be called
``AuthorBook``.
We should then add a method called ``authors`` to the ``Book`` class
(note that the method name here is arbitrary, but should describe the
relationship). This method calls the protected ``has_many_through``
method provided by Paris, passing in the class name of the related
objects. **Pass the model class name literally, not a pluralised
version**. The ``authors`` method should return an ORM instance ready
for (optional) further filtering.
.. code-block:: php
<?php
class Author extends Model {
public function books() {
return $this->has_many_through('Book');
}
}
class Book extends Model {
public function authors() {
return $this->has_many_through('Author');
}
}
class AuthorBook extends Model {
}
The API for this method works as follows:
.. code-block:: php
<?php
// Select a particular book from the database
$book = Model::factory('Book')->find_one($book_id);
// Find the authors associated with the book
$authors = $book->authors()->find_many();
// Get the first author
$first_author = $authors[0];
// Find all the books written by this author
$first_author_books = $first_author->books()->find_many();
Overriding defaults
'''''''''''''''''''
The ``has_many_through`` method takes up to six arguments, which allow
us to progressively override default assumptions made by the method.
**First argument: associated model name** - this is mandatory and should
be the name of the model we wish to select across the association.
**Second argument: intermediate model name** - this is optional and
defaults to the names of the two associated models, sorted
alphabetically and concatenated.
**Third argument: custom key to base table on intermediate table** -
this is optional, and defaults to the name of the base table with
``_id`` appended.
**Fourth argument: custom key to associated table on intermediate
table** - this is optional, and defaults to the name of the associated
table with ``_id`` appended.
**Fifth argument: foreign key column in the base table** -
this is optional, and defaults to the name of the primary key column in
the base table.
**Sixth argument: foreign key column in the associated table** -
this is optional, and defaults to the name of the primary key column
in the associated table.

242
vendor/j4mie/paris/docs/conf.py vendored Normal file
View File

@ -0,0 +1,242 @@
# -*- coding: utf-8 -*-
#
# Paris documentation build configuration file, created by
# sphinx-quickstart on Wed Nov 28 15:47:04 2012.
#
# 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 = []
# 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'Paris'
copyright = u'2014, Jamie Matthews and Simon Holywell'
# 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 = ''
# The full version, including alpha/beta/rc tags.
release = ''
# 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 = ['_build']
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# If true, '()' will be appended to :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 .. 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 = 'sphinx'
# 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 = 'default'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# 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 = None
# 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 = 'Parisdoc'
# -- Options for LaTeX output --------------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'Paris.tex', u'Paris Documentation',
u'Jamie Matthews and Simon Holywell', '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
# 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', 'paris', u'Paris Documentation',
[u'Jamie Matthews and Simon Holywell'], 1)
]
# If true, show URL addresses after external links.
#man_show_urls = False
# -- Options for Texinfo output ------------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'Paris', u'Paris Documentation',
u'Jamie Matthews and Simon Holywell', 'Paris', 'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'

123
vendor/j4mie/paris/docs/configuration.rst vendored Normal file
View File

@ -0,0 +1,123 @@
Configuration
=============
Setup
~~~~~
Paris requires `Idiorm`_. Install Idiorm and Paris somewhere in your
project directory, and ``require`` both.
.. code-block:: php
<?php
require_once 'your/path/to/idiorm.php';
require_once 'your/path/to/paris.php';
Then, you need to tell Idiorm how to connect to your database. **For
full details of how to do this, see `Idiorm's documentation`_.**
Briefly, you need to pass a *Data Source Name* connection string to the
``configure`` method of the ORM class.
.. code-block:: php
<?php
ORM::configure('sqlite:./example.db');
You may also need to pass a username and password to your database
driver, using the ``username`` and ``password`` configuration options.
For example, if you are using MySQL:
.. code-block:: php
<?php
ORM::configure('mysql:host=localhost;dbname=my_database');
ORM::configure('username', 'database_user');
ORM::configure('password', 'top_secret');
Model prefixing
~~~~~~~~~~~~~~~
Setting: ``Model::$auto_prefix_models``
To save having type out model class name prefixes whenever code utilises ``Model::for_table()``
it is possible to specify a prefix that will be prepended onto the class name.
The model prefix is treated the same way as any other class name when Paris
attempts to convert it to a table name. This is documented in the :doc:`Models`
section of the documentation.
Here is a namespaced example to make it clearer:
.. code-block:: php
<?php
Model::$auto_prefix_models = '\\Tests\\';
Model::factory('Simple')->find_many(); // SQL executed: SELECT * FROM `tests_simple`
Model::factory('SimpleUser')->find_many(); // SQL executed: SELECT * FROM `tests_simple_user`
Model prefixes are only compatible with the ``Model::factory()`` methods described above.
Where the shorter ``SimpleUser::find_many()`` style syntax is used, the addition of a
Model prefix will cause ``Class not found`` errors.
.. note::
Model class property ``$_table`` sets an explicit table name, ignoring the
``$auto_prefix_models`` property in your individual model classes. See documentation in
the :doc:`Models` section of the documentation.
Model prefixing
~~~~~~~~~~~~~~~
Setting: ``Model::$short_table_names``
Set as ``true`` to disregard namespace information when computing table names
from class names.
By default the class ``\Models\CarTyre`` expects the table name ``models_car_tyre``.
With ``Model::$short_table_names = true`` the class ``\Models\CarTyre`` expects the
table name ``car_tyre``.
.. code-block:: php
<?php
Model::$short_table_names = true;
Model::factory('CarTyre')->find_many(); // SQL executed: SELECT * FROM `car_tyre`
namespace Models {
class CarTyre extends Model {
}
}
Further Configuration
~~~~~~~~~~~~~~~~~~~~~
The only other configuration options provided by Paris itself are the
``$_table`` and ``$_id_column`` static properties on model classes. To
configure the database connection, you should use Idiorm’s configuration
system via the ``ORM::configure`` method.
If you are using multiple connections, the optional `$_connection_key` static property may also be used to provide a default string key indicating which database connection in `ORM` should be used.
**See `Idiorm's documentation`_ for full details.**
Query logging
~~~~~~~~~~~~~
Idiorm can log all queries it executes. To enable query logging, set the
``logging`` option to ``true`` (it is ``false`` by default).
.. code-block:: php
<?php
ORM::configure('logging', true);
When query logging is enabled, you can use two static methods to access
the log. ``ORM::get_last_query()`` returns the most recent query
executed. ``ORM::get_query_log()`` returns an array of all queries
executed.
.. _Idiorm's documentation: http://github.com/j4mie/idiorm/
.. _Idiorm: http://github.com/j4mie/idiorm/

40
vendor/j4mie/paris/docs/connections.rst vendored Normal file
View File

@ -0,0 +1,40 @@
Multiple Connections
====================
Paris now works with multiple database conections (and necessarily relies on an updated version of Idiorm that also supports multiple connections). Database connections are identified by a string name, and default to ``OrmWrapper::DEFAULT_CONNECTION`` (which is really ``ORM::DEFAULT_CONNECTION``).
See `Idiorm’s documentation`_ for information about configuring multiple connections.
The connection to use can be specified in two separate ways. To indicate a default connection key for a subclass of ``Model``, create a public static property in your model class called ``$_connection_name``.
.. code-block:: php
<?php
// A named connection, where 'alternate' is an arbitray key name
ORM::configure('sqlite:./example2.db', null, 'alternate');
class SomeClass extends Model
{
public static $_connection_name = 'alternate';
}
The connection to use can also be specified as an optional additional parameter to ``OrmWrapper::for_table()``, or to ``Model::factory()``. This will override the default setting (if any) found in the ``$_connection_name`` static property.
.. code-block:: php
<?php
$person = Model::factory('Author', 'alternate')->find_one(1); // Uses connection named 'alternate'
The connection can be changed after a model is populated, should that be necessary:
.. code-block:: php
<?php
$person = Model::factory('Author')->find_one(1); // Uses default connection
$person->orm = Model::factory('Author', 'alternate'); // Switches to connection named 'alternate'
$person->name = 'Foo';
$person->save(); // *Should* now save through the updated connection
Queries across multiple connections are not supported. However, as the Paris methods ``has_one``, ``has_many`` and ``belongs_to`` don't require joins, these *should* work as expected, even when the objects on opposite sides of the relation belong to diffrent connections. The ``has_many_through`` relationship requires joins, and so will not reliably work across different connections.
.. _Idiorm’s documentation: http://github.com/j4mie/idiorm/

76
vendor/j4mie/paris/docs/filters.rst vendored Normal file
View File

@ -0,0 +1,76 @@
Filters
=======
It is often desirable to create reusable queries that can be used to
extract particular subsets of data without repeating large sections of
code. Paris allows this by providing a method called ``filter`` which
can be chained in queries alongside the existing Idiorm query API. The
filter method takes the name of a **public static** method on the
current Model subclass as an argument. The supplied method will be
called at the point in the chain where ``filter`` is called, and will be
passed the ``ORM`` object as the first parameter. It should return the
ORM object after calling one or more query methods on it. The method
chain can then be continued if necessary.
It is easiest to illustrate this with an example. Imagine an application
in which users can be assigned a role, which controls their access to
certain pieces of functionality. In this situation, you may often wish
to retrieve a list of users with the role ‘admin’. To do this, add a
static method called (for example) ``admins`` to your Model class:
.. code-block:: php
<?php
class User extends Model {
public static function admins($orm) {
return $orm->where('role', 'admin');
}
}
You can then use this filter in your queries:
.. code-block:: php
<?php
$admin_users = Model::factory('User')->filter('admins')->find_many();
You can also chain it with other methods as normal:
.. code-block:: php
<?php
$young_admins = Model::factory('User')
->filter('admins')
->where_lt('age', 18)
->find_many();
Filters with arguments
~~~~~~~~~~~~~~~~~~~~~~
You can also pass arguments to custom filters. Any additional arguments
passed to the ``filter`` method (after the name of the filter to apply)
will be passed through to your custom filter as additional arguments
(after the ORM instance).
For example, let’s say you wish to generalise your role filter (see
above) to allow you to retrieve users with any role. You can pass the
role name to the filter as an argument:
.. code-block:: php
<?php
class User extends Model {
public static function has_role($orm, $role) {
return $orm->where('role', $role);
}
}
$admin_users = Model::factory('User')->filter('has_role', 'admin')->find_many();
$guest_users = Model::factory('User')->filter('has_role', 'guest')->find_many();
These examples may seem simple (``filter('has_role', 'admin')`` could
just as easily be achieved using ``where('role', 'admin')``), but
remember that filters can contain arbitrarily complex code - adding
``raw_where`` clauses or even complete ``raw_query`` calls to perform
joins, etc. Filters provide a powerful mechanism to hide complexity in
your model’s query API.

34
vendor/j4mie/paris/docs/index.rst vendored Normal file
View File

@ -0,0 +1,34 @@
.. Paris documentation master file, created by
sphinx-quickstart on Wed Nov 28 15:47:04 2012.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Paris's documentation!
=================================
Contents:
.. toctree::
:maxdepth: 2
philosophy
installation
configuration
models
associations
querying
filters
transactions
validation
migrations
connections
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

19
vendor/j4mie/paris/docs/installation.rst vendored Normal file
View File

@ -0,0 +1,19 @@
Installation
============
Packagist
~~~~~~~~~
This library is available through Packagist with the vendor and package
identifier of ``j4mie/paris``
Please see the `Packagist documentation`_ for further information.
Download
~~~~~~~~
You can clone the git repository, download idiorm.php or a release tag
and then drop the idiorm.php file in the vendors/3rd party/libs
directory of your project.
.. _Packagist documentation: http://packagist.org/

190
vendor/j4mie/paris/docs/make.bat vendored Normal file
View File

@ -0,0 +1,190 @@
@ECHO OFF
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set BUILDDIR=_build
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
set I18NSPHINXOPTS=%SPHINXOPTS% .
if NOT "%PAPER%" == "" (
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
)
if "%1" == "" goto help
if "%1" == "help" (
: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. text to make text files
echo. man to make manual pages
echo. texinfo to make Texinfo files
echo. gettext to make PO message catalogs
echo. changes to make an overview over 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
goto end
)
if "%1" == "clean" (
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
del /q /s %BUILDDIR%\*
goto end
)
if "%1" == "html" (
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/html.
goto end
)
if "%1" == "dirhtml" (
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
goto end
)
if "%1" == "singlehtml" (
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
goto end
)
if "%1" == "pickle" (
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can process the pickle files.
goto end
)
if "%1" == "json" (
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can process the JSON files.
goto end
)
if "%1" == "htmlhelp" (
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can run HTML Help Workshop with the ^
.hhp project file in %BUILDDIR%/htmlhelp.
goto end
)
if "%1" == "qthelp" (
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can run "qcollectiongenerator" with the ^
.qhcp project file in %BUILDDIR%/qthelp, like this:
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Paris.qhcp
echo.To view the help file:
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Paris.ghc
goto end
)
if "%1" == "devhelp" (
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished.
goto end
)
if "%1" == "epub" (
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The epub file is in %BUILDDIR%/epub.
goto end
)
if "%1" == "latex" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
if errorlevel 1 exit /b 1
echo.
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
goto end
)
if "%1" == "text" (
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The text files are in %BUILDDIR%/text.
goto end
)
if "%1" == "man" (
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The manual pages are in %BUILDDIR%/man.
goto end
)
if "%1" == "texinfo" (
%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
goto end
)
if "%1" == "gettext" (
%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
goto end
)
if "%1" == "changes" (
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
if errorlevel 1 exit /b 1
echo.
echo.The overview file is in %BUILDDIR%/changes.
goto end
)
if "%1" == "linkcheck" (
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
if errorlevel 1 exit /b 1
echo.
echo.Link check complete; look for any errors in the above output ^
or in %BUILDDIR%/linkcheck/output.txt.
goto end
)
if "%1" == "doctest" (
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
if errorlevel 1 exit /b 1
echo.
echo.Testing of doctests in the sources finished, look at the ^
results in %BUILDDIR%/doctest/output.txt.
goto end
)
:end

24
vendor/j4mie/paris/docs/migrations.rst vendored Normal file
View File

@ -0,0 +1,24 @@
Migrations
==========
Paris does not have native support for migrations, but some work has been
done to integrate `PHPMig`_. If you want to have migrations in your project
then this is recommended route as Paris will never have migrations directly
implemented in the core. Please refer to the Paris and Idiorm Philosophy for
reasons why.
To integrate Paris with PHPMig you will need to follow their `installation
instructions`_ and then configure it to use the Paris PDO instance:
.. code-block:: php
<?php
$container['db'] = $container->share(function(){
return ORM::get_db();
});
$container['phpmig.adapter'] = $container->share(function() use ($container) {
return new Adapter\PDO\Sql($container['db'], 'migrations');
});
.. _PHPMig: https://github.com/davedevelopment/phpmig
.. _installation instructions: https://github.com/davedevelopment/phpmig#getting-started

120
vendor/j4mie/paris/docs/models.rst vendored Normal file
View File

@ -0,0 +1,120 @@
Models
======
Model classes
~~~~~~~~~~~~~
You should create a model class for each entity in your application. For
example, if you are building an application that requires users, you
should create a ``User`` class. Your model classes should extend the
base ``Model`` class:
.. code-block:: php
<?php
class User extends Model {
}
Paris takes care of creating instances of your model classes, and
populating them with *data* from the database. You can then add
*behaviour* to this class in the form of public methods which implement
your application logic. This combination of data and behaviour is the
essence of the `Active Record pattern`_.
IDE Auto-complete
^^^^^^^^^^^^^^^^^
As Paris does not require you to specify a method/function per database column
it can be difficult to know what properties are available on a particular model.
Due to the magic nature of PHP's `__get()`_ method it is impossible for an IDE
to give you autocomplete hints as well.
To work around this you can use PHPDoc comment blocks to list the properties of
the model. These properties should mirror the names of your database tables
columns.
.. code-block:: php
<?php
/**
* @property int $id
* @property string $first_name
* @property string $last_name
* @property string $email
*/
class User extends Model {
}
For more information please see the `PHPDoc manual @property`_ documentation.
Database tables
~~~~~~~~~~~~~~~
Your ``User`` class should have a corresponding ``user`` table in your
database to store its data.
By default, Paris assumes your class names are in *CapWords* style, and
your table names are in *lowercase\_with\_underscores* style. It will
convert between the two automatically. For example, if your class is
called ``CarTyre``, Paris will look for a table named ``car_tyre``.
If you are using namespaces then they will be converted to a table name
in a similar way. For example ``\Models\CarTyre`` would be converted to
``models_car_tyre``. Note here that backslashes are replaced with underscores
in addition to the *CapWords* replacement discussed in the previous paragraph.
To disregard namespace information when calculating the table name, set
``Model::$short_table_names = true;``. Optionally this may be set or overridden at
class level with the **public static** property ``$_table_use_short_name``. The
``$_table_use_short_name`` takes precedence over ``Model::$short_table_names``
unless ``$_table_use_short_name`` is ``null`` (default).
Either setting results in ``\Models\CarTyre`` being converted to ``car_tyre``.
.. code-block:: php
<?php
class User extends Model {
public static $_table_use_short_name = true;
}
To override the default naming behaviour and directly specify a table name,
add a **public static** property to your class called ``$_table``:
.. code-block:: php
<?php
class User extends Model {
public static $_table = 'my_user_table';
}
Auto prefixing
^^^^^^^^^^^^^^
To save having type out model class name prefixes whenever code utilises ``Model::for_table()``
it is possible to specify a prefix that will be prepended onto the class name.
See the :doc:`Configuration` documentation for more details.
ID column
~~~~~~~~~
Paris requires that your database tables have a unique primary key
column. By default, Paris will use a column called ``id``. To override
this default behaviour, add a **public static** property to your class
called ``$_id_column``:
.. code-block:: php
<?php
class User extends Model {
public static $_id_column = 'my_id_column';
}
**Note** - Paris has its *own* default ID column name mechanism, and
does not respect column names specified in Idiorm’s configuration.
.. _Active Record pattern: http://martinfowler.com/eaaCatalog/activeRecord.html
.. ___get: https://secure.php.net/manual/en/language.oop5.overloading.php#object.get
.. _PHPDoc manual @property: https://www.phpdoc.org/docs/latest/references/phpdoc/tags/property.html

6
vendor/j4mie/paris/docs/philosophy.rst vendored Normal file
View File

@ -0,0 +1,6 @@
Philosophy
==========
Paris is built with the same *less is more* philosophy as `Idiorm`_.
.. _Idiorm: http://github.com/j4mie/idiorm/

197
vendor/j4mie/paris/docs/querying.rst vendored Normal file
View File

@ -0,0 +1,197 @@
Querying
========
Querying allows you to select data from your database and populate
instances of your model classes. Queries start with a call to a static
*factory method* on the base ``Model`` class that takes a single
argument: the name of the model class you wish to use for your query.
This factory method is then used as the start of a *method chain* which
gives you full access to `Idiorm`_\ ’s fluent query API. **See Idiorm’s
documentation for details of this API.**
For example:
.. code-block:: php
<?php
$users = Model::factory('User')
->where('name', 'Fred')
->where_gte('age', 20)
->find_many();
You can also use the same shortcut provided by Idiorm when looking up a
record by its primary key ID:
.. code-block:: php
<?php
$user = Model::factory('User')->find_one($id);
If you are using PHP 5.3+ you can also do the following:
.. code-block:: php
<?php
$users = User::where('name', 'Fred')
->where_gte('age', 20)
->find_many();
This does the same as the example above but is shorter and more readable.
The only differences between using Idiorm and using Paris for querying
are as follows:
1. You do not need to call the ``for_table`` method to specify the
database table to use. Paris will supply this automatically based on
the class name (or the ``$_table`` static property, if present).
2. The ``find_one`` and ``find_many`` methods will return instances of
*your model subclass*, instead of the base ``ORM`` class. Like
Idiorm, ``find_one`` will return a single instance or ``false`` if no
rows matched your query, while ``find_many`` will return an array of
instances, which may be empty if no rows matched.
3. Custom filtering, see next section.
You may also retrieve a count of the number of rows returned by your
query. This method behaves exactly like Idiorm’s ``count`` method:
.. code-block:: php
<?php
$count = Model::factory('User')->where_lt('age', 20)->count();
A note on PSR-1 and camelCase
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
All the methods detailed in the documentation can also be called in a PSR-1 way:
underscores (_) become camelCase. Here follows an example of one query chain
being converted to a PSR-1 compliant style.
.. code-block:: php
<?php
// documented and default style
$count = Model::factory('User')->where_lt('age', 20)->find_one();
// PSR-1 compliant style
$count = Model::factory('User')->whereLt('age', 20)->findOne();
As you can see any method can be changed from the documented underscore (_) format
to that of a camelCase method name.
.. note::
In the background the PSR-1 compliant style uses the `__call()` and
`__callStatic()` magic methods to map the camelCase method name you supply
to the original underscore method name. It then uses `call_user_func_array()`
to apply the arguments to the method. If this minimal overhead is too great
then you can simply revert to using the underscore methods to avoid it. In
general this will not be a bottle neck in any application however and should
be considered a micro-optimisation.
As `__callStatic()` was added in PHP 5.3.0 you will need at least that version
of PHP to use this feature in any meaningful way.
Getting data from objects, updating and inserting data
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The model instances returned by your queries now behave exactly as if
they were instances of Idiorm’s raw ``ORM`` class.
You can access data:
.. code-block:: php
<?php
$user = Model::factory('User')->find_one($id);
echo $user->name;
Update data and save the instance:
.. code-block:: php
<?php
$user = Model::factory('User')->find_one($id);
$user->name = 'Paris';
$user->save();
To create a new (empty) instance, use the ``create`` method:
.. code-block:: php
<?php
$user = Model::factory('User')->create();
$user->name = 'Paris';
$user->save();
To check whether a property has been changed since the object was
created (or last saved), call the ``is_dirty`` method:
.. code-block:: php
<?php
$name_has_changed = $person->is_dirty('name'); // Returns true or false
You can also use database expressions when setting values on your model:
.. code-block:: php
<?php
$user = Model::factory('User')->find_one($id);
$user->name = 'Paris';
$user->set_expr('last_logged_in', 'NOW()');
$user->save();
Of course, because these objects are instances of your base model
classes, you can also call methods that you have defined on them:
.. code-block:: php
<?php
class User extends Model {
public function full_name() {
return $this->first_name . ' ' . $this->last_name;
}
}
$user = Model::factory('User')->find_one($id);
echo $user->full_name();
To delete the database row associated with an instance of your model,
call its ``delete`` method:
.. code-block:: php
<?php
$user = Model::factory('User')->find_one($id);
$user->delete();
You can also get the all the data wrapped by a model subclass instance
using the ``as_array`` method. This will return an associative array
mapping column names (keys) to their values.
The ``as_array`` method takes column names as optional arguments. If one
or more of these arguments is supplied, only matching column names will
be returned.
.. code-block:: php
<?php
class Person extends Model {
}
$person = Model::factory('Person')->create();
$person->first_name = 'Fred';
$person->surname = 'Bloggs';
$person->age = 50;
// Returns array('first_name' => 'Fred', 'surname' => 'Bloggs', 'age' => 50)
$data = $person->as_array();
// Returns array('first_name' => 'Fred', 'age' => 50)
$data = $person->as_array('first_name', 'age');
.. _Idiorm: http://github.com/j4mie/idiorm/

21
vendor/j4mie/paris/docs/transactions.rst vendored Normal file
View File

@ -0,0 +1,21 @@
Transactions
============
Paris (or Idiorm) doesn’t supply any extra methods to deal with
transactions, but it’s very easy to use PDO’s built-in methods:
.. code-block:: php
<?php
// Start a transaction
ORM::get_db()->beginTransaction();
// Commit a transaction
ORM::get_db()->commit();
// Roll back a transaction
ORM::get_db()->rollBack();
For more details, see `the PDO documentation on Transactions`_.
.. _the PDO documentation on Transactions: http://www.php.net/manual/en/pdo.transactions.php

27
vendor/j4mie/paris/docs/validation.rst vendored Normal file
View File

@ -0,0 +1,27 @@
A word on validation
====================
It’s generally considered a good idea to centralise your data validation
in a single place, and a good place to do this is inside your model
classes. This is preferable to handling validation alongside form
handling code, for example. Placing validation code inside models means
that if you extend your application in the future to update your model
via an alternative route (say a REST API rather than a form) you can
re-use the same validation code.
Despite this, Paris doesn’t provide any built-in support for validation.
This is because validation is potentially quite complex, and often very
application-specific. Paris is deliberately quite ignorant about your
actual data - it simply executes queries, and gives you the
responsibility of making sure the data inside your models is valid and
correct. Adding a full validation framework to Paris would probably
require more code than Paris itself!
However, there are several simple ways that you could add validation to
your models without any help from Paris. You could override the
``save()`` method, check the data is valid, and return ``false`` on
failure, or call ``parent::save()`` on success. You could create your
own subclass of the ``Model`` base class and add your own generic
validation methods. Or you could write your own external validation
framework which you pass model instances to for checking. Choose
whichever approach is most suitable for your own requirements.