Init

Makefile

@@ -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/PhalconDocumentation.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PhalconDocumentation.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/PhalconDocumentation"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PhalconDocumentation"
+	@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."

_build/html/_sources/api/Phalcon_Acl.txt

@@ -0,0 +1,59 @@
+Class **Phalcon_Acl**
+=====================
+
+This component allows to manage ACL lists. An access control list (ACL) is a list  of permissions attached to an object. An ACL specifies which users or system processes  are granted access to objects, as well as what operations are allowed on given objects.  
+
+.. code-block:: php
+
+    <?php
+
+    $acl = new Phalcon_Acl('Memory');
+
+    // Default action is deny access
+    $acl->setDefaultAction(Phalcon_Acl::DENY);
+
+    // Create some roles
+    $roleAdmins = new Phalcon_Acl_Role('Administrators', 'Super-User role');
+    $roleGuests = new Phalcon_Acl_Role('Guests');
+
+    // Add "Guests" role to acl
+    $acl->addRole($roleGuests);
+
+    // Add "Designers" role to acl
+    $acl->addRole('Designers'));
+
+    // Define the "Customers" resource
+    $customersResource = new Phalcon_Acl_Resource('Customers', 'Customers management');
+
+    // Add "customers" resource with a couple of operations
+    $acl->addResource($customersResource, 'search');
+    $acl->addResource($customersResource, array('create', 'update'));
+
+    // Set access level for roles into resources
+    $acl->allow('Guests', 'Customers', 'search');
+    $acl->allow('Guests', 'Customers', 'create');
+    $acl->deny('Guests', 'Customers', 'update');
+
+    // Check whether role has access to the operations
+    $acl->isAllowed('Guests', 'Customers', 'edit')    //Returns 0
+    $acl->isAllowed('Guests', 'Customers', 'search'); //Returns 1
+    $acl->isAllowed('Guests', 'Customers', 'create'); //Returns 1
+
+Constants
+---------
+
+integer **ALLOW**
+
+integer **DENY**
+
+Methods
+---------
+
+**__construct** (string $adapterName, array $options)
+
+\tPhalcon_Acl Constructor
+
+**mixed** **__call** (string $method, array $arguments)
+
+\tPass any call to the internal adapter object
+

_build/html/_sources/api/Phalcon_Acl_Adapter_Memory.txt

@@ -0,0 +1,130 @@
+Class **Phalcon_Acl_Adapter_Memory**
+====================================
+
+Manages ACL lists in memory
+
+Methods
+---------
+
+**setDefaultAction** (int $defaultAccess)
+
+Sets the default access level (Phalcon_Acl::ALLOW or Phalcon_Acl::DENY)
+
+**getDefaultAction** ()
+
+Returns the default ACL access level
+
+**boolean** **addRole** (string $roleObject, array $accessInherits)
+
+Adds a role to the ACL list. Second parameter lets to inherit access data from other existing role  Example:  
+
+.. code-block:: php
+
+    <?php $acl->addRole('administrator', 'consultor');
+
+
+.. code-block:: php
+
+    <?php $acl->addRole('administrator', 'consultor');
+
+
+**addInherit** (string $roleName, string $roleToInherit)
+
+Inherit a role from another existing role
+
+**boolean** **isRole** (string $roleName)
+
+Check whether role exists in the roles list
+
+**boolean** **isResource** (string $resourceName)
+
+Check whether a resource exist in the resources list
+
+**boolean** **addResource** (Phalcon_Acl_Resource $resource, unknown $accessList)
+
+Adds a resource to the ACL list. Access names can be a particular action, for example search, update, delete, etc. or a list of them:
+
+.. code-block:: php
+
+    <?php
+
+    // Add a resource to the the list allowing access to an action
+    $acl->addResource(new Phalcon_Acl_Resource('customers'), 'search');
+    $acl->addResource('customers', 'search');
+
+    // Add a resource  with an access list
+    $acl->addResource(new Phalcon_Acl_Resource('customers'), array('create', 'search'));
+    $acl->addResource('customers', array('create', 'search'));
+
+
+**addResourceAccess** (string $resourceName, mixed $accessList)
+
+Adds access to resources
+
+**dropResourceAccess** (string $resourceName, mixed $accessList)
+
+Removes an access from a resource
+
+**_allowOrDeny** (unknown $roleName, unknown $resourceName, unknown $access, unknown $action)
+
+**allow** (string $roleName, string $resourceName, mixed $access)
+
+Allow access to a role on a resource  You can use '*' as wildcard  Ej:  
+
+.. code-block:: php
+
+    <?php
+
+    // Allow guests to search customers
+    $acl->allow('guests', 'customers', 'search');
+
+    // Allow guests to search or create customers
+    $acl->allow('guests', 'customers', array('search', 'create'));
+
+    // Allow any role to browse products
+    $acl->allow('*', 'products', 'browse');
+
+    // Allow any role to browse any resource
+    $acl->allow('*', '*', 'browse');
+
+
+**boolean** **deny** (string $roleName, string $resourceName, mixed $access)
+
+Deny access to a role on a resource. You can use '*' as a wildcard e.g.:  
+
+.. code-block:: php
+
+    <?php
+
+    // Deny guests to search customers
+    $acl->deny('guests', 'customers', 'search');
+
+    // Deny guests to search or create customers
+    $acl->deny('guests', 'customers', array('search', 'create'));
+
+    // Deny any role to browse products
+    $acl->deny('*', 'products', 'browse');
+
+    // Deny any role to browse any resource
+    $acl->deny('*', '*', 'browse');
+
+
+**boolean** **isAllowed** (string $role, string $resource, unknown $access)
+
+Check whether a role is allowed to access an action of a resource
+
+.. code-block:: php
+
+    <?php
+
+    // Can andres create new products (resource: Products)
+    $acl->isAllowed('andres', 'Products', 'create');
+
+    // Can guests edit any resource?
+    $acl->isAllowed('guests', '*', 'edit');
+
+
+**_rebuildAccessList** ()
+
+Rebuild the list of access from the inherit lists
+

_build/html/_sources/api/Phalcon_Acl_Exception.txt

@@ -0,0 +1,5 @@
+Class **Phalcon_Acl_Exception**
+===============================
+
+Class for exceptions thrown by Phalcon_Acl
+

_build/html/_sources/api/Phalcon_Acl_Resource.txt

@@ -0,0 +1,20 @@
+Class **Phalcon_Acl_Resource**
+==============================
+
+This class defines a resource entity and its description
+
+Methods
+---------
+
+**__construct** (string $name, string $description)
+
+Phalcon_Acl_Resource description
+
+**string** **getName** ()
+
+Returns the resource name
+
+**string** **getDescription** ()
+
+Returns the resource description
+

_build/html/_sources/api/Phalcon_Acl_Role.txt

@@ -0,0 +1,20 @@
+Class **Phalcon_Acl_Role**
+==========================
+
+This class defines a role entity and its description
+
+Methods
+---------
+
+**__construct** (string $name, string $description)
+
+Phalcon_Acl_Role description
+
+**string** **getName** ()
+
+Returns the role name
+
+**string** **getDescription** ()
+
+Returns the role description
+