vendor/swiftmailer/doc/including-the-files.rst
author ymh <ymh.work@gmail.com>
Fri, 04 Nov 2011 11:52:47 +0100
changeset 24 57ff6d39f88c
parent 0 7f95f8617b0b
permissions -rwxr-xr-x
first full dynamic version of the bundle
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
7f95f8617b0b first commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
     1
Including Swift Mailer (Autoloading)
7f95f8617b0b first commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
     2
====================================
7f95f8617b0b first commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
     3
7f95f8617b0b first commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
     4
Swift Mailer uses an auto-loader so the only file you need to include is the
7f95f8617b0b first commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
     5
``lib/swift_required.php`` file.
7f95f8617b0b first commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
     6
7f95f8617b0b first commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
     7
To use Swift Mailer's autoloader:
7f95f8617b0b first commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
     8
7f95f8617b0b first commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
     9
* Put Swift Mailer somewhere accessible to your PHP scripts (this does not
7f95f8617b0b first commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    10
  need to be in the web root).
7f95f8617b0b first commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    11
7f95f8617b0b first commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    12
* Include, or require the ``lib/swift_required.php`` file.
7f95f8617b0b first commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    13
7f95f8617b0b first commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    14
* Follow the remainder of the documentation for using the available
7f95f8617b0b first commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    15
  components.
7f95f8617b0b first commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    16
7f95f8617b0b first commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    17
.. note::
7f95f8617b0b first commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    18
7f95f8617b0b first commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    19
    While Swift Mailer's autoloader is designed to play nicely with other
7f95f8617b0b first commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    20
    autoloaders, sometimes you may have a need to avoid using Swift Mailer's
7f95f8617b0b first commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    21
    autoloader and use your own instead. Include the ``swift_init.php``
7f95f8617b0b first commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    22
    instead of the ``swift_required.php`` if you need to do this. The very
7f95f8617b0b first commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    23
    minimum include is the ``swift_init.php`` file since Swift Mailer will not
7f95f8617b0b first commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    24
    work without the dependency injection this file sets up:
7f95f8617b0b first commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    25
7f95f8617b0b first commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    26
    .. code-block:: php
7f95f8617b0b first commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    27
7f95f8617b0b first commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    28
        require_once '/path/to/swift-mailer/lib/swift_required.php';
7f95f8617b0b first commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    29
7f95f8617b0b first commit
ymh <ymh.work@gmail.com>
parents:
diff changeset
    30
        /* rest of code goes here */