{"tenancy":{"slug":"tenancy","name":"Tenancy","description":"The next-gen SaaS toolkit extending Laravel to service multiple tenant applications from the same code base. Scalable, increased flexibility and modularity.\n","repository":"https:\/\/github.com\/tenancy\/tenancy","downloads":null,"stargazers":{"2018-02":2,"2018-03":12,"2018-04":20,"2018-05":35,"2018-06":243,"2018-07":323,"2018-08":360,"2018-09":379,"2018-10":394,"2018-11":409,"2018-12":424,"2019-01":447,"2019-02":462,"2019-03":478,"2019-04":497,"2019-05":514,"2019-06":533,"2019-07":558,"2019-08":580,"2019-09":600,"2019-10":620,"2019-11":639,"2019-12":655,"2020-01":669,"2020-02":684,"2020-03":699,"2020-04":719,"2020-05":760,"2020-06":781,"2020-07":811,"2020-08":825,"2020-09":833,"2020-10":848,"2020-11":865,"2020-12":877,"2021-01":893,"2021-02":899,"2021-03":905,"2021-04":916,"2021-05":928,"2021-06":934,"2021-07":938,"2021-08":948,"2021-09":954,"2021-10":963,"2021-11":975,"2021-12":980,"2022-01":988,"2022-02":993,"2022-03":1002,"2022-04":1007,"2022-05":1013,"2022-06":1023,"2022-07":1028,"2022-08":1033,"2022-09":1037,"2022-10":1041},"versions":{"2.x":{"slug":"2.x","name":"2.x","status":"Stable","suggestion_using":true,"branch":"2.x","package":"tenancy","tree":[{"name":"getting started","links":["introduction","requirements","installation","architecture"],"slug":"getting-started","articles":[{"title":"Introduction","icon":"fal fa-clipboard-check","excerpt":"An introduction to the Tenancy ecosystem.","path":"docs\/tenancy\/2.x\/introduction.md","slug":"introduction","package":"tenancy","version":"2.x","contents":"<h1 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h1>\n<p>Tenancy is developed as a small ecosystem. It's a set of products\/packages that are all focused on one simple thing: Providing you the best way to get multi-tenancy working in your application.<\/p>\n<h2 id=\"the-idea\"><a href=\"#the-idea\" class=\"anchor-link\"><\/a>The idea<\/h2>\n<p>The general idea of Tenancy is to give a really powerful modular way of getting multi-tenancy working in <strong>any<\/strong> Laravel application.<\/p>\n<p>By using a modular approach we allow you to select only the components you need for your specific application. This allows you to only implement the specific functions you need without being forced to implement additional functionality changing how your application works.<\/p>\n","updated_at":{"date":"2022-06-14 06:44:26.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/introduction.md"},{"title":"Requirements","icon":"fal fa-clipboard-check","excerpt":"System and package requirements you need to take care of before installation.","path":"docs\/tenancy\/2.x\/requirements.md","slug":"requirements","package":"tenancy","version":"2.x","contents":"<h1 id=\"requirements\"><a href=\"#requirements\" class=\"anchor-link\"><\/a>Requirements<\/h1>\n<h2 id=\"knowledge\"><a href=\"#knowledge\" class=\"anchor-link\"><\/a>Knowledge<\/h2>\n<p>Multi-tenancy can be really hard to understand, let alone apply in an application. That's why we recommend everybody to first be fluent with Laravel application development before starting with Tenancy.<\/p>\n<h2 id=\"software\"><a href=\"#software\" class=\"anchor-link\"><\/a>Software<\/h2>\n<p>Tenancy is always looking to support the latest Laravel version for their packages. This version of Tenancy supports<\/p>\n<ul>\n<li>Laravel 9.x<\/li>\n<li>PHP 8.0 or higher<\/li>\n<\/ul>\n<p>As docs can sometimes be outdated, we highly recommend you to have a look at the most recent <a href=\"https:\/\/github.com\/tenancy\/tenancy\/actions?query=branch%3Amaster\">Github Actions<\/a>.<\/p>\n<h2 id=\"module-specific-requirements\"><a href=\"#module-specific-requirements\" class=\"anchor-link\"><\/a>Module Specific Requirements<\/h2>\n<p>Depending on which Tenancy modules are being used, there may be additional module specific requirements. Be sure to check each module that you are installing to ensure you meet the requirements.<\/p>\n","updated_at":{"date":"2022-06-14 06:44:26.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/requirements.md"},{"title":"Installation","icon":"fal fa-arrow-alt-to-bottom","path":"docs\/tenancy\/2.x\/installation.md","slug":"installation","package":"tenancy","version":"2.x","contents":"<h1 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h1>\n<ol>\n<li>\n<a href=\"#base-installation\">Base Installation<\/a>\n<\/li>\n<li>\n<a href=\"#simplified-install\">Simplified Install<\/a>\n<\/li>\n<li>\n<a href=\"#selective-install\">Selective Install<\/a> (<em>Recommended<\/em>)<\/li>\n<li>\n<a href=\"#next-steps\">Next Steps<\/a>\n<\/li>\n<\/ol>\n<h2 id=\"base-installation\"><a href=\"#base-installation\" class=\"anchor-link\"><\/a>Base Installation<\/h2>\n<p>There are two methods for getting the base package installed, <a href=\"#simplified-install\">Simplified<\/a> and <a href=\"#selective-install\">Selective<\/a>.<\/p>\n<p>The simplified install method will install the base package and all of the additional modules, but will not register all of the providers.<\/p>\n<p>The selective install method will only install the base package, and each additional module will need to be installed on its own.<\/p>\n<p>We would highly recommend using the selective installation method as it ensure that only the modules you need are installed, and it will automatically register the appropriate providers.<\/p>\n<h3 id=\"simplified-install\"><a href=\"#simplified-install\" class=\"anchor-link\"><\/a>Simplified Install<\/h3>\n<p>For a quick, simplified installation you can install everything at once:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/tenancy\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>IMPORTANT: You will need to manually enable your <a href=\"https:\/\/tenancy.dev\/docs\/tenancy\/2.x\/database-drivers\">database driver of choice<\/a>, by adding the related service provider to <code>app.php<\/code>.<\/p><\/div>\n<div class=\"alert alert-info\"><p>CAUTION: This will load specific non-intrusive Affects by default. You can check which are loaded by looking in the <code>composer.json<\/code> of the repository.<\/p><\/div>\n<p>This is an easy way of giving this toolkit a spin!<\/p>\n<div class=\"alert alert-info\"><p>We recommend selectively installing the packages you need.<\/p><\/div>\n<p>After you've installed tenancy\/tenancy make sure you register the Affects and Hooks you wish to use. You do this by simply registering the respective Providers.\nHere is the non-exhaustive list of providers that can be added to <code>config\/app.php<\/code>, make sure you comment out the ones you don't need.\nThe exact provider needed is included in each component's documentation.<\/p>\n<pre><code class=\"language-php\">    'providers' =&gt; [\n         \/\/ ...\n\n        \/*\n         * Package Service Providers...\n         *\/\n        Tenancy\\Affects\\Broadcasts\\Provider::class,\n        Tenancy\\Affects\\Cache\\Provider::class,\n        Tenancy\\Affects\\Configs\\Provider::class,\n        Tenancy\\Affects\\Connections\\Provider::class,\n        Tenancy\\Affects\\Filesystems\\Provider::class,\n        Tenancy\\Affects\\Logs\\Provider::class,\n        Tenancy\\Affects\\Mails\\Provider::class,\n        Tenancy\\Affects\\Models\\Provider::class,\n        Tenancy\\Affects\\Routes\\Provider::class,\n        Tenancy\\Affects\\URLs\\Provider::class,\n        Tenancy\\Affects\\Views\\Provider::class,\n\n        Tenancy\\Hooks\\Database\\Provider::class,\n        Tenancy\\Hooks\\Migration\\Provider::class,\n        Tenancy\\Hooks\\Hostname\\Provider::class,\n\n        Tenancy\\Database\\Drivers\\Mysql\\Provider::class,\n        Tenancy\\Database\\Drivers\\Sqlite\\Provider::class,\n         \/\/ ...\n    ]\n<\/code><\/pre>\n<h3 id=\"selective-install\"><a href=\"#selective-install\" class=\"anchor-link\"><\/a>Selective Install<\/h3>\n<p>Instead of loading all tenancy packages at once, you can selectively install\nwhat you need. You need at least the framework:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/framework\n<\/code><\/pre>\n<h2 id=\"next-steps\"><a href=\"#next-steps\" class=\"anchor-link\"><\/a>Next Steps<\/h2>\n<p>Now that the base package is installed you will need to determine what your <a href=\"tenant-what-is\">tenant object will be<\/a> and <a href=\"tenant-setup\">perform setup of the tenant object(s)<\/a>.<\/p>\n<p>After that selectively add and\/or configure:<\/p>\n<ul>\n<li>\n<a href=\"database-drivers\">Database drivers<\/a>. Where to allocate tenant information.<\/li>\n<li>\n<a href=\"hooks-general\">Lifecycle hooks<\/a>. Impact your application whenever tenants are created, updated or deleted.<\/li>\n<li>\n<a href=\"identification-general\">Identification drivers<\/a>. Allowing you to configure how your tenant is identified.<\/li>\n<li>\n<a href=\"affects-general\">Affects<\/a>. How your application is modified once a tenant is identified.<\/li>\n<\/ul>\n","updated_at":{"date":"2022-08-31 07:06:30.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/installation.md"},{"title":"Architecture","icon":"fa fa-cubes","excerpt":"An introduction to the architecture of Tenancy.","path":"docs\/tenancy\/2.x\/architecture.md","slug":"architecture","package":"tenancy","version":"2.x","contents":"<h1 id=\"architecture\"><a href=\"#architecture\" class=\"anchor-link\"><\/a>Architecture<\/h1>\n<p>The architecture of Tenancy is broken up into three main component types.<\/p>\n<ul>\n<li>Lifecycle Hooks<\/li>\n<li>Identification<\/li>\n<li>Affects<\/li>\n<\/ul>\n<h2 id=\"lifecycle-hooks\"><a href=\"#lifecycle-hooks\" class=\"anchor-link\"><\/a>Lifecycle Hooks<\/h2>\n<p>These components focus on what happens when a tenant is created, updated, or deleted in the system.\nThings as simple as ensuring that the domain a tenant sign up with is valid, to creating databases and registering\/creating services to handle the needs to the tenant occur in these components.<\/p>\n<p><a href=\"hooks-general\">Read More<\/a><\/p>\n<h2 id=\"identification\"><a href=\"#identification\" class=\"anchor-link\"><\/a>Identification<\/h2>\n<p>The identification components of tenancy are responsible for identifying the tenant before application logic\noccurs regardless if that logic stems from an HTTP request, a job running in a queue, or a command being run in the console.<\/p>\n<p><a href=\"identification-general\">Read More<\/a><\/p>\n<h2 id=\"affects\"><a href=\"#affects\" class=\"anchor-link\"><\/a>Affects<\/h2>\n<p>The Affect components are responsible for changing the application for the tenant that has been identified.\nSetting up connections to databases, changing logging settings, and the configuration of other services\noccur in these components.<\/p>\n<p><a href=\"affects-general\">Read More<\/a><\/p>\n","updated_at":{"date":"2022-06-14 06:44:26.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/architecture.md"}]},{"name":"tenants","links":["tenant-what-is","tenant-setup"],"slug":"tenants","articles":[{"title":"What is a tenant?","icon":"fal fa-id-badge","excerpt":"How to determine the selection of your tenant, what are valid\nsubjects and how do you configure these inside tenancy.\n","tags":["tenant"],"path":"docs\/tenancy\/2.x\/tenant-what-is.md","slug":"tenant-what-is","package":"tenancy","version":"2.x","contents":"<h1 id=\"what-is-a-tenant\"><a href=\"#what-is-a-tenant\" class=\"anchor-link\"><\/a>What is a Tenant?<\/h1>\n<ol>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#deciding-on-your-tenant\">Deciding on your Tenant<\/a>\n<\/li>\n<li>\n<a href=\"#next-step\">Next Step<\/a>\n<\/li>\n<\/ol>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p>Whether to separate data based on the requested hostname, the logged\nin user or the team the user belongs to, is entirely up to you.<\/p>\n<p>The subject of tenancy, <strong>the tenant<\/strong>, can be any eloquent Model\nin your application you wish to build your business logic around.<\/p>\n<h2 id=\"deciding-on-your-tenant\"><a href=\"#deciding-on-your-tenant\" class=\"anchor-link\"><\/a>Deciding on your Tenant<\/h2>\n<p>The most important decision in building a multi-tenant application\nis choosing your tenant. In order to help you with this, ask yourself the\nfollowing questions.<\/p>\n<p>To which entity in my business logic does the tenant data belong to?<\/p>\n<p>Do I have companies with employees signing up? Then most likely that\ncompany is the tenant, it holds all the information we want to keep separated\nfrom any other company in the application. This is a very common\nchoice visible with applications using a vanity url, eg yourteam.saas.app.<\/p>\n<p>Or perhaps we can keep it simple by marking the user as a tenant. This will\nconnect all data to a single account instead. A great example of this is\nGMail. You log in and see only the emails of your account.<\/p>\n<p>A hybrid version is also well known, GitHub offers personal namespaces, for instance\ngithub.com\/luceos and team namespaces like github.com\/tenancy.<\/p>\n<p>Tenancy offers a solution for any scenario as there's no limitation to how\na tenant is identified, nor how many tenants can be configured. To give you an idea\nusing the hybrid example from above the tenants would be both a User model\nand an Organization model. They can be marked as a valid tenant entity by applying\na contract and implementing the required methods.<\/p>\n<h2 id=\"next-step\"><a href=\"#next-step\" class=\"anchor-link\"><\/a>Next Step<\/h2>\n<p>Once you have identified what object(s) will be your tenant you will need to setup those tenants. To get started continue to <a href=\"tenant-setup\">Tenant Setup<\/a><\/p>\n","updated_at":{"date":"2022-06-14 06:44:26.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/tenant-what-is.md"},{"title":"Tenant Setup","icon":"fal fa-id-card-alt","excerpt":"General tenant setup.\n","tags":["tenant"],"path":"docs\/tenancy\/2.x\/tenant-setup.md","slug":"tenant-setup","package":"tenancy","version":"2.x","contents":"<h1 id=\"tenant-setup\"><a href=\"#tenant-setup\" class=\"anchor-link\"><\/a>Tenant Setup<\/h1>\n<ul>\n<li>\n<a href=\"#tenant-contract\">Tenant Contract<\/a>\n<ul>\n<li>\n<a href=\"#tenant-model-trait\">Tenant Model Trait<\/a>\n<\/li>\n<\/ul>\n<\/li>\n<li>\n<a href=\"tenant-registration\">Tenant Registration<\/a>\n<\/li>\n<li>\n<a href=\"#next-steps\">Next Steps<\/a>\n<ul>\n<li>\n<a href=\"#lifecycle-hooks\">Lifecycle Hooks<\/a>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2 id=\"tenant-contract\"><a href=\"#tenant-contract\" class=\"anchor-link\"><\/a>Tenant Contract<\/h2>\n<p>The tenant contract <code>Tenancy\\Identification\\Contracts\\Tenant<\/code> marks a specific\nClass as a valid tenant. Have the class implement the contract methods to get started:<\/p>\n<pre><code class=\"language-php\">use Illuminate\\Database\\Eloquent\\Model;\nuse Tenancy\\Identification\\Contracts\\Tenant;\n\nclass User extends Model implements Tenant\n{\n    \/**\n     * The attribute of the Model to use for the key.\n     *\n     * @return string\n     *\/\n    public function getTenantKeyName(): string\n    {\n        return 'id';\n    }\n\n    \/**\n     * The actual value of the key for the tenant Model.\n     *\n     * @return string|int\n     *\/\n    public function getTenantKey()\n    {\n        return $this-&gt;id;\n    }\n\n    \/**\n     * A unique identifier, eg class or table to distinguish this tenant Model.\n     *\n     * @return string\n     *\/\n    public function getTenantIdentifier(): string\n    {\n        return get_class($this);\n    }\n}\n<\/code><\/pre>\n<p>This will force your User model to implement some methods\nrequired for tenancy to do its work.<\/p>\n<h3 id=\"tenant-model-trait\"><a href=\"#tenant-model-trait\" class=\"anchor-link\"><\/a>Tenant Model Trait<\/h3>\n<p>Of course tenancy offers an easy way of applying the methods\nrequired by the contract to a model by using a trait for those specific functions.<\/p>\n<pre><code class=\"language-php\">use Illuminate\\Database\\Eloquent\\Model;\nuse Tenancy\\Identification\\Concerns\\AllowsTenantIdentification;\nuse Tenancy\\Identification\\Contracts\\Tenant;\n\nclass User extends Model implements Tenant\n{\n    use AllowsTenantIdentification;\n}\n<\/code><\/pre>\n<p>Your first valid tenant is a fact. Now we need to make sure our application\nis aware it exists.<\/p>\n<h2 id=\"tenant-registration\"><a href=\"#tenant-registration\" class=\"anchor-link\"><\/a>Tenant Registration<\/h2>\n<p>In order for the package to know a valid tenant is available, you will need\nto register it on the tenant identification resolver. The best to do so is inside\nyour <code>app\/Providers\/AppServiceProvider<\/code> or alternatively a dedicated <code>app\/Providers\/TenantProvider<\/code>\nwhich you created. You do this by providing the Tenant Resolver with the tenants using the <code>addModel<\/code> function.<\/p>\n<pre><code class=\"language-php\">namespace App\\Providers;\n\nuse App\\User;\nuse Illuminate\\Support\\ServiceProvider;\nuse Tenancy\\Identification\\Contracts\\ResolvesTenants;\n\nclass AppServiceProvider extends ServiceProvider\n{\n    \/**\n     * Bootstrap any application services.\n     *\n     * @return void\n     *\/\n    public function boot()\n    {\n        \/\/\n    }\n\n    \/**\n     * Register any application services.\n     *\n     * @return void\n     *\/\n    public function register()\n    {\n        $this-&gt;app-&gt;resolving(ResolvesTenants::class, function (ResolvesTenants $resolver) {\n            $resolver-&gt;addModel(User::class);\n            \n            return $resolver;\n        });\n    }\n}\n<\/code><\/pre>\n<h2 id=\"next-steps\"><a href=\"#next-steps\" class=\"anchor-link\"><\/a>Next Steps<\/h2>\n<h3 id=\"lifecycle-hooks\"><a href=\"#lifecycle-hooks\" class=\"anchor-link\"><\/a>Lifecycle Hooks<\/h3>\n<p><a href=\"hooks-general\">Lifecycle Hooks<\/a> allow you to take specific actions when a Tenant is created, updated, or deleted.<\/p>\n","updated_at":{"date":"2022-06-14 06:44:26.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/tenant-setup.md"}]},{"name":"lifecycle","links":["hooks-general","hooks-database","hooks-migrations","hooks-hostname","hooks-custom"],"slug":"lifecycle","articles":[{"title":"About lifecycle hooks","icon":"fal fa-heartbeat","excerpt":"How tenancy hooks into tenant lifecycle events\n","tags":["hooks","tenant"],"path":"docs\/tenancy\/2.x\/hooks-general.md","slug":"hooks-general","package":"tenancy","version":"2.x","contents":"<h1 id=\"lifecycle-hooks\"><a href=\"#lifecycle-hooks\" class=\"anchor-link\"><\/a>Lifecycle Hooks<\/h1>\n<ul>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#events\">Events<\/a>\n<\/li>\n<li>\n<a href=\"#priority\">Priority<\/a>\n<\/li>\n<li>\n<a href=\"#available-hooks\">Available Hooks<\/a>\n<\/li>\n<li>\n<a href=\"#next-steps\">Next Steps<\/a>\n<\/li>\n<\/ul>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p>Lifecycle hooks are executed whenever a tenant is created, updated or deleted.\nThey allow simple bootstrapping of a newly created tenant, like provisioning a new\ndatabase virtual machine, registering domains or setting up a S3 bucket.<\/p>\n<p>When the <code>HookResolver<\/code> fires the hooks, it will:<\/p>\n<ul>\n<li>Resolve the registered hooks.<\/li>\n<li>Call the <code>for()<\/code> method on the hook with the specific <a href=\"#events\">lifecycle event<\/a>.<\/li>\n<li>Filter hooks that aren't supposed to fire, by checking the response of the method <code>fires()<\/code>.<\/li>\n<li>Sorts based on the <code>priority()<\/code> method, see <a href=\"#priorities\">priorities<\/a>.<\/li>\n<li>Then calls the <code>fire()<\/code> method either:\n<ul>\n<li>directly.<\/li>\n<li>or dispatched to the queue returned from the <code>queue()<\/code> method when <code>queued()<\/code> is true.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2 id=\"events\"><a href=\"#events\" class=\"anchor-link\"><\/a>Events<\/h2>\n<p>Lifecycle hooks listen for any of the following events:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Tenant\\Events\\Created<\/code>\n<\/li>\n<li>\n<code>Tenancy\\Tenant\\Events\\Updated<\/code>\n<\/li>\n<li>\n<code>Tenancy\\Tenant\\Events\\Deleted<\/code>\n<\/li>\n<\/ul>\n<p>You will have to fire these events in your own codebase, for instance:<\/p>\n<pre><code class=\"language-php\">event(new \\Tenancy\\Tenant\\Events\\Created($tenant));\n<\/code><\/pre>\n<p>Or through Laravel's <code>$dispatchesEvents<\/code>:<\/p>\n<pre><code class=\"language-php\">use Illuminate\\Database\\Eloquent\\Model;\n\nclass Tenant extends Model\n{\n    protected $dispatchesEvents = [\n        'created' =&gt; \\Tenancy\\Tenant\\Events\\Created::class,\n        'updated' =&gt; \\Tenancy\\Tenant\\Events\\Updated::class,\n        'deleted' =&gt; \\Tenancy\\Tenant\\Events\\Deleted::class,\n    ];\n}\n<\/code><\/pre>\n<p>Some pointers you need to take into consideration:<\/p>\n<ul>\n<li>The tenant has to implement the <a href=\"identification-general#tenant-contract\">Tenant Contract<\/a>.<\/li>\n<li>Fire the event after your own code is finished.<\/li>\n<li>Fire the event outside of any transactions, so that changed attributes\nhave persisted and correct values are used by the hooks.<\/li>\n<\/ul>\n<h2 id=\"priorities\"><a href=\"#priorities\" class=\"anchor-link\"><\/a>Priorities<\/h2>\n<p>For hooks to be executed in the right sequence (eg migrations running after the database is created),\nthe hooks require a priority. Make sure your hooks use the correct value. Hooks are ran from lowest\nto highest priority.<\/p>\n<ul>\n<li>Databases created, updated and deleted: <code>-100<\/code>\n<\/li>\n<li>Migrations, if hooks-migrations is enabled: <code>-50<\/code>\n<\/li>\n<\/ul>\n<p>As a result if you want to set up and configure a database server when a tenant is created, make sure to\ndo so with a priority lower than -100. If you want to configure a database value dynamically after the\nmigrations and seeds are done, use a value higher than -50.<\/p>\n<h2 id=\"available-hooks\"><a href=\"#available-hooks\" class=\"anchor-link\"><\/a>Available Hooks<\/h2>\n<h3 id=\"first-party\"><a href=\"#first-party\" class=\"anchor-link\"><\/a>First Party<\/h3>\n<p><a href=\"hooks-database\">Database<\/a><\/p>\n<p><a href=\"hooks-migrations\">Migrations<\/a><\/p>\n<p><a href=\"hooks-hostname\">Hostname<\/a><\/p>\n<h2 id=\"next-steps\"><a href=\"#next-steps\" class=\"anchor-link\"><\/a>Next Steps<\/h2>\n<h3 id=\"identification\"><a href=\"#identification\" class=\"anchor-link\"><\/a>Identification<\/h3>\n<p><a href=\"identification-general\">Identification Drivers<\/a> will be how your application determins which tenant should be loaded during a request, command, or job.<\/p>\n","updated_at":{"date":"2022-06-14 06:44:26.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/hooks-general.md"},{"title":"Hooks Database","icon":"fal fa-database","excerpt":"How tenancy works with the Tenant lifecycle for Database mutations.\n","tags":["hooks","tenant","database"],"path":"docs\/tenancy\/2.x\/hooks-database.md","slug":"hooks-database","package":"tenancy","version":"2.x","contents":"<h1 id=\"lifecycle-hook-database\"><a href=\"#lifecycle-hook-database\" class=\"anchor-link\"><\/a>Lifecycle Hook: Database<\/h1>\n<ol>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#requirements\">Requirements<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuring\">Configuring<\/a>\n<ol>\n<li>\n<a href=\"#configuring-example\">Example<\/a>\n<\/li>\n<li>\n<a href=\"#remote-database-servers\">Remote Database Servers<\/a>\n<\/li>\n<li>\n<a href=\"#seperate-database-servers\">Seperate Database Server<\/a>\n<\/li>\n<\/ol>\n<\/li>\n<li>\n<a href=\"#database-mutations\">Database Mutations<\/a>\n<ol>\n<li>\n<a href=\"#mutations-example\">Example<\/a>\n<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to handle the creation, updating, and deletion of a Tenant's Database.<\/p>\n<p><strong>Requirements<\/strong><\/p>\n<ul>\n<li>In order to use this package a <a href=\"database-drivers\">Database Driver<\/a> must also be installed.<\/li>\n<li>A <a href=\"what-is-a-tenant\">Tenant<\/a> that dispatches the <code>Created<\/code>, <code>Updated<\/code>, and\/or <code>Deleted<\/code> <a href=\"hooks-general#events\">lifecycle events<\/a>.<\/li>\n<\/ul>\n<p><strong>Recommendations<\/strong><\/p>\n<ul>\n<li>To use the Tenant Database with the <code>onTenant<\/code> trait; The <a href=\"affects-connections\"><code>affects-connections<\/code><\/a> package should also be installed.<\/li>\n<\/ul>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Create a new Database when a Tenant is created.<\/li>\n<li>Update the Database when the Tenant is updated.<\/li>\n<li>Delete a Database when a Tenant is deleted.<\/li>\n<li>and Many More!<\/li>\n<\/ul>\n<p><strong>Events &amp; Methods<\/strong><\/p>\n<ul>\n<li>\n<code>Tenancy\\Hooks\\Database\\Events\\Drivers\\Configuring<\/code>\n<ul>\n<li>\n<code>useConnection()<\/code>\n<\/li>\n<li>\n<code>useConfig()<\/code>\n<\/li>\n<li>\n<code>defaults()<\/code>\n<\/li>\n<\/ul>\n<\/li>\n<li>\n<code>Tenancy\\Hooks\\Database\\Events\\ConfigureDatabaseMutation<\/code>\n<ul>\n<li>\n<code>disable()<\/code>\n<\/li>\n<li>\n<code>priority()<\/code>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2 id=\"requirements\"><a href=\"#requirements\" class=\"anchor-link\"><\/a>Requirements<\/h2>\n<ul>\n<li>\n<p>A Database Driver is responsible for actually creating the database. Most of the Database Drivers will run specific &quot;elevated permissions&quot; queries in order to provide a database and\/or a database user.<\/p>\n<p>Find a driver and corresponding information on the <a href=\"database-drivers\">Database Drivers Page<\/a><\/p>\n<\/li>\n<li>\n<p>A <a href=\"what-is-a-tenant\">Tenant<\/a> that dispatches the <code>Created<\/code>, <code>Updated<\/code>, and\/or <code>Deleted<\/code> <a href=\"hooks-general#events\">lifecycle events<\/a>.<\/p>\n<\/li>\n<\/ul>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<p>Most hooks have a really straight forward installation. <code>hooks-database<\/code> has a different approach and requires at least one of the <a href=\"database-drivers\">Database Drivers<\/a> to also be installed.<\/p>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/hooks-database\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Hooks\\Database\\Provider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuring\"><a href=\"#configuring\" class=\"anchor-link\"><\/a>Configuring<\/h2>\n<p>After requiring the package, we highly recommend you to listen to the <code>Tenancy\\Hooks\\Database\\Events\\Drivers\\Configuring<\/code> event. This allows you to adjust the Database configuration just the way you want it.<\/p>\n<p>There are a few functions to help you with setting up your Configuration.<\/p>\n<ul>\n<li>\n<code>useConnection()<\/code>, this function allows you to use one of the connections that you have defined in the <code>config\/database.php<\/code> of your Laravel application. It uses the name of the connection to identify which connection you're trying to use.<\/li>\n<li>\n<code>useConfig()<\/code>, this function allows you to use a file in any path to provide an array as a configuration.<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>All the above functions allow you to provide an <code>override<\/code> which will be merged in the provided configuration.<\/p><\/div>\n<ul>\n<li>\n<code>defaults()<\/code>, this will return an array that uses Tenancy's internal code to figure out the following:\n<ul>\n<li>Database Name, which is the tenant key<\/li>\n<li>Database User, which is the tenant key<\/li>\n<li>Database User Password, which is generated based on the <code>PasswordGenerator<\/code> that is in <code>tenancy\/framework<\/code>.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h3 id=\"configuring-example\"><a href=\"#configuring-example\" class=\"anchor-link\"><\/a>Configuring Example<\/h3>\n<p>In the example below we will configure the database to be created using the information from the <code>mysql<\/code> database connection defined in the <code>config\/database.php<\/code> and add Tenancy's default database settings to this.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Hooks\\Database\\Events\\Drivers\\Configuring;\n\nclass ConfigureTenantDatabase\n{\n    public function handle(Configuring $event)\n    {\n        $event-&gt;useConnection('mysql', $event-&gt;defaults($event-&gt;tenant));\n    }\n}\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Note: The <code>Tenancy\\Hooks\\Database\\Events\\Drivers\\Configuring<\/code> event is only used to generate the\nstatements required to manage the Tenant's database and user. It is <em>NOT<\/em> used to connect to the\ndatabase that these statements will run on.<\/p><\/div>\n<h4 id=\"remote-database-servers\"><a href=\"#remote-database-servers\" class=\"anchor-link\"><\/a>Remote Database Servers<\/h4>\n<p>In many production applications, the database will be on a seperate server than the application\nis executing on. This may cause issues in some cases due to how databases configure user access.<\/p>\n<p>Expanding on the previous example, the example below will set the host for the user to a wildcard\nallowing this user to connect from any host and access the database.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Hooks\\Database\\Events\\Drivers\\Configuring;\n\nclass ConfigureTenantDatabase\n{\n    public function handle(Configuring $event)\n    {\n        $overrides = array_merge(\n            ['host'=&gt;'%'],\n            $event-&gt;defaults($event-&gt;tenant)\n        );\n        $event-&gt;useConnection('mysql', $overrides);\n    }\n}\n<\/code><\/pre>\n<h4 id=\"seperate-database-servers\"><a href=\"#seperate-database-servers\" class=\"anchor-link\"><\/a>Seperate Database Servers<\/h4>\n<p>By default Tenancy will try to create the Tenant's database and user using the default connection.\nIn cases where Tenant's are stored on different database servers you will need to implement the\n<code>ManagesSystemConnection<\/code> interface.<\/p>\n<p>To get started have the <a href=\"what-is-a-tenant\">Tenant<\/a> class implement the <code>ManagesSystemConnection<\/code> interface\nand implement the <code>getManagingSystemConnection<\/code> method.<\/p>\n<p>In the following example, we assume that you have a <code>premium-mysql<\/code> connection specified in your\n<code>config\/database.php<\/code> configuration file.<\/p>\n<pre><code class=\"language-php\">use Illuminate\\Database\\Eloquent\\Model;\nuse Tenancy\\Identification\\Concerns\\AllowsTenantIdentification;\nuse Tenancy\\Identification\\Contracts\\Tenant;\nuse Tenancy\\Database\\Drivers\\Mysql\\Concerns\\ManagesSystemConnection;\n\nclass User extends Model implements Tenant, ManagesSystemConnection\n{\n    use AllowsTenantIdentification;\n\n    public function getManagingSystemConnection(): ?string\n    {\n        return 'premium-mysql';\n    }\n}\n<\/code><\/pre>\n<h2 id=\"database-mutations\"><a href=\"#database-mutations\" class=\"anchor-link\"><\/a>Database Mutations<\/h2>\n<p>Tenancy has provided a specific Event (<code>Tenancy\\Hooks\\Database\\Events\\ConfigureDatabaseMutation<\/code>) that will allow you to &quot;configure&quot; the Database Mutation. This event will be fired once we're sure that the Database Mutation should fire.<\/p>\n<p>This event will allow you to:<\/p>\n<ul>\n<li>Reprioritize the Hook<\/li>\n<li>Disable the hook<\/li>\n<\/ul>\n<p>You could do anything you could want when this event is fired.<\/p>\n<h3 id=\"mutations-example\"><a href=\"#mutations-example\" class=\"anchor-link\"><\/a>Mutations Example<\/h3>\n<p>In the example below we disable the mutation in order to retain the database after a Tenant is deleted.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Hooks\\Database\\Events\\ConfigureDatabaseMutation;\nuse Tenancy\\Tenant\\Events\\Deleted;\n\nclass ConfigureTenantDatabaseMutations\n{\n    public function handle(ConfigureDatabaseMutation $event)\n    {\n        if($event-&gt;event instanceof Deleted)\n        {\n            $event-&gt;disable();\n        }\n    }\n}\n<\/code><\/pre>\n","updated_at":{"date":"2022-06-14 06:44:26.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/hooks-database.md"},{"title":"Migrations and seeds","icon":"fal fa-inventory","excerpt":"Automatically run migrations and seeds on tenant lifecycle events.\n","tags":["hooks","tenant","migrations","seeds"],"path":"docs\/tenancy\/2.x\/hooks-migrations.md","slug":"hooks-migrations","package":"tenancy","version":"2.x","contents":"<h1 id=\"lifecycle-hook-migrations\"><a href=\"#lifecycle-hook-migrations\" class=\"anchor-link\"><\/a>Lifecycle Hook: Migrations<\/h1>\n<ul>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#migrations\">Migrations<\/a>\n<ul>\n<li>\n<a href=\"#migrations-configuration\">Configuration<\/a>\n<\/li>\n<li>\n<a href=\"#migrations-example\">Example<\/a>\n<\/li>\n<\/ul>\n<\/li>\n<li>\n<a href=\"#seeds\">Seeds<\/a>\n<ul>\n<li>\n<a href=\"#seeds-configuration\">Configuration<\/a>\n<\/li>\n<li>\n<a href=\"#seeds-example\">Example<\/a>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to handle the running of migrations and seeds.<\/p>\n<p><strong>Requirements<\/strong><\/p>\n<ul>\n<li>\n<p>This package requires the installation and configuration of the <a href=\"https:\/\/tenancy.dev\/docs\/tenancy\/1.x\/affects-connections\"><code>affects-connections<\/code><\/a> package.<\/p>\n<\/li>\n<li>\n<p>A <a href=\"tenant-what-is\">Tenant<\/a> that dispatches the <code>Created<\/code>, <code>Updated<\/code>, and\/or <code>Deleted<\/code> <a href=\"hooks-general#events\">lifecycle events<\/a>.<\/p>\n<\/li>\n<\/ul>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Run migrations after a database is created<\/li>\n<li>Run seeds after the database is created<\/li>\n<li>Run migrations after a tenant is updated or deleted.<\/li>\n<li>and Many More!<\/li>\n<\/ul>\n<p><strong>Events &amp; Methods<\/strong><\/p>\n<ul>\n<li>\n<code>Tenancy\\Hooks\\Migration\\Events\\ConfigureMigrations<\/code>\n<ul>\n<li>\n<code>path()<\/code>\n<\/li>\n<li>\n<code>flush()<\/code>\n<\/li>\n<li>\n<code>disable()<\/code>\n<\/li>\n<li>\n<code>priority()<\/code>\n<\/li>\n<\/ul>\n<\/li>\n<li>\n<code>Tenancy\\Hooks\\Migration\\Events\\ConfigureSeeds<\/code>\n<ul>\n<li>\n<code>seed()<\/code>\n<\/li>\n<li>\n<code>disable()<\/code>\n<\/li>\n<li>\n<code>priority()<\/code>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<p><code>hooks-migration<\/code> is a package that is a bit more complex than most Tenancy packages. This will take care of everything after a Database is created for your multi-database setup.<\/p>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/hooks-migration\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Hooks\\Migration\\Provider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"migrations\"><a href=\"#migrations\" class=\"anchor-link\"><\/a>Migrations<\/h2>\n<h3 id=\"migrations-configuration\"><a href=\"#migrations-configuration\" class=\"anchor-link\"><\/a>Migrations Configuration<\/h3>\n<p>Once you've installed the package, you will have to configure how Tenant should be migrated. You can do this by listening to the <code>\\Tenancy\\Hooks\\Migration\\Events\\ConfigureMigrations<\/code> event. It will provide you with some simple functionality in order to make your Migrations work like a charm:<\/p>\n<ul>\n<li>\n<code>path()<\/code>, this function allows you to register a path where your migrations are located. These migrations will be used once the migrations run.<\/li>\n<li>\n<code>disable()<\/code>, this function allows you to completely disable the migrations.<\/li>\n<li>\n<code>priority()<\/code>, this function allows you to change the priority in which the migrations run.<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>Warning: The default priority for migrations is: <code>-50<\/code> and will run <em>after<\/em> the <a href=\"hooks-database\">Database Hooks<\/a>.<\/p>\n<p>If migrations are not disabled or ran with a priority less than <code>-100<\/code> for the <code>Deleted<\/code> event you will receive an error as the database will have already been deleted.<\/p><\/div>\n<h3 id=\"migrations-example\"><a href=\"#migrations-example\" class=\"anchor-link\"><\/a>Migrations Example<\/h3>\n<p>In the example below we'll add the <code>database\/tenant\/migrations<\/code> folder containing migrations that should be used for the Tenant database.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Hooks\\Migration\\Events\\ConfigureMigrations;\n\nclass ConfigureTenantMigrations\n{\n    public function handle(ConfigureMigrations $event)\n    {\n        $event-&gt;path(database_path('tenant\/migrations'));\n    }\n}\n<\/code><\/pre>\n<h4 id=\"running-migrations-manually\"><a href=\"#running-migrations-manually\" class=\"anchor-link\"><\/a>Running migrations manually<\/h4>\n<p>If you have migration hook set up, you can fire <code>Tenancy\\Tenant\\Events\\Updated<\/code> event, which will trigger hooks and run the migrations:<\/p>\n<pre><code class=\"language-php\">event(new \\Tenancy\\Tenant\\Events\\Updated($tenant));\n<\/code><\/pre>\n<p>Alternativelly, you can use <code>php artisan migrate<\/code> command by passing addditional parameters:<\/p>\n<ul>\n<li>\n<code>--tenant<\/code> parameter will specify which tenant to run migrations for. This requires <a href=\"identification-console\">console identification<\/a>.<\/li>\n<li>\n<code>--database<\/code> parameter will tell migrations to run on <code>tenant<\/code> connection, which is set up dinamically using <a href=\"affects-connections\">affects-connections<\/a>.<\/li>\n<li>\n<code>--path<\/code> parameter will specify migration path.<\/li>\n<\/ul>\n<p>Example:<\/p>\n<pre><code>php artisan migrate --tenant=1 --database=tenant --path=database\/tenant\/migrations\n<\/code><\/pre>\n<h2 id=\"seeds\"><a href=\"#seeds\" class=\"anchor-link\"><\/a>Seeds<\/h2>\n<h3 id=\"seeds-configuration\"><a href=\"#seeds-configuration\" class=\"anchor-link\"><\/a>Seeds Configuration<\/h3>\n<p>Once you've installed the migrations, you might want to seed the database with some data for the tenant. In that case you can listen to the <code>\\Tenancy\\Hooks\\Migration\\Events\\ConfigureSeeds<\/code> event. This event has one very simple method that will be of use to you:<\/p>\n<ul>\n<li>\n<code>seed()<\/code>, this function will take the string of the seeder class. You can see how to use this in the example below.<\/li>\n<li>\n<code>disable()<\/code>, this function allows you to completely disable the seeds.<\/li>\n<li>\n<code>priority()<\/code>, this function allows you to change the priority in which the seeds run.<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>Note: the default priority is <code>-40<\/code> and will default to running after the migrations hook.<\/p><\/div>\n<h3 id=\"seeds-example\"><a href=\"#seeds-example\" class=\"anchor-link\"><\/a>Seeds Example<\/h3>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Hooks\\Migration\\Events\\ConfigureSeeds;\n\nclass ConfigureTenantSeeds\n{\n    public function handle(ConfigureSeeds $event)\n    {\n        $event-&gt;seed(\\UsersSeeder::class);\n    }\n}\n<\/code><\/pre>\n","updated_at":{"date":"2022-08-31 07:34:37.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/hooks-migrations.md"},{"title":"Hooks Hostname","icon":"fal fa-heartbeat","excerpt":"How tenancy works with the Tenant lifecycle for Hostname mutations.\n","tags":["tenant","hooks","hostname"],"path":"docs\/tenancy\/2.x\/hooks-hostname.md","slug":"hooks-hostname","package":"tenancy","version":"2.x","contents":"<h1 id=\"lifecycle-hook-hostname\"><a href=\"#lifecycle-hook-hostname\" class=\"anchor-link\"><\/a>Lifecycle Hook: Hostname<\/h1>\n<ul>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#introduction\">Introduction<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<ul>\n<li>\n<a href=\"#tenant\">Tenant<\/a>\n<\/li>\n<li>\n<a href=\"#handlers\">Handlers<\/a>\n<\/li>\n<li>\n<a href=\"#hook\">Hook<\/a>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to allow running custom functions when a Tenant is updated.<\/p>\n<p><strong>Requirements<\/strong><\/p>\n<ul>\n<li>A <a href=\"tenant-what-is\">Tenant<\/a> that dispatches the <code>Created<\/code>, <code>Updated<\/code>, and\/or <code>Deleted<\/code> <a href=\"hooks-general#events\">lifecycle events<\/a>.<\/li>\n<\/ul>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Register a new SSL Certificate<\/li>\n<li>Register a domain<\/li>\n<li>Change some configuration files<\/li>\n<li>Test the DNS to make sure the records are configured correctly<\/li>\n<li>and Many More!<\/li>\n<\/ul>\n<p><strong>Events &amp; Methods<\/strong><\/p>\n<ul>\n<li>\n<code>\\Tenancy\\Hooks\\Hostname\\Events\\ConfigureHostnames<\/code>\n<ul>\n<li>\n<code>disable()<\/code>\n<\/li>\n<li>\n<code>priority()<\/code>\n<\/li>\n<li>\n<code>registerHandler()<\/code>\n<\/li>\n<li>\n<code>getHandlers()<\/code>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h2>\n<p><code>Hooks-hostname<\/code> is all about working with hostnames of a tenant. A tenant might have one or multiple domains it is served over. During the lifecycle of this tenant it might change a few times and you need to take care of some really specific things.<\/p>\n<p>This hook allows you to register so-called <code>HostnameHandlers<\/code>. These handlers will take care of anything related to the hostname of a tenant.<\/p>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/hooks-hostname\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Hooks\\Hostname\\Provider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<h3 id=\"tenant\"><a href=\"#tenant\" class=\"anchor-link\"><\/a>Tenant<\/h3>\n<p>To begin, your Tenant's needs to be updated to use the <code>Tenancy\\Hooks\\Hostname\\Contracts\\HasHostnames<\/code> Contract and implement the <code>getHostnames<\/code> function returning an array of hostnames for the Tenant.<\/p>\n<p>In the following example we will assume that the Tenant has a &quot;hostname&quot; attribute.<\/p>\n<pre><code class=\"language-php\">class Tenant implements \\Tenancy\\Hooks\\Hostname\\Contracts\\HasHostnames\n{\n    public function getHostnames(): array\n    {\n        return [\n            $this-&gt;hostname\n        ];\n    }\n}\n<\/code><\/pre>\n<h3 id=\"handlers\"><a href=\"#handlers\" class=\"anchor-link\"><\/a>Handlers<\/h3>\n<p>Next, Handlers need to be created. They perform the logic to execute for each hostname such as registering a domain, updating nginx\/apache configuration files, etc.<\/p>\n<p>To create a handler, you need to create a new class that implements the <code>Tenancy\\Hooks\\Hostname\\Contracts\\HostnameHandler<\/code> contract and implements the <code>handle<\/code> function to perform the required logic.<\/p>\n<p>In the following example we try to check if the domains of the tenant are valid. If the tenant does not have valid domains, we will send an email to the administrator regarding the domains not being valid.<\/p>\n<pre><code class=\"language-php\">namespace App\\Handlers;\n\nuse Tenancy\\Hooks\\Hostname\\Contracts\\HostnameHandler;\nuse Tenancy\\Tenant\\Events\\Event;\nuse Illuminate\\Support\\Facades\\Mail;\n\nclass SimpleHandler implements HostnameHandler\n{\n    public function handle(Event $event): void\n    {\n        if (!$this-&gt;hasValidDomains($event-&gt;tenant)) {\n            Mail::to($event-&gt;tenant-&gt;email)-&gt;send(new DomainsNotValid($event-&gt;tenant-&gt;getHostnames()));\n        }\n    }\n}\n<\/code><\/pre>\n<h3 id=\"hook\"><a href=\"#hook\" class=\"anchor-link\"><\/a>Hook<\/h3>\n<p>Like most other hooks, this hook fires a simple event that allows you to configure it properly. The event is <code>\\Tenancy\\Hooks\\Hostname\\Events\\ConfigureHostnames<\/code> and it has some really simply functionality:<\/p>\n<ul>\n<li>\n<code>registerHandler()<\/code>, which allows you to register a handler.<\/li>\n<li>\n<code>getHandlers()<\/code>, which allows you to get the handler.<\/li>\n<\/ul>\n<p>In the following example we will register the handler created in the previous example.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse App\\Handlers\\SimpleHandler;\nuse Tenancy\\Hooks\\Hostname\\Events\\ConfigureHostnames;\n\nclass ConfigureHostnameHandlers\n{\n    public function handle(ConfigureHostnames $event)\n    {\n        $event-&gt;registerHandler(new SimpleHandler);\n    }\n}\n<\/code><\/pre>\n","updated_at":{"date":"2022-06-14 06:44:26.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/hooks-hostname.md"},{"title":"Custom lifecycle hooks","icon":"fal fa-gear","excerpt":"How to create custom lifecycle hooks\n","tags":["hooks","tenant"],"path":"docs\/tenancy\/2.x\/hooks-custom.md","slug":"hooks-custom","package":"tenancy","version":"2.x","contents":"<h1 id=\"lifecycle-hooks-custom-hooks\"><a href=\"#lifecycle-hooks-custom-hooks\" class=\"anchor-link\"><\/a>Lifecycle Hooks: Custom Hooks<\/h1>\n<ul>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#base\">Base<\/a>\n<\/li>\n<li>\n<a href=\"#implementation\">Implementation<\/a>\n<ul>\n<li>\n<a href=\"#general\">General<\/a>\n<\/li>\n<li>\n<a href=\"#differences\">Differences<\/a>\n<\/li>\n<\/ul>\n<\/li>\n<li>\n<a href=\"#registration\">Registration<\/a>\n<\/li>\n<li>\n<a href=\"#advanced\">Advanced<\/a>\n<ul>\n<li>\n<a href=\"#configureshook-event\">ConfiguresHook Event<\/a>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>Enable custom functionality that isn't available through existing hooks.<\/p>\n<p><strong>Requirements<\/strong><\/p>\n<ul>\n<li>Knowledge of how <a href=\"hooks-general\">Lifecycle Hooks work<\/a>\n<\/li>\n<li>A <a href=\"tenant-what-is\">Tenant<\/a> that dispatches the <code>Created<\/code>, <code>Updated<\/code>, and\/or <code>Deleted<\/code> <a href=\"hooks-general#events\">lifecycle events<\/a>.<\/li>\n<\/ul>\n<h2 id=\"base\"><a href=\"#base\" class=\"anchor-link\"><\/a>Base<\/h2>\n<p>You can build your own hook by implementing the <code>Tenancy\\Contracts\\LifecycleHook<\/code> contract.<\/p>\n<p>There are two abstract Hook classes that make implementation easier:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Lifecycle\\Hook<\/code>\n<\/li>\n<li>\n<code>Tenancy\\Lifecycle\\ConfigurableHook<\/code>\n<\/li>\n<\/ul>\n<p>The basic difference is that the hook settings are not expected to change in a <code>Hook<\/code>,\nbut are expected to be fluid in the <code>ConfigurableHook<\/code>.<\/p>\n<p>I.e. A Lifecycle Hook that always run at the same default priority on the same default queue should use <code>Hook<\/code>,\nbut a LifecycleHook that will run on the Tenant's Queue should use <code>ConfigurableHook<\/code><\/p>\n<h2 id=\"implementation\"><a href=\"#implementation\" class=\"anchor-link\"><\/a>Implementation<\/h2>\n<h3 id=\"general\"><a href=\"#general\" class=\"anchor-link\"><\/a>General<\/h3>\n<p>Implementation only requires you to create a <code>fire<\/code> method that contains the logic for the hook.<\/p>\n<pre><code class=\"language-php\">public function fire()\n{\n    echo &quot;Running hook for &quot;.$this-&gt;event-&gt;tenant-&gt;name;\n}\n<\/code><\/pre>\n<p>If the hook needs to implement different logic based on the event (I.e. Created vs Deleted) you can check the type of event in the <code>fire<\/code> method.<\/p>\n<pre><code class=\"language-php\">public function fire()\n{\n    \/\/ Created Event\n    if($this-&gt;event instanceof \\Tenancy\\Tenant\\Events\\Created)\n    {\n        dump(&quot;Running hook for the creation of a tenant&quot;);\n        return;\n    }\n    \/\/ Deleted Event\n    if($this-&gt;event instanceof \\Tenancy\\Tenant\\Events\\Deleted)\n    {\n        dump(&quot;Running hook for the deletion of a tenant&quot;);\n        return;\n    }\n}\n<\/code><\/pre>\n<p>In the event the hook only needs to be run based on one event you can disable the hook and only enable it when it should be fired<\/p>\n<pre><code class=\"language-php\">namespace App\\Hooks;\n\nclass CustomCreateHook extends ConfigurableHook\n{\n    public $fires = false;\n\n    public function for($event)\n    {\n        parent::for($event);\n        \n        if($this-&gt;event instanceof \\Tenancy\\Tenant\\Events\\Created)\n        {\n            $this-&gt;fires = true;\n        }\n        return $this;\n    }\n}\n<\/code><\/pre>\n<p>For more advanced or tenant-dependent changes to the event, consider creating an <a href=\"#configureshooks-event\">Event and Listener<\/a> to configure the Hook.<\/p>\n<h3 id=\"differences\"><a href=\"#differences\" class=\"anchor-link\"><\/a>Differences<\/h3>\n<p>The implementation of both <code>Hook<\/code> and <code>ConfigurableHook<\/code> is generally the same with the exception of the following differences.<\/p>\n<p><strong>Queues<\/strong><\/p>\n<p><code>Hook<\/code> defaults to running on a queue, and defaults to the applications default queue.\n<code>ConfigurableHook<\/code> does not default to using a queue and will only run on a queue when the queue is specified<\/p>\n<pre><code class=\"language-php\">\/\/ Hook\npublic $queued = true;\npublic $queue = null;\n\n\/\/ ConfigurableHook\npublic $queue = null;\n<\/code><\/pre>\n<p><strong>Fires<\/strong><\/p>\n<p><code>Hook<\/code> defaults to always fire as long as the event being passed is a valid Tenancy Event.\n<code>ConfigurableHook<\/code> defaults to always fire.<\/p>\n<pre><code class=\"language-php\">\/\/ Hook\npublic $event; \/\/Must be an instance of Tenancy\\Tenant\\Events\\Event\npublic $fires = true;\n\n\/\/ ConfigurableHook\npublic $fires = true;\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Note: Both <code>Hook<\/code> and <code>ConfigurableHook<\/code> have the <code>$event<\/code> property which contains the tenant in <code>$event-&gt;tenant<\/code><\/p><\/div>\n<h2 id=\"registration\"><a href=\"#registration\" class=\"anchor-link\"><\/a>Registration<\/h2>\n<p>There are two methods of registering your custom Lifecycle Event.<\/p>\n<h3 id=\"extend-hooksprovider\"><a href=\"#extend-hooksprovider\" class=\"anchor-link\"><\/a>Extend HooksProvider<\/h3>\n<p>The simplest method is to create a new Service Provider (or use an existing one) and have it extend <code>Tenancy\\Support\\HooksProvider<\/code>. Then create an array of your custom hooks.<\/p>\n<pre><code class=\"language-php\">namespace App\\Providers;\n\nclass TenantLifecycleProvider extends \\Tenancy\\Support\\HooksProvider\n{\n    protected $hooks = [\n        \\App\\Hooks\\CustomHook::class,\n    ];\n}\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>This is the recommended method of registering Lifecycle Events<\/p><\/div>\n<h3 id=\"resolving-the-resolver\"><a href=\"#resolving-the-resolver\" class=\"anchor-link\"><\/a>Resolving the Resolver<\/h3>\n<pre><code class=\"language-php\">namespace App\\Providers;\n\nuse Illuminate\\Support\\ServiceProvider;\nuse Tenancy\\Lifecycle\\Contracts\\ResolvesHooks;\n\nclass AppServiceProvider extends ServiceProvider\n{\n    public function boot()\n    {\n        $this-&gt;app-&gt;resolving(ResolvesHooks::class, function (ResolvesHooks $resolver) {\n            $resolver-&gt;addHook(\\App\\Hooks\\CustomHook::class);\n        });\n    }\n}\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Please note, this is not the recommended method of registering your Lifecycle Event<\/p><\/div>\n<h2 id=\"advanced\"><a href=\"#advanced\" class=\"anchor-link\"><\/a>Advanced<\/h2>\n<h3 id=\"configureshook-event\"><a href=\"#configureshook-event\" class=\"anchor-link\"><\/a>ConfiguresHook Event<\/h3>\n<div class=\"alert alert-info\"><p>It is recommended that you only implement this for <code>ConfigurableHook<\/code> hooks.<\/p><\/div>\n<p>In the event you want to perform advanced logic to configure the hook, much like the available hooks, you can create a new Event and Listener in order to configure your custom Hook. In order to do so, ensure you override the <code>for<\/code> method in your hook as follows.<\/p>\n<pre><code class=\"language-php\">\/\/ Hook\npublic function for($event)\n{\n    parent::for($event);\n    event(\\App\\Events\\ConfiguresCustomHookEvent($this-&gt;event, $this));\n    return $this;\n}\n<\/code><\/pre>\n<p><strong>Example Event<\/strong><\/p>\n<pre><code class=\"language-php\">namespace App\\Events;\n\nclass ConfiguresCustomHookEvent\n{\n    \/**\n     * @var Event\n     *\/\n    public $event;\n\n    \/**\n     * @var ConfigurableHook\n     *\/\n    public $hook;\n\n    public function __construct(Event $event, ConfigurableHook $hook)\n    {\n        $this-&gt;event = $event;\n        $this-&gt;hook = $hook;\n    }\n    \n    public function disable()\n    {\n        $this-&gt;hook-&gt;fires = false;\n        return $this;\n    }\n\n    public function priority(int $priority = -50)\n    {\n        $this-&gt;hook-&gt;priority = $priority;\n        return $this;\n    }\n}\n<\/code><\/pre>\n<p>At this point you can create your listener for the new event and register it as per the Laravel documentation.<\/p>\n","updated_at":{"date":"2022-06-14 06:44:26.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/hooks-custom.md"}]},{"name":"identification","links":["identification-general","identification-http","identification-queue","identification-console","identification-environment"],"slug":"identification","articles":[{"title":"General Setup","icon":"fal fa-id-card-alt","excerpt":"General setup for tenant identification.\n","tags":["tenant","identification"],"path":"docs\/tenancy\/2.x\/identification-general.md","slug":"identification-general","package":"tenancy","version":"2.x","contents":"<h1 id=\"tenant-identification\"><a href=\"#tenant-identification\" class=\"anchor-link\"><\/a>Tenant Identification<\/h1>\n<ul>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#handling-nothing-identified\">Handling Nothing Identified<\/a>\n<\/li>\n<li>\n<a href=\"#identification-drivers\">Identification Drivers<\/a>\n<\/li>\n<li>\n<a href=\"#next-steps\">Next Steps<\/a>\n<\/li>\n<\/ul>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p>The tenant identification procedure decides which tenant you are trying to service. Although using the <code>TenantResolver<\/code> isn't absolutely necessary, doing so offloads a great deal of the tenancy business logic to the application.<\/p>\n<p>The <code>TenantResolver<\/code> dispatches a few events used by the identification drivers to identify the currently requested <a href=\"tenant-what-is\">Tenant<\/a>. By using an event you are not limited to only one driver. Each driver will only trigger it's own contract when it is identifying. However, if identification is triggered without a specific driver, it will try to identify all drivers. The first driver to respond with a valid tenant object will cause the other drivers to be ignored.<\/p>\n<div class=\"alert alert-info\"><p>Before making any changes to any code, it is recommended that you read though this entire document first.<\/p><\/div>\n<h2 id=\"handling-nothing-identified\"><a href=\"#handling-nothing-identified\" class=\"anchor-link\"><\/a>Handling Nothing Identified<\/h2>\n<p>Depending on how you choose to build out your application, there may be times where you need to perform\nspecific logic when no tenant is identified. To achieve this one simply needs to create a listener for the <code>Tenancy\\Identification\\Events\\NothingIdentified<\/code> event.<\/p>\n<p>In the following example we will abort execution and return a 404 error.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Identification\\Events\\NothingIdentified;\n\nclass NoTenantIdentified \n{\n    public function handle(NothingIdentified $event) \n    {\n        abort(404);\n    }\n}\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Note: This is only required if your application always expects to have a tenant identified and does not have a default non-tenant side.<\/p><\/div>\n<h2 id=\"identification-drivers\"><a href=\"#identification-drivers\" class=\"anchor-link\"><\/a>Identification Drivers<\/h2>\n<p>Every driver uses the same principle. In order for a tenant to be used by the driver it has to implement an interface (or in Laravel terminology contract) related to the driver.<\/p>\n<p>Depending on your application, you may need to identify a Tenant using different methods. The following Identification Drivers are available to be used alone, or in combination.<\/p>\n<p><a href=\"identification-console\">Console Identification<\/a><\/p>\n<p><a href=\"identification-environment\">Environment Identification<\/a><\/p>\n<p><a href=\"identification-http\">HTTP based Identification<\/a><\/p>\n<p><a href=\"identification-queue\">Queue Identification<\/a><\/p>\n<div class=\"alert alert-info\"><p>The identification driver will only attempt identification of a tenant model when it implements the contract of the driver.<\/p><\/div>\n<h2 id=\"next-steps\"><a href=\"#next-steps\" class=\"anchor-link\"><\/a>Next Steps<\/h2>\n<h3 id=\"affects\"><a href=\"#affects\" class=\"anchor-link\"><\/a>Affects<\/h3>\n<p><a href=\"affects-general\">Affects<\/a> change the behaviour of your Laravel application by integrating closely with the framework.<\/p>\n","updated_at":{"date":"2022-06-14 06:44:26.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/identification-general.md"},{"title":"Identification driver http","icon":"fal fa-browser","excerpt":"Identifies tenants using the request (object).\n","tags":["identification","http","driver"],"path":"docs\/tenancy\/2.x\/identification-http.md","slug":"identification-http","package":"tenancy","version":"2.x","contents":"<h1 id=\"tenant-identification-http\"><a href=\"#tenant-identification-http\" class=\"anchor-link\"><\/a>Tenant Identification: HTTP<\/h1>\n<ul>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#introduction\">Introduction<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<ul>\n<li>\n<a href=\"#example\">Example<\/a>\n<\/li>\n<li>\n<a href=\"#subdomain-example\">Subdomain Example<\/a>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to allow a <a href=\"tenant-what-is\">Tenant<\/a> to be identified by a HTTP request.<\/p>\n<p><strong>Requirements<\/strong><\/p>\n<p>The Tenant <a href=\"tenant-setup\">must be registered in the TenantResolver<\/a><\/p>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Identify a Tenant by a sub-directory path<\/li>\n<li>Identify a Tenant by a subdomain<\/li>\n<li>Identify a Tenant based on a unique domain<\/li>\n<li>Identify a Tenant based on a query parameter<\/li>\n<li>And many more!<\/li>\n<\/ul>\n<h2 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h2>\n<p>Identifying a tenant through the HTTP request object is a very common way of identifying tenants.\nIn order to allow a tenant to be identified with the Http driver, you\nneed to apply a Contract to the <a href=\"tenant-what-is\">tenant<\/a> class and implement the required\nmethods.<\/p>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/identification-driver-http\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Identification\\Drivers\\Http\\Providers\\IdentificationProvider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<p>Tenants that will be identified via HTTP need to implement the <code>Tenancy\\Identification\\Drivers\\Http\\Contracts\\IdentifiesByHttp<\/code> Contract.<\/p>\n<p>The <code>tenantIdentificationByHttp<\/code> method should return the tenant that is identified based on the current request.<\/p>\n<h3 id=\"example\"><a href=\"#example\" class=\"anchor-link\"><\/a>Example<\/h3>\n<p>The example below assumes your Customer has two additional columns to identify the portal it's configured to use. The\nportal hostname and path allow you to identify this Customer as being the Tenant for the current hostname and path\nrequested.<\/p>\n<pre><code class=\"language-php\">use Illuminate\\Database\\Eloquent\\Model;\nuse Illuminate\\Http\\Request;\nuse Tenancy\\Identification\\Concerns\\AllowsTenantIdentification;\nuse Tenancy\\Identification\\Contracts\\Tenant;\nuse Tenancy\\Identification\\Drivers\\Http\\Contracts\\IdentifiesByHttp;\n\nclass Customer extends Model implements Tenant, IdentifiesByHttp\n{\n  use AllowsTenantIdentification;\n  \n    \/**\n     * Specify whether the tenant model is matching the request.\n     *\n     * @param Request $request\n     * @return Tenant\n     *\/\n    public function tenantIdentificationByHttp(Request $request): ?Tenant\n    {\n        return $this-&gt;query()\n            -&gt;where('portal_hostname', $request-&gt;getHttpHost())\n            -&gt;where('portal_path', $request-&gt;path())\n            -&gt;first();\n    }\n}\n<\/code><\/pre>\n<h3 id=\"subdomain-example\"><a href=\"#subdomain-example\" class=\"anchor-link\"><\/a>Subdomain Example<\/h3>\n<p>The following example assumes that your Customer model has an extra column for a subdomain the user is configured to use.<\/p>\n<pre><code class=\"language-php\">use Illuminate\\Database\\Eloquent\\Model;\nuse Illuminate\\Http\\Request;\nuse Tenancy\\Identification\\Concerns\\AllowsTenantIdentification;\nuse Tenancy\\Identification\\Contracts\\Tenant;\nuse Tenancy\\Identification\\Drivers\\Http\\Contracts\\IdentifiesByHttp;\n\nclass Customer extends Model implements Tenant, IdentifiesByHttp\n{\n  use AllowsTenantIdentification;\n  \n    \/**\n     * Specify whether the tenant model is matching the request.\n     *\n     * @param Request $request\n     * @return Tenant\n     *\/\n    public function tenantIdentificationByHttp(Request $request): ?Tenant\n    {\n        list($subdomain) = explode('.', $request-&gt;getHost(), 2);\n        return $this-&gt;query()\n            -&gt;where('subdomain', $subdomain)\n            -&gt;first();\n    }\n}\n<\/code><\/pre>\n","updated_at":{"date":"2022-06-14 06:44:26.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/identification-http.md"},{"title":"Identification driver queue","icon":"fal fa-conveyor-belt","excerpt":"Identifies tenants using the queue.\n","tags":["identification","console","driver","queue"],"path":"docs\/tenancy\/2.x\/identification-queue.md","slug":"identification-queue","package":"tenancy","version":"2.x","contents":"<h1 id=\"tenant-identification-queue\"><a href=\"#tenant-identification-queue\" class=\"anchor-link\"><\/a>Tenant Identification: Queue<\/h1>\n<ul>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#introduction\">Introduction<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<\/li>\n<li>\n<a href=\"#example\">Example<\/a>\n<\/li>\n<li>\n<a href=\"#overriding\">Overriding<\/a>\n<ul>\n<li>\n<a href=\"#example-job\">Example Job<\/a>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to allow a <a href=\"tenant-what-is\">Tenant<\/a> to be identified in a queued Job.<\/p>\n<p><strong>Requirements<\/strong><\/p>\n<p>The Tenant <a href=\"tenant-setup\">must be registered in the TenantResolver<\/a><\/p>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Identify the Tenant a specific job is for<\/li>\n<li>And many more!<\/li>\n<\/ul>\n<h2 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h2>\n<p>One of the most powerful features in Laravel are the <a href=\"https:\/\/laravel.com\/docs\/master\/queues\">queues<\/a>. These are used for running specific tasks that don't need a UI and can be delayed. These can be hard to handle when it comes to multi-tenancy, and that is exactly where this package comes in.<\/p>\n<p>The package already does a lot of work for you, if an tenant is identified at the moment a job is queued, it will remember which tenant it was. It will also provide you with some powerful override tools in case you want to queue something for a different tenant.<\/p>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/identification-driver-queue\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Identification\\Drivers\\Queue\\Providers\\IdentificationProvider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuring\"><a href=\"#configuring\" class=\"anchor-link\"><\/a>Configuring<\/h2>\n<p>In order to enable queue identification for a tenant, it will have to implement the specific contract <code>Tenancy\\Identification\\Drivers\\Queue\\Contracts\\IdentifiesByQueue<\/code>. You will see that in this function you will get a simple custom <code>Processing<\/code> event which will contain one of these 2 pieces of information:<\/p>\n<ul>\n<li>The default provided <code>tenant_key<\/code> and <code>tenant_identifier<\/code> that are registered if a tenant was identified when a job was queued.<\/li>\n<li>The <a href=\"#overriding\">overridden<\/a> <code>tenant<\/code>, <code>tenant_key<\/code> or <code>tenant_identifier<\/code>, which you can provide yourself.<\/li>\n<\/ul>\n<h3 id=\"example\"><a href=\"#example\" class=\"anchor-link\"><\/a>Example<\/h3>\n<p>In the example below we will first check if an override tenant has been provided. If that is not the case, we will simply check if we can find the tenant in this model.<\/p>\n<p><code>app\/Models\/Customer.php<\/code><\/p>\n<pre><code class=\"language-php\">use Illuminate\\Database\\Eloquent\\Model;\nuse Tenancy\\Identification\\Concerns\\AllowsTenantIdentification;\nuse Tenancy\\Identification\\Contracts\\Tenant;\nuse Tenancy\\Identification\\Drivers\\Queue\\Events\\Processing;\nuse Tenancy\\Identification\\Drivers\\Queue\\Contracts\\IdentifiesByQueue;\n\nclass Customer extends Model implements Tenant, IdentifiesByQueue\n{\n    public function tenantIdentificationByQueue(Processing $event): ?Tenant\n    {\n        if ($event-&gt;tenant) {\n            return $event-&gt;tenant;\n        }\n\n        if ($event-&gt;tenant_key &amp;&amp; $event-&gt;tenant_identifier === $this-&gt;getTenantIdentifier()) {\n            return $this-&gt;newQuery()\n                -&gt;where($this-&gt;getTenantKeyName(), $event-&gt;tenant_key)\n                -&gt;first();\n        }\n\n        return null;\n    }\n} \n<\/code><\/pre>\n<h2 id=\"overriding\"><a href=\"#overriding\" class=\"anchor-link\"><\/a>Overriding<\/h2>\n<p>Sometimes you might want to override the tenant (when you have an admin panel that is a tenant for example). You can do this by providing one of the following public keys for a job:<\/p>\n<ul>\n<li>\n<code>tenant_identifier<\/code>, this should be the same as the <code>getTenantIdentifier<\/code> of a tenant.<\/li>\n<li>\n<code>tenant_key<\/code>, this should be the same as the <code>getTenantKey<\/code> of a tenant.<\/li>\n<li>\n<code>tenant<\/code>, this can be an entire Tenant object.<\/li>\n<\/ul>\n<h3 id=\"overridable-job\"><a href=\"#overridable-job\" class=\"anchor-link\"><\/a>Overridable Job<\/h3>\n<pre><code class=\"language-php\">namespace App\\Jobs;\n\nuse App\\Models\\Customer;\nuse Illuminate\\Bus\\Queueable;\nuse Illuminate\\Contracts\\Queue\\ShouldQueue;\nuse Illuminate\\Foundation\\Bus\\Dispatchable;\nuse Illuminate\\Queue\\InteractsWithQueue;\nuse Illuminate\\Queue\\SerializesModels;\nuse Tenancy\\Facades\\Tenancy;\n\nclass MailCustomer implements ShouldQueue\n{\n    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;\n\n    \/** @var Customer $tenant *\/\n    public $tenant;\n\n    public function __construct(Customer $customer, $tenant_key = null, string $tenant_identifier = null)\n    {\n        $this-&gt;tenant = $customer;\n    }\n\n    public function handle()\n    {\n        \/\/ ..\n    }\n}\n\n<\/code><\/pre>\n","updated_at":{"date":"2022-06-14 06:44:26.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/identification-queue.md"},{"title":"Console Identification","icon":"fal fa-terminal","excerpt":"Identifies tenants using the console\/artisan.\n","tags":["identification","console","driver","artisan"],"path":"docs\/tenancy\/2.x\/identification-console.md","slug":"identification-console","package":"tenancy","version":"2.x","contents":"<h1 id=\"tenant-identification-console\"><a href=\"#tenant-identification-console\" class=\"anchor-link\"><\/a>Tenant Identification: Console<\/h1>\n<ul>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#introduction\">Introduction<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<ul>\n<li>\n<a href=\"#example\">Example<\/a>\n<\/li>\n<li>\n<a href=\"#advance-example\">Advance Example<\/a>\n<\/li>\n<\/ul>\n<\/li>\n<li>\n<a href=\"#usage\">Usage<\/a>\n<\/li>\n<\/ul>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to allow a <a href=\"tenant-what-is\">Tenant<\/a> to be identified though console commands<\/p>\n<p><strong>Requirements<\/strong><\/p>\n<p>The Tenant <a href=\"tenant-setup\">must be registered in the TenantResolver<\/a><\/p>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Identify a Tenant by a custom field<\/li>\n<li>Identify a Tenant by an ID<\/li>\n<li>And many more!<\/li>\n<\/ul>\n<h2 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h2>\n<p>Uses the console input object to identify a tenant.<\/p>\n<p>In order to allow a tenant to be identified with the Console driver, all\ncommands have gained two new options, <code>--tenant<\/code> and <code>--tenant-identifier<\/code>.<\/p>\n<p>For a tenant to be identified with the Console driver, you\nneed to apply a Contract to the [tenant][tenant-what-is] class and implement the required\nmethods.<\/p>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<div class=\"alert alert-info\"><p>Make sure that the model you are using <a href=\"identification-general\">is registered in the TenantResolver<\/a>.<\/p><\/div>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/identification-driver-console\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Identification\\Drivers\\Console\\Providers\\IdentificationProvider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<p>Tenants that will be identified by console need to implement the <code>Tenancy\\Identification\\Drivers\\Console\\Contracts\\IdentifiesByConsole<\/code> contract.<\/p>\n<p>The <code>tenantIdentificationByConsole<\/code> method should return the tenant that is identified based on the current request.<\/p>\n<h3 id=\"example\"><a href=\"#example\" class=\"anchor-link\"><\/a>Example<\/h3>\n<p>The following example assumes your Customer has a slug column with which we use to identify it.<\/p>\n<pre><code class=\"language-php\">use Illuminate\\Database\\Eloquent\\Model;\nuse Tenancy\\Identification\\Concerns\\AllowsTenantIdentification;\nuse Tenancy\\Identification\\Contracts\\Tenant;\nuse Tenancy\\Identification\\Drivers\\Console\\Contracts\\IdentifiesByConsole;\nuse Symfony\\Component\\Console\\Input\\InputInterface;\n\nclass Customer extends Model implements Tenant, IdentifiesByConsole\n{\n    use AllowsTenantIdentification;\n  \n    \/**\n     * Specify whether the tenant model is matching the request.\n     *\n     * @param Request $request\n     * @return Tenant\n     *\/\n    public function tenantIdentificationByConsole(InputInterface $input): ?Tenant\n    {\n        if ($input-&gt;hasParameterOption('--tenant')) {\n            return $this-&gt;query()\n                -&gt;where('slug', $input-&gt;getParameterOption('--tenant'))\n                -&gt;first();\n        }\n        \n        return null;\n    }\n}\n<\/code><\/pre>\n<h3 id=\"advance-example\"><a href=\"#advance-example\" class=\"anchor-link\"><\/a>Advance Example<\/h3>\n<p>In the following example, we will expand upon the previous example with the assumption that you have multiple Tenant types, that may share the same slug.<\/p>\n<pre><code class=\"language-php\">use Illuminate\\Database\\Eloquent\\Model;\nuse Tenancy\\Identification\\Concerns\\AllowsTenantIdentification;\nuse Tenancy\\Identification\\Contracts\\Tenant;\nuse Tenancy\\Identification\\Drivers\\Console\\Contracts\\IdentifiesByConsole;\nuse Symfony\\Component\\Console\\Input\\InputInterface;\n\nclass Customer extends Model implements Tenant, IdentifiesByConsole\n{\n    use AllowsTenantIdentification;\n  \n    \/**\n     * Specify whether the tenant model is matching the request.\n     *\n     * @param Request $request\n     * @return Tenant|null\n     *\/\n    public function tenantIdentificationByConsole(InputInterface $input): ?Tenant\n    {\n        if ($input-&gt;hasParameterOption('--tenant-identifier')) {\n            if($input-&gt;getParameterOption('--tenant-identifier') != $this-&gt;getTenantIdentifier()) {\n                return null;\n            }\n        }\n        if ($input-&gt;hasParameterOption('--tenant')) {\n            return $this-&gt;query()\n                -&gt;where('slug', $input-&gt;getParameterOption('--tenant'))\n                -&gt;first();\n        }\n        \n        return null;\n    }\n}\n<\/code><\/pre>\n<h2 id=\"usage\"><a href=\"#usage\" class=\"anchor-link\"><\/a>Usage<\/h2>\n<h3 id=\"code-tenantcode\"><a href=\"#code-tenantcode\" class=\"anchor-link\"><\/a><code>--tenant<\/code><\/h3>\n<p>This option allows you to specify a specific Tenant.<\/p>\n<p>In the following example we will assume that you want to list the routes available for a specific tenant.<\/p>\n<p>We will also assume that the tenant in question has the previous example implemented, has the slug of &quot;my-first-tenant&quot;.<\/p>\n<pre><code class=\"language-bash\">php artisan route:list --tenant=my-first-tenant\n<\/code><\/pre>\n<h3 id=\"code-tenant-identifiercode\"><a href=\"#code-tenant-identifiercode\" class=\"anchor-link\"><\/a><code>--tenant-identifier<\/code><\/h3>\n<p>This option allows you to specify a specific Tenant type.<\/p>\n<p>Because Tenants can be multiple classes this option is useful when writing custom commands to do something specific to different types of Tenants, or when different types of tenants could be identified by the same <code>--tenant<\/code> value.<\/p>\n<h4 id=\"custom-command\"><a href=\"#custom-command\" class=\"anchor-link\"><\/a>Custom Command<\/h4>\n<p>In the following example command, we will assume that every tenant has a &quot;maintenance&quot; value to enable or disable it from being redirected to a maintenance page without having to bring down the entire application.<\/p>\n<p>We will also assume that you have two Tenants; User's and Organization's.<\/p>\n<pre><code class=\"language-php\">namespace App\\Console\\Commands;\n\nuse Illuminate\\Console\\Command;\n\nclass TenantMaintenanceCommand extends Command\n{\n    protected $signature = 'tenant:maintenance';\n\n    protected $description = 'Inverts the Maintenance mode for a tenant';\n\n    \/** @var Resolver *\/\n    protected $resolver;\n\n    public function __construct(ResolvesTenants $resolver)\n    {\n        parent::__construct();\n        $this-&gt;resolver = $resolver;\n    }\n\n    public function handle()\n    {\n        $this-&gt;resolver-&gt;getModels()-&gt;each(function (string $class) {\n            $model = (new $class());\n\n            if ($this-&gt;option('tenant-identifier') != $model-&gt;getTenantIdentifier()) {\n                return;\n            }\n\n            $model-&gt;all()-&gt;each(function($tenant) {\n                $tenant-&gt;maintenance = !$tenant-&gt;maintenance;\n                $tenant-&gt;save();\n            })\n\n        });\n    }\n}\n<\/code><\/pre>\n<h4 id=\"usage\"><a href=\"#usage\" class=\"anchor-link\"><\/a>Usage<\/h4>\n<p>In order to run your custom command only for User Tenants you can do the following:<\/p>\n<pre><code class=\"language-bash\">php artisan tenant:maintenance --tenant-identifier=mysql.users\n<\/code><\/pre>\n","updated_at":{"date":"2022-06-14 06:44:26.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/identification-console.md"},{"title":"Environment Identification","icon":"fal fa-leaf","excerpt":"Identifies tenants using the environment\n","tags":["environment","console","driver","artisan"],"path":"docs\/tenancy\/2.x\/identification-environment.md","slug":"identification-environment","package":"tenancy","version":"2.x","contents":"<h1 id=\"tenant-identification-environment\"><a href=\"#tenant-identification-environment\" class=\"anchor-link\"><\/a>Tenant Identification: Environment<\/h1>\n<ul>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#introduction\">Introduction<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<ul>\n<li>\n<a href=\"#example\">Example<\/a>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to allow a <a href=\"tenant-what-is\">Tenant<\/a> to be identified based on the environment<\/p>\n<p><strong>Requirements<\/strong><\/p>\n<p>The Tenant <a href=\"tenant-setup\">must be registered in the TenantResolver<\/a><\/p>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Identify a Tenant by which environment the application is running in<\/li>\n<li>Ensure a specific tenant is loaded in a demonstration environment<\/li>\n<li>And many more!<\/li>\n<\/ul>\n<h2 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h2>\n<p>This package allows the identification of a tenant based on the environment.<\/p>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/identification-driver-environment\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Identification\\Drivers\\Environment\\Providers\\IdentificationProvider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<p>This allows you to set up your own identification requirements based on environment variables, eg:<\/p>\n<ul>\n<li>Slug, custom generated, human readable string.<\/li>\n<li>Id, the database auto increment id.<\/li>\n<\/ul>\n<h3 id=\"example\"><a href=\"#example\" class=\"anchor-link\"><\/a>Example<\/h3>\n<pre><code class=\"language-php\">use Illuminate\\Database\\Eloquent\\Model;\nuse Tenancy\\Identification\\Concerns\\AllowsTenantIdentification;\nuse Tenancy\\Identification\\Contracts\\Tenant;\nuse Tenancy\\Identification\\Drivers\\Environment\\Contracts\\IdentifiesByEnvironment;\n\nclass Customer extends Model implements Tenant, IdentifiesByEnvironment\n{\n  use AllowsTenantIdentification;\n  \n    \/**\n     * Specify whether the tenant model is matching the request.\n     *\n     * @return Tenant\n     *\/\n    public function tenantIdentificationByEnvironment(): ?Tenant\n    {\n        if ($tenant = env('TENANT')) {\n            return $this-&gt;query()\n                -&gt;where('slug', $tenant)\n                -&gt;first();\n        }\n        \n        return null;\n    }\n}\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Be warned that using the <code>env()<\/code> helper will not work when the config is cached by Laravel.<\/p><\/div>\n","updated_at":{"date":"2022-06-14 06:44:26.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/identification-environment.md"}]},{"name":"affects","links":["affects-general","affects-broadcasts","affects-cache","affects-configs","affects-connections","affects-filesystems","affects-logs","affects-mails","affects-models","affects-routes","affects-urls","affects-views"],"slug":"affects","articles":[{"title":"About affects","icon":"fal fa-reply-all","excerpt":"How tenancy modifies your Laravel app.\n","tags":["affects","tenant"],"path":"docs\/tenancy\/2.x\/affects-general.md","slug":"affects-general","package":"tenancy","version":"2.x","contents":"<h1 id=\"affects\"><a href=\"#affects\" class=\"anchor-link\"><\/a>Affects<\/h1>\n<ul>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#Process\">Process<\/a>\n<\/li>\n<\/ul>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p>Affects change the behaviour of your Laravel application by integrating closely with the\nframework. You can modify routes, views and much more by using an affect or creating\nyour own!<\/p>\n<p>Affects are an important component to the workings of tenancy. Each affect influences your\nLaravel app, but enabling them isn't enough for most of them. Affects fire events, which allow\nyou to hook into. This makes it incredibly easy to implement your own specific modifications\nwithout the hard work of hooking into the Laravel ecosystem or knowing the inner workings of\nthe tenancy framework.<\/p>\n<h2 id=\"process\"><a href=\"#process\" class=\"anchor-link\"><\/a>Process<\/h2>\n<p>The easiest way to listen to the events and influence the affects to do your bidding, is by\ncreating a listener in the EventServiceProvider. Let's take the <a href=\"affects-routes\">Routes Affects<\/a>\nas an example.<\/p>\n<p>First, create a listener.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Affects\\Routes\\Events\\ConfigureRoutes;\n\nclass TenantRoutes \n{\n    public function handle(ConfigureRoutes $event) \n    {\n        $event\n            -&gt;flush()\n            -&gt;fromFile(\n                ['middleware' =&gt; ['web']],\n                base_path('\/routes\/tenant.php')\n            );\n    }\n}\n<\/code><\/pre>\n<p>Now register that listener in your EventServiceProvider for instance.<\/p>\n<pre><code class=\"language-php\">namespace App\\Providers;\n\nuse App\\Listeners\\TenantRoutes;\nuse Illuminate\\Auth\\Events\\Registered;\nuse Illuminate\\Auth\\Listeners\\SendEmailVerificationNotification;\nuse Illuminate\\Foundation\\Support\\Providers\\EventServiceProvider as ServiceProvider;\nuse Tenancy\\Affects\\Routes\\Events\\ConfigureRoutes;\n\nclass EventServiceProvider extends ServiceProvider\n{\n    protected $listen = [\n        Registered::class =&gt; [\n            SendEmailVerificationNotification::class,\n        ],\n        \n        ConfigureRoutes::class =&gt; [\n            TenantRoutes::class,\n        ]\n    ];\n    \/\/ ..\n}\n\n<\/code><\/pre>\n<p>That's it, from now on whenever a tenant is identified or switched to, the routes\ncontained in <code>routes\/tenant.php<\/code> are activated.<\/p>\n","updated_at":{"date":"2022-06-14 06:44:26.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/affects-general.md"},{"title":"Broadcasts","icon":"fal fa-wifi","excerpt":"Makes the broadcasts adapt to your tenant identification.\n","tags":["affects","tenant","broadcasts"],"path":"docs\/tenancy\/2.x\/affects-broadcasts.md","slug":"affects-broadcasts","package":"tenancy","version":"2.x","contents":"<h1 id=\"affects-broadcasts\"><a href=\"#affects-broadcasts\" class=\"anchor-link\"><\/a>Affects-Broadcasts<\/h1>\n<ol>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<ol>\n<li>\n<a href=\"#example\">Example<\/a>\n<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to allow the use of different broadcast drivers and settings based on the tenant.<\/p>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Use a tenant chosen broadcast driver.<\/li>\n<li>Use different Redis servers per tenant for broadcasts.<\/li>\n<\/ul>\n<p><strong>Events &amp; Methods<\/strong><\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Broadcasts\\Events\\ConfigureBroadcast<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/affects-broadcasts\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Broadcasts\\Provider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<p>Once you've installed the package, all you have to do is configure the package. You can configure this package by listening to the <code>Tenancy\\Affects\\Broadcasts\\Events\\ConfigureBroadcast<\/code> event. Once you're listening to the event, you can start configuring your <code>tenant<\/code> broadcast driver with the provided <code>$config<\/code> array.<\/p>\n<h3 id=\"example\"><a href=\"#example\" class=\"anchor-link\"><\/a>Example<\/h3>\n<p>In the below example, we will create a pusher driver for the tenant broadcast driver.<\/p>\n<div class=\"alert alert-info\"><p>We assume that you have the pusher information on the tenant model.<\/p><\/div>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Affects\\Broadcasts\\Events\\ConfigureBroadcast;\n\nclass ConfigureTenantBroadcast\n{\n    public function handle(ConfigureBroadcast $event)\n    {\n        $event-&gt;config = [\n            'driver' =&gt; 'pusher',\n            'key' =&gt; $event-&gt;event-&gt;tenant-&gt;pusher_key,\n            'secret' =&gt; $event-&gt;event-&gt;tenant-&gt;pusher_secret,\n            'app_id' =&gt; $event-&gt;event-&gt;tenant-&gt;pusher_app_id,\n            'options' =&gt; [\n                'cluster' =&gt; $event-&gt;event-&gt;tenant-&gt;pusher_cluster,\n                'useTLS' =&gt; true,\n            ],\n        ];\n    }\n}\n<\/code><\/pre>\n","updated_at":{"date":"2022-10-14 07:28:47.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/affects-broadcasts.md"},{"title":"Cache","icon":"fal fa-inventory","excerpt":"Makes the cache adapt to your tenant identification.\n","tags":["affects","tenant","cache"],"path":"docs\/tenancy\/2.x\/affects-cache.md","slug":"affects-cache","package":"tenancy","version":"2.x","contents":"<h1 id=\"affects-cache\"><a href=\"#affects-cache\" class=\"anchor-link\"><\/a>Affects-Cache<\/h1>\n<ol>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<ol>\n<li>\n<a href=\"#example\">Example<\/a>\n<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to allow the use of different cache drivers and settings based on the tenant.<\/p>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Store cache information in different locations per tenant<\/li>\n<li>Store cache files for each tenant on their own database.<\/li>\n<\/ul>\n<p><strong>Events &amp; Methods<\/strong><\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Cache\\Events\\ConfigureCache<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/affects-cache\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Cache\\Provider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<p>Configuration of the package is really easy. You can listen to the <code>Tenancy\\Affects\\Cache\\Events\\ConfigureCache<\/code> event to start configuring. Configuration can then be done by simply changing the config that will automatically be considered the <code>tenant<\/code> cache driver.<\/p>\n<h3 id=\"example\"><a href=\"#example\" class=\"anchor-link\"><\/a>Example<\/h3>\n<p>In the below example, we will add a <code>tenant<\/code> cache driver that uses the <code>tenant<\/code> database connection.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Affects\\Cache\\Events\\ConfigureCache;\n\nclass ConfigureTenantCache\n{\n    public function handle(ConfigureCache $event)\n    {\n        $event-&gt;config = [\n            'driver' =&gt; 'database',\n            'table' =&gt; 'cache',\n            'connection' =&gt; 'tenant'\n        ];\n    }\n}\n<\/code><\/pre>\n","updated_at":{"date":"2022-06-14 06:44:25.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/affects-cache.md"},{"title":"Configs","icon":"fal fa-sliders-v","excerpt":"How you can easily affect the configs in your Laravel application.\n","tags":["affects","tenant","configs"],"path":"docs\/tenancy\/2.x\/affects-configs.md","slug":"affects-configs","package":"tenancy","version":"2.x","contents":"<h1 id=\"affects-config\"><a href=\"#affects-config\" class=\"anchor-link\"><\/a>Affects-Config<\/h1>\n<ol>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<ol>\n<li>\n<a href=\"#example\">Example<\/a>\n<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to allow the use change the configuration for different integrations or packages based on the current tenant.<\/p>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Use a tenant's API credentials for a 3rd party service<\/li>\n<\/ul>\n<p><strong>Events &amp; Methods<\/strong><\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Configs\\Events\\ConfigureConfig<\/code>\n<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>All the calls you do to the event, will be forwarded to the <code>Repository<\/code> (the class that holds all the configs).<\/p><\/div>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/affects-configs\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Configs\\Provider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<p>After the installation, it's all about configuring. Like other affects, you can listen to an event <code>Tenancy\\Affects\\Configs\\Events\\ConfigureConfig<\/code>. When you're listening to the event, you can get to work right away.<\/p>\n<h3 id=\"example\"><a href=\"#example\" class=\"anchor-link\"><\/a>Example<\/h3>\n<p>In the below example, we'll take the integration key from the tenant and set it in our configuration so the integration can use it.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Affects\\Configs\\Events\\ConfigureConfig;\n\nclass ConfigureTenantIntegrations\n{\n    public function handle(ConfigureConfig $event)\n    {\n        if($tenant = $event-&gt;event-&gt;tenant)\n        {\n            $event-&gt;set('integrations.integration.key', $tenant-&gt;integration_key);\n        }\n    }\n}\n<\/code><\/pre>\n","updated_at":{"date":"2022-06-14 06:44:26.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/affects-configs.md"},{"title":"Connections","icon":"fal fa-network-wired","excerpt":"Makes the database connections adapt to your tenant identification.\n","tags":["affects","tenant","connections"],"path":"docs\/tenancy\/2.x\/affects-connections.md","slug":"affects-connections","package":"tenancy","version":"2.x","contents":"<h1 id=\"affects-connections\"><a href=\"#affects-connections\" class=\"anchor-link\"><\/a>Affects-Connections<\/h1>\n<ol>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#requirements\">Requirements<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<ol>\n<li>\n<a href=\"#resolving-the-configuration\">Resolving the Connection Configuration<\/a>\n<ol>\n<li>\n<a href=\"#resolving-example\">Example<\/a>\n<\/li>\n<\/ol>\n<\/li>\n<li>\n<a href=\"#configuring-the-connection\">Configuring the Connection<\/a>\n<ol>\n<li>\n<a href=\"#configuring-example\">Example<\/a>\n<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<\/li>\n<li>\n<a href=\"#using-the-connection\">Using the Connection<\/a>\n<ol>\n<li>\n<a href=\"#trait-example\">Tenancy's Trait Example<\/a>\n<\/li>\n<li>\n<a href=\"#tenancy-facade-example\">Tenancy Facade Example<\/a>\n<\/li>\n<li>\n<a href=\"#laravel-db-facade-example\">Laravel DB Facade Example<\/a>\n<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to allow the access of Tenant data from a different data sources.<\/p>\n<p><strong>Recommendations<\/strong><\/p>\n<p>To automate the management of separate databases for each tenant install the <a href=\"hooks-database\"><code>hooks-database<\/code><\/a> package.<\/p>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Tenant Data is stored in different Databases<\/li>\n<li>Tenant Data is stored on different Servers<\/li>\n<li>Tenant Data is stored in different Clusters<\/li>\n<li>and Many More!<\/li>\n<\/ul>\n<p><strong>Events &amp; Methods<\/strong><\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Connections\\Events\\Resolving<\/code>\n<\/li>\n<li>\n<code>Tenancy\\Affects\\Connections\\Events\\Drivers\\Configuring<\/code>\n<ul>\n<li>\n<code>defaults<\/code>\n<\/li>\n<li>\n<code>useConfig<\/code>\n<\/li>\n<li>\n<code>useConnection<\/code>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/affects-connections\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Connections\\Provider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<p>This package has quite a complex setup, but it's really worth it in the end.<\/p>\n<h3 id=\"resolving-the-configuration\"><a href=\"#resolving-the-configuration\" class=\"anchor-link\"><\/a>Resolving the configuration<\/h3>\n<p>We will start with the <code>Tenancy\\Affects\\Connections\\Events\\Resolving<\/code> event. This event allows you to provide an instance which will be used to Provide a configuration. You can do this by listening to the event and <strong>returning<\/strong> an instance that will provide the configuration for the upcoming connection request.<\/p>\n<h4 id=\"resolving-example\"><a href=\"#resolving-example\" class=\"anchor-link\"><\/a>Resolving Example<\/h4>\n<p>In the below example we will return the instance itself as the class responsible for providing a connection configuration.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Identification\\Contracts\\Tenant;\nuse Tenancy\\Affects\\Connections\\Contracts\\ProvidesConfiguration;\nuse Tenancy\\Affects\\Connections\\Events\\Resolving;\nuse Tenancy\\Affects\\Connections\\Events\\Drivers\\Configuring;\n\nclass ResolveTenantConnection implements ProvidesConfiguration\n{\n    public function handle(Resolving $event)\n    {\n        return $this;\n    }\n\n    public function configure(Tenant $tenant): array\n    {\n        $config = [];\n\n        event(new Configuring($tenant, $config, $this));\n\n        return $config;\n    }\n}\n<\/code><\/pre>\n<h3 id=\"configuring-the-connection\"><a href=\"#configuring-the-connection\" class=\"anchor-link\"><\/a>Configuring the Connection<\/h3>\n<p>When the connection is resolved, we'll get to the configuring of the connection. In the example above we fire the <code>Configuring<\/code> event that is in the Tenancy package. We will now use that event to configure the connection. This event provides you with some functions in order to setup the database connection you want.<\/p>\n<ul>\n<li>\n<code>useConnection()<\/code>, this function allows you to use one of the connections that you have defined in the <code>config\/database.php<\/code> of your Laravel application. It uses the name of the connection to identify which connection you're trying to use.<\/li>\n<li>\n<code>useConfig()<\/code>, this function allows you to use a file in any path to provide an array as a configuration.<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>All the above functions allow you to provide an <code>override<\/code> which will be merged in the provided configuration.<\/p><\/div>\n<ul>\n<li>\n<code>defaults()<\/code>, this will return an array that uses Tenancy's internal code to figure out the following:\n<ul>\n<li>Database Name, which is the tenant key<\/li>\n<li>Database User, which is the tenant key<\/li>\n<li>Database User Password, which is generated based on the <code>PasswordGenerator<\/code> that is in <code>tenancy\/framework<\/code>.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h4 id=\"configuring-example\"><a href=\"#configuring-example\" class=\"anchor-link\"><\/a>Configuring Example<\/h4>\n<p>In the following example we will use the MySQL connection that is inside the <code>config\/database.php<\/code> and combine it with the configuration that tenancy provides.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Affects\\Connections\\Events\\Drivers\\Configuring;\n\nclass ConfigureTenantConnection\n{\n    public function handle(Configuring $event)\n    {\n        $event-&gt;useConnection('mysql', $event-&gt;defaults($event-&gt;tenant));\n    }\n}\n<\/code><\/pre>\n<h2 id=\"using-the-connection\"><a href=\"#using-the-connection\" class=\"anchor-link\"><\/a>Using the connection<\/h2>\n<p>After you've completely configured the connection, you can finally use and all of it's powers. The package creates a new connection named <code>tenant<\/code> which can be used as well as a simple trait to ensure Models use the Tenant's Database.<\/p>\n<h3 id=\"trait-example\"><a href=\"#trait-example\" class=\"anchor-link\"><\/a>Trait Example<\/h3>\n<p>The <code>OnTenant<\/code> trait (<code>Tenancy\\Affects\\Connections\\Support\\Traits\\OnTenant<\/code>) allows you to put models on the Tenant connection. You can see how to use it in the example below.<\/p>\n<pre><code class=\"language-php\">use Illuminate\\Database\\Eloquent\\Model;\nuse Tenancy\\Affects\\Connections\\Support\\Traits\\OnTenant;\n\nclass Role extends Model\n{\n    use OnTenant;\n}\n<\/code><\/pre>\n<h3 id=\"tenancy-facade-example\"><a href=\"#tenancy-facade-example\" class=\"anchor-link\"><\/a>Tenancy Facade Example<\/h3>\n<p>Using the <code>Tenancy<\/code> (<code>Tenancy\\Facades\\Tenancy<\/code>) Facade, we can also retrieve the connection of the identified tenant as seen in the example below.<\/p>\n<pre><code class=\"language-php\">Tenancy::getTenantConnection()-&gt;select(...);\n<\/code><\/pre>\n<h3 id=\"laravel-db-facade-example\"><a href=\"#laravel-db-facade-example\" class=\"anchor-link\"><\/a>Laravel DB Facade Example<\/h3>\n<p>If you are using Laravel's <code>DB<\/code> Facade, you are able to access the tenant connection as seen in the example below.<\/p>\n<pre><code class=\"language-php\">DB::connection(Tenancy::getTenantConnectionName())-&gt;select(...);\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Note: This is not a recommended Method.<\/p><\/div>\n","updated_at":{"date":"2022-06-14 06:44:26.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/affects-connections.md"},{"title":"Filesystems","icon":"fal fa-hdd","excerpt":"Makes the filesystems adapt to your tenant identification.\n","tags":["affects","tenant","filesystems"],"path":"docs\/tenancy\/2.x\/affects-filesystems.md","slug":"affects-filesystems","package":"tenancy","version":"2.x","contents":"<h1 id=\"affects-filesystems\"><a href=\"#affects-filesystems\" class=\"anchor-link\"><\/a>Affects-Filesystems<\/h1>\n<ol>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<ol>\n<li>\n<a href=\"#example\">Example<\/a>\n<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to allow the separation of tenant files, directories or even storage servers.<\/p>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Store Tenant files in different S3 Buckets<\/li>\n<li>Store Tenant files using different storage providers<\/li>\n<\/ul>\n<p><strong>Events &amp; Methods<\/strong><\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Filesystems\\Events\\ConfigureDisk<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/affects-filesystems\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Filesystems\\Provider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<p>When you're configuring this package, you will have to listen to the <code>Tenancy\\Affects\\Filesystems\\Events\\ConfigureDisk<\/code> event. This event will allow you to change the configuration for a <code>tenant<\/code> disk, simply by changing the config that is provided.<\/p>\n<h3 id=\"example\"><a href=\"#example\" class=\"anchor-link\"><\/a>Example<\/h3>\n<p>In this example we will register the <code>tenant<\/code> disk driver as a local driver with a folder in the <code>storage\/app\/<\/code> folder.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Affects\\Filesystems\\Events\\ConfigureDisk;\n\nclass ConfigureTenantDisk\n{\n    public function handle(ConfigureDisk $event)\n    {\n        $event-&gt;config = [\n            'driver' =&gt; 'local',\n            'root' =&gt; storage_path('app\/' . $event-&gt;event-&gt;tenant-&gt;getTenantKey()),\n        ];\n    }\n}\n<\/code><\/pre>\n","updated_at":{"date":"2022-06-14 06:44:26.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/affects-filesystems.md"},{"title":"Logs","icon":"fal fa-book","excerpt":"Makes the logs adapt to your tenant identification.\n","tags":["affects","tenant","logs"],"path":"docs\/tenancy\/2.x\/affects-logs.md","slug":"affects-logs","package":"tenancy","version":"2.x","contents":"<h1 id=\"affects-logs\"><a href=\"#affects-logs\" class=\"anchor-link\"><\/a>Affects-Logs<\/h1>\n<ol>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<ol>\n<li>\n<a href=\"#example\">Example<\/a>\n<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to allow the logging of errors into a separate file, location, or service for each tenant.<\/p>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Resolve specific tenant issues without going though logs for every tenant<\/li>\n<li>Find common problems across multiple tenants<\/li>\n<li>Log errors in different locations<\/li>\n<\/ul>\n<p><strong>Events &amp; Methods<\/strong><\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Logs\\Events\\ConfigureLogs<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/affects-logs\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Logs\\Provider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<p>Configuration of this package is fairly easy, you can listen to the <code>Tenancy\\Affects\\Logs\\Events\\ConfigureLogs<\/code> event and provide a log configuration for your tenant driver.<\/p>\n<h3 id=\"example\"><a href=\"#example\" class=\"anchor-link\"><\/a>Example<\/h3>\n<p>In the below example we will configure a <code>tenant<\/code> log driver which will log the errors to a slack channel configure on the tenant.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Affects\\Logs\\Events\\ConfigureLogs;\n\nclass ConfigureTenantLogs\n{\n    public function handle(ConfigureLogs $event)\n    {\n        $event-&gt;config = [\n            'driver' =&gt; 'slack',\n            'url' =&gt; $event-&gt;event-&gt;tenant-&gt;slack_webhook_url,\n            'username' =&gt; 'Tenant Logs',\n            'emoji' =&gt; ':boom:',\n            'level' =&gt; 'critical',\n        ];\n    }\n}\n<\/code><\/pre>\n","updated_at":{"date":"2022-06-14 06:44:26.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/affects-logs.md"},{"title":"Mails","icon":"fal fa-envelope","excerpt":"How you can easily affect the mails in your Laravel application.\n","tags":["affects","tenant","mails"],"path":"docs\/tenancy\/2.x\/affects-mails.md","slug":"affects-mails","package":"tenancy","version":"2.x","contents":"<h1 id=\"affects-mails\"><a href=\"#affects-mails\" class=\"anchor-link\"><\/a>Affects-Mails<\/h1>\n<ol>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<ol>\n<li>\n<a href=\"#example\">Example<\/a>\n<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to allow the sending of emails though a tenant's email address.<\/p>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Send emails from a tenant's email server<\/li>\n<li>Send emails from different providers<\/li>\n<\/ul>\n<p><strong>Events &amp; Methods<\/strong><\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Mails\\Events\\ConfigureMails<\/code>\n<ul>\n<li>\n<code>replaceSwiftMailer<\/code>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>All other calls you do to the event, will be forwarded to the <code>Mailer<\/code>.<\/p><\/div>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/affects-mails\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Mails\\Provider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<p>After the installation of the package, all you have to do is configure the package in the way you want. Like most affects, this package will fire an event <code>Tenancy\\Affects\\Mails\\Events\\ConfigureMails<\/code>, which will provide you with some functionality to change or update the <code>Swift_Mailer<\/code> used:<\/p>\n<ul>\n<li>\n<code>replaceSwiftMailer()<\/code>, this will change the default mailer to the one provided.<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>All the calls you do to the event, will be forwarded to the <code>Mailer<\/code>.<\/p><\/div>\n<h3 id=\"example\"><a href=\"#example\" class=\"anchor-link\"><\/a>Example<\/h3>\n<p>In the following example we will change the 'from' address on the emails that are sent.\nWe will assume that every tenant has two additional fields called <code>email_from<\/code> and <code>email_name<\/code> to store what email and display name should be used for outgoing email.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Affects\\Mails\\Events\\ConfigureMails;\n\nclass ConfigureTenantMails\n{\n    public function handle(ConfigureMails $event)\n    {\n        if($tenant = $event-&gt;event-&gt;tenant)\n        {\n            \/\/ Set the &quot;From&quot; Field\n            $event-&gt;alwaysFrom($tenant-&gt;email_from, $tenant-&gt;email_name);\n            \n            \/\/ Optionally add the &quot;ReplyTo&quot; Field\n            $event-&gt;alwaysReplyTo($tenant-&gt;mail_replyto, $tenant-&gt;mail_replyto_name);\n        }\n    }\n}\n<\/code><\/pre>\n","updated_at":{"date":"2022-06-14 06:44:26.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/affects-mails.md"},{"title":"Models","icon":"fal fa-hand-holding-box","excerpt":"How you can easily affect the models in your Laravel application.\n","tags":["affects","tenant","models"],"path":"docs\/tenancy\/2.x\/affects-models.md","slug":"affects-models","package":"tenancy","version":"2.x","contents":"<h1 id=\"affects-models\"><a href=\"#affects-models\" class=\"anchor-link\"><\/a>Affects-Models<\/h1>\n<ol>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<ol>\n<li>\n<a href=\"#example\">Example<\/a>\n<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to allow the modification of models provided by other packages.<\/p>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Change the connection used by a third-party package to use the tenant's database connection.<\/li>\n<\/ul>\n<p><strong>Events &amp; Methods<\/strong><\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Models\\Events\\ConfigureModels<\/code>\n<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>All the method calls will be forwarded to the model in a nice and simple way<\/p><\/div>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/affects-models\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Models\\Provider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<p>After the installation, it's time for configuring. A lot of the setup for this package is the same as the other affects, but this one is a bit more flexible. It will fire the <code>Tenancy\\Affects\\Models\\Events\\ConfigureModels<\/code> event, which will forward all the method calls to the models in a nice and simple way.<\/p>\n<p>You can do this by using the following functions:<\/p>\n<ul>\n<li>\n<code>$event-&gt;functionName($models, $parameter1, $parameter2, $parameterx ...)<\/code>, this will perform the function as normal functions on the models.<\/li>\n<li>\n<code>ConfigureModels::functionName($models, $paramater1, $parameter2, $parameterx ...)<\/code>, this will perform the functions as static functions on the models.<\/li>\n<\/ul>\n<h3 id=\"example\"><a href=\"#example\" class=\"anchor-link\"><\/a>Example<\/h3>\n<p>In the below example, we'll change the <code>Connection<\/code> of the Models, so they will use the tenant's database connection<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Vendor\\Package\\Models\\Permission;\nuse Tenancy\\Affects\\Models\\Events\\ConfigureModels;\nuse Tenancy\\Facades\\Tenancy;\n\nclass ConfigureTenantModels\n{\n    protected $model = Permission::class;\n\n    public function handle(ConfigureModels $event)\n    {\n        if($event-&gt;event-&gt;tenant)\n        {\n            $event-&gt;setConnection(\n                $this-&gt;model,\n                Tenancy::getTenantConnectionName()\n            );\n        }\n    }\n}\n<\/code><\/pre>\n","updated_at":{"date":"2022-06-14 06:44:26.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/affects-models.md"},{"title":"Routes","icon":"fal fa-road","excerpt":"How you can easily affect the routes in your Laravel application.\n","tags":["affects","tenant","routes"],"path":"docs\/tenancy\/2.x\/affects-routes.md","slug":"affects-routes","package":"tenancy","version":"2.x","contents":"<h1 id=\"affects-routes\"><a href=\"#affects-routes\" class=\"anchor-link\"><\/a>Affects-Routes<\/h1>\n<ol>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<ol>\n<li>\n<a href=\"#example\">Example<\/a>\n<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to modify the routes that are loaded once a Tenant is identified.<\/p>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Clear system only routes<\/li>\n<li>Load tenant-specific routes<\/li>\n<\/ul>\n<p><strong>Events &amp; Methods<\/strong><\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Routes\\Events\\ConfigureRoutes<\/code>\n<ul>\n<li>\n<code>flush<\/code>\n<\/li>\n<li>\n<code>fromFile<\/code>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h2>\n<p>In order to keep your application clean, you might want to separate the routes for tenants into different files.<\/p>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/affects-routes \n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Routes\\Provider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<p>After the installation of the package, all you have to do is configure the package in the way you want. Like most affects, this package will fire an event <code>Tenancy\\Affects\\Routes\\Events\\ConfigureRoutes<\/code>, which will provide you with some functionality to load and configure your routes:<\/p>\n<ul>\n<li>\n<code>flush()<\/code>, this will remove all currently loaded routes.<\/li>\n<li>\n<code>fromFile()<\/code>, this will allow you to load routes from a specific file.<\/li>\n<\/ul>\n<h3 id=\"example\"><a href=\"#example\" class=\"anchor-link\"><\/a>Example<\/h3>\n<p>In the example we will register the routes for a Tenant if one is identified.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Affects\\Routes\\Events\\ConfigureRoutes;\n\nclass TenantRoutes \n{\n    public function handle(ConfigureRoutes $event) \n    {\n        if($event-&gt;event-&gt;tenant)\n        {\n            $event\n                -&gt;flush()\n                -&gt;fromFile(\n                    ['middleware' =&gt; ['web']],\n                    base_path('\/routes\/tenant.php')\n                );\n        }\n    }\n}\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Note: This example does not set a namespace for your routes. If you're following the default laravel convention you might want to specify a namespace. Alternative is to use tuple notation.<\/p><\/div>\n","updated_at":{"date":"2022-06-14 06:44:26.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/affects-routes.md"},{"title":"URLs","icon":"fal fa-link","excerpt":"How you can easily affect the urls in your Laravel application.\n","tags":["affects","tenant","url"],"path":"docs\/tenancy\/2.x\/affects-urls.md","slug":"affects-urls","package":"tenancy","version":"2.x","contents":"<h1 id=\"affects-urls\"><a href=\"#affects-urls\" class=\"anchor-link\"><\/a>Affects-URLs<\/h1>\n<ol>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<ol>\n<li>\n<a href=\"#example\">Example<\/a>\n<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to modify domain being used when generating URL's.<\/p>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Tenants access the application using a custom domain<\/li>\n<li>Tenants receive custom subdomains to access the application<\/li>\n<\/ul>\n<p><strong>Events &amp; Methods<\/strong><\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\URLs\\Events\\ConfigureURL<\/code>\n<ul>\n<li>\n<code>changeRoot<\/code>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/affects-urls\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\URLs\\Provider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<p>Once you've installed the package, there's only some small configuring to do. You can do this by listening to the <code>Tenancy\\Affects\\URLs\\Events\\ConfigureURL<\/code> event. This event provides you with some additional classes and functionality you can use.<\/p>\n<ul>\n<li>\n<code>changeRoot()<\/code>, allows you to change the root url of the application.<\/li>\n<\/ul>\n<h3 id=\"example\"><a href=\"#example\" class=\"anchor-link\"><\/a>Example<\/h3>\n<p>In the below example, we'll change the URL to the tenant's name suffixed with <code>.test<\/code>.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Affects\\URLs\\Events\\ConfigureURL;\n\nclass ConfigureApplicationUrl\n{\n    public function handle(ConfigureURL $event)\n    {\n        if($tenant = $event-&gt;event-&gt;tenant)\n        {\n            $event-&gt;changeRoot($tenant-&gt;name . '.test');\n        }\n    }\n}\n<\/code><\/pre>\n","updated_at":{"date":"2022-06-14 06:44:26.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/affects-urls.md"},{"title":"Views","icon":"fal fa-file-alt","excerpt":"How you can easily affect the views in your Laravel application.\n","tags":["affects","tenant","views"],"path":"docs\/tenancy\/2.x\/affects-views.md","slug":"affects-views","package":"tenancy","version":"2.x","contents":"<h1 id=\"affects-views\"><a href=\"#affects-views\" class=\"anchor-link\"><\/a>Affects-Views<\/h1>\n<ol>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<ol>\n<li>\n<a href=\"#example\">Example<\/a>\n<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to allow the use of custom views overriding or in addition to existing system views.<\/p>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Tenants require additional views customized for them<\/li>\n<li>Some tenants have additional feature sets that require additional views<\/li>\n<\/ul>\n<p><strong>Events &amp; Methods<\/strong><\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Views\\Events\\ConfigureViews<\/code>\n<ul>\n<li>\n<code>addNamespace<\/code>\n<\/li>\n<li>\n<code>addPath<\/code>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h2>\n<p>Tenants might need different sites \/ views in your application. If you ever need such a thing, you can use <code>affects-views<\/code>. It will allow you to load and\/or override views in our application really easily.<\/p>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/affects-views\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Views\\Provider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<p>Once you've installed the package, all you have to do is configure it. The package will fire a <code>Tenancy\\Affects\\Views\\Events\\ConfigureViews<\/code> event to configure all the views for a specific tenant. The event will come with some basic functionality:<\/p>\n<ul>\n<li>\n<code>addNamespace()<\/code>, this will allow you to load a specific path of views in a specific namespace.<\/li>\n<li>\n<code>addPath()<\/code>, this will allow you to load a specific path of views into the specific namespace.<\/li>\n<\/ul>\n<h3 id=\"example\"><a href=\"#example\" class=\"anchor-link\"><\/a>Example<\/h3>\n<p>In this example we'll load the tenant routes once a tenant is identified from the <code>resources\/views\/tenant<\/code> folder.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nclass ConfigureTenantViews\n{\n    public function handle(ConfigureViews $event)\n    {\n        if($event-&gt;event-&gt;tenant)\n        {\n            $event-&gt;addPath(resource_path('views\/tenant'));\n        }\n    }\n}\n<\/code><\/pre>\n","updated_at":{"date":"2022-06-14 06:44:26.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/affects-views.md"}]},{"name":"database","links":["database-drivers","database-mysql","database-sqlite"],"slug":"database","articles":[{"title":"Database drivers","icon":"fal fa-warehouse-alt","excerpt":"The database drivers able to service the data required by your application.\n","tags":["database","tenant","driver"],"path":"docs\/tenancy\/2.x\/database-drivers.md","slug":"database-drivers","package":"tenancy","version":"2.x","contents":"<h1 id=\"database-drivers\"><a href=\"#database-drivers\" class=\"anchor-link\"><\/a>Database Drivers<\/h1>\n<p>A Database Driver is responsible for the actual management (Creation, Updating, Deletion) of the Tenant's database and\/or database user. Most of the Database Drivers will run specific &quot;elevated permissions&quot; queries in order to provide a database and\/or a database user.<\/p>\n<p>The principles of the Database Drivers are quite simple. The <code>DatabaseResolver<\/code> will fire a simple set of events that allow the database drivers to hook into. They will provide a class that implements <code>ProvidesDatabase<\/code>.<\/p>\n<p>Yes, you can install multiple database drivers, thus allowing you to use a different connection per <a href=\"tenant-what-is\">tenant<\/a> based on your requirements.<\/p>\n<h2 id=\"available-drivers\"><a href=\"#available-drivers\" class=\"anchor-link\"><\/a>Available Drivers<\/h2>\n<p>There are some Database Drivers that are maintained by the Tenancy organization, some might also be maintained by our Community.<\/p>\n<p>Each Database Driver will have their own installation guide.<\/p>\n<h3 id=\"first-party-drivers\"><a href=\"#first-party-drivers\" class=\"anchor-link\"><\/a>First Party Drivers<\/h3>\n<ul>\n<li>\n<a href=\"database-mysql\">MySQL<\/a>\n<\/li>\n<li>\n<a href=\"database-sqlite\">SQLite<\/a>\n<\/li>\n<\/ul>\n","updated_at":{"date":"2022-06-14 06:44:26.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/database-drivers.md"},{"title":"Database driver MySQL","icon":"fal fa-warehouse-alt","excerpt":"Maintains the tenant MySQL database.\n","tags":["database","tenant","driver","mysql"],"path":"docs\/tenancy\/2.x\/database-mysql.md","slug":"database-mysql","package":"tenancy","version":"2.x","contents":"<h1 id=\"database-driver-mysql\"><a href=\"#database-driver-mysql\" class=\"anchor-link\"><\/a>Database Driver: MySQL<\/h1>\n<ol>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#requirements\">Requirements<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<\/li>\n<\/ol>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to enable the management (Creation, Updating, Deletion) of Tenant MySQL Databases and MySQL Users.<\/p>\n<p><strong>Requirements<\/strong><\/p>\n<ul>\n<li>MySQL server with a version &gt;= <code>5.7.6<\/code>\n<\/li>\n<li>When using the <a href=\"hooks-database\"><code>hooks-database<\/code><\/a> package the MySQL user defined in <code>database.php<\/code> must have the ability to create users, databases, and grant privileges.<\/li>\n<li>This package also requires the installation and configuration of the <a href=\"affects-connections\"><code>affects-connections<\/code><\/a> package.\n(<em>Note:<\/em> This package is not required for the use of the <a href=\"affects-connections\"><code>affects-connections<\/code><\/a> package)<\/li>\n<\/ul>\n<p><strong>Recommendations<\/strong><\/p>\n<ul>\n<li>To automate the management of Tenant Databases when a Tenant is created, updated, or deleted; The <a href=\"hooks-database\"><code>hooks-database<\/code><\/a> package should also be installed.<\/li>\n<\/ul>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>A Tenant's information needs to be stored in a separate database from other Tenants.<\/li>\n<li>and Many More!<\/li>\n<\/ul>\n<h2 id=\"requirements\"><a href=\"#requirements\" class=\"anchor-link\"><\/a>Requirements<\/h2>\n<ul>\n<li>\n<p>Because this package uses the MySQL command <code>IF NOT EXISTS<\/code> is used which is only supported in versions &gt;= <code>5.7.6<\/code><\/p>\n<\/li>\n<li>\n<p>Because this package runs specific &quot;elevated permissions&quot; queries in order to provide a database and a database user, the user defined in <code>database.php<\/code> needs to have the ability to create users, databases, and grant privileges.<\/p>\n<p>The following is a sample query to create a user with those privileges.<\/p>\n<\/li>\n<\/ul>\n<pre><code class=\"language-mysql\">CREATE DATABASE IF NOT EXISTS tenancy;\nCREATE USER IF NOT EXISTS tenancy@localhost IDENTIFIED BY 'someRandomPassword';\nGRANT ALL PRIVILEGES ON *.* TO tenancy@localhost WITH GRANT OPTION;\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p><strong>Note:<\/strong> The above command is simply an example. It will grant full access to all databases to the <code>tenancy<\/code> user. Please consult your teams security professional.<\/p><\/div>\n<ul>\n<li>The  <code>affects-connections<\/code> package is required by this package in order to transfer the database from one database user to another when the database user. This change occurs when the Tenant is updated causing a new database username within the <code>hooks-database<\/code> package.<\/li>\n<\/ul>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/db-driver-mysql\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Database\\Drivers\\Mysql\\Provider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<p>Detailed configuration steps are located in the <a href=\"hooks-database\"><code>hooks-database<\/code><\/a> package and the <a href=\"affects-connections\"><code>affects-connections<\/code><\/a> package.<\/p>\n<p>In general there are several ways of setting the tenant database configuration for MySQL:<\/p>\n<ul>\n<li>Reusing a connection configured in <code>database.php<\/code> under <code>connections<\/code>.<\/li>\n<li>Load a configuration array from a separate file.<\/li>\n<\/ul>\n<h3 id=\"example\"><a href=\"#example\" class=\"anchor-link\"><\/a>Example<\/h3>\n<p>In the example below we will configure the database to be created using the information from the <code>mysql<\/code> database connection defined in the <code>config\/database.php<\/code> and add Tenancy's default database settings to this.<\/p>\n<pre><code class=\"language-php\">$event-&gt;useConnection('mysql', $event-&gt;defaults($event-&gt;tenant));\n<\/code><\/pre>\n","updated_at":{"date":"2022-06-14 06:44:26.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/database-mysql.md"},{"title":"Database driver SQLite","icon":"fal fa-warehouse-alt","excerpt":"Maintains the tenant SQLite database.\n","tags":["tenant","database","driver","sqlite"],"path":"docs\/tenancy\/2.x\/database-sqlite.md","slug":"database-sqlite","package":"tenancy","version":"2.x","contents":"<h1 id=\"database-driver-sqlite\"><a href=\"#database-driver-sqlite\" class=\"anchor-link\"><\/a>Database Driver: SQLite<\/h1>\n<ol>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#requirements\">Requirements<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<\/li>\n<\/ol>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to enable the management (Creation, Updating, Deletion) of Tenant SQLite Databases.<\/p>\n<p><strong>Requirements<\/strong><\/p>\n<p>When using the <a href=\"hooks-database\"><code>hooks-database<\/code><\/a> package the the location where the SQLite database will be stored needs to be writeable by the user running the code. (I.E. <code>www-data<\/code>)<\/p>\n<p><strong>Recommendations<\/strong><\/p>\n<ul>\n<li>To automate the management of Tenant Databases when a Tenant is created, updated, or deleted; The <a href=\"hooks-database\"><code>hooks-database<\/code><\/a> package should also be installed.<\/li>\n<li>To use the Tenant Database with the <code>onTenant<\/code> trait; The <a href=\"https:\/\/tenancy.dev\/docs\/tenancy\/1.x\/affects-connections\"><code>affects-connections<\/code><\/a> package should also be installed. (<em>Note:<\/em> This package is not required for the use of the <a href=\"affects-connections\"><code>affects-connections<\/code><\/a> package)<\/li>\n<\/ul>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>A Tenant's information needs to be stored in a separate database from other Tenants.<\/li>\n<li>A Tenants location needs to be stored in a location that is local to the webserver and not accessible outside of the filesystem it is stored on.<\/li>\n<li>and Many More!<\/li>\n<\/ul>\n<h2 id=\"requirements\"><a href=\"#requirements\" class=\"anchor-link\"><\/a>Requirements<\/h2>\n<p>Because this package will create a new SQLite database file, the location that database files are being created needs to be writeable by the user running the code. (I.E. <code>www-data<\/code>)<\/p>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<div class=\"alert alert-info\"><p>CAUTION: This will only provide <strong>local<\/strong> databases, which are not accessible remotely.<\/p><\/div>\n<div class=\"alert alert-info\"><p>CAUTION: This database driver might require additional steps for configuration. It is based on a filesystem, and not a real database like most Database Drivers.<\/p><\/div>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/db-driver-sqlite\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Database\\Drivers\\Sqlite\\Provider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<p>Detailed configuration steps are located in the <a href=\"hooks-database\"><code>hooks-database<\/code><\/a> package and the <a href=\"affects-connections\"><code>affects-connections<\/code><\/a> package.<\/p>\n<h3 id=\"example\"><a href=\"#example\" class=\"anchor-link\"><\/a>Example<\/h3>\n<p>In the following example we set the connection to use SQLite, and set the database path to be specific to the tenant based on the Tenant's Key.<\/p>\n<pre><code class=\"language-php\">$event-&gt;useConnection('sqlite', [\n\t'database' =&gt; database_path('tenant\/'.$event-&gt;tenant-&gt;getTenantKey().'.sqlite'),\n]);\n<\/code><\/pre>\n","updated_at":{"date":"2022-06-14 06:44:26.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/database-sqlite.md"}]},{"name":"meta","links":["faq-common-problems","compared-to-hyn"],"slug":"meta","articles":[{"title":"FAQ - Frequently Asked Questions","icon":"fal fa-question","excerpt":"Frequently Asked Questions, common problems and some possibly not immediately obvious information\n","tags":["tenant","faq"],"path":"docs\/tenancy\/2.x\/faq-common-problems.md","slug":"faq-common-problems","package":"tenancy","version":"2.x","contents":"<h1 id=\"faq-frequently-asked-questions\"><a href=\"#faq-frequently-asked-questions\" class=\"anchor-link\"><\/a>FAQ - Frequently Asked Questions<\/h1>\n<h2 id=\"migrations\"><a href=\"#migrations\" class=\"anchor-link\"><\/a>Migrations<\/h2>\n<p><strong>Problem<\/strong><\/p>\n<p>I've set up the lifecycle-hooks Database and Migration. When creating a new tenant all my migrations for tenant databases are run.\nNo matter what I try (<code>artisan migrate<\/code>, <code>artisan migrate --tenant<\/code>, ...), I can't get new migrations to be applied on existing tenant databases.<\/p>\n<p><strong>Solution<\/strong><\/p>\n<p>Migrations for tenant databases are triggered by <a href=\"hooks-general#events\">lifecycle events<\/a>.\nSo, all you have to do is to fire an <code>Updated<\/code> event for the tenant you want to migrate. <strong>Yes, this does mean you need to fire one event for each of your tenants if you want to migrate all at once.<\/strong><\/p>\n<p>You can do this via <code>artisan tinker<\/code>, create a custom artisan command (e.g. <code>migrate:tenants<\/code>, inside your own tenant managing commands, ...), etc.<\/p>\n<p>The code might look something like this:<\/p>\n<pre><code class=\"language-php\">\\App\\Tenant::cursor()-&gt;each(function($tenant) { event(new Updated($tenant)); });\n<\/code><\/pre>\n<h2 id=\"sql-error-while-deleting-a-tenant\"><a href=\"#sql-error-while-deleting-a-tenant\" class=\"anchor-link\"><\/a>SQL error while deleting a tenant<\/h2>\n<p><strong>Problem<\/strong><\/p>\n<p>When deleting a tenant I receive a SQL error indicating it might have something to do with the deleted tenant<\/p>\n<p><strong>Solution<\/strong><\/p>\n<p>Migrations are run <strong>after<\/strong> database actions. So, in this case, Tenancy tries to run some migrations on the tenants database, by the tenants user, which at this point both won't exist anymore.<\/p>\n<p>You might want to change your <code>ConfigureMigrations<\/code> listener to take that into account:<\/p>\n<pre><code class=\"language-php\">&lt;?php\n\nnamespace App\\Listeners;\n\nuse Tenancy\\Hooks\\Migration\\Events\\ConfigureMigrations;\nuse Tenancy\\Tenant\\Events\\Deleted;\n\nclass ConfigureTenantMigrations\n{\n    public function handle(ConfigureMigrations $event)\n    {\n        $event-&gt;path(database_path('tenant\/migrations'));\n\n        if($event-&gt;event instanceof Deleted) {\n            $event-&gt;disable();\n        }\n    }\n}\n\n<\/code><\/pre>\n<h2 id=\"form-validations-are-run-against-the-system-database-instead-of-the-tenants-database\"><a href=\"#form-validations-are-run-against-the-system-database-instead-of-the-tenants-database\" class=\"anchor-link\"><\/a>Form validations are run against the system database instead of the tenants database<\/h2>\n<p><strong>Problem<\/strong><\/p>\n<p>Laravel keeps trying to run validations against my system database, even though my models are using the <code>OnTenant<\/code> trait. What's going on?<\/p>\n<p><em>Example<\/em><\/p>\n<p>Let's take a default Laravel UI scaffold including auth. The <em>RegisterController<\/em> looks something like this:<\/p>\n<pre><code class=\"language-php\">[... snip ...]\nprotected function validator(array $data)\n{\n    return Validator::make($data, [\n        'name' =&gt; ['required', 'string', 'max:255'],\n        'email' =&gt; ['required', 'string', 'email', 'max:255', 'unique:users'],\n        'password' =&gt; ['required', 'string', 'min:8', 'confirmed'],\n    ]);\n}\n[... snip ...]\n<\/code><\/pre>\n<p>You can clearly see the validation rule stating <em>unique:users<\/em>. So, what gives?<\/p>\n<p><strong>Solution<\/strong><\/p>\n<p>It's simple. Form validation in Laravel <strong>does not<\/strong> use your models! So, to get it to work, you need to tell Laravel that you want to validate against a table in a different database.<\/p>\n<p>Luckily, all you need to do is to prefix the table name with the right connection name.<\/p>\n<pre><code class=\"language-php\">        'email' =&gt; ['required', 'string', 'email', 'max:255', 'unique:' . Tenancy::getTenantConnectionName() . '.users'],\n<\/code><\/pre>\n<p>There, that's all you need!<\/p>\n<h2 id=\"i-need-to-run-some-code-after-my-affects-are-finished\"><a href=\"#i-need-to-run-some-code-after-my-affects-are-finished\" class=\"anchor-link\"><\/a>I need to run some code after my affects are finished<\/h2>\n<p><strong>Problem<\/strong><\/p>\n<p>I need to do some stuff directly after my affects are finished, but before the rest of the app is run<\/p>\n<p><em>Example<\/em><\/p>\n<p>You might be using a third party package in your application, and you need to configure it based on your tenant; AFTER your <a href=\"affects-configs\">affects-config<\/a> is finished.<\/p>\n<p><strong>Solution<\/strong><\/p>\n<p>Instead of listening to some specific event fired by the affect, just add a second listener for <code>Tenancy\\Affects\\Configs\\Events\\ConfigureConfig<\/code><\/p>\n<p>Before:<\/p>\n<pre><code class=\"language-php\">class EventServiceProvider extends ServiceProvider\n{\n    protected $listen = [\n        \\Tenancy\\Affects\\Configs\\Events\\ConfigureConfig::class =&gt; [\n            ConfigureTenantConfigs::class,\n        ],\n    ];\n}\n<\/code><\/pre>\n<p>After:<\/p>\n<pre><code class=\"language-php\">class EventServiceProvider extends ServiceProvider\n{\n    protected $listen = [\n        \\Tenancy\\Affects\\Configs\\Events\\ConfigureConfig::class =&gt; [\n            ConfigureTenantConfigs::class,\n            ConfigurePackage::class,\n        ],\n    ];\n}\n<\/code><\/pre>\n<p>Done.<\/p>\n","updated_at":{"date":"2022-06-14 06:44:26.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/faq-common-problems.md"},{"title":"Compared to hyn","icon":"fal fa-box-check","path":"docs\/tenancy\/2.x\/compared-to-hyn.md","slug":"compared-to-hyn","package":"tenancy","version":"2.x","contents":"<p>The predecessor, <code>hyn\/multi-tenant<\/code> (&quot;hyn&quot;), to this package (&quot;tenancy&quot;)\nwas created with a different purpose in mind. Originally the intent of my multi tenant\npackage was to offer digital media companies a fast and easy way to set up\nwebsites for all customers, even when each of these were serving different apps.\nThis type of multi tenancy has been slowly replaced with the Software as a Service we see nowadays.<\/p>\n<h1 id=\"local-dependencies\"><a href=\"#local-dependencies\" class=\"anchor-link\"><\/a>Local dependencies<\/h1>\n<p>The challenges of modern SaaS are not related to offering additional code\nusing dynamically, composer auto loaded packages. Nor do they rely on\nlocal filesystems. The successor to hyn <code>tenancy\/tenancy<\/code> (&quot;tenancy&quot;) aims\nsolely on apps living in the cloud using scalable architecture like block\nstorage, load balancing and cloud databases.<\/p>\n<p>Functionality offered in hyn which rely on local filesystems are therefore\nno longer a default feature. This includes most (if not all) overrides\nfrom files living inside the tenant directory.<\/p>\n<h1 id=\"tenant-identification\"><a href=\"#tenant-identification\" class=\"anchor-link\"><\/a>Tenant identification<\/h1>\n<p>Although hyn was never intended to be opinionated about the choices of\nthe developer - a few changes to improve that position -\nit would still use a hostname and website model to relate to a tenant.<\/p>\n<p>Initial confusion arose while binding the hostname, identified from the current request,\ninto the service container as a tenant. In version 5.2 of hyn a correction\nwas introduced binding a website model to a new tenant contract.<\/p>\n<p>In the end, forcing any developer to use the requested host for identification, while\nusing other implementations to identify the tenant inside, for instance, artisan commands\ndoesn't make a lot of sense. Tenant identification should be contained inside one\nspecific shard of code. The <code>TenantResolver<\/code> class in tenancy offers a centrally\norganised method of identifying tenants; event listeners can respond with a\ntenant compliant model. The first listener to provide a valid tenant model &quot;wins&quot;,\nswitching the current environment.<\/p>\n<h1 id=\"modularity\"><a href=\"#modularity\" class=\"anchor-link\"><\/a>Modularity<\/h1>\n<p>Back when hyn versions made huge leaps - while much of the interaction with Laravel was\nmostly a matter of research, trial and error - the package that\nadded an admin dashboard was dropped in order to focus on creating a fundamentally better package.<\/p>\n<p>In addition as new Laravel versions were released in pretty fast succession, new versions\n(3.x, 4.x and 5.x) of hyn were started to offer to these new versions (5.3, 5.4 and 5.5).\nIn the end, maintaining so many branches was a pain and the package was reduced to one,\nsingle 5.x version; a monolith.<\/p>\n<p>This has been very fruitful for the package, but it made deciding whether to add functionality\nnot closely related to multi tenancy a struggle. Tenancy has been set up to work with git subsplit;\nthe same way the Laravel framework is maintained. One repository contains all packages, using\nthe subsplit command read-only package repositories are updated automatically.<\/p>\n<p>With this set up developing, maintaining and testing existing and new packages becomes far easier,\nit also reduces the overhead for contributors.<\/p>\n<h1 id=\"extensibility\"><a href=\"#extensibility\" class=\"anchor-link\"><\/a>Extensibility<\/h1>\n<p>Now that modularity is been taken care of, working on third party integration no longer feels like\na new burden to pick up. Planned native integrations for the future include:<\/p>\n<ul>\n<li>Laravel Spark.<\/li>\n<li>Laravel Horizon.<\/li>\n<li>Different permission packages.<\/li>\n<li>Voyager and possibly other admin toolkits.<\/li>\n<\/ul>\n<p>Keep an eye on the <a href=\"https:\/\/github.com\/tenancy\/tenancy\/labels\/type%3Aintegration\">integrations<\/a> label on\nGitHub, or <a href=\"https:\/\/github.com\/tenancy\/tenancy\/issues\/new\">submit an integration request<\/a> if you have one!<\/p>\n","updated_at":{"date":"2022-06-14 06:44:26.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/compared-to-hyn.md"}]},{"name":"tutorials","links":["tutorial-basic-setup","tutorial-multi-database"],"slug":"tutorials","articles":[{"title":"Basic Setup","icon":"fal fa-cogs","excerpt":"How to create a basic Setup with the Tenancy Ecosystem\n","tags":["tenancy","tutorial","basic"],"path":"docs\/tenancy\/2.x\/tutorial-basic-setup.md","slug":"tutorial-basic-setup","package":"tenancy","version":"2.x","contents":"<h2 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h2>\n<p>The Tenancy Ecosystem works in really flexible ways. In order for you to get started easily we will show you how to create a really basic setup. In this basic setup we will teach you:<\/p>\n<ul>\n<li>How to create a tenant<\/li>\n<li>How to get tenancy ready for Identification<\/li>\n<li>How to get tenancy ready for Lifecycle Hooks<\/li>\n<\/ul>\n<h2 id=\"creating-a-tenant\"><a href=\"#creating-a-tenant\" class=\"anchor-link\"><\/a>Creating a tenant<\/h2>\n<p>After you've created your own Laravel project, we recommend you to start off by installing and configuring the <code>tenancy\/framework<\/code>.<\/p>\n<p>First, install the package:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/framework\n<\/code><\/pre>\n<p>When the installation is done, create a model and a migration for your Tenant model. In this tutorial we will use a <code>Customer<\/code> model.<\/p>\n<p>After you've created your model, make sure it implements the <code>Tenancy\\Identification\\Contracts\\Tenant<\/code> contract.<\/p>\n<div class=\"alert alert-info\"><p>Tip: You can easily implement the contract by using our simple trait: <code>Tenancy\\Identification\\Concerns\\AllowsTenantIdentification<\/code><\/p><\/div>\n<p>Your model should now look something like this:\n<code>app\/Models\/Customer.php<\/code><\/p>\n<pre><code class=\"language-php\">use Illuminate\\Database\\Eloquent\\Model;\nuse Tenancy\\Identification\\Concerns\\AllowsTenantIdentification;\nuse Tenancy\\Identification\\Contracts\\Tenant;\n\nclass Customer extends Model implements Tenant\n{\n    use AllowsTenantIdentification;\n}\n<\/code><\/pre>\n<p>You've now succesfully created a simple tenant model!<\/p>\n<h2 id=\"preparing-for-identification\"><a href=\"#preparing-for-identification\" class=\"anchor-link\"><\/a>Preparing for Identification<\/h2>\n<p>Tenancy needs to be aware of the tenant that you have just created in order to identify it. We will do this by registering the model into the <code>TenantResolver<\/code> (which is simply a class responsible for identifying tenants).<\/p>\n<p>We can easily register a model by using a callback in one of Laravel's default Service Providers. Let's use the <code>app\/Providers\/AppServiceProvider<\/code> in this case.<\/p>\n<pre><code class=\"language-php\">namespace App\\Providers;\n\nuse Illuminate\\Support\\ServiceProvider;\nuse App\\Models\\Customer;\nuse Tenancy\\Identification\\Contracts\\ResolvesTenants;\n\nclass AppServiceProvider extends ServiceProvider\n{\n    \/**\n     * Register any application services.\n     *\n     * @return void\n     *\/\n    public function register()\n    {\n        $this-&gt;app-&gt;resolving(ResolvesTenants::class, function (ResolvesTenants $resolver){\n            $resolver-&gt;addModel(Customer::class);\n            return $resolver;\n        });\n    }\n}\n<\/code><\/pre>\n<p>Now when the <code>TenantResolver<\/code> is being made, it will register the model. Really easy and really handy.<\/p>\n<div class=\"alert alert-info\"><p>Tip: If you have multiple Tenant models, you could register all of them like this.<\/p><\/div>\n<h2 id=\"preparing-for-lifecycle-hooks\"><a href=\"#preparing-for-lifecycle-hooks\" class=\"anchor-link\"><\/a>Preparing for Lifecycle Hooks<\/h2>\n<div class=\"alert alert-info\"><p>If you have no idea what the Lifecycle or Lifecycle Hooks are, we recommend you to <a href=\"hooks-general\">read about those first<\/a>.<\/p><\/div>\n<p>To prepare your tenant for lifecycle hooks, we will fire off some events for when a model is:<\/p>\n<ul>\n<li>Created<\/li>\n<li>Updated<\/li>\n<li>Deleted<\/li>\n<\/ul>\n<p>We can do this with Laravel's really handy <code>dispatchesEvents<\/code> variable on models. It allows you to define specific events that should be fired when a model is being made. Here's an example of how to make it work for our Customer model:\n<code>app\/Models\/Customer.php<\/code><\/p>\n<pre><code class=\"language-php\">use Illuminate\\Database\\Eloquent\\Model;\nuse Tenancy\\Identification\\Concerns\\AllowsTenantIdentification;\nuse Tenancy\\Identification\\Contracts\\Tenant;\nuse Tenancy\\Tenant\\Events;\n\nclass Customer extends Model implements Tenant\n{\n    use AllowsTenantIdentification;\n\n    protected $dispatchesEvents = [\n        'created' =&gt; Events\\Created::class,\n        'updated' =&gt; Events\\Updated::class,\n        'deleted' =&gt; Events\\Deleted::class,\n    ];\n}\n<\/code><\/pre>\n<p>Now when you're creating a model like you normally do, it will fire off the Events for tenancy. When Tenancy receives these events, it will start firing Lifecycle Hooks.<\/p>\n","updated_at":{"date":"2022-06-14 06:44:26.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/tutorial-basic-setup.md"},{"title":"Multi Database Setup","icon":"fal fa-database","excerpt":"How to create a Multi Database Setup with the Tenancy Ecosystem\n","tags":["tenancy","tutorial","multi database"],"path":"docs\/tenancy\/2.x\/tutorial-multi-database.md","slug":"tutorial-multi-database","package":"tenancy","version":"2.x","contents":"<h2 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h2>\n<p>Setting up a multi database tenancy setup can be quite difficult. There's a lot of different (moving) pieces and that's exactly why we made this tutorial. In this tutorial we will talk about:<\/p>\n<ul>\n<li>Setting up tenancy so it will create a new DB for each tenant<\/li>\n<li>Changing the connection whenever a tenant is identified<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>This tutorial assumes that you have a basic setup (meaning a tenant model that is firing hooks).<\/p><\/div>\n<h2 id=\"creation-of-the-database\"><a href=\"#creation-of-the-database\" class=\"anchor-link\"><\/a>Creation of the database<\/h2>\n<p>Creating of the database is a collaboration between 2 different type of packages:<\/p>\n<ul>\n<li>A Lifecycle Hook (<code>tenancy\/hooks-database<\/code> in this case)<\/li>\n<li>A Database Driver (<code>tenancy\/db-driver-mysql<\/code> for example). There are more Database Driver to choose from, in case you need one for a different Database.<\/li>\n<\/ul>\n<h3 id=\"setting-up\"><a href=\"#setting-up\" class=\"anchor-link\"><\/a>Setting Up<\/h3>\n<p>We will first focus on installing <code>hooks-database<\/code>. You can install this package by simply running the following command in your project:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/hooks-database\n<\/code><\/pre>\n<p>After that is done, we will focus on configuring the creation of the database.<\/p>\n<p>Configuring the database is fairly easy. It starts of with creating a new listener that listens to the <code>Tenancy\\Hooks\\Database\\Events\\Drivers\\Configuring<\/code> event. Once you've created a listener, we will go to the actual configuration.<\/p>\n<p>There are multiple ways to configure the Database Creation. In this tutorial we will use tenancy's default functionality in order to make it work. In your listener use the following code:<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Hooks\\Database\\Events\\Drivers\\Configuring;\n\nclass ConfigureTenantDatabase\n{\n    public function handle(Configuring $event)\n    {\n        $event-&gt;useConnection('mysql', $event-&gt;defaults($event-&gt;tenant));\n    }\n}\n<\/code><\/pre>\n<p>What this code will do is quite simple:<\/p>\n<ul>\n<li>It will use the <code>mysql<\/code> configuration provided in the <code>config\/database.php<\/code> of your application.<\/li>\n<li>It will use the <code>tenant_key<\/code> for a database name and database username<\/li>\n<li>It will use some information on the tenant for generating a secret password<\/li>\n<\/ul>\n<p>You've now completely configured the creating of the database, but now it's time to actually create the database.<\/p>\n<p>Creating the database is really easy, simply install the database driver of your choice (we recommend <code>tenancy\/db-driver-mysql<\/code>) through composer.<\/p>\n<p>You should now be able to create a new Database, by simply creating a new tenant.<\/p>\n<h2 id=\"changing-the-connection\"><a href=\"#changing-the-connection\" class=\"anchor-link\"><\/a>Changing the connection<\/h2>\n<p>There's one package responsible for changing of the connection and that is <code>affects-connections<\/code>. Once a tenant is identified, it will creating a new <code>tenant<\/code> connection which will direct to the database that we setup earlier. So let's get started on this installation.<\/p>\n<p>First, install the package by running:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/affects-connections\n<\/code><\/pre>\n<p>After the installation, we will focusing on <code>Resolving<\/code> the connection. This is simply us telling tenancy what class it should use in order to get a configuration for the connection. Create a new listener that listens to the <code>Tenancy\\Affects\\Connections\\Events\\Resolving<\/code> event.<\/p>\n<div class=\"alert alert-info\"><p>Important: This event expects to <strong>return<\/strong> an instance\/class that will provide the configuration of the connection, not the configuration itself.<\/p><\/div>\n<p>In this example, we will tell tenancy that this listener is responsible for configuring that connection. We do this by simply returning the instance like shown below.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Affects\\Connections\\Events\\Resolving;\n\nclass ResolveTenantConnection\n{\n    public function handle(Resolving $event)\n    {\n        return $this;\n    }\n}\n<\/code><\/pre>\n<p>However, this class does not implements the <code>ProvidesConfiguration<\/code> contract which is responsible for providing a connection configuration to Tenant, so we will do that.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Identification\\Contracts\\Tenant;\nuse Tenancy\\Affects\\Connections\\Contracts\\ProvidesConfiguration;\nuse Tenancy\\Affects\\Connections\\Events\\Resolving;\n\nclass ResolveTenantConnection implements ProvidesConfiguration\n{\n    public function handle(Resolving $event)\n    {\n        return $this;\n    }\n\n    public function configure(Tenant $tenant): array\n    {\n        return [];\n    }\n}\n<\/code><\/pre>\n<p>Right now we're providing an empty array as a connection setting. This won't work, and we will have to implement some logic in order to provide an actual connection configuration. You can do 2 different types of setups in this case:<\/p>\n<ul>\n<li>You can put all the logic for a connection here.<\/li>\n<li>You can fire off a <code>Configuring<\/code> event in order to configure it in a different listener.<\/li>\n<\/ul>\n<p>In this tutorial we decided to fire off a <code>Configuring<\/code> event. You can do that by looking at the example below.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Identification\\Contracts\\Tenant;\nuse Tenancy\\Affects\\Connections\\Events\\Resolving;\nuse Tenancy\\Affects\\Connections\\Events\\Drivers\\Configuring;\nuse Tenancy\\Affects\\Connections\\Contracts\\ProvidesConfiguration;\n\nclass ResolveTenantConnection implements ProvidesConfiguration\n{\n    public function handle(Resolving $event)\n    {\n        return $this;\n    }\n\n    public function configure(Tenant $tenant): array\n    {\n        $config = [];\n\n        event(new Configuring($tenant, $config, $this));\n\n        return $config;\n    }\n}\n<\/code><\/pre>\n<p>After you've done this, we will move to the actual configuring of the connection. Create a new listener that listens to the <code>Tenancy\\Affects\\Connections\\Events\\Drivers\\Configuring<\/code> event. This event is basically the same event as the event we used for the database.\nThis allows us to use the exact same code that we used then in order to configure the database. You can see an example below.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Affects\\Connections\\Events\\Drivers\\Configuring;\n\nclass ConfigureTenantConnection\n{\n    public function handle(Configuring $event)\n    {\n        $event-&gt;useConnection('mysql', $event-&gt;defaults($event-&gt;tenant));\n    }\n}\n<\/code><\/pre>\n<h2 id=\"done\"><a href=\"#done\" class=\"anchor-link\"><\/a>Done!<\/h2>\n<p>You're all done now, congratulations! You've now setup your own multi tenancy setup using the Tenancy Ecosystem!<\/p>\n<p>You should have the following result:<\/p>\n<ul>\n<li>Creating a new Customer (or your own tenant model), will result in a new database creation<\/li>\n<li>Switching to the tenant will create a new <code>tenant<\/code> connection.<\/li>\n<\/ul>\n","updated_at":{"date":"2022-06-14 06:44:26.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/2.x\/tutorial-multi-database.md"}]}],"hidden_articles":[]},"1.x":{"slug":"1.x","name":"1.x","status":"Deprecated","suggestion_using":null,"branch":"1.x","package":"tenancy","tree":[{"name":"getting started","links":["introduction","requirements","installation","architecture"],"slug":"getting-started","articles":[{"title":"Introduction","icon":"fal fa-clipboard-check","excerpt":"An introduction to the Tenancy ecosystem.","path":"docs\/tenancy\/1.x\/introduction.md","slug":"introduction","package":"tenancy","version":"1.x","contents":"<h1 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h1>\n<p>Tenancy is developed as a small ecosystem. It's a set of products\/packages that are all focused on one simple thing: Providing you the best way to get multi-tenancy working in your application.<\/p>\n<h2 id=\"the-idea\"><a href=\"#the-idea\" class=\"anchor-link\"><\/a>The idea<\/h2>\n<p>The general idea of Tenancy is to give a really powerful modular way of getting multi-tenancy working in <strong>any<\/strong> Laravel application.<\/p>\n<p>By using a modular approach we allow you to select only the components you need for your specific application. This allows you to only implement the specific functions you need without being forced to implement additional functionality changing how your application works.<\/p>\n","updated_at":{"date":"2020-06-23 15:16:05.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/introduction.md"},{"title":"Requirements","icon":"fal fa-clipboard-check","excerpt":"System and package requirements you need to take care of before installation.","path":"docs\/tenancy\/1.x\/requirements.md","slug":"requirements","package":"tenancy","version":"1.x","contents":"<h1 id=\"requirements\"><a href=\"#requirements\" class=\"anchor-link\"><\/a>Requirements<\/h1>\n<h2 id=\"knowledge\"><a href=\"#knowledge\" class=\"anchor-link\"><\/a>Knowledge<\/h2>\n<p>Multi-tenancy can be really hard to understand, let alone apply in an application. That's why we recommend everybody to first be fluent with Laravel application development before starting with Tenancy.<\/p>\n<h2 id=\"software\"><a href=\"#software\" class=\"anchor-link\"><\/a>Software<\/h2>\n<p>Tenancy is always looking to support the latest Laravel version for their packages. This version of Tenancy supports<\/p>\n<ul>\n<li>Laravel 7.x or higher<\/li>\n<li>PHP 7.2 or higher<\/li>\n<\/ul>\n<p>As docs can sometimes be outdated, we highly recommend you to have a look at the most recent <a href=\"https:\/\/github.com\/tenancy\/tenancy\/actions?query=branch%3Amaster\">Github Actions<\/a>.<\/p>\n<h2 id=\"module-specific-requirements\"><a href=\"#module-specific-requirements\" class=\"anchor-link\"><\/a>Module Specific Requirements<\/h2>\n<p>Depending on which Tenancy modules are being used, there may be additional module specific requirements. Be sure to check each module that you are installing to ensure you meet the requirements.<\/p>\n","updated_at":{"date":"2020-10-07 15:31:19.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/requirements.md"},{"title":"Installation","icon":"fal fa-arrow-alt-to-bottom","path":"docs\/tenancy\/1.x\/installation.md","slug":"installation","package":"tenancy","version":"1.x","contents":"<h1 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h1>\n<ol>\n<li>\n<a href=\"#base-installation\">Base Installation<\/a>\n<\/li>\n<li>\n<a href=\"#simplified-install\">Simplified Install<\/a>\n<\/li>\n<li>\n<a href=\"#selective-install\">Selective Install<\/a> (<em>Recommended<\/em>)<\/li>\n<li>\n<a href=\"#next-steps\">Next Steps<\/a>\n<\/li>\n<\/ol>\n<h2 id=\"base-installation\"><a href=\"#base-installation\" class=\"anchor-link\"><\/a>Base Installation<\/h2>\n<p>There are two methods for getting the base package installed, <a href=\"#simplified-install\">Simplified<\/a> and <a href=\"#selective-install\">Selective<\/a>.<\/p>\n<p>The simplified install method will install the base package and all of the additional modules, but will not register all of the providers.<\/p>\n<p>The selective install method will only install the base package, and each additional module will need to be installed on its own.<\/p>\n<p>We would highly recommend using the selective installation method as it ensure that only the modules you need are installed, and it will automatically register the appropriate providers.<\/p>\n<h3 id=\"simplified-install\"><a href=\"#simplified-install\" class=\"anchor-link\"><\/a>Simplified Install<\/h3>\n<p>For a quick, simplified installation you can install everything at once:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/tenancy\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>CAUTION: This will load specific non-intrusive Affects by default. You can check which are loaded by looking in the <code>composer.json<\/code> of the repository.<\/p><\/div>\n<p>This is an easy way of giving this toolkit a spin!<\/p>\n<div class=\"alert alert-info\"><p>We recommend selectively installing the packages you need.<\/p><\/div>\n<p>After you've installed tenancy\/tenancy make sure you register the Affects and Hooks you wish to use. You do this by simply registering the respective Providers.\nHere is the non-exhaustive list of providers that can be added to <code>config\/app.php<\/code>, make sure you comment out the ones you don't need.\nThe exact provider needed is included in each component's documentation.<\/p>\n<pre><code class=\"language-php\">    'providers' =&gt; [\n         \/\/ ...\n\n        \/*\n         * Package Service Providers...\n         *\/\n        Tenancy\\Affects\\Broadcasts\\Provider::class,\n        Tenancy\\Affects\\Cache\\Provider::class,\n        Tenancy\\Affects\\Configs\\Provider::class,\n        Tenancy\\Affects\\Connections\\Provider::class,\n        Tenancy\\Affects\\Filesystems\\Provider::class,\n        Tenancy\\Affects\\Logs\\Provider::class,\n        Tenancy\\Affects\\Mails\\Provider::class,\n        Tenancy\\Affects\\Models\\Provider::class,\n        Tenancy\\Affects\\Routes\\Provider::class,\n        Tenancy\\Affects\\URLs\\Provider::class,\n        Tenancy\\Affects\\Views\\Provider::class,\n\n        Tenancy\\Hooks\\Database\\Provider::class,\n        Tenancy\\Hooks\\Migration\\Provider::class,\n        Tenancy\\Hooks\\Hostname\\Provider::class,\n\n        Tenancy\\Database\\Drivers\\Mysql\\Provider::class,\n        Tenancy\\Database\\Drivers\\Sqlite\\Provider::class,\n         \/\/ ...\n    ]\n<\/code><\/pre>\n<h3 id=\"selective-install\"><a href=\"#selective-install\" class=\"anchor-link\"><\/a>Selective Install<\/h3>\n<p>Instead of loading all tenancy packages at once, you can selectively install\nwhat you need. You need at least the framework:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/framework\n<\/code><\/pre>\n<h2 id=\"next-steps\"><a href=\"#next-steps\" class=\"anchor-link\"><\/a>Next Steps<\/h2>\n<p>Now that the base package is installed you will need to determine what your <a href=\"tenant-what-is\">tenant object will be<\/a> and <a href=\"tenant-setup\">perform setup of the tenant object(s)<\/a>.<\/p>\n<p>After that selectively add and\/or configure:<\/p>\n<ul>\n<li>\n<a href=\"database-drivers\">Database drivers<\/a>. Where to allocate tenant information.<\/li>\n<li>\n<a href=\"hooks-general\">Lifecycle hooks<\/a>. Impact your application whenever tenants are created, updated or deleted.<\/li>\n<li>\n<a href=\"identification-general\">Identification drivers<\/a>. Allowing you to configure how your tenant is identified.<\/li>\n<li>\n<a href=\"affects-general\">Affects<\/a>. How your application is modified once a tenant is identified.<\/li>\n<\/ul>\n","updated_at":{"date":"2020-08-13 12:53:46.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/installation.md"},{"title":"Architecture","icon":"fa fa-cubes","excerpt":"An introduction to the architecture of Tenancy.","path":"docs\/tenancy\/1.x\/architecture.md","slug":"architecture","package":"tenancy","version":"1.x","contents":"<h1 id=\"architecture\"><a href=\"#architecture\" class=\"anchor-link\"><\/a>Architecture<\/h1>\n<p>The architecture of Tenancy is broken up into three main component types.<\/p>\n<ul>\n<li>Lifecycle Hooks<\/li>\n<li>Identification<\/li>\n<li>Affects<\/li>\n<\/ul>\n<h2 id=\"lifecycle-hooks\"><a href=\"#lifecycle-hooks\" class=\"anchor-link\"><\/a>Lifecycle Hooks<\/h2>\n<p>These components focus on what happens when a tenant is created, updated, or deleted in the system.\nThings as simple as ensuring that the domain a tenant sign up with is valid, to creating databases and registering\/creating services to handle the needs to the tenant occur in these components.<\/p>\n<p><a href=\"hooks-general\">Read More<\/a><\/p>\n<h2 id=\"identification\"><a href=\"#identification\" class=\"anchor-link\"><\/a>Identification<\/h2>\n<p>The identification components of tenancy are responsible for identifying the tenant before application logic\noccurs regardless if that logic stems from an HTTP request, a job running in a queue, or a command being run in the console.<\/p>\n<p><a href=\"identification-general\">Read More<\/a><\/p>\n<h2 id=\"affects\"><a href=\"#affects\" class=\"anchor-link\"><\/a>Affects<\/h2>\n<p>The Affect components are responsible for changing the application for the tenant that has been identified.\nSetting up connections to databases, changing logging settings, and the configuration of other services\noccur in these components.<\/p>\n<p><a href=\"affects-general\">Read More<\/a><\/p>\n","updated_at":{"date":"2020-08-13 12:53:46.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/architecture.md"}]},{"name":"tenants","links":["tenant-what-is","tenant-setup"],"slug":"tenants","articles":[{"title":"What is a tenant?","icon":"fal fa-id-badge","excerpt":"How to determine the selection of your tenant, what are valid\nsubjects and how do you configure these inside tenancy.\n","tags":["tenant"],"path":"docs\/tenancy\/1.x\/tenant-what-is.md","slug":"tenant-what-is","package":"tenancy","version":"1.x","contents":"<h1 id=\"what-is-a-tenant\"><a href=\"#what-is-a-tenant\" class=\"anchor-link\"><\/a>What is a Tenant?<\/h1>\n<ol>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#deciding-on-your-tenant\">Deciding on your Tenant<\/a>\n<\/li>\n<li>\n<a href=\"#next-step\">Next Step<\/a>\n<\/li>\n<\/ol>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p>Whether to separate data based on the requested hostname, the logged\nin user or the team the user belongs to, is entirely up to you.<\/p>\n<p>The subject of tenancy, <strong>the tenant<\/strong>, can be any eloquent Model\nin your application you wish to build your business logic around.<\/p>\n<h2 id=\"deciding-on-your-tenant\"><a href=\"#deciding-on-your-tenant\" class=\"anchor-link\"><\/a>Deciding on your Tenant<\/h2>\n<p>The most important decision in building a multi-tenant application\nis choosing your tenant. In order to help you with this, ask yourself the\nfollowing questions.<\/p>\n<p>To which entity in my business logic does the tenant data belong to?<\/p>\n<p>Do I have companies with employees signing up? Then most likely that\ncompany is the tenant, it holds all the information we want to keep separated\nfrom any other company in the application. This is a very common\nchoice visible with applications using a vanity url, eg yourteam.saas.app.<\/p>\n<p>Or perhaps we can keep it simple by marking the user as a tenant. This will\nconnect all data to a single account instead. A great example of this is\nGMail. You log in and see only the emails of your account.<\/p>\n<p>A hybrid version is also well known, GitHub offers personal namespaces, for instance\ngithub.com\/luceos and team namespaces like github.com\/tenancy.<\/p>\n<p>Tenancy offers a solution for any scenario as there's no limitation to how\na tenant is identified, nor how many tenants can be configured. To give you an idea\nusing the hybrid example from above the tenants would be both a User model\nand an Organization model. They can be marked as a valid tenant entity by applying\na contract and implementing the required methods.<\/p>\n<h2 id=\"next-step\"><a href=\"#next-step\" class=\"anchor-link\"><\/a>Next Step<\/h2>\n<p>Once you have identified what object(s) will be your tenant you will need to setup those tenants. To get started continue to <a href=\"tenant-setup\">Tenant Setup<\/a><\/p>\n","updated_at":{"date":"2020-08-13 12:53:46.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/tenant-what-is.md"},{"title":"Tenant Setup","icon":"fal fa-id-card-alt","excerpt":"General tenant setup.\n","tags":["tenant"],"path":"docs\/tenancy\/1.x\/tenant-setup.md","slug":"tenant-setup","package":"tenancy","version":"1.x","contents":"<h1 id=\"tenant-setup\"><a href=\"#tenant-setup\" class=\"anchor-link\"><\/a>Tenant Setup<\/h1>\n<ul>\n<li>\n<a href=\"#tenant-contract\">Tenant Contract<\/a>\n<ul>\n<li>\n<a href=\"#tenant-model-trait\">Tenant Model Trait<\/a>\n<\/li>\n<\/ul>\n<\/li>\n<li>\n<a href=\"tenant-registration\">Tenant Registration<\/a>\n<\/li>\n<li>\n<a href=\"#next-steps\">Next Steps<\/a>\n<ul>\n<li>\n<a href=\"#lifecycle-hooks\">Lifecycle Hooks<\/a>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2 id=\"tenant-contract\"><a href=\"#tenant-contract\" class=\"anchor-link\"><\/a>Tenant Contract<\/h2>\n<p>The tenant contract <code>Tenancy\\Identification\\Contracts\\Tenant<\/code> marks a specific\nClass as a valid tenant. Have the class implement the contract methods to get started:<\/p>\n<pre><code class=\"language-php\">use Illuminate\\Database\\Eloquent\\Model;\nuse Tenancy\\Identification\\Contracts\\Tenant;\n\nclass User extends Model implements Tenant\n{\n    \/**\n     * The attribute of the Model to use for the key.\n     *\n     * @return string\n     *\/\n    public function getTenantKeyName(): string\n    {\n        return 'id';\n    }\n\n    \/**\n     * The actual value of the key for the tenant Model.\n     *\n     * @return string|int\n     *\/\n    public function getTenantKey()\n    {\n        return $this-&gt;id;\n    }\n\n    \/**\n     * A unique identifier, eg class or table to distinguish this tenant Model.\n     *\n     * @return string\n     *\/\n    public function getTenantIdentifier(): string\n    {\n        return get_class($this);\n    }\n}\n<\/code><\/pre>\n<p>This will force your User model to implement some methods\nrequired for tenancy to do its work.<\/p>\n<h3 id=\"tenant-model-trait\"><a href=\"#tenant-model-trait\" class=\"anchor-link\"><\/a>Tenant Model Trait<\/h3>\n<p>Of course tenancy offers an easy way of applying the methods\nrequired by the contract to a model by using a trait for those specific functions.<\/p>\n<pre><code class=\"language-php\">use Illuminate\\Database\\Eloquent\\Model;\nuse Tenancy\\Identification\\Concerns\\AllowsTenantIdentification;\nuse Tenancy\\Identification\\Contracts\\Tenant;\n\nclass User extends Model implements Tenant\n{\n    use AllowsTenantIdentification;\n}\n<\/code><\/pre>\n<p>Your first valid tenant is a fact. Now we need to make sure our application\nis aware it exists.<\/p>\n<h2 id=\"tenant-registration\"><a href=\"#tenant-registration\" class=\"anchor-link\"><\/a>Tenant Registration<\/h2>\n<p>In order for the package to know a valid tenant is available, you will need\nto register it on the tenant identification resolver. The best to do so is inside\nyour <code>app\/Providers\/AppServiceProvider<\/code> or alternatively a dedicated <code>app\/Providers\/TenantProvider<\/code>\nwhich you created. You do this by providing the Tenant Resolver with the tenants using the <code>addModel<\/code> function.<\/p>\n<pre><code class=\"language-php\">namespace App\\Providers;\n\nuse App\\User;\nuse Illuminate\\Support\\ServiceProvider;\nuse Tenancy\\Identification\\Contracts\\ResolvesTenants;\n\nclass AppServiceProvider extends ServiceProvider\n{\n    \/**\n     * Bootstrap any application services.\n     *\n     * @return void\n     *\/\n    public function boot()\n    {\n        \/\/\n    }\n\n    \/**\n     * Register any application services.\n     *\n     * @return void\n     *\/\n    public function register()\n    {\n        $this-&gt;app-&gt;resolving(ResolvesTenants::class, function (ResolvesTenants $resolver) {\n            $resolver-&gt;addModel(User::class);\n            \n            return $resolver;\n        });\n    }\n}\n<\/code><\/pre>\n<h2 id=\"next-steps\"><a href=\"#next-steps\" class=\"anchor-link\"><\/a>Next Steps<\/h2>\n<h3 id=\"lifecycle-hooks\"><a href=\"#lifecycle-hooks\" class=\"anchor-link\"><\/a>Lifecycle Hooks<\/h3>\n<p><a href=\"hooks-general\">Lifecycle Hooks<\/a> allow you to take specific actions when a Tenant is created, updated, or deleted.<\/p>\n","updated_at":{"date":"2020-08-13 12:53:46.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/tenant-setup.md"}]},{"name":"lifecycle","links":["hooks-general","hooks-database","hooks-migrations","hooks-hostname","hooks-custom"],"slug":"lifecycle","articles":[{"title":"About lifecycle hooks","icon":"fal fa-heartbeat","excerpt":"How tenancy hooks into tenant lifecycle events\n","tags":["hooks","tenant"],"path":"docs\/tenancy\/1.x\/hooks-general.md","slug":"hooks-general","package":"tenancy","version":"1.x","contents":"<h1 id=\"lifecycle-hooks\"><a href=\"#lifecycle-hooks\" class=\"anchor-link\"><\/a>Lifecycle Hooks<\/h1>\n<ul>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#events\">Events<\/a>\n<\/li>\n<li>\n<a href=\"#priority\">Priority<\/a>\n<\/li>\n<li>\n<a href=\"#available-hooks\">Available Hooks<\/a>\n<\/li>\n<li>\n<a href=\"#next-steps\">Next Steps<\/a>\n<\/li>\n<\/ul>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p>Lifecycle hooks are executed whenever a tenant is created, updated or deleted.\nThey allow simple bootstrapping of a newly created tenant, like provisioning a new\ndatabase virtual machine, registering domains or setting up a S3 bucket.<\/p>\n<p>When the <code>HookResolver<\/code> fires the hooks, it will:<\/p>\n<ul>\n<li>Resolve the registered hooks.<\/li>\n<li>Call the <code>for()<\/code> method on the hook with the specific <a href=\"#events\">lifecycle event<\/a>.<\/li>\n<li>Filter hooks that aren't supposed to fire, by checking the response of the method <code>fires()<\/code>.<\/li>\n<li>Sorts based on the <code>priority()<\/code> method, see <a href=\"#priorities\">priorities<\/a>.<\/li>\n<li>Then calls the <code>fire()<\/code> method either:\n<ul>\n<li>directly.<\/li>\n<li>or dispatched to the queue returned from the <code>queue()<\/code> method when <code>queued()<\/code> is true.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2 id=\"events\"><a href=\"#events\" class=\"anchor-link\"><\/a>Events<\/h2>\n<p>Lifecycle hooks listen for any of the following events:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Tenant\\Events\\Created<\/code>\n<\/li>\n<li>\n<code>Tenancy\\Tenant\\Events\\Updated<\/code>\n<\/li>\n<li>\n<code>Tenancy\\Tenant\\Events\\Deleted<\/code>\n<\/li>\n<\/ul>\n<p>You will have to fire these events in your own codebase, for instance:<\/p>\n<pre><code class=\"language-php\">event(new \\Tenancy\\Tenant\\Events\\Created($tenant));\n<\/code><\/pre>\n<p>Or through Laravel's <code>$dispatchesEvents<\/code>:<\/p>\n<pre><code class=\"language-php\">use Illuminate\\Database\\Eloquent\\Model;\n\nclass Tenant extends Model\n{\n    protected $dispatchesEvents = [\n        'created' =&gt; \\Tenancy\\Tenant\\Events\\Created::class,\n        'updated' =&gt; \\Tenancy\\Tenant\\Events\\Updated::class,\n        'deleted' =&gt; \\Tenancy\\Tenant\\Events\\Deleted::class,\n    ];\n}\n<\/code><\/pre>\n<p>Some pointers you need to take into consideration:<\/p>\n<ul>\n<li>The tenant has to implement the <a href=\"identification-general#tenant-contract\">Tenant Contract<\/a>.<\/li>\n<li>Fire the event after your own code is finished.<\/li>\n<li>Fire the event outside of any transactions, so that changed attributes\nhave persisted and correct values are used by the hooks.<\/li>\n<\/ul>\n<h2 id=\"priorities\"><a href=\"#priorities\" class=\"anchor-link\"><\/a>Priorities<\/h2>\n<p>For hooks to be executed in the right sequence (eg migrations running after the database is created),\nthe hooks require a priority. Make sure your hooks use the correct value. Hooks are ran from lowest\nto highest priority.<\/p>\n<ul>\n<li>Databases created, updated and deleted: <code>-100<\/code>\n<\/li>\n<li>Migrations, if hooks-migrations is enabled: <code>-50<\/code>\n<\/li>\n<\/ul>\n<p>As a result if you want to set up and configure a database server when a tenant is created, make sure to\ndo so with a priority lower than -100. If you want to configure a database value dynamically after the\nmigrations and seeds are done, use a value higher than -50.<\/p>\n<h2 id=\"available-hooks\"><a href=\"#available-hooks\" class=\"anchor-link\"><\/a>Available Hooks<\/h2>\n<h3 id=\"first-party\"><a href=\"#first-party\" class=\"anchor-link\"><\/a>First Party<\/h3>\n<p><a href=\"hooks-database\">Database<\/a><\/p>\n<p><a href=\"hooks-migrations\">Migrations<\/a><\/p>\n<p><a href=\"hooks-hostname\">Hostname<\/a><\/p>\n<h2 id=\"next-steps\"><a href=\"#next-steps\" class=\"anchor-link\"><\/a>Next Steps<\/h2>\n<h3 id=\"identification\"><a href=\"#identification\" class=\"anchor-link\"><\/a>Identification<\/h3>\n<p><a href=\"identification-general\">Identification Drivers<\/a> will be how your application determins which tenant should be loaded during a request, command, or job.<\/p>\n","updated_at":{"date":"2020-08-13 12:53:46.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/hooks-general.md"},{"title":"Hooks Database","icon":"fal fa-database","excerpt":"How tenancy works with the Tenant lifecycle for Database mutations.\n","tags":["hooks","tenant","database"],"path":"docs\/tenancy\/1.x\/hooks-database.md","slug":"hooks-database","package":"tenancy","version":"1.x","contents":"<h1 id=\"lifecycle-hook-database\"><a href=\"#lifecycle-hook-database\" class=\"anchor-link\"><\/a>Lifecycle Hook: Database<\/h1>\n<ol>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#requirements\">Requirements<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuring\">Configuring<\/a>\n<ol>\n<li>\n<a href=\"#configuring-example\">Example<\/a>\n<\/li>\n<li>\n<a href=\"#remote-database-servers\">Remote Database Servers<\/a>\n<\/li>\n<li>\n<a href=\"#seperate-database-servers\">Seperate Database Server<\/a>\n<\/li>\n<\/ol>\n<\/li>\n<li>\n<a href=\"#database-mutations\">Database Mutations<\/a>\n<ol>\n<li>\n<a href=\"#mutations-example\">Example<\/a>\n<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to handle the creation, updating, and deletion of a Tenant's Database.<\/p>\n<p><strong>Requirements<\/strong><\/p>\n<ul>\n<li>In order to use this package a <a href=\"database-drivers\">Database Driver<\/a> must also be installed.<\/li>\n<li>A <a href=\"what-is-a-tenant\">Tenant<\/a> that dispatches the <code>Created<\/code>, <code>Updated<\/code>, and\/or <code>Deleted<\/code> <a href=\"hooks-general#events\">lifecycle events<\/a>.<\/li>\n<\/ul>\n<p><strong>Recommendations<\/strong><\/p>\n<ul>\n<li>To use the Tenant Database with the <code>onTenant<\/code> trait; The <a href=\"affects-connections\"><code>affects-connections<\/code><\/a> package should also be installed.<\/li>\n<\/ul>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Create a new Database when a Tenant is created.<\/li>\n<li>Update the Database when the Tenant is updated.<\/li>\n<li>Delete a Database when a Tenant is deleted.<\/li>\n<li>and Many More!<\/li>\n<\/ul>\n<p><strong>Events &amp; Methods<\/strong><\/p>\n<ul>\n<li>\n<code>Tenancy\\Hooks\\Database\\Events\\Drivers\\Configuring<\/code>\n<ul>\n<li>\n<code>useConnection()<\/code>\n<\/li>\n<li>\n<code>useConfig()<\/code>\n<\/li>\n<li>\n<code>defaults()<\/code>\n<\/li>\n<\/ul>\n<\/li>\n<li>\n<code>Tenancy\\Hooks\\Database\\Events\\ConfigureDatabaseMutation<\/code>\n<ul>\n<li>\n<code>disable()<\/code>\n<\/li>\n<li>\n<code>priority()<\/code>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2 id=\"requirements\"><a href=\"#requirements\" class=\"anchor-link\"><\/a>Requirements<\/h2>\n<ul>\n<li>\n<p>A Database Driver is responsible for actually creating the database. Most of the Database Drivers will run specific &quot;elevated permissions&quot; queries in order to provide a database and\/or a database user.<\/p>\n<p>Find a driver and corresponding information on the <a href=\"database-drivers\">Database Drivers Page<\/a><\/p>\n<\/li>\n<li>\n<p>A <a href=\"what-is-a-tenant\">Tenant<\/a> that dispatches the <code>Created<\/code>, <code>Updated<\/code>, and\/or <code>Deleted<\/code> <a href=\"hooks-general#events\">lifecycle events<\/a>.<\/p>\n<\/li>\n<\/ul>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<p>Most hooks have a really straight forward installation. <code>hooks-database<\/code> has a different approach and requires at least one of the <a href=\"database-drivers\">Database Drivers<\/a> to also be installed.<\/p>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/hooks-database\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Hooks\\Database\\Provider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuring\"><a href=\"#configuring\" class=\"anchor-link\"><\/a>Configuring<\/h2>\n<p>After requiring the package, we highly recommend you to listen to the <code>Tenancy\\Hooks\\Database\\Events\\Drivers\\Configuring<\/code> event. This allows you to adjust the Database configuration just the way you want it.<\/p>\n<p>There are a few functions to help you with setting up your Configuration.<\/p>\n<ul>\n<li>\n<code>useConnection()<\/code>, this function allows you to use one of the connections that you have defined in the <code>config\/database.php<\/code> of your Laravel application. It uses the name of the connection to identify which connection you're trying to use.<\/li>\n<li>\n<code>useConfig()<\/code>, this function allows you to use a file in any path to provide an array as a configuration.<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>All the above functions allow you to provide an <code>override<\/code> which will be merged in the provided configuration.<\/p><\/div>\n<ul>\n<li>\n<code>defaults()<\/code>, this will return an array that uses Tenancy's internal code to figure out the following:\n<ul>\n<li>Database Name, which is the tenant key<\/li>\n<li>Database User, which is the tenant key<\/li>\n<li>Database User Password, which is generated based on the <code>PasswordGenerator<\/code> that is in <code>tenancy\/framework<\/code>.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h3 id=\"configuring-example\"><a href=\"#configuring-example\" class=\"anchor-link\"><\/a>Configuring Example<\/h3>\n<p>In the example below we will configure the database to be created using the information from the <code>mysql<\/code> database connection defined in the <code>config\/database.php<\/code> and add Tenancy's default database settings to this.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Hooks\\Database\\Events\\Drivers\\Configuring;\n\nclass ConfigureTenantDatabase\n{\n    public function handle(Configuring $event)\n    {\n        $event-&gt;useConnection('mysql', $event-&gt;defaults($event-&gt;tenant));\n    }\n}\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Note: The <code>Tenancy\\Hooks\\Database\\Events\\Drivers\\Configuring<\/code> event is only used to generate the\nstatements required to manage the Tenant's database and user. It is <em>NOT<\/em> used to connect to the\ndatabase that these statements will run on.<\/p><\/div>\n<h4 id=\"remote-database-servers\"><a href=\"#remote-database-servers\" class=\"anchor-link\"><\/a>Remote Database Servers<\/h4>\n<p>In many production applications, the database will be on a seperate server than the application\nis executing on. This may cause issues in some cases due to how databases configure user access.<\/p>\n<p>Expanding on the previous example, the example below will set the host for the user to a wildcard\nallowing this user to connect from any host and access the database.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Hooks\\Database\\Events\\Drivers\\Configuring;\n\nclass ConfigureTenantDatabase\n{\n    public function handle(Configuring $event)\n    {\n        $overrides = array_merge(\n            ['host'=&gt;'%'],\n            $event-&gt;defaults($event-&gt;tenant)\n        );\n        $event-&gt;useConnection('mysql', $overrides);\n    }\n}\n<\/code><\/pre>\n<h4 id=\"seperate-database-servers\"><a href=\"#seperate-database-servers\" class=\"anchor-link\"><\/a>Seperate Database Servers<\/h4>\n<p>By default Tenancy will try to create the Tenant's database and user using the default connection.\nIn cases where Tenant's are stored on different database servers you will need to implement the\n<code>ManagesSystemConnection<\/code> interface.<\/p>\n<p>To get started have the <a href=\"what-is-a-tenant\">Tenant<\/a> class implement the <code>ManagesSystemConnection<\/code> interface\nand implement the <code>getManagingSystemConnection<\/code> method.<\/p>\n<p>In the following example, we assume that you have a <code>premium-mysql<\/code> connection specified in your\n<code>config\/database.php<\/code> configuration file.<\/p>\n<pre><code class=\"language-php\">use Illuminate\\Database\\Eloquent\\Model;\nuse Tenancy\\Identification\\Concerns\\AllowsTenantIdentification;\nuse Tenancy\\Identification\\Contracts\\Tenant;\nuse Tenancy\\Database\\Drivers\\Mysql\\Concerns\\ManagesSystemConnection;\n\nclass User extends Model implements Tenant, ManagesSystemConnection\n{\n    use AllowsTenantIdentification;\n\n    public function getManagingSystemConnection(): ?string\n    {\n        return 'premium-mysql';\n    }\n}\n<\/code><\/pre>\n<h2 id=\"database-mutations\"><a href=\"#database-mutations\" class=\"anchor-link\"><\/a>Database Mutations<\/h2>\n<p>Tenancy has provided a specific Event (<code>Tenancy\\Hooks\\Database\\Events\\ConfigureDatabaseMutation<\/code>) that will allow you to &quot;configure&quot; the Database Mutation. This event will be fired once we're sure that the Database Mutation should fire.<\/p>\n<p>This event will allow you to:<\/p>\n<ul>\n<li>Reprioritize the Hook<\/li>\n<li>Disable the hook<\/li>\n<\/ul>\n<p>You could do anything you could want when this event is fired.<\/p>\n<h3 id=\"mutations-example\"><a href=\"#mutations-example\" class=\"anchor-link\"><\/a>Mutations Example<\/h3>\n<p>In the example below we disable the mutation in order to retain the database after a Tenant is deleted.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Hooks\\Database\\Events\\ConfigureDatabaseMutation;\nuse Tenancy\\Tenant\\Events\\Deleted;\n\nclass ConfigureTenantDatabaseMutations\n{\n    public function handle(ConfigureDatabaseMutation $event)\n    {\n        if($event-&gt;event instanceof Deleted)\n        {\n            $event-&gt;disable();\n        }\n    }\n}\n<\/code><\/pre>\n","updated_at":{"date":"2021-03-02 23:46:58.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/hooks-database.md"},{"title":"Migrations and seeds","icon":"fal fa-inventory","excerpt":"Automatically run migrations and seeds on tenant lifecycle events.\n","tags":["hooks","tenant","migrations","seeds"],"path":"docs\/tenancy\/1.x\/hooks-migrations.md","slug":"hooks-migrations","package":"tenancy","version":"1.x","contents":"<h1 id=\"lifecycle-hook-migrations\"><a href=\"#lifecycle-hook-migrations\" class=\"anchor-link\"><\/a>Lifecycle Hook: Migrations<\/h1>\n<ul>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#migrations\">Migrations<\/a>\n<ul>\n<li>\n<a href=\"#migrations-configuration\">Configuration<\/a>\n<\/li>\n<li>\n<a href=\"#migrations-example\">Example<\/a>\n<\/li>\n<\/ul>\n<\/li>\n<li>\n<a href=\"#seeds\">Seeds<\/a>\n<ul>\n<li>\n<a href=\"#seeds-configuration\">Configuration<\/a>\n<\/li>\n<li>\n<a href=\"#seeds-example\">Example<\/a>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to handle the running of migrations and seeds.<\/p>\n<p><strong>Requirements<\/strong><\/p>\n<ul>\n<li>\n<p>This package requires the installation and configuration of the <a href=\"https:\/\/tenancy.dev\/docs\/tenancy\/1.x\/affects-connections\"><code>affects-connections<\/code><\/a> package.<\/p>\n<\/li>\n<li>\n<p>A <a href=\"tenant-what-is\">Tenant<\/a> that dispatches the <code>Created<\/code>, <code>Updated<\/code>, and\/or <code>Deleted<\/code> <a href=\"hooks-general#events\">lifecycle events<\/a>.<\/p>\n<\/li>\n<\/ul>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Run migrations after a database is created<\/li>\n<li>Run seeds after the database is created<\/li>\n<li>Run migrations after a tenant is updated or deleted.<\/li>\n<li>and Many More!<\/li>\n<\/ul>\n<p><strong>Events &amp; Methods<\/strong><\/p>\n<ul>\n<li>\n<code>Tenancy\\Hooks\\Migration\\Events\\ConfigureMigrations<\/code>\n<ul>\n<li>\n<code>path()<\/code>\n<\/li>\n<li>\n<code>flush()<\/code>\n<\/li>\n<li>\n<code>disable()<\/code>\n<\/li>\n<li>\n<code>priority()<\/code>\n<\/li>\n<\/ul>\n<\/li>\n<li>\n<code>Tenancy\\Hooks\\Migration\\Events\\ConfigureSeeds<\/code>\n<ul>\n<li>\n<code>seed()<\/code>\n<\/li>\n<li>\n<code>disable()<\/code>\n<\/li>\n<li>\n<code>priority()<\/code>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<p><code>hooks-migration<\/code> is a package that is a bit more complex than most Tenancy packages. This will take care of everything after a Database is created for your multi-database setup.<\/p>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/hooks-migration\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Hooks\\Migration\\Provider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"migrations\"><a href=\"#migrations\" class=\"anchor-link\"><\/a>Migrations<\/h2>\n<h3 id=\"migrations-configuration\"><a href=\"#migrations-configuration\" class=\"anchor-link\"><\/a>Migrations Configuration<\/h3>\n<p>Once you've installed the package, you will have to configure how Tenant should be migrated. You can do this by listening to the <code>\\Tenancy\\Hooks\\Migration\\Events\\ConfigureMigrations<\/code> event. It will provide you with some simple functionality in order to make your Migrations work like a charm:<\/p>\n<ul>\n<li>\n<code>path()<\/code>, this function allows you to register a path where your migrations are located. These migrations will be used once the migrations run.<\/li>\n<li>\n<code>disable()<\/code>, this function allows you to completely disable the migrations.<\/li>\n<li>\n<code>priority()<\/code>, this function allows you to change the priority in which the migrations run.<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>Warning: The default priority for migrations is: <code>-50<\/code> and will run <em>after<\/em> the <a href=\"hooks-database\">Database Hooks<\/a>.<\/p>\n<p>If migrations are not disabled or ran with a priority less than <code>-100<\/code> for the <code>Deleted<\/code> event you will receive an error as the database will have already been deleted.<\/p><\/div>\n<h3 id=\"migrations-example\"><a href=\"#migrations-example\" class=\"anchor-link\"><\/a>Migrations Example<\/h3>\n<p>In the example below we'll add the <code>database\/tenant\/migrations<\/code> folder containing migrations that should be used for the Tenant database.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Hooks\\Migration\\Events\\ConfigureMigrations;\n\nclass ConfigureTenantMigrations\n{\n    public function handle(ConfigureMigrations $event)\n    {\n        $event-&gt;path(database_path('tenant\/migrations'));\n    }\n}\n<\/code><\/pre>\n<h4 id=\"running-migrations-manually\"><a href=\"#running-migrations-manually\" class=\"anchor-link\"><\/a>Running migrations manually<\/h4>\n<p>If you have migration hook set up, you can fire <code>Tenancy\\Tenant\\Events\\Updated<\/code> event, which will trigger hooks and run the migrations:<\/p>\n<pre><code class=\"language-php\">event(new \\Tenancy\\Tenant\\Events\\Updated($tenant));\n<\/code><\/pre>\n<p>Alternativelly, you can use <code>php artisan migrate<\/code> command by passing addditional parameters:<\/p>\n<ul>\n<li>\n<code>--tenant<\/code> parameter will specify which tenant to run migrations for. This requires <a href=\"identification-console\">console identification<\/a>.<\/li>\n<li>\n<code>--database<\/code> parameter will tell migrations to run on <code>tenant<\/code> connection, which is set up dinamically using <a href=\"affects-connections\">affects-connections<\/a>.<\/li>\n<li>\n<code>--path<\/code> parameter will specify migration path.<\/li>\n<\/ul>\n<p>Example:<\/p>\n<pre><code>php artisan migrate --tenant=1 --database=tenant --path=database\/tenant\/migrations\n<\/code><\/pre>\n<h2 id=\"seeds\"><a href=\"#seeds\" class=\"anchor-link\"><\/a>Seeds<\/h2>\n<h3 id=\"seeds-configuration\"><a href=\"#seeds-configuration\" class=\"anchor-link\"><\/a>Seeds Configuration<\/h3>\n<p>Once you've installed the migrations, you might want to seed the database with some data for the tenant. In that case you can listen to the <code>\\Tenancy\\Hooks\\Migration\\Events\\ConfigureSeeds<\/code> event. This event has one very simple method that will be of use to you:<\/p>\n<ul>\n<li>\n<code>seed()<\/code>, this function will take the string of the seeder class. You can see how to use this in the example below.<\/li>\n<li>\n<code>disable()<\/code>, this function allows you to completely disable the seeds.<\/li>\n<li>\n<code>priority()<\/code>, this function allows you to change the priority in which the seeds run.<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>Note: the default priority is <code>-40<\/code> and will default to running after the migrations hook.<\/p><\/div>\n<h3 id=\"seeds-example\"><a href=\"#seeds-example\" class=\"anchor-link\"><\/a>Seeds Example<\/h3>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Hooks\\Migration\\Events\\ConfigureSeeds;\n\nclass ConfigureTenantSeeds\n{\n    public function handle(ConfigureSeeds $event)\n    {\n        $event-&gt;seed(\\UsersSeeder::class);\n    }\n}\n<\/code><\/pre>\n","updated_at":{"date":"2022-08-31 07:34:37.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/hooks-migrations.md"},{"title":"Hooks Hostname","icon":"fal fa-heartbeat","excerpt":"How tenancy works with the Tenant lifecycle for Hostname mutations.\n","tags":["tenant","hooks","hostname"],"path":"docs\/tenancy\/1.x\/hooks-hostname.md","slug":"hooks-hostname","package":"tenancy","version":"1.x","contents":"<h1 id=\"lifecycle-hook-hostname\"><a href=\"#lifecycle-hook-hostname\" class=\"anchor-link\"><\/a>Lifecycle Hook: Hostname<\/h1>\n<ul>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#introduction\">Introduction<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<ul>\n<li>\n<a href=\"#tenant\">Tenant<\/a>\n<\/li>\n<li>\n<a href=\"#handlers\">Handlers<\/a>\n<\/li>\n<li>\n<a href=\"#hook\">Hook<\/a>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to allow running custom functions when a Tenant is updated.<\/p>\n<p><strong>Requirements<\/strong><\/p>\n<ul>\n<li>A <a href=\"tenant-what-is\">Tenant<\/a> that dispatches the <code>Created<\/code>, <code>Updated<\/code>, and\/or <code>Deleted<\/code> <a href=\"hooks-general#events\">lifecycle events<\/a>.<\/li>\n<\/ul>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Register a new SSL Certificate<\/li>\n<li>Register a domain<\/li>\n<li>Change some configuration files<\/li>\n<li>Test the DNS to make sure the records are configured correctly<\/li>\n<li>and Many More!<\/li>\n<\/ul>\n<p><strong>Events &amp; Methods<\/strong><\/p>\n<ul>\n<li>\n<code>\\Tenancy\\Hooks\\Hostname\\Events\\ConfigureHostnames<\/code>\n<ul>\n<li>\n<code>disable()<\/code>\n<\/li>\n<li>\n<code>priority()<\/code>\n<\/li>\n<li>\n<code>registerHandler()<\/code>\n<\/li>\n<li>\n<code>getHandlers()<\/code>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h2>\n<p><code>Hooks-hostname<\/code> is all about working with hostnames of a tenant. A tenant might have one or multiple domains it is served over. During the lifecycle of this tenant it might change a few times and you need to take care of some really specific things.<\/p>\n<p>This hook allows you to register so-called <code>HostnameHandlers<\/code>. These handlers will take care of anything related to the hostname of a tenant.<\/p>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/hooks-hostname\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Hooks\\Hostname\\Provider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<h3 id=\"tenant\"><a href=\"#tenant\" class=\"anchor-link\"><\/a>Tenant<\/h3>\n<p>To begin, your Tenant's needs to be updated to use the <code>Tenancy\\Hooks\\Hostname\\Contracts\\HasHostnames<\/code> Contract and implement the <code>getHostnames<\/code> function returning an array of hostnames for the Tenant.<\/p>\n<p>In the following example we will assume that the Tenant has a &quot;hostname&quot; attribute.<\/p>\n<pre><code class=\"language-php\">class Tenant implements \\Tenancy\\Hooks\\Hostname\\Contracts\\HasHostnames\n{\n    public function getHostnames(): array\n    {\n        return [\n            $this-&gt;hostname\n        ];\n    }\n}\n<\/code><\/pre>\n<h3 id=\"handlers\"><a href=\"#handlers\" class=\"anchor-link\"><\/a>Handlers<\/h3>\n<p>Next, Handlers need to be created. They perform the logic to execute for each hostname such as registering a domain, updating nginx\/apache configuration files, etc.<\/p>\n<p>To create a handler, you need to create a new class that implements the <code>Tenancy\\Hooks\\Hostname\\Contracts\\HostnameHandler<\/code> contract and implements the <code>handle<\/code> function to perform the required logic.<\/p>\n<p>In the following example we try to check if the domains of the tenant are valid. If the tenant does not have valid domains, we will send an email to the administrator regarding the domains not being valid.<\/p>\n<pre><code class=\"language-php\">namespace App\\Handlers;\n\nuse Tenancy\\Hooks\\Hostname\\Contracts\\HostnameHandler;\nuse Tenancy\\Tenant\\Events\\Event;\nuse Illuminate\\Support\\Facades\\Mail;\n\nclass SimpleHandler implements HostnameHandler\n{\n    public function handle(Event $event): void\n    {\n        if (!$this-&gt;hasValidDomains($event-&gt;tenant)) {\n            Mail::to($event-&gt;tenant-&gt;email)-&gt;send(new DomainsNotValid($event-&gt;tenant-&gt;getHostnames()));\n        }\n    }\n}\n<\/code><\/pre>\n<h3 id=\"hook\"><a href=\"#hook\" class=\"anchor-link\"><\/a>Hook<\/h3>\n<p>Like most other hooks, this hook fires a simple event that allows you to configure it properly. The event is <code>\\Tenancy\\Hooks\\Hostname\\Events\\ConfigureHostnames<\/code> and it has some really simply functionality:<\/p>\n<ul>\n<li>\n<code>registerHandler()<\/code>, which allows you to register a handler.<\/li>\n<li>\n<code>getHandlers()<\/code>, which allows you to get the handler.<\/li>\n<\/ul>\n<p>In the following example we will register the handler created in the previous example.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse App\\Handlers\\SimpleHandler;\nuse Tenancy\\Hooks\\Hostname\\Events\\ConfigureHostnames;\n\nclass ConfigureHostnameHandlers\n{\n    public function handle(ConfigureHostnames $event)\n    {\n        $event-&gt;registerHandler(new SimpleHandler);\n    }\n}\n<\/code><\/pre>\n","updated_at":{"date":"2021-08-08 11:06:30.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/hooks-hostname.md"},{"title":"Custom lifecycle hooks","icon":"fal fa-gear","excerpt":"How to create custom lifecycle hooks\n","tags":["hooks","tenant"],"path":"docs\/tenancy\/1.x\/hooks-custom.md","slug":"hooks-custom","package":"tenancy","version":"1.x","contents":"<h1 id=\"lifecycle-hooks-custom-hooks\"><a href=\"#lifecycle-hooks-custom-hooks\" class=\"anchor-link\"><\/a>Lifecycle Hooks: Custom Hooks<\/h1>\n<ul>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#base\">Base<\/a>\n<\/li>\n<li>\n<a href=\"#implementation\">Implementation<\/a>\n<ul>\n<li>\n<a href=\"#general\">General<\/a>\n<\/li>\n<li>\n<a href=\"#differences\">Differences<\/a>\n<\/li>\n<\/ul>\n<\/li>\n<li>\n<a href=\"#registration\">Registration<\/a>\n<\/li>\n<li>\n<a href=\"#advanced\">Advanced<\/a>\n<ul>\n<li>\n<a href=\"#configureshook-event\">ConfiguresHook Event<\/a>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>Enable custom functionality that isn't available through existing hooks.<\/p>\n<p><strong>Requirements<\/strong><\/p>\n<ul>\n<li>Knowledge of how <a href=\"hooks-general\">Lifecycle Hooks work<\/a>\n<\/li>\n<li>A <a href=\"tenant-what-is\">Tenant<\/a> that dispatches the <code>Created<\/code>, <code>Updated<\/code>, and\/or <code>Deleted<\/code> <a href=\"hooks-general#events\">lifecycle events<\/a>.<\/li>\n<\/ul>\n<h2 id=\"base\"><a href=\"#base\" class=\"anchor-link\"><\/a>Base<\/h2>\n<p>You can build your own hook by implementing the <code>Tenancy\\Contracts\\LifecycleHook<\/code> contract.<\/p>\n<p>There are two abstract Hook classes that make implementation easier:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Lifecycle\\Hook<\/code>\n<\/li>\n<li>\n<code>Tenancy\\Lifecycle\\ConfigurableHook<\/code>\n<\/li>\n<\/ul>\n<p>The basic difference is that the hook settings are not expected to change in a <code>Hook<\/code>,\nbut are expected to be fluid in the <code>ConfigurableHook<\/code>.<\/p>\n<p>I.e. A Lifecycle Hook that always run at the same default priority on the same default queue should use <code>Hook<\/code>,\nbut a LifecycleHook that will run on the Tenant's Queue should use <code>ConfigurableHook<\/code><\/p>\n<h2 id=\"implementation\"><a href=\"#implementation\" class=\"anchor-link\"><\/a>Implementation<\/h2>\n<h3 id=\"general\"><a href=\"#general\" class=\"anchor-link\"><\/a>General<\/h3>\n<p>Implementation only requires you to create a <code>fire<\/code> method that contains the logic for the hook.<\/p>\n<pre><code class=\"language-php\">public function fire()\n{\n    echo &quot;Running hook for &quot;.$this-&gt;event-&gt;tenant-&gt;name;\n}\n<\/code><\/pre>\n<p>If the hook needs to implement different logic based on the event (I.e. Created vs Deleted) you can check the type of event in the <code>fire<\/code> method.<\/p>\n<pre><code class=\"language-php\">public function fire()\n{\n    \/\/ Created Event\n    if($this-&gt;event instanceof \\Tenancy\\Tenant\\Events\\Created)\n    {\n        dump(&quot;Running hook for the creation of a tenant&quot;);\n        return;\n    }\n    \/\/ Deleted Event\n    if($this-&gt;event instanceof \\Tenancy\\Tenant\\Events\\Deleted)\n    {\n        dump(&quot;Running hook for the deletion of a tenant&quot;);\n        return;\n    }\n}\n<\/code><\/pre>\n<p>In the event the hook only needs to be run based on one event you can disable the hook and only enable it when it should be fired<\/p>\n<pre><code class=\"language-php\">namespace App\\Hooks;\n\nclass CustomCreateHook extends ConfigurableHook\n{\n    public $fires = false;\n\n    public function for($event)\n    {\n        parent::for($event);\n        \n        if($this-&gt;event instanceof \\Tenancy\\Tenant\\Events\\Created)\n        {\n            $this-&gt;fires = true;\n        }\n        return $this;\n    }\n}\n<\/code><\/pre>\n<p>For more advanced or tenant-dependent changes to the event, consider creating an <a href=\"#configureshooks-event\">Event and Listener<\/a> to configure the Hook.<\/p>\n<h3 id=\"differences\"><a href=\"#differences\" class=\"anchor-link\"><\/a>Differences<\/h3>\n<p>The implementation of both <code>Hook<\/code> and <code>ConfigurableHook<\/code> is generally the same with the exception of the following differences.<\/p>\n<p><strong>Queues<\/strong><\/p>\n<p><code>Hook<\/code> defaults to running on a queue, and defaults to the applications default queue.\n<code>ConfigurableHook<\/code> does not default to using a queue and will only run on a queue when the queue is specified<\/p>\n<pre><code class=\"language-php\">\/\/ Hook\npublic $queued = true;\npublic $queue = null;\n\n\/\/ ConfigurableHook\npublic $queue = null;\n<\/code><\/pre>\n<p><strong>Fires<\/strong><\/p>\n<p><code>Hook<\/code> defaults to always fire as long as the event being passed is a valid Tenancy Event.\n<code>ConfigurableHook<\/code> defaults to always fire.<\/p>\n<pre><code class=\"language-php\">\/\/ Hook\npublic $event; \/\/Must be an instance of Tenancy\\Tenant\\Events\\Event\npublic $fires = true;\n\n\/\/ ConfigurableHook\npublic $fires = true;\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Note: Both <code>Hook<\/code> and <code>ConfigurableHook<\/code> have the <code>$event<\/code> property which contains the tenant in <code>$event-&gt;tenant<\/code><\/p><\/div>\n<h2 id=\"registration\"><a href=\"#registration\" class=\"anchor-link\"><\/a>Registration<\/h2>\n<p>There are two methods of registering your custom Lifecycle Event.<\/p>\n<h3 id=\"extend-hooksprovider\"><a href=\"#extend-hooksprovider\" class=\"anchor-link\"><\/a>Extend HooksProvider<\/h3>\n<p>The simplest method is to create a new Service Provider (or use an existing one) and have it extend <code>Tenancy\\Support\\HooksProvider<\/code>. Then create an array of your custom hooks.<\/p>\n<pre><code class=\"language-php\">namespace App\\Providers;\n\nclass TenantLifecycleProvider extends \\Tenancy\\Support\\HooksProvider\n{\n    protected $hooks = [\n        \\App\\Hooks\\CustomHook::class,\n    ];\n}\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>This is the recommended method of registering Lifecycle Events<\/p><\/div>\n<h3 id=\"resolving-the-resolver\"><a href=\"#resolving-the-resolver\" class=\"anchor-link\"><\/a>Resolving the Resolver<\/h3>\n<pre><code class=\"language-php\">namespace App\\Providers;\n\nuse Illuminate\\Support\\ServiceProvider;\nuse Tenancy\\Lifecycle\\Contracts\\ResolvesHooks;\n\nclass AppServiceProvider extends ServiceProvider\n{\n    public function boot()\n    {\n        $this-&gt;app-&gt;resolving(ResolvesHooks::class, function (ResolvesHooks $resolver) {\n            $resolver-&gt;addHook(\\App\\Hooks\\CustomHook::class);\n        });\n    }\n}\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Please note, this is not the recommended method of registering your Lifecycle Event<\/p><\/div>\n<h2 id=\"advanced\"><a href=\"#advanced\" class=\"anchor-link\"><\/a>Advanced<\/h2>\n<h3 id=\"configureshook-event\"><a href=\"#configureshook-event\" class=\"anchor-link\"><\/a>ConfiguresHook Event<\/h3>\n<div class=\"alert alert-info\"><p>It is recommended that you only implement this for <code>ConfigurableHook<\/code> hooks.<\/p><\/div>\n<p>In the event you want to perform advanced logic to configure the hook, much like the available hooks, you can create a new Event and Listener in order to configure your custom Hook. In order to do so, ensure you override the <code>for<\/code> method in your hook as follows.<\/p>\n<pre><code class=\"language-php\">\/\/ Hook\npublic function for($event)\n{\n    parent::for($event);\n    event(\\App\\Events\\ConfiguresCustomHookEvent($this-&gt;event, $this));\n    return $this;\n}\n<\/code><\/pre>\n<p><strong>Example Event<\/strong><\/p>\n<pre><code class=\"language-php\">namespace App\\Events;\n\nclass ConfiguresCustomHookEvent\n{\n    \/**\n     * @var Event\n     *\/\n    public $event;\n\n    \/**\n     * @var ConfigurableHook\n     *\/\n    public $hook;\n\n    public function __construct(Event $event, ConfigurableHook $hook)\n    {\n        $this-&gt;event = $event;\n        $this-&gt;hook = $hook;\n    }\n    \n    public function disable()\n    {\n        $this-&gt;hook-&gt;fires = false;\n        return $this;\n    }\n\n    public function priority(int $priority = -50)\n    {\n        $this-&gt;hook-&gt;priority = $priority;\n        return $this;\n    }\n}\n<\/code><\/pre>\n<p>At this point you can create your listener for the new event and register it as per the Laravel documentation.<\/p>\n","updated_at":{"date":"2020-08-13 12:53:46.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/hooks-custom.md"}]},{"name":"identification","links":["identification-general","identification-http","identification-queue","identification-console","identification-environment"],"slug":"identification","articles":[{"title":"General Setup","icon":"fal fa-id-card-alt","excerpt":"General setup for tenant identification.\n","tags":["tenant","identification"],"path":"docs\/tenancy\/1.x\/identification-general.md","slug":"identification-general","package":"tenancy","version":"1.x","contents":"<h1 id=\"tenant-identification\"><a href=\"#tenant-identification\" class=\"anchor-link\"><\/a>Tenant Identification<\/h1>\n<ul>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#handling-nothing-identified\">Handling Nothing Identified<\/a>\n<\/li>\n<li>\n<a href=\"#identification-drivers\">Identification Drivers<\/a>\n<\/li>\n<li>\n<a href=\"#next-steps\">Next Steps<\/a>\n<\/li>\n<\/ul>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p>The tenant identification procedure decides which tenant you are trying to service. Although using the <code>TenantResolver<\/code> isn't absolutely necessary, doing so offloads a great deal of the tenancy business logic to the application.<\/p>\n<p>The <code>TenantResolver<\/code> dispatches a few events used by the identification drivers to identify the currently requested <a href=\"tenant-what-is\">Tenant<\/a>. By using an event you are not limited to only one driver. Each driver will only trigger it's own contract when it is identifying. However, if identification is triggered without a specific driver, it will try to identify all drivers. The first driver to respond with a valid tenant object will cause the other drivers to be ignored.<\/p>\n<div class=\"alert alert-info\"><p>Before making any changes to any code, it is recommended that you read though this entire document first.<\/p><\/div>\n<h2 id=\"handling-nothing-identified\"><a href=\"#handling-nothing-identified\" class=\"anchor-link\"><\/a>Handling Nothing Identified<\/h2>\n<p>Depending on how you choose to build out your application, there may be times where you need to perform\nspecific logic when no tenant is identified. To achieve this one simply needs to create a listener for the <code>Tenancy\\Identification\\Events\\NothingIdentified<\/code> event.<\/p>\n<p>In the following example we will abort execution and return a 404 error.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Identification\\Events\\NothingIdentified;\n\nclass NoTenantIdentified \n{\n    public function handle(NothingIdentified $event) \n    {\n        abort(404);\n    }\n}\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Note: This is only required if your application always expects to have a tenant identified and does not have a default non-tenant side.<\/p><\/div>\n<h2 id=\"identification-drivers\"><a href=\"#identification-drivers\" class=\"anchor-link\"><\/a>Identification Drivers<\/h2>\n<p>Every driver uses the same principle. In order for a tenant to be used by the driver it has to implement an interface (or in Laravel terminology contract) related to the driver.<\/p>\n<p>Depending on your application, you may need to identify a Tenant using different methods. The following Identification Drivers are available to be used alone, or in combination.<\/p>\n<p><a href=\"identification-console\">Console Identification<\/a><\/p>\n<p><a href=\"identification-environment\">Environment Identification<\/a><\/p>\n<p><a href=\"identification-http\">HTTP based Identification<\/a><\/p>\n<p><a href=\"identification-queue\">Queue Identification<\/a><\/p>\n<div class=\"alert alert-info\"><p>The identification driver will only attempt identification of a tenant model when it implements the contract of the driver.<\/p><\/div>\n<h2 id=\"next-steps\"><a href=\"#next-steps\" class=\"anchor-link\"><\/a>Next Steps<\/h2>\n<h3 id=\"affects\"><a href=\"#affects\" class=\"anchor-link\"><\/a>Affects<\/h3>\n<p><a href=\"affects-general\">Affects<\/a> change the behaviour of your Laravel application by integrating closely with the framework.<\/p>\n","updated_at":{"date":"2020-08-13 12:53:46.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/identification-general.md"},{"title":"Identification driver http","icon":"fal fa-browser","excerpt":"Identifies tenants using the request (object).\n","tags":["identification","http","driver"],"path":"docs\/tenancy\/1.x\/identification-http.md","slug":"identification-http","package":"tenancy","version":"1.x","contents":"<h1 id=\"tenant-identification-http\"><a href=\"#tenant-identification-http\" class=\"anchor-link\"><\/a>Tenant Identification: HTTP<\/h1>\n<ul>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#introduction\">Introduction<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<ul>\n<li>\n<a href=\"#example\">Example<\/a>\n<\/li>\n<li>\n<a href=\"#subdomain-example\">Subdomain Example<\/a>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to allow a <a href=\"tenant-what-is\">Tenant<\/a> to be identified by a HTTP request.<\/p>\n<p><strong>Requirements<\/strong><\/p>\n<p>The Tenant <a href=\"tenant-setup\">must be registered in the TenantResolver<\/a><\/p>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Identify a Tenant by a sub-directory path<\/li>\n<li>Identify a Tenant by a subdomain<\/li>\n<li>Identify a Tenant based on a unique domain<\/li>\n<li>Identify a Tenant based on a query parameter<\/li>\n<li>And many more!<\/li>\n<\/ul>\n<h2 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h2>\n<p>Identifying a tenant through the HTTP request object is a very common way of identifying tenants.\nIn order to allow a tenant to be identified with the Http driver, you\nneed to apply a Contract to the <a href=\"tenant-what-is\">tenant<\/a> class and implement the required\nmethods.<\/p>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/identification-driver-http\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Identification\\Drivers\\Http\\Providers\\IdentificationProvider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<p>Tenants that will be identified via HTTP need to implement the <code>Tenancy\\Identification\\Drivers\\Http\\Contracts\\IdentifiesByHttp<\/code> Contract.<\/p>\n<p>The <code>tenantIdentificationByHttp<\/code> method should return the tenant that is identified based on the current request.<\/p>\n<h3 id=\"example\"><a href=\"#example\" class=\"anchor-link\"><\/a>Example<\/h3>\n<p>The example below assumes your Customer has two additional columns to identify the portal it's configured to use. The\nportal hostname and path allow you to identify this Customer as being the Tenant for the current hostname and path\nrequested.<\/p>\n<pre><code class=\"language-php\">use Illuminate\\Database\\Eloquent\\Model;\nuse Illuminate\\Http\\Request;\nuse Tenancy\\Identification\\Concerns\\AllowsTenantIdentification;\nuse Tenancy\\Identification\\Contracts\\Tenant;\nuse Tenancy\\Identification\\Drivers\\Http\\Contracts\\IdentifiesByHttp;\n\nclass Customer extends Model implements Tenant, IdentifiesByHttp\n{\n  use AllowsTenantIdentification;\n  \n    \/**\n     * Specify whether the tenant model is matching the request.\n     *\n     * @param Request $request\n     * @return Tenant\n     *\/\n    public function tenantIdentificationByHttp(Request $request): ?Tenant\n    {\n        return $this-&gt;query()\n            -&gt;where('portal_hostname', $request-&gt;getHttpHost())\n            -&gt;where('portal_path', $request-&gt;path())\n            -&gt;first();\n    }\n}\n<\/code><\/pre>\n<h3 id=\"subdomain-example\"><a href=\"#subdomain-example\" class=\"anchor-link\"><\/a>Subdomain Example<\/h3>\n<p>The following example assumes that your Customer model has an extra column for a subdomain the user is configured to use.<\/p>\n<pre><code class=\"language-php\">use Illuminate\\Database\\Eloquent\\Model;\nuse Illuminate\\Http\\Request;\nuse Tenancy\\Identification\\Concerns\\AllowsTenantIdentification;\nuse Tenancy\\Identification\\Contracts\\Tenant;\nuse Tenancy\\Identification\\Drivers\\Http\\Contracts\\IdentifiesByHttp;\n\nclass Customer extends Model implements Tenant, IdentifiesByHttp\n{\n  use AllowsTenantIdentification;\n  \n    \/**\n     * Specify whether the tenant model is matching the request.\n     *\n     * @param Request $request\n     * @return Tenant\n     *\/\n    public function tenantIdentificationByHttp(Request $request): ?Tenant\n    {\n        list($subdomain) = explode('.', $request-&gt;getHost(), 2);\n        return $this-&gt;query()\n            -&gt;where('subdomain', $subdomain)\n            -&gt;first();\n    }\n}\n<\/code><\/pre>\n","updated_at":{"date":"2020-08-13 12:53:46.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/identification-http.md"},{"title":"Identification driver queue","icon":"fal fa-conveyor-belt","excerpt":"Identifies tenants using the queue.\n","tags":["identification","console","driver","queue"],"path":"docs\/tenancy\/1.x\/identification-queue.md","slug":"identification-queue","package":"tenancy","version":"1.x","contents":"<h1 id=\"tenant-identification-queue\"><a href=\"#tenant-identification-queue\" class=\"anchor-link\"><\/a>Tenant Identification: Queue<\/h1>\n<ul>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#introduction\">Introduction<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<\/li>\n<li>\n<a href=\"#example\">Example<\/a>\n<\/li>\n<li>\n<a href=\"#overriding\">Overriding<\/a>\n<ul>\n<li>\n<a href=\"#example-job\">Example Job<\/a>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to allow a <a href=\"tenant-what-is\">Tenant<\/a> to be identified in a queued Job.<\/p>\n<p><strong>Requirements<\/strong><\/p>\n<p>The Tenant <a href=\"tenant-setup\">must be registered in the TenantResolver<\/a><\/p>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Identify the Tenant a specific job is for<\/li>\n<li>And many more!<\/li>\n<\/ul>\n<h2 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h2>\n<p>One of the most powerful features in Laravel are the <a href=\"https:\/\/laravel.com\/docs\/master\/queues\">queues<\/a>. These are used for running specific tasks that don't need a UI and can be delayed. These can be hard to handle when it comes to multi-tenancy, and that is exactly where this package comes in.<\/p>\n<p>The package already does a lot of work for you, if an tenant is identified at the moment a job is queued, it will remember which tenant it was. It will also provide you with some powerful override tools in case you want to queue something for a different tenant.<\/p>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/identification-driver-queue\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Identification\\Drivers\\Queue\\Providers\\IdentificationProvider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuring\"><a href=\"#configuring\" class=\"anchor-link\"><\/a>Configuring<\/h2>\n<p>In order to enable queue identification for a tenant, it will have to implement the specific contract <code>Tenancy\\Identification\\Drivers\\Queue\\Contracts\\IdentifiesByQueue<\/code>. You will see that in this function you will get a simple custom <code>Processing<\/code> event which will contain one of these 2 pieces of information:<\/p>\n<ul>\n<li>The default provided <code>tenant_key<\/code> and <code>tenant_identifier<\/code> that are registered if a tenant was identified when a job was queued.<\/li>\n<li>The <a href=\"#overriding\">overridden<\/a> <code>tenant<\/code>, <code>tenant_key<\/code> or <code>tenant_identifier<\/code>, which you can provide yourself.<\/li>\n<\/ul>\n<h3 id=\"example\"><a href=\"#example\" class=\"anchor-link\"><\/a>Example<\/h3>\n<p>In the example below we will first check if an override tenant has been provided. If that is not the case, we will simply check if we can find the tenant in this model.<\/p>\n<p><code>app\/Models\/Customer.php<\/code><\/p>\n<pre><code class=\"language-php\">use Illuminate\\Database\\Eloquent\\Model;\nuse Tenancy\\Identification\\Concerns\\AllowsTenantIdentification;\nuse Tenancy\\Identification\\Contracts\\Tenant;\nuse Tenancy\\Identification\\Drivers\\Queue\\Events\\Processing;\nuse Tenancy\\Identification\\Drivers\\Queue\\Contracts\\IdentifiesByQueue;\n\nclass Customer extends Model implements Tenant, IdentifiesByQueue\n{\n    public function tenantIdentificationByQueue(Processing $event): ?Tenant\n    {\n        if ($event-&gt;tenant) {\n            return $event-&gt;tenant;\n        }\n\n        if ($event-&gt;tenant_key &amp;&amp; $event-&gt;tenant_identifier === $this-&gt;getTenantIdentifier()) {\n            return $this-&gt;newQuery()\n                -&gt;where($this-&gt;getTenantKeyName(), $event-&gt;tenant_key)\n                -&gt;first();\n        }\n\n        return null;\n    }\n} \n<\/code><\/pre>\n<h2 id=\"overriding\"><a href=\"#overriding\" class=\"anchor-link\"><\/a>Overriding<\/h2>\n<p>Sometimes you might want to override the tenant (when you have an admin panel that is a tenant for example). You can do this by providing one of the following public keys for a job:<\/p>\n<ul>\n<li>\n<code>tenant_identifier<\/code>, this should be the same as the <code>getTenantIdentifier<\/code> of a tenant.<\/li>\n<li>\n<code>tenant_key<\/code>, this should be the same as the <code>getTenantKey<\/code> of a tenant.<\/li>\n<li>\n<code>tenant<\/code>, this can be an entire Tenant object.<\/li>\n<\/ul>\n<h3 id=\"overridable-job\"><a href=\"#overridable-job\" class=\"anchor-link\"><\/a>Overridable Job<\/h3>\n<pre><code class=\"language-php\">namespace App\\Jobs;\n\nuse App\\Models\\Customer;\nuse Illuminate\\Bus\\Queueable;\nuse Illuminate\\Contracts\\Queue\\ShouldQueue;\nuse Illuminate\\Foundation\\Bus\\Dispatchable;\nuse Illuminate\\Queue\\InteractsWithQueue;\nuse Illuminate\\Queue\\SerializesModels;\nuse Tenancy\\Facades\\Tenancy;\n\nclass MailCustomer implements ShouldQueue\n{\n    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;\n\n    \/** @var Customer $tenant *\/\n    public $tenant;\n\n    public function __construct(Customer $customer, $tenant_key = null, string $tenant_identifier = null)\n    {\n        $this-&gt;tenant = $customer;\n    }\n\n    public function handle()\n    {\n        \/\/ ..\n    }\n}\n\n<\/code><\/pre>\n","updated_at":{"date":"2020-08-13 12:53:46.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/identification-queue.md"},{"title":"Console Identification","icon":"fal fa-terminal","excerpt":"Identifies tenants using the console\/artisan.\n","tags":["identification","console","driver","artisan"],"path":"docs\/tenancy\/1.x\/identification-console.md","slug":"identification-console","package":"tenancy","version":"1.x","contents":"<h1 id=\"tenant-identification-console\"><a href=\"#tenant-identification-console\" class=\"anchor-link\"><\/a>Tenant Identification: Console<\/h1>\n<ul>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#introduction\">Introduction<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<ul>\n<li>\n<a href=\"#example\">Example<\/a>\n<\/li>\n<li>\n<a href=\"#advance-example\">Advance Example<\/a>\n<\/li>\n<\/ul>\n<\/li>\n<li>\n<a href=\"#usage\">Usage<\/a>\n<\/li>\n<\/ul>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to allow a <a href=\"tenant-what-is\">Tenant<\/a> to be identified though console commands<\/p>\n<p><strong>Requirements<\/strong><\/p>\n<p>The Tenant <a href=\"tenant-setup\">must be registered in the TenantResolver<\/a><\/p>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Identify a Tenant by a custom field<\/li>\n<li>Identify a Tenant by an ID<\/li>\n<li>And many more!<\/li>\n<\/ul>\n<h2 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h2>\n<p>Uses the console input object to identify a tenant.<\/p>\n<p>In order to allow a tenant to be identified with the Console driver, all\ncommands have gained two new options, <code>--tenant<\/code> and <code>--tenant-identifier<\/code>.<\/p>\n<p>For a tenant to be identified with the Console driver, you\nneed to apply a Contract to the [tenant][tenant-what-is] class and implement the required\nmethods.<\/p>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<div class=\"alert alert-info\"><p>Make sure that the model you are using <a href=\"identification-general\">is registered in the TenantResolver<\/a>.<\/p><\/div>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/identification-driver-console\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Identification\\Drivers\\Console\\Providers\\IdentificationProvider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<p>Tenants that will be identified by console need to implement the <code>Tenancy\\Identification\\Drivers\\Console\\Contracts\\IdentifiesByConsole<\/code> contract.<\/p>\n<p>The <code>tenantIdentificationByConsole<\/code> method should return the tenant that is identified based on the current request.<\/p>\n<h3 id=\"example\"><a href=\"#example\" class=\"anchor-link\"><\/a>Example<\/h3>\n<p>The following example assumes your Customer has a slug column with which we use to identify it.<\/p>\n<pre><code class=\"language-php\">use Illuminate\\Database\\Eloquent\\Model;\nuse Tenancy\\Identification\\Concerns\\AllowsTenantIdentification;\nuse Tenancy\\Identification\\Contracts\\Tenant;\nuse Tenancy\\Identification\\Drivers\\Console\\Contracts\\IdentifiesByConsole;\nuse Symfony\\Component\\Console\\Input\\InputInterface;\n\nclass Customer extends Model implements Tenant, IdentifiesByConsole\n{\n    use AllowsTenantIdentification;\n  \n    \/**\n     * Specify whether the tenant model is matching the request.\n     *\n     * @param Request $request\n     * @return Tenant\n     *\/\n    public function tenantIdentificationByConsole(InputInterface $input): ?Tenant\n    {\n        if ($input-&gt;hasParameterOption('--tenant')) {\n            return $this-&gt;query()\n                -&gt;where('slug', $input-&gt;getParameterOption('--tenant'))\n                -&gt;first();\n        }\n        \n        return null;\n    }\n}\n<\/code><\/pre>\n<h3 id=\"advance-example\"><a href=\"#advance-example\" class=\"anchor-link\"><\/a>Advance Example<\/h3>\n<p>In the following example, we will expand upon the previous example with the assumption that you have multiple Tenant types, that may share the same slug.<\/p>\n<pre><code class=\"language-php\">use Illuminate\\Database\\Eloquent\\Model;\nuse Tenancy\\Identification\\Concerns\\AllowsTenantIdentification;\nuse Tenancy\\Identification\\Contracts\\Tenant;\nuse Tenancy\\Identification\\Drivers\\Console\\Contracts\\IdentifiesByConsole;\nuse Symfony\\Component\\Console\\Input\\InputInterface;\n\nclass Customer extends Model implements Tenant, IdentifiesByConsole\n{\n    use AllowsTenantIdentification;\n  \n    \/**\n     * Specify whether the tenant model is matching the request.\n     *\n     * @param Request $request\n     * @return Tenant|null\n     *\/\n    public function tenantIdentificationByConsole(InputInterface $input): ?Tenant\n    {\n        if ($input-&gt;hasParameterOption('--tenant-identifier')) {\n            if($input-&gt;getParameterOption('--tenant-identifier') != $this-&gt;getTenantIdentifier()) {\n                return null;\n            }\n        }\n        if ($input-&gt;hasParameterOption('--tenant')) {\n            return $this-&gt;query()\n                -&gt;where('slug', $input-&gt;getParameterOption('--tenant'))\n                -&gt;first();\n        }\n        \n        return null;\n    }\n}\n<\/code><\/pre>\n<h2 id=\"usage\"><a href=\"#usage\" class=\"anchor-link\"><\/a>Usage<\/h2>\n<h3 id=\"code-tenantcode\"><a href=\"#code-tenantcode\" class=\"anchor-link\"><\/a><code>--tenant<\/code><\/h3>\n<p>This option allows you to specify a specific Tenant.<\/p>\n<p>In the following example we will assume that you want to list the routes available for a specific tenant.<\/p>\n<p>We will also assume that the tenant in question has the previous example implemented, has the slug of &quot;my-first-tenant&quot;.<\/p>\n<pre><code class=\"language-bash\">php artisan route:list --tenant=my-first-tenant\n<\/code><\/pre>\n<h3 id=\"code-tenant-identifiercode\"><a href=\"#code-tenant-identifiercode\" class=\"anchor-link\"><\/a><code>--tenant-identifier<\/code><\/h3>\n<p>This option allows you to specify a specific Tenant type.<\/p>\n<p>Because Tenants can be multiple classes this option is useful when writing custom commands to do something specific to different types of Tenants, or when different types of tenants could be identified by the same <code>--tenant<\/code> value.<\/p>\n<h4 id=\"custom-command\"><a href=\"#custom-command\" class=\"anchor-link\"><\/a>Custom Command<\/h4>\n<p>In the following example command, we will assume that every tenant has a &quot;maintenance&quot; value to enable or disable it from being redirected to a maintenance page without having to bring down the entire application.<\/p>\n<p>We will also assume that you have two Tenants; User's and Organization's.<\/p>\n<pre><code class=\"language-php\">namespace App\\Console\\Commands;\n\nuse Illuminate\\Console\\Command;\n\nclass TenantMaintenanceCommand extends Command\n{\n    protected $signature = 'tenant:maintenance';\n\n    protected $description = 'Inverts the Maintenance mode for a tenant';\n\n    \/** @var Resolver *\/\n    protected $resolver;\n\n    public function __construct(ResolvesTenants $resolver)\n    {\n        parent::__construct();\n        $this-&gt;resolver = $resolver;\n    }\n\n    public function handle()\n    {\n        $this-&gt;resolver-&gt;getModels()-&gt;each(function (string $class) {\n            $model = (new $class());\n\n            if ($this-&gt;option('tenant-identifier') != $model-&gt;getTenantIdentifier()) {\n                return;\n            }\n\n            $model-&gt;all()-&gt;each(function($tenant) {\n                $tenant-&gt;maintenance = !$tenant-&gt;maintenance;\n                $tenant-&gt;save();\n            })\n\n        });\n    }\n}\n<\/code><\/pre>\n<h4 id=\"usage\"><a href=\"#usage\" class=\"anchor-link\"><\/a>Usage<\/h4>\n<p>In order to run your custom command only for User Tenants you can do the following:<\/p>\n<pre><code class=\"language-bash\">php artisan tenant:maintenance --tenant-identifier=mysql.users\n<\/code><\/pre>\n","updated_at":{"date":"2020-08-13 12:53:46.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/identification-console.md"},{"title":"Environment Identification","icon":"fal fa-leaf","excerpt":"Identifies tenants using the environment\n","tags":["environment","console","driver","artisan"],"path":"docs\/tenancy\/1.x\/identification-environment.md","slug":"identification-environment","package":"tenancy","version":"1.x","contents":"<h1 id=\"tenant-identification-environment\"><a href=\"#tenant-identification-environment\" class=\"anchor-link\"><\/a>Tenant Identification: Environment<\/h1>\n<ul>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#introduction\">Introduction<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<ul>\n<li>\n<a href=\"#example\">Example<\/a>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to allow a <a href=\"tenant-what-is\">Tenant<\/a> to be identified based on the environment<\/p>\n<p><strong>Requirements<\/strong><\/p>\n<p>The Tenant <a href=\"tenant-setup\">must be registered in the TenantResolver<\/a><\/p>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Identify a Tenant by which environment the application is running in<\/li>\n<li>Ensure a specific tenant is loaded in a demonstration environment<\/li>\n<li>And many more!<\/li>\n<\/ul>\n<h2 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h2>\n<p>This package allows the identification of a tenant based on the environment.<\/p>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/identification-driver-environment\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Identification\\Drivers\\Environment\\Providers\\IdentificationProvider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<p>This allows you to set up your own identification requirements based on environment variables, eg:<\/p>\n<ul>\n<li>Slug, custom generated, human readable string.<\/li>\n<li>Id, the database auto increment id.<\/li>\n<\/ul>\n<h3 id=\"example\"><a href=\"#example\" class=\"anchor-link\"><\/a>Example<\/h3>\n<pre><code class=\"language-php\">use Illuminate\\Database\\Eloquent\\Model;\nuse Tenancy\\Identification\\Concerns\\AllowsTenantIdentification;\nuse Tenancy\\Identification\\Contracts\\Tenant;\nuse Tenancy\\Identification\\Drivers\\Environment\\Contracts\\IdentifiesByEnvironment;\n\nclass Customer extends Model implements Tenant, IdentifiesByEnvironment\n{\n  use AllowsTenantIdentification;\n  \n    \/**\n     * Specify whether the tenant model is matching the request.\n     *\n     * @return Tenant\n     *\/\n    public function tenantIdentificationByEnvironment(): ?Tenant\n    {\n        if ($tenant = env('TENANT')) {\n            return $this-&gt;query()\n                -&gt;where('slug', $tenant)\n                -&gt;first();\n        }\n        \n        return null;\n    }\n}\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Be warned that using the <code>env()<\/code> helper will not work when the config is cached by Laravel.<\/p><\/div>\n","updated_at":{"date":"2020-08-13 12:53:46.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/identification-environment.md"}]},{"name":"affects","links":["affects-general","affects-broadcasts","affects-cache","affects-configs","affects-connections","affects-filesystems","affects-logs","affects-mails","affects-models","affects-routes","affects-urls","affects-views"],"slug":"affects","articles":[{"title":"About affects","icon":"fal fa-reply-all","excerpt":"How tenancy modifies your Laravel app.\n","tags":["affects","tenant"],"path":"docs\/tenancy\/1.x\/affects-general.md","slug":"affects-general","package":"tenancy","version":"1.x","contents":"<h1 id=\"affects\"><a href=\"#affects\" class=\"anchor-link\"><\/a>Affects<\/h1>\n<ul>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#Process\">Process<\/a>\n<\/li>\n<\/ul>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p>Affects change the behaviour of your Laravel application by integrating closely with the\nframework. You can modify routes, views and much more by using an affect or creating\nyour own!<\/p>\n<p>Affects are an important component to the workings of tenancy. Each affect influences your\nLaravel app, but enabling them isn't enough for most of them. Affects fire events, which allow\nyou to hook into. This makes it incredibly easy to implement your own specific modifications\nwithout the hard work of hooking into the Laravel ecosystem or knowing the inner workings of\nthe tenancy framework.<\/p>\n<h2 id=\"process\"><a href=\"#process\" class=\"anchor-link\"><\/a>Process<\/h2>\n<p>The easiest way to listen to the events and influence the affects to do your bidding, is by\ncreating a listener in the EventServiceProvider. Let's take the <a href=\"affects-routes\">Routes Affects<\/a>\nas an example.<\/p>\n<p>First, create a listener.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Affects\\Routes\\Events\\ConfigureRoutes;\n\nclass TenantRoutes \n{\n    public function handle(ConfigureRoutes $event) \n    {\n        $event\n            -&gt;flush()\n            -&gt;fromFile(\n                ['middleware' =&gt; ['web']],\n                base_path('\/routes\/tenant.php')\n            );\n    }\n}\n<\/code><\/pre>\n<p>Now register that listener in your EventServiceProvider for instance.<\/p>\n<pre><code class=\"language-php\">namespace App\\Providers;\n\nuse App\\Listeners\\TenantRoutes;\nuse Illuminate\\Auth\\Events\\Registered;\nuse Illuminate\\Auth\\Listeners\\SendEmailVerificationNotification;\nuse Illuminate\\Foundation\\Support\\Providers\\EventServiceProvider as ServiceProvider;\nuse Tenancy\\Affects\\Routes\\Events\\ConfigureRoutes;\n\nclass EventServiceProvider extends ServiceProvider\n{\n    protected $listen = [\n        Registered::class =&gt; [\n            SendEmailVerificationNotification::class,\n        ],\n        \n        ConfigureRoutes::class =&gt; [\n            TenantRoutes::class,\n        ]\n    ];\n    \/\/ ..\n}\n\n<\/code><\/pre>\n<p>That's it, from now on whenever a tenant is identified or switched to, the routes\ncontained in <code>routes\/tenant.php<\/code> are activated.<\/p>\n","updated_at":{"date":"2021-08-24 03:42:30.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/affects-general.md"},{"title":"Broadcasts","icon":"fal fa-wifi","excerpt":"Makes the broadcasts adapt to your tenant identification.\n","tags":["affects","tenant","broadcasts"],"path":"docs\/tenancy\/1.x\/affects-broadcasts.md","slug":"affects-broadcasts","package":"tenancy","version":"1.x","contents":"<h1 id=\"affects-broadcasts\"><a href=\"#affects-broadcasts\" class=\"anchor-link\"><\/a>Affects-Broadcasts<\/h1>\n<ol>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<ol>\n<li>\n<a href=\"#example\">Example<\/a>\n<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to allow the use of different broadcast drivers and settings based on the tenant.<\/p>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Use a tenant chosen broadcast driver.<\/li>\n<li>Use different Redis servers per tenant for broadcasts.<\/li>\n<\/ul>\n<p><strong>Events &amp; Methods<\/strong><\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Broadcasts\\Events\\ConfigureBroadcast<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/affects-broadcasts\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Broadcasts\\Provider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<p>Once you've installed the package, all you have to do is configure the package. You can configure this package by listening to the <code>Tenancy\\Affects\\Broadcasts\\Events\\ConfigureBroadcasts<\/code> event. Once you're listening to the event, you can start configuring your <code>tenant<\/code> broadcast driver with the provided <code>$config<\/code> array.<\/p>\n<h3 id=\"example\"><a href=\"#example\" class=\"anchor-link\"><\/a>Example<\/h3>\n<p>In the below example, we will create a pusher driver for the tenant broadcast driver.<\/p>\n<div class=\"alert alert-info\"><p>We assume that you have the pusher information on the tenant model.<\/p><\/div>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Affects\\Broadcasts\\Events\\ConfigureBroadcasts;\n\nclass ConfigureTenantBroadcast\n{\n    public function handle(ConfigureBroadcasts $event)\n    {\n        $event-&gt;config = [\n            'driver' =&gt; 'pusher',\n            'key' =&gt; $event-&gt;event-&gt;tenant-&gt;pusher_key,\n            'secret' =&gt; $event-&gt;event-&gt;tenant-&gt;pusher_secret,\n            'app_id' =&gt; $event-&gt;event-&gt;tenant-&gt;pusher_app_id,\n            'options' =&gt; [\n                'cluster' =&gt; $event-&gt;event-&gt;tenant-&gt;pusher_cluster,\n                'useTLS' =&gt; true,\n            ],\n        ];\n    }\n}\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-29 17:56:08.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/affects-broadcasts.md"},{"title":"Cache","icon":"fal fa-inventory","excerpt":"Makes the cache adapt to your tenant identification.\n","tags":["affects","tenant","cache"],"path":"docs\/tenancy\/1.x\/affects-cache.md","slug":"affects-cache","package":"tenancy","version":"1.x","contents":"<h1 id=\"affects-cache\"><a href=\"#affects-cache\" class=\"anchor-link\"><\/a>Affects-Cache<\/h1>\n<ol>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<ol>\n<li>\n<a href=\"#example\">Example<\/a>\n<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to allow the use of different cache drivers and settings based on the tenant.<\/p>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Store cache information in different locations per tenant<\/li>\n<li>Store cache files for each tenant on their own database.<\/li>\n<\/ul>\n<p><strong>Events &amp; Methods<\/strong><\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Cache\\Events\\ConfigureCache<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/affects-cache\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Cache\\Provider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<p>Configuration of the package is really easy. You can listen to the <code>Tenancy\\Affects\\Cache\\Events\\ConfigureCache<\/code> event to start configuring. Configuration can then be done by simply changing the config that will automatically be considered the <code>tenant<\/code> cache driver.<\/p>\n<h3 id=\"example\"><a href=\"#example\" class=\"anchor-link\"><\/a>Example<\/h3>\n<p>In the below example, we will add a <code>tenant<\/code> cache driver that uses the <code>tenant<\/code> database connection.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Affects\\Cache\\Events\\ConfigureCache;\n\nclass ConfigureTenantCache\n{\n    public function handle(ConfigureCache $event)\n    {\n        $event-&gt;config = [\n            'driver' =&gt; 'database',\n            'table' =&gt; 'cache',\n            'connection' =&gt; 'tenant'\n        ];\n    }\n}\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-29 17:56:08.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/affects-cache.md"},{"title":"Configs","icon":"fal fa-sliders-v","excerpt":"How you can easily affect the configs in your Laravel application.\n","tags":["affects","tenant","configs"],"path":"docs\/tenancy\/1.x\/affects-configs.md","slug":"affects-configs","package":"tenancy","version":"1.x","contents":"<h1 id=\"affects-config\"><a href=\"#affects-config\" class=\"anchor-link\"><\/a>Affects-Config<\/h1>\n<ol>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<ol>\n<li>\n<a href=\"#example\">Example<\/a>\n<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to allow the use change the configuration for different integrations or packages based on the current tenant.<\/p>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Use a tenant's API credentials for a 3rd party service<\/li>\n<\/ul>\n<p><strong>Events &amp; Methods<\/strong><\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Configs\\Events\\ConfigureConfig<\/code>\n<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>All the calls you do to the event, will be forwarded to the <code>Repository<\/code> (the class that holds all the configs).<\/p><\/div>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/affects-configs\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Configs\\Provider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<p>After the installation, it's all about configuring. Like other affects, you can listen to an event <code>Tenancy\\Affects\\Configs\\Events\\ConfigureConfig<\/code>. When you're listening to the event, you can get to work right away.<\/p>\n<h3 id=\"example\"><a href=\"#example\" class=\"anchor-link\"><\/a>Example<\/h3>\n<p>In the below example, we'll take the integration key from the tenant and set it in our configuration so the integration can use it.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Affects\\Configs\\Events\\ConfigureConfig;\n\nclass ConfigureTenantIntegrations\n{\n    public function handle(ConfigureConfig $event)\n    {\n        if($tenant = $event-&gt;event-&gt;tenant)\n        {\n            $event-&gt;set('integrations.integration.key', $tenant-&gt;integration_key);\n        }\n    }\n}\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-29 17:56:08.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/affects-configs.md"},{"title":"Connections","icon":"fal fa-network-wired","excerpt":"Makes the database connections adapt to your tenant identification.\n","tags":["affects","tenant","connections"],"path":"docs\/tenancy\/1.x\/affects-connections.md","slug":"affects-connections","package":"tenancy","version":"1.x","contents":"<h1 id=\"affects-connections\"><a href=\"#affects-connections\" class=\"anchor-link\"><\/a>Affects-Connections<\/h1>\n<ol>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#requirements\">Requirements<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<ol>\n<li>\n<a href=\"#resolving-the-configuration\">Resolving the Connection Configuration<\/a>\n<ol>\n<li>\n<a href=\"#resolving-example\">Example<\/a>\n<\/li>\n<\/ol>\n<\/li>\n<li>\n<a href=\"#configuring-the-connection\">Configuring the Connection<\/a>\n<ol>\n<li>\n<a href=\"#configuring-example\">Example<\/a>\n<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<\/li>\n<li>\n<a href=\"#using-the-connection\">Using the Connection<\/a>\n<ol>\n<li>\n<a href=\"#trait-example\">Tenancy's Trait Example<\/a>\n<\/li>\n<li>\n<a href=\"#tenancy-facade-example\">Tenancy Facade Example<\/a>\n<\/li>\n<li>\n<a href=\"#laravel-db-facade-example\">Laravel DB Facade Example<\/a>\n<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to allow the access of Tenant data from a different data sources.<\/p>\n<p><strong>Recommendations<\/strong><\/p>\n<p>To automate the management of separate databases for each tenant install the <a href=\"hooks-database\"><code>hooks-database<\/code><\/a> package.<\/p>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Tenant Data is stored in different Databases<\/li>\n<li>Tenant Data is stored on different Servers<\/li>\n<li>Tenant Data is stored in different Clusters<\/li>\n<li>and Many More!<\/li>\n<\/ul>\n<p><strong>Events &amp; Methods<\/strong><\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Connections\\Events\\Resolving<\/code>\n<\/li>\n<li>\n<code>Tenancy\\Affects\\Connections\\Events\\Drivers\\Configuring<\/code>\n<ul>\n<li>\n<code>defaults<\/code>\n<\/li>\n<li>\n<code>useConfig<\/code>\n<\/li>\n<li>\n<code>useConnection<\/code>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/affects-connections\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Connections\\Provider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<p>This package has quite a complex setup, but it's really worth it in the end.<\/p>\n<h3 id=\"resolving-the-configuration\"><a href=\"#resolving-the-configuration\" class=\"anchor-link\"><\/a>Resolving the configuration<\/h3>\n<p>We will start with the <code>Tenancy\\Affects\\Connections\\Events\\Resolving<\/code> event. This event allows you to provide an instance which will be used to Provide a configuration. You can do this by listening to the event and <strong>returning<\/strong> an instance that will provide the configuration for the upcoming connection request.<\/p>\n<h4 id=\"resolving-example\"><a href=\"#resolving-example\" class=\"anchor-link\"><\/a>Resolving Example<\/h4>\n<p>In the below example we will return the instance itself as the class responsible for providing a connection configuration.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Identification\\Contracts\\Tenant;\nuse Tenancy\\Affects\\Connections\\Contracts\\ProvidesConfiguration;\nuse Tenancy\\Affects\\Connections\\Events\\Resolving;\nuse Tenancy\\Affects\\Connections\\Events\\Drivers\\Configuring;\n\nclass ResolveTenantConnection implements ProvidesConfiguration\n{\n    public function handle(Resolving $event)\n    {\n        return $this;\n    }\n\n    public function configure(Tenant $tenant): array\n    {\n        $config = [];\n\n        event(new Configuring($tenant, $config, $this));\n\n        return $config;\n    }\n}\n<\/code><\/pre>\n<h3 id=\"configuring-the-connection\"><a href=\"#configuring-the-connection\" class=\"anchor-link\"><\/a>Configuring the Connection<\/h3>\n<p>When the connection is resolved, we'll get to the configuring of the connection. In the example above we fire the <code>Configuring<\/code> event that is in the Tenancy package. We will now use that event to configure the connection. This event provides you with some functions in order to setup the database connection you want.<\/p>\n<ul>\n<li>\n<code>useConnection()<\/code>, this function allows you to use one of the connections that you have defined in the <code>config\/database.php<\/code> of your Laravel application. It uses the name of the connection to identify which connection you're trying to use.<\/li>\n<li>\n<code>useConfig()<\/code>, this function allows you to use a file in any path to provide an array as a configuration.<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>All the above functions allow you to provide an <code>override<\/code> which will be merged in the provided configuration.<\/p><\/div>\n<ul>\n<li>\n<code>defaults()<\/code>, this will return an array that uses Tenancy's internal code to figure out the following:\n<ul>\n<li>Database Name, which is the tenant key<\/li>\n<li>Database User, which is the tenant key<\/li>\n<li>Database User Password, which is generated based on the <code>PasswordGenerator<\/code> that is in <code>tenancy\/framework<\/code>.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h4 id=\"configuring-example\"><a href=\"#configuring-example\" class=\"anchor-link\"><\/a>Configuring Example<\/h4>\n<p>In the following example we will use the MySQL connection that is inside the <code>config\/database.php<\/code> and combine it with the configuration that tenancy provides.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Affects\\Connections\\Events\\Drivers\\Configuring;\n\nclass ConfigureTenantConnection\n{\n    public function handle(Configuring $event)\n    {\n        $event-&gt;useConnection('mysql', $event-&gt;defaults($event-&gt;tenant));\n    }\n}\n<\/code><\/pre>\n<h2 id=\"using-the-connection\"><a href=\"#using-the-connection\" class=\"anchor-link\"><\/a>Using the connection<\/h2>\n<p>After you've completely configured the connection, you can finally use and all of it's powers. The package creates a new connection named <code>tenant<\/code> which can be used as well as a simple trait to ensure Models use the Tenant's Database.<\/p>\n<h3 id=\"trait-example\"><a href=\"#trait-example\" class=\"anchor-link\"><\/a>Trait Example<\/h3>\n<p>The <code>OnTenant<\/code> trait (<code>Tenancy\\Affects\\Connections\\Support\\Traits\\OnTenant<\/code>) allows you to put models on the Tenant connection. You can see how to use it in the example below.<\/p>\n<pre><code class=\"language-php\">use Illuminate\\Database\\Eloquent\\Model;\nuse Tenancy\\Affects\\Connections\\Support\\Traits\\OnTenant;\n\nclass Role extends Model\n{\n    use OnTenant;\n}\n<\/code><\/pre>\n<h3 id=\"tenancy-facade-example\"><a href=\"#tenancy-facade-example\" class=\"anchor-link\"><\/a>Tenancy Facade Example<\/h3>\n<p>Using the <code>Tenancy<\/code> (<code>Tenancy\\Facades\\Tenancy<\/code>) Facade, we can also retrieve the connection of the identified tenant as seen in the example below.<\/p>\n<pre><code class=\"language-php\">Tenancy::getTenantConnection()-&gt;select(...);\n<\/code><\/pre>\n<h3 id=\"laravel-db-facade-example\"><a href=\"#laravel-db-facade-example\" class=\"anchor-link\"><\/a>Laravel DB Facade Example<\/h3>\n<p>If you are using Laravel's <code>DB<\/code> Facade, you are able to access the tenant connection as seen in the example below.<\/p>\n<pre><code class=\"language-php\">DB::connection(Tenancy::getTenantConnectionName())-&gt;select(...);\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Note: This is not a recommended Method.<\/p><\/div>\n","updated_at":{"date":"2020-08-07 02:24:19.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/affects-connections.md"},{"title":"Filesystems","icon":"fal fa-hdd","excerpt":"Makes the filesystems adapt to your tenant identification.\n","tags":["affects","tenant","filesystems"],"path":"docs\/tenancy\/1.x\/affects-filesystems.md","slug":"affects-filesystems","package":"tenancy","version":"1.x","contents":"<h1 id=\"affects-filesystems\"><a href=\"#affects-filesystems\" class=\"anchor-link\"><\/a>Affects-Filesystems<\/h1>\n<ol>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<ol>\n<li>\n<a href=\"#example\">Example<\/a>\n<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to allow the separation of tenant files, directories or even storage servers.<\/p>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Store Tenant files in different S3 Buckets<\/li>\n<li>Store Tenant files using different storage providers<\/li>\n<\/ul>\n<p><strong>Events &amp; Methods<\/strong><\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Filesystems\\Events\\ConfigureDisk<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/affects-filesystems\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Filesystems\\Provider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<p>When you're configuring this package, you will have to listen to the <code>Tenancy\\Affects\\Filesystems\\Events\\ConfigureDisk<\/code> event. This event will allow you to change the configuration for a <code>tenant<\/code> disk, simply by changing the config that is provided.<\/p>\n<h3 id=\"example\"><a href=\"#example\" class=\"anchor-link\"><\/a>Example<\/h3>\n<p>In this example we will register the <code>tenant<\/code> disk driver as a local driver with a folder in the <code>storage\/app\/<\/code> folder.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Affects\\Filesystems\\Events\\ConfigureDisk;\n\nclass ConfigureTenantDisk\n{\n    public function handle(ConfigureDisk $event)\n    {\n        $event-&gt;config = [\n            'driver' =&gt; 'local',\n            'root' =&gt; storage_path('app\/' . $event-&gt;event-&gt;tenant-&gt;getTenantKey()),\n        ];\n    }\n}\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-29 17:56:08.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/affects-filesystems.md"},{"title":"Logs","icon":"fal fa-book","excerpt":"Makes the logs adapt to your tenant identification.\n","tags":["affects","tenant","logs"],"path":"docs\/tenancy\/1.x\/affects-logs.md","slug":"affects-logs","package":"tenancy","version":"1.x","contents":"<h1 id=\"affects-logs\"><a href=\"#affects-logs\" class=\"anchor-link\"><\/a>Affects-Logs<\/h1>\n<ol>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<ol>\n<li>\n<a href=\"#example\">Example<\/a>\n<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to allow the logging of errors into a separate file, location, or service for each tenant.<\/p>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Resolve specific tenant issues without going though logs for every tenant<\/li>\n<li>Find common problems across multiple tenants<\/li>\n<li>Log errors in different locations<\/li>\n<\/ul>\n<p><strong>Events &amp; Methods<\/strong><\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Logs\\Events\\ConfigureLogs<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/affects-logs\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Logs\\Provider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<p>Configuration of this package is fairly easy, you can listen to the <code>Tenancy\\Affects\\Logs\\Events\\ConfigureLogs<\/code> event and provide a log configuration for your tenant driver.<\/p>\n<h3 id=\"example\"><a href=\"#example\" class=\"anchor-link\"><\/a>Example<\/h3>\n<p>In the below example we will configure a <code>tenant<\/code> log driver which will log the errors to a slack channel configure on the tenant.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Affects\\Logs\\Events\\ConfigureLogs;\n\nclass ConfigureTenantLogs\n{\n    public function handle(ConfigureLogs $event)\n    {\n        $event-&gt;config = [\n            'driver' =&gt; 'slack',\n            'url' =&gt; $event-&gt;event-&gt;tenant-&gt;slack_webhook_url,\n            'username' =&gt; 'Tenant Logs',\n            'emoji' =&gt; ':boom:',\n            'level' =&gt; 'critical',\n        ];\n    }\n}\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-29 17:56:08.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/affects-logs.md"},{"title":"Mails","icon":"fal fa-envelope","excerpt":"How you can easily affect the mails in your Laravel application.\n","tags":["affects","tenant","mails"],"path":"docs\/tenancy\/1.x\/affects-mails.md","slug":"affects-mails","package":"tenancy","version":"1.x","contents":"<h1 id=\"affects-mails\"><a href=\"#affects-mails\" class=\"anchor-link\"><\/a>Affects-Mails<\/h1>\n<ol>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<ol>\n<li>\n<a href=\"#example\">Example<\/a>\n<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to allow the sending of emails though a tenant's email address.<\/p>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Send emails from a tenant's email server<\/li>\n<li>Send emails from different providers<\/li>\n<\/ul>\n<p><strong>Events &amp; Methods<\/strong><\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Mails\\Events\\ConfigureMails<\/code>\n<ul>\n<li>\n<code>replaceSwiftMailer<\/code>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>All other calls you do to the event, will be forwarded to the <code>Mailer<\/code>.<\/p><\/div>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/affects-mails\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Mails\\Provider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<p>After the installation of the package, all you have to do is configure the package in the way you want. Like most affects, this package will fire an event <code>Tenancy\\Affects\\Mails\\Events\\ConfigureMails<\/code>, which will provide you with some functionality to change or update the <code>Swift_Mailer<\/code> used:<\/p>\n<ul>\n<li>\n<code>replaceSwiftMailer()<\/code>, this will change the default mailer to the one provided.<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>All the calls you do to the event, will be forwarded to the <code>Mailer<\/code>.<\/p><\/div>\n<h3 id=\"example\"><a href=\"#example\" class=\"anchor-link\"><\/a>Example<\/h3>\n<p>In the following example we will change the 'from' address on the emails that are sent.\nWe will assume that every tenant has two additional fields called <code>email_from<\/code> and <code>email_name<\/code> to store what email and display name should be used for outgoing email.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Affects\\Mails\\Events\\ConfigureMails;\n\nclass ConfigureTenantMails\n{\n    public function handle(ConfigureMails $event)\n    {\n        if($tenant = $event-&gt;event-&gt;tenant)\n        {\n            \/\/ Set the &quot;From&quot; Field\n            $event-&gt;alwaysFrom($tenant-&gt;email_from, $tenant-&gt;email_name);\n            \n            \/\/ Optionally add the &quot;ReplyTo&quot; Field\n            $event-&gt;alwaysReplyTo($tenant-&gt;mail_replyto, $tenant-&gt;mail_replyto_name);\n        }\n    }\n}\n<\/code><\/pre>\n","updated_at":{"date":"2021-11-19 17:46:58.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/affects-mails.md"},{"title":"Models","icon":"fal fa-hand-holding-box","excerpt":"How you can easily affect the models in your Laravel application.\n","tags":["affects","tenant","models"],"path":"docs\/tenancy\/1.x\/affects-models.md","slug":"affects-models","package":"tenancy","version":"1.x","contents":"<h1 id=\"affects-models\"><a href=\"#affects-models\" class=\"anchor-link\"><\/a>Affects-Models<\/h1>\n<ol>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<ol>\n<li>\n<a href=\"#example\">Example<\/a>\n<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to allow the modification of models provided by other packages.<\/p>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Change the connection used by a third-party package to use the tenant's database connection.<\/li>\n<\/ul>\n<p><strong>Events &amp; Methods<\/strong><\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Models\\Events\\ConfigureModels<\/code>\n<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>All the method calls will be forwarded to the model in a nice and simple way<\/p><\/div>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/affects-models\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Models\\Provider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<p>After the installation, it's time for configuring. A lot of the setup for this package is the same as the other affects, but this one is a bit more flexible. It will fire the <code>Tenancy\\Affects\\Models\\Events\\ConfigureModels<\/code> event, which will forward all the method calls to the models in a nice and simple way.<\/p>\n<p>You can do this by using the following functions:<\/p>\n<ul>\n<li>\n<code>$event-&gt;functionName($models, $parameter1, $parameter2, $parameterx ...)<\/code>, this will perform the function as normal functions on the models.<\/li>\n<li>\n<code>ConfigureModels::functionName($models, $paramater1, $parameter2, $parameterx ...)<\/code>, this will perform the functions as static functions on the models.<\/li>\n<\/ul>\n<h3 id=\"example\"><a href=\"#example\" class=\"anchor-link\"><\/a>Example<\/h3>\n<p>In the below example, we'll change the <code>Connection<\/code> of the Models, so they will use the tenant's database connection<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Vendor\\Package\\Models\\Permission;\nuse Tenancy\\Affects\\Models\\Events\\ConfigureModels;\nuse Tenancy\\Facades\\Tenancy;\n\nclass ConfigureTenantModels\n{\n    protected $model = Permission::class;\n\n    public function handle(ConfigureModels $event)\n    {\n        if($event-&gt;event-&gt;tenant)\n        {\n            $event-&gt;setConnection(\n                $this-&gt;model,\n                Tenancy::getTenantConnectionName()\n            );\n        }\n    }\n}\n<\/code><\/pre>\n","updated_at":{"date":"2021-02-22 22:10:55.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/affects-models.md"},{"title":"Routes","icon":"fal fa-road","excerpt":"How you can easily affect the routes in your Laravel application.\n","tags":["affects","tenant","routes"],"path":"docs\/tenancy\/1.x\/affects-routes.md","slug":"affects-routes","package":"tenancy","version":"1.x","contents":"<h1 id=\"affects-routes\"><a href=\"#affects-routes\" class=\"anchor-link\"><\/a>Affects-Routes<\/h1>\n<ol>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<ol>\n<li>\n<a href=\"#example\">Example<\/a>\n<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to modify the routes that are loaded once a Tenant is identified.<\/p>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Clear system only routes<\/li>\n<li>Load tenant-specific routes<\/li>\n<\/ul>\n<p><strong>Events &amp; Methods<\/strong><\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Routes\\Events\\ConfigureRoutes<\/code>\n<ul>\n<li>\n<code>flush<\/code>\n<\/li>\n<li>\n<code>fromFile<\/code>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h2>\n<p>In order to keep your application clean, you might want to separate the routes for tenants into different files.<\/p>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/affects-routes \n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Routes\\Provider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<p>After the installation of the package, all you have to do is configure the package in the way you want. Like most affects, this package will fire an event <code>Tenancy\\Affects\\Routes\\Events\\ConfigureRoutes<\/code>, which will provide you with some functionality to load and configure your routes:<\/p>\n<ul>\n<li>\n<code>flush()<\/code>, this will remove all currently loaded routes.<\/li>\n<li>\n<code>fromFile()<\/code>, this will allow you to load routes from a specific file.<\/li>\n<\/ul>\n<h3 id=\"example\"><a href=\"#example\" class=\"anchor-link\"><\/a>Example<\/h3>\n<p>In the example we will register the routes for a Tenant if one is identified.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Affects\\Routes\\Events\\ConfigureRoutes;\n\nclass TenantRoutes \n{\n    public function handle(ConfigureRoutes $event) \n    {\n        if($event-&gt;event-&gt;tenant)\n        {\n            $event\n                -&gt;flush()\n                -&gt;fromFile(\n                    ['middleware' =&gt; ['web']],\n                    base_path('\/routes\/tenant.php')\n                );\n        }\n    }\n}\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Note: This example does not set a namespace for your routes. If you're following the default laravel convention you might want to specify a namespace. Alternative is to use tuple notation.<\/p><\/div>\n","updated_at":{"date":"2020-07-29 17:56:08.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/affects-routes.md"},{"title":"URLs","icon":"fal fa-link","excerpt":"How you can easily affect the urls in your Laravel application.\n","tags":["affects","tenant","url"],"path":"docs\/tenancy\/1.x\/affects-urls.md","slug":"affects-urls","package":"tenancy","version":"1.x","contents":"<h1 id=\"affects-urls\"><a href=\"#affects-urls\" class=\"anchor-link\"><\/a>Affects-URLs<\/h1>\n<ol>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<ol>\n<li>\n<a href=\"#example\">Example<\/a>\n<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to modify domain being used when generating URL's.<\/p>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Tenants access the application using a custom domain<\/li>\n<li>Tenants receive custom subdomains to access the application<\/li>\n<\/ul>\n<p><strong>Events &amp; Methods<\/strong><\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\URLs\\Events\\ConfigureURL<\/code>\n<ul>\n<li>\n<code>changeRoot<\/code>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/affects-urls\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\URLs\\Provider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<p>Once you've installed the package, there's only some small configuring to do. You can do this by listening to the <code>Tenancy\\Affects\\URLs\\Events\\ConfigureURL<\/code> event. This event provides you with some additional classes and functionality you can use.<\/p>\n<ul>\n<li>\n<code>changeRoot()<\/code>, allows you to change the root url of the application.<\/li>\n<\/ul>\n<h3 id=\"example\"><a href=\"#example\" class=\"anchor-link\"><\/a>Example<\/h3>\n<p>In the below example, we'll change the URL to the tenant's name suffixed with <code>.test<\/code>.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Affects\\URLs\\Events\\ConfigureURL;\n\nclass ConfigureApplicationUrl\n{\n    public function handle(ConfigureURL $event)\n    {\n        if($tenant = $event-&gt;event-&gt;tenant)\n        {\n            $event-&gt;changeRoot($tenant-&gt;name . '.test');\n        }\n    }\n}\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-29 17:56:08.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/affects-urls.md"},{"title":"Views","icon":"fal fa-file-alt","excerpt":"How you can easily affect the views in your Laravel application.\n","tags":["affects","tenant","views"],"path":"docs\/tenancy\/1.x\/affects-views.md","slug":"affects-views","package":"tenancy","version":"1.x","contents":"<h1 id=\"affects-views\"><a href=\"#affects-views\" class=\"anchor-link\"><\/a>Affects-Views<\/h1>\n<ol>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<ol>\n<li>\n<a href=\"#example\">Example<\/a>\n<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to allow the use of custom views overriding or in addition to existing system views.<\/p>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>Tenants require additional views customized for them<\/li>\n<li>Some tenants have additional feature sets that require additional views<\/li>\n<\/ul>\n<p><strong>Events &amp; Methods<\/strong><\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Views\\Events\\ConfigureViews<\/code>\n<ul>\n<li>\n<code>addNamespace<\/code>\n<\/li>\n<li>\n<code>addPath<\/code>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h2 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h2>\n<p>Tenants might need different sites \/ views in your application. If you ever need such a thing, you can use <code>affects-views<\/code>. It will allow you to load and\/or override views in our application really easily.<\/p>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/affects-views\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Affects\\Views\\Provider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<p>Once you've installed the package, all you have to do is configure it. The package will fire a <code>Tenancy\\Affects\\Views\\Events\\ConfigureViews<\/code> event to configure all the views for a specific tenant. The event will come with some basic functionality:<\/p>\n<ul>\n<li>\n<code>addNamespace()<\/code>, this will allow you to load a specific path of views in a specific namespace.<\/li>\n<li>\n<code>addPath()<\/code>, this will allow you to load a specific path of views into the specific namespace.<\/li>\n<\/ul>\n<h3 id=\"example\"><a href=\"#example\" class=\"anchor-link\"><\/a>Example<\/h3>\n<p>In this example we'll load the tenant routes once a tenant is identified from the <code>resources\/views\/tenant<\/code> folder.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nclass ConfigureTenantViews\n{\n    public function handle(ConfigureViews $event)\n    {\n        if($event-&gt;event-&gt;tenant)\n        {\n            $event-&gt;addPath(resource_path('views\/tenant'));\n        }\n    }\n}\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-29 17:56:08.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/affects-views.md"}]},{"name":"database","links":["database-drivers","database-mysql","database-sqlite"],"slug":"database","articles":[{"title":"Database drivers","icon":"fal fa-warehouse-alt","excerpt":"The database drivers able to service the data required by your application.\n","tags":["database","tenant","driver"],"path":"docs\/tenancy\/1.x\/database-drivers.md","slug":"database-drivers","package":"tenancy","version":"1.x","contents":"<h1 id=\"database-drivers\"><a href=\"#database-drivers\" class=\"anchor-link\"><\/a>Database Drivers<\/h1>\n<p>A Database Driver is responsible for the actual management (Creation, Updating, Deletion) of the Tenant's database and\/or database user. Most of the Database Drivers will run specific &quot;elevated permissions&quot; queries in order to provide a database and\/or a database user.<\/p>\n<p>The principles of the Database Drivers are quite simple. The <code>DatabaseResolver<\/code> will fire a simple set of events that allow the database drivers to hook into. They will provide a class that implements <code>ProvidesDatabase<\/code>.<\/p>\n<p>Yes, you can install multiple database drivers, thus allowing you to use a different connection per <a href=\"tenant-what-is\">tenant<\/a> based on your requirements.<\/p>\n<h2 id=\"available-drivers\"><a href=\"#available-drivers\" class=\"anchor-link\"><\/a>Available Drivers<\/h2>\n<p>There are some Database Drivers that are maintained by the Tenancy organization, some might also be maintained by our Community.<\/p>\n<p>Each Database Driver will have their own installation guide.<\/p>\n<h3 id=\"first-party-drivers\"><a href=\"#first-party-drivers\" class=\"anchor-link\"><\/a>First Party Drivers<\/h3>\n<ul>\n<li>\n<a href=\"database-mysql\">MySQL<\/a>\n<\/li>\n<li>\n<a href=\"database-sqlite\">SQLite<\/a>\n<\/li>\n<\/ul>\n","updated_at":{"date":"2020-08-13 12:53:46.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/database-drivers.md"},{"title":"Database driver MySQL","icon":"fal fa-warehouse-alt","excerpt":"Maintains the tenant MySQL database.\n","tags":["database","tenant","driver","mysql"],"path":"docs\/tenancy\/1.x\/database-mysql.md","slug":"database-mysql","package":"tenancy","version":"1.x","contents":"<h1 id=\"database-driver-mysql\"><a href=\"#database-driver-mysql\" class=\"anchor-link\"><\/a>Database Driver: MySQL<\/h1>\n<ol>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#requirements\">Requirements<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<\/li>\n<\/ol>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to enable the management (Creation, Updating, Deletion) of Tenant MySQL Databases and MySQL Users.<\/p>\n<p><strong>Requirements<\/strong><\/p>\n<ul>\n<li>MySQL server with a version &gt;= <code>5.7.6<\/code>\n<\/li>\n<li>When using the <a href=\"hooks-database\"><code>hooks-database<\/code><\/a> package the MySQL user defined in <code>database.php<\/code> must have the ability to create users, databases, and grant privileges.<\/li>\n<li>This package also requires the installation and configuration of the <a href=\"affects-connections\"><code>affects-connections<\/code><\/a> package.\n(<em>Note:<\/em> This package is not required for the use of the <a href=\"affects-connections\"><code>affects-connections<\/code><\/a> package)<\/li>\n<\/ul>\n<p><strong>Recommendations<\/strong><\/p>\n<ul>\n<li>To automate the management of Tenant Databases when a Tenant is created, updated, or deleted; The <a href=\"hooks-database\"><code>hooks-database<\/code><\/a> package should also be installed.<\/li>\n<\/ul>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>A Tenant's information needs to be stored in a separate database from other Tenants.<\/li>\n<li>and Many More!<\/li>\n<\/ul>\n<h2 id=\"requirements\"><a href=\"#requirements\" class=\"anchor-link\"><\/a>Requirements<\/h2>\n<ul>\n<li>\n<p>Because this package uses the MySQL command <code>IF NOT EXISTS<\/code> is used which is only supported in versions &gt;= <code>5.7.6<\/code><\/p>\n<\/li>\n<li>\n<p>Because this package runs specific &quot;elevated permissions&quot; queries in order to provide a database and a database user, the user defined in <code>database.php<\/code> needs to have the ability to create users, databases, and grant privileges.<\/p>\n<p>The following is a sample query to create a user with those privileges.<\/p>\n<\/li>\n<\/ul>\n<pre><code class=\"language-mysql\">CREATE DATABASE IF NOT EXISTS tenancy;\nCREATE USER IF NOT EXISTS tenancy@localhost IDENTIFIED BY 'someRandomPassword';\nGRANT ALL PRIVILEGES ON *.* TO tenancy@localhost WITH GRANT OPTION;\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p><strong>Note:<\/strong> The above command is simply an example. It will grant full access to all databases to the <code>tenancy<\/code> user. Please consult your teams security professional.<\/p><\/div>\n<ul>\n<li>The  <code>affects-connections<\/code> package is required by this package in order to transfer the database from one database user to another when the database user. This change occurs when the Tenant is updated causing a new database username within the <code>hooks-database<\/code> package.<\/li>\n<\/ul>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/db-driver-mysql\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Database\\Drivers\\Mysql\\Provider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<p>Detailed configuration steps are located in the <a href=\"hooks-database\"><code>hooks-database<\/code><\/a> package and the <a href=\"affects-connections\"><code>affects-connections<\/code><\/a> package.<\/p>\n<p>In general there are several ways of setting the tenant database configuration for MySQL:<\/p>\n<ul>\n<li>Reusing a connection configured in <code>database.php<\/code> under <code>connections<\/code>.<\/li>\n<li>Load a configuration array from a separate file.<\/li>\n<\/ul>\n<h3 id=\"example\"><a href=\"#example\" class=\"anchor-link\"><\/a>Example<\/h3>\n<p>In the example below we will configure the database to be created using the information from the <code>mysql<\/code> database connection defined in the <code>config\/database.php<\/code> and add Tenancy's default database settings to this.<\/p>\n<pre><code class=\"language-php\">$event-&gt;useConnection('mysql', $event-&gt;defaults($event-&gt;tenant));\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-29 17:56:08.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/database-mysql.md"},{"title":"Database driver SQLite","icon":"fal fa-warehouse-alt","excerpt":"Maintains the tenant SQLite database.\n","tags":["tenant","database","driver","sqlite"],"path":"docs\/tenancy\/1.x\/database-sqlite.md","slug":"database-sqlite","package":"tenancy","version":"1.x","contents":"<h1 id=\"database-driver-sqlite\"><a href=\"#database-driver-sqlite\" class=\"anchor-link\"><\/a>Database Driver: SQLite<\/h1>\n<ol>\n<li>\n<a href=\"#overview\">Overview<\/a>\n<\/li>\n<li>\n<a href=\"#requirements\">Requirements<\/a>\n<\/li>\n<li>\n<a href=\"#installation\">Installation<\/a>\n<\/li>\n<li>\n<a href=\"#configuration\">Configuration<\/a>\n<\/li>\n<\/ol>\n<h2 id=\"overview\"><a href=\"#overview\" class=\"anchor-link\"><\/a>Overview<\/h2>\n<p><strong>Purpose<\/strong><\/p>\n<p>The purpose of this package is to enable the management (Creation, Updating, Deletion) of Tenant SQLite Databases.<\/p>\n<p><strong>Requirements<\/strong><\/p>\n<p>When using the <a href=\"hooks-database\"><code>hooks-database<\/code><\/a> package the the location where the SQLite database will be stored needs to be writeable by the user running the code. (I.E. <code>www-data<\/code>)<\/p>\n<p><strong>Recommendations<\/strong><\/p>\n<ul>\n<li>To automate the management of Tenant Databases when a Tenant is created, updated, or deleted; The <a href=\"hooks-database\"><code>hooks-database<\/code><\/a> package should also be installed.<\/li>\n<li>To use the Tenant Database with the <code>onTenant<\/code> trait; The <a href=\"https:\/\/tenancy.dev\/docs\/tenancy\/1.x\/affects-connections\"><code>affects-connections<\/code><\/a> package should also be installed. (<em>Note:<\/em> This package is not required for the use of the <a href=\"affects-connections\"><code>affects-connections<\/code><\/a> package)<\/li>\n<\/ul>\n<p><strong>Use Cases<\/strong><\/p>\n<ul>\n<li>A Tenant's information needs to be stored in a separate database from other Tenants.<\/li>\n<li>A Tenants location needs to be stored in a location that is local to the webserver and not accessible outside of the filesystem it is stored on.<\/li>\n<li>and Many More!<\/li>\n<\/ul>\n<h2 id=\"requirements\"><a href=\"#requirements\" class=\"anchor-link\"><\/a>Requirements<\/h2>\n<p>Because this package will create a new SQLite database file, the location that database files are being created needs to be writeable by the user running the code. (I.E. <code>www-data<\/code>)<\/p>\n<h2 id=\"installation\"><a href=\"#installation\" class=\"anchor-link\"><\/a>Installation<\/h2>\n<div class=\"alert alert-info\"><p>CAUTION: This will only provide <strong>local<\/strong> databases, which are not accessible remotely.<\/p><\/div>\n<div class=\"alert alert-info\"><p>CAUTION: This database driver might require additional steps for configuration. It is based on a filesystem, and not a real database like most Database Drivers.<\/p><\/div>\n<h3 id=\"using-tenancyframework\"><a href=\"#using-tenancyframework\" class=\"anchor-link\"><\/a>Using Tenancy\/Framework<\/h3>\n<p>Install via composer:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/db-driver-sqlite\n<\/code><\/pre>\n<h3 id=\"using-tenancytenancy-or-with-provider-discovery-disabled\"><a href=\"#using-tenancytenancy-or-with-provider-discovery-disabled\" class=\"anchor-link\"><\/a>Using Tenancy\/Tenancy or with provider discovery disabled<\/h3>\n<p>Register the following ServiceProvider:<\/p>\n<ul>\n<li>\n<code>Tenancy\\Database\\Drivers\\Sqlite\\Provider::class<\/code>\n<\/li>\n<\/ul>\n<h2 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h2>\n<p>Detailed configuration steps are located in the <a href=\"hooks-database\"><code>hooks-database<\/code><\/a> package and the <a href=\"affects-connections\"><code>affects-connections<\/code><\/a> package.<\/p>\n<h3 id=\"example\"><a href=\"#example\" class=\"anchor-link\"><\/a>Example<\/h3>\n<p>In the following example we set the connection to use SQLite, and set the database path to be specific to the tenant based on the Tenant's Key.<\/p>\n<pre><code class=\"language-php\">$event-&gt;useConnection('sqlite', [\n\t'database' =&gt; database_path('tenant\/'.$event-&gt;tenant-&gt;getTenantKey().'.sqlite'),\n]);\n<\/code><\/pre>\n","updated_at":{"date":"2021-06-25 13:28:52.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/database-sqlite.md"}]},{"name":"meta","links":["faq-common-problems","compared-to-hyn"],"slug":"meta","articles":[{"title":"FAQ - Frequently Asked Questions","icon":"fal fa-question","excerpt":"Frequently Asked Questions, common problems and some possibly not immediately obvious information\n","tags":["tenant","faq"],"path":"docs\/tenancy\/1.x\/faq-common-problems.md","slug":"faq-common-problems","package":"tenancy","version":"1.x","contents":"<h1 id=\"faq-frequently-asked-questions\"><a href=\"#faq-frequently-asked-questions\" class=\"anchor-link\"><\/a>FAQ - Frequently Asked Questions<\/h1>\n<h2 id=\"migrations\"><a href=\"#migrations\" class=\"anchor-link\"><\/a>Migrations<\/h2>\n<p><strong>Problem<\/strong><\/p>\n<p>I've set up the lifecycle-hooks Database and Migration. When creating a new tenant all my migrations for tenant databases are run.\nNo matter what I try (<code>artisan migrate<\/code>, <code>artisan migrate --tenant<\/code>, ...), I can't get new migrations to be applied on existing tenant databases.<\/p>\n<p><strong>Solution<\/strong><\/p>\n<p>Migrations for tenant databases are triggered by <a href=\"hooks-general#events\">lifecycle events<\/a>.\nSo, all you have to do is to fire an <code>Updated<\/code> event for the tenant you want to migrate. <strong>Yes, this does mean you need to fire one event for each of your tenants if you want to migrate all at once.<\/strong><\/p>\n<p>You can do this via <code>artisan tinker<\/code>, create a custom artisan command (e.g. <code>migrate:tenants<\/code>, inside your own tenant managing commands, ...), etc.<\/p>\n<p>The code might look something like this:<\/p>\n<pre><code class=\"language-php\">\\App\\Tenant::cursor()-&gt;each(function($tenant) { event(new Updated($tenant)); });\n<\/code><\/pre>\n<h2 id=\"sql-error-while-deleting-a-tenant\"><a href=\"#sql-error-while-deleting-a-tenant\" class=\"anchor-link\"><\/a>SQL error while deleting a tenant<\/h2>\n<p><strong>Problem<\/strong><\/p>\n<p>When deleting a tenant I receive a SQL error indicating it might have something to do with the deleted tenant<\/p>\n<p><strong>Solution<\/strong><\/p>\n<p>Migrations are run <strong>after<\/strong> database actions. So, in this case, Tenancy tries to run some migrations on the tenants database, by the tenants user, which at this point both won't exist anymore.<\/p>\n<p>You might want to change your <code>ConfigureMigrations<\/code> listener to take that into account:<\/p>\n<pre><code class=\"language-php\">&lt;?php\n\nnamespace App\\Listeners;\n\nuse Tenancy\\Hooks\\Migration\\Events\\ConfigureMigrations;\nuse Tenancy\\Tenant\\Events\\Deleted;\n\nclass ConfigureTenantMigrations\n{\n    public function handle(ConfigureMigrations $event)\n    {\n        $event-&gt;path(database_path('tenant\/migrations'));\n\n        if($event-&gt;event instanceof Deleted) {\n            $event-&gt;disable();\n        }\n    }\n}\n\n<\/code><\/pre>\n<h2 id=\"form-validations-are-run-against-the-system-database-instead-of-the-tenants-database\"><a href=\"#form-validations-are-run-against-the-system-database-instead-of-the-tenants-database\" class=\"anchor-link\"><\/a>Form validations are run against the system database instead of the tenants database<\/h2>\n<p><strong>Problem<\/strong><\/p>\n<p>Laravel keeps trying to run validations against my system database, even though my models are using the <code>OnTenant<\/code> trait. What's going on?<\/p>\n<p><em>Example<\/em><\/p>\n<p>Let's take a default Laravel UI scaffold including auth. The <em>RegisterController<\/em> looks something like this:<\/p>\n<pre><code class=\"language-php\">[... snip ...]\nprotected function validator(array $data)\n{\n    return Validator::make($data, [\n        'name' =&gt; ['required', 'string', 'max:255'],\n        'email' =&gt; ['required', 'string', 'email', 'max:255', 'unique:users'],\n        'password' =&gt; ['required', 'string', 'min:8', 'confirmed'],\n    ]);\n}\n[... snip ...]\n<\/code><\/pre>\n<p>You can clearly see the validation rule stating <em>unique:users<\/em>. So, what gives?<\/p>\n<p><strong>Solution<\/strong><\/p>\n<p>It's simple. Form validation in Laravel <strong>does not<\/strong> use your models! So, to get it to work, you need to tell Laravel that you want to validate against a table in a different database.<\/p>\n<p>Luckily, all you need to do is to prefix the table name with the right connection name.<\/p>\n<pre><code class=\"language-php\">        'email' =&gt; ['required', 'string', 'email', 'max:255', 'unique:' . Tenancy::getTenantConnectionName() . '.users'],\n<\/code><\/pre>\n<p>There, that's all you need!<\/p>\n<h2 id=\"i-need-to-run-some-code-after-my-affects-are-finished\"><a href=\"#i-need-to-run-some-code-after-my-affects-are-finished\" class=\"anchor-link\"><\/a>I need to run some code after my affects are finished<\/h2>\n<p><strong>Problem<\/strong><\/p>\n<p>I need to do some stuff directly after my affects are finished, but before the rest of the app is run<\/p>\n<p><em>Example<\/em><\/p>\n<p>You might be using a third party package in your application, and you need to configure it based on your tenant; AFTER your <a href=\"affects-configs\">affects-config<\/a> is finished.<\/p>\n<p><strong>Solution<\/strong><\/p>\n<p>Instead of listening to some specific event fired by the affect, just add a second listener for <code>Tenancy\\Affects\\Configs\\Events\\ConfigureConfig<\/code><\/p>\n<p>Before:<\/p>\n<pre><code class=\"language-php\">class EventServiceProvider extends ServiceProvider\n{\n    protected $listen = [\n        \\Tenancy\\Affects\\Configs\\Events\\ConfigureConfig::class =&gt; [\n            ConfigureTenantConfigs::class,\n        ],\n    ];\n}\n<\/code><\/pre>\n<p>After:<\/p>\n<pre><code class=\"language-php\">class EventServiceProvider extends ServiceProvider\n{\n    protected $listen = [\n        \\Tenancy\\Affects\\Configs\\Events\\ConfigureConfig::class =&gt; [\n            ConfigureTenantConfigs::class,\n            ConfigurePackage::class,\n        ],\n    ];\n}\n<\/code><\/pre>\n<p>Done.<\/p>\n","updated_at":{"date":"2020-09-08 13:42:49.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/faq-common-problems.md"},{"title":"Compared to hyn","icon":"fal fa-box-check","path":"docs\/tenancy\/1.x\/compared-to-hyn.md","slug":"compared-to-hyn","package":"tenancy","version":"1.x","contents":"<p>The predecessor, <code>hyn\/multi-tenant<\/code> (&quot;hyn&quot;), to this package (&quot;tenancy&quot;)\nwas created with a different purpose in mind. Originally the intent of my multi tenant\npackage was to offer digital media companies a fast and easy way to set up\nwebsites for all customers, even when each of these were serving different apps.\nThis type of multi tenancy has been slowly replaced with the Software as a Service we see nowadays.<\/p>\n<h1 id=\"local-dependencies\"><a href=\"#local-dependencies\" class=\"anchor-link\"><\/a>Local dependencies<\/h1>\n<p>The challenges of modern SaaS are not related to offering additional code\nusing dynamically, composer auto loaded packages. Nor do they rely on\nlocal filesystems. The successor to hyn <code>tenancy\/tenancy<\/code> (&quot;tenancy&quot;) aims\nsolely on apps living in the cloud using scalable architecture like block\nstorage, load balancing and cloud databases.<\/p>\n<p>Functionality offered in hyn which rely on local filesystems are therefore\nno longer a default feature. This includes most (if not all) overrides\nfrom files living inside the tenant directory.<\/p>\n<h1 id=\"tenant-identification\"><a href=\"#tenant-identification\" class=\"anchor-link\"><\/a>Tenant identification<\/h1>\n<p>Although hyn was never intended to be opinionated about the choices of\nthe developer - a few changes to improve that position -\nit would still use a hostname and website model to relate to a tenant.<\/p>\n<p>Initial confusion arose while binding the hostname, identified from the current request,\ninto the service container as a tenant. In version 5.2 of hyn a correction\nwas introduced binding a website model to a new tenant contract.<\/p>\n<p>In the end, forcing any developer to use the requested host for identification, while\nusing other implementations to identify the tenant inside, for instance, artisan commands\ndoesn't make a lot of sense. Tenant identification should be contained inside one\nspecific shard of code. The <code>TenantResolver<\/code> class in tenancy offers a centrally\norganised method of identifying tenants; event listeners can respond with a\ntenant compliant model. The first listener to provide a valid tenant model &quot;wins&quot;,\nswitching the current environment.<\/p>\n<h1 id=\"modularity\"><a href=\"#modularity\" class=\"anchor-link\"><\/a>Modularity<\/h1>\n<p>Back when hyn versions made huge leaps - while much of the interaction with Laravel was\nmostly a matter of research, trial and error - the package that\nadded an admin dashboard was dropped in order to focus on creating a fundamentally better package.<\/p>\n<p>In addition as new Laravel versions were released in pretty fast succession, new versions\n(3.x, 4.x and 5.x) of hyn were started to offer to these new versions (5.3, 5.4 and 5.5).\nIn the end, maintaining so many branches was a pain and the package was reduced to one,\nsingle 5.x version; a monolith.<\/p>\n<p>This has been very fruitful for the package, but it made deciding whether to add functionality\nnot closely related to multi tenancy a struggle. Tenancy has been set up to work with git subsplit;\nthe same way the Laravel framework is maintained. One repository contains all packages, using\nthe subsplit command read-only package repositories are updated automatically.<\/p>\n<p>With this set up developing, maintaining and testing existing and new packages becomes far easier,\nit also reduces the overhead for contributors.<\/p>\n<h1 id=\"extensibility\"><a href=\"#extensibility\" class=\"anchor-link\"><\/a>Extensibility<\/h1>\n<p>Now that modularity is been taken care of, working on third party integration no longer feels like\na new burden to pick up. Planned native integrations for the future include:<\/p>\n<ul>\n<li>Laravel Spark.<\/li>\n<li>Laravel Horizon.<\/li>\n<li>Different permission packages.<\/li>\n<li>Voyager and possibly other admin toolkits.<\/li>\n<\/ul>\n<p>Keep an eye on the <a href=\"https:\/\/github.com\/tenancy\/tenancy\/labels\/type%3Aintegration\">integrations<\/a> label on\nGitHub, or <a href=\"https:\/\/github.com\/tenancy\/tenancy\/issues\/new\">submit an integration request<\/a> if you have one!<\/p>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/compared-to-hyn.md"}]},{"name":"tutorials","links":["tutorial-basic-setup","tutorial-multi-database"],"slug":"tutorials","articles":[{"title":"Basic Setup","icon":"fal fa-cogs","excerpt":"How to create a basic Setup with the Tenancy Ecosystem\n","tags":["tenancy","tutorial","basic"],"path":"docs\/tenancy\/1.x\/tutorial-basic-setup.md","slug":"tutorial-basic-setup","package":"tenancy","version":"1.x","contents":"<h2 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h2>\n<p>The Tenancy Ecosystem works in really flexible ways. In order for you to get started easily we will show you how to create a really basic setup. In this basic setup we will teach you:<\/p>\n<ul>\n<li>How to create a tenant<\/li>\n<li>How to get tenancy ready for Identification<\/li>\n<li>How to get tenancy ready for Lifecycle Hooks<\/li>\n<\/ul>\n<h2 id=\"creating-a-tenant\"><a href=\"#creating-a-tenant\" class=\"anchor-link\"><\/a>Creating a tenant<\/h2>\n<p>After you've created your own Laravel project, we recommend you to start off by installing and configuring the <code>tenancy\/framework<\/code>.<\/p>\n<p>First, install the package:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/framework\n<\/code><\/pre>\n<p>When the installation is done, create a model and a migration for your Tenant model. In this tutorial we will use a <code>Customer<\/code> model.<\/p>\n<p>After you've created your model, make sure it implements the <code>Tenancy\\Identification\\Contracts\\Tenant<\/code> contract.<\/p>\n<div class=\"alert alert-info\"><p>Tip: You can easily implement the contract by using our simple trait: <code>Tenancy\\Identification\\Concerns\\AllowsTenantIdentification<\/code><\/p><\/div>\n<p>Your model should now look something like this:\n<code>app\/Models\/Customer.php<\/code><\/p>\n<pre><code class=\"language-php\">use Illuminate\\Database\\Eloquent\\Model;\nuse Tenancy\\Identification\\Concerns\\AllowsTenantIdentification;\nuse Tenancy\\Identification\\Contracts\\Tenant;\n\nclass Customer extends Model implements Tenant\n{\n    use AllowsTenantIdentification;\n}\n<\/code><\/pre>\n<p>You've now succesfully created a simple tenant model!<\/p>\n<h2 id=\"preparing-for-identification\"><a href=\"#preparing-for-identification\" class=\"anchor-link\"><\/a>Preparing for Identification<\/h2>\n<p>Tenancy needs to be aware of the tenant that you have just created in order to identify it. We will do this by registering the model into the <code>TenantResolver<\/code> (which is simply a class responsible for identifying tenants).<\/p>\n<p>We can easily register a model by using a callback in one of Laravel's default Service Providers. Let's use the <code>app\/Providers\/AppServiceProvider<\/code> in this case.<\/p>\n<pre><code class=\"language-php\">namespace App\\Providers;\n\nuse Illuminate\\Support\\ServiceProvider;\nuse App\\Models\\Customer;\nuse Tenancy\\Identification\\Contracts\\ResolvesTenants;\n\nclass AppServiceProvider extends ServiceProvider\n{\n    \/**\n     * Register any application services.\n     *\n     * @return void\n     *\/\n    public function register()\n    {\n        $this-&gt;app-&gt;resolving(ResolvesTenants::class, function (ResolvesTenants $resolver){\n            $resolver-&gt;addModel(Customer::class);\n            return $resolver;\n        });\n    }\n}\n<\/code><\/pre>\n<p>Now when the <code>TenantResolver<\/code> is being made, it will register the model. Really easy and really handy.<\/p>\n<div class=\"alert alert-info\"><p>Tip: If you have multiple Tenant models, you could register all of them like this.<\/p><\/div>\n<h2 id=\"preparing-for-lifecycle-hooks\"><a href=\"#preparing-for-lifecycle-hooks\" class=\"anchor-link\"><\/a>Preparing for Lifecycle Hooks<\/h2>\n<div class=\"alert alert-info\"><p>If you have no idea what the Lifecycle or Lifecycle Hooks are, we recommend you to <a href=\"hooks-general\">read about those first<\/a>.<\/p><\/div>\n<p>To prepare your tenant for lifecycle hooks, we will fire off some events for when a model is:<\/p>\n<ul>\n<li>Created<\/li>\n<li>Updated<\/li>\n<li>Deleted<\/li>\n<\/ul>\n<p>We can do this with Laravel's really handy <code>dispatchesEvents<\/code> variable on models. It allows you to define specific events that should be fired when a model is being made. Here's an example of how to make it work for our Customer model:\n<code>app\/Models\/Customer.php<\/code><\/p>\n<pre><code class=\"language-php\">use Illuminate\\Database\\Eloquent\\Model;\nuse Tenancy\\Identification\\Concerns\\AllowsTenantIdentification;\nuse Tenancy\\Identification\\Contracts\\Tenant;\nuse Tenancy\\Tenant\\Events;\n\nclass Customer extends Model implements Tenant\n{\n    use AllowsTenantIdentification;\n\n    protected $dispatchesEvents = [\n        'created' =&gt; Events\\Created::class,\n        'updated' =&gt; Events\\Updated::class,\n        'deleted' =&gt; Events\\Deleted::class,\n    ];\n}\n<\/code><\/pre>\n<p>Now when you're creating a model like you normally do, it will fire off the Events for tenancy. When Tenancy receives these events, it will start firing Lifecycle Hooks.<\/p>\n","updated_at":{"date":"2021-03-26 03:55:42.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/tutorial-basic-setup.md"},{"title":"Multi Database Setup","icon":"fal fa-database","excerpt":"How to create a Multi Database Setup with the Tenancy Ecosystem\n","tags":["tenancy","tutorial","multi database"],"path":"docs\/tenancy\/1.x\/tutorial-multi-database.md","slug":"tutorial-multi-database","package":"tenancy","version":"1.x","contents":"<h2 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h2>\n<p>Setting up a multi database tenancy setup can be quite difficult. There's a lot of different (moving) pieces and that's exactly why we made this tutorial. In this tutorial we will talk about:<\/p>\n<ul>\n<li>Setting up tenancy so it will create a new DB for each tenant<\/li>\n<li>Changing the connection whenever a tenant is identified<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>This tutorial assumes that you have a basic setup (meaning a tenant model that is firing hooks).<\/p><\/div>\n<h2 id=\"creation-of-the-database\"><a href=\"#creation-of-the-database\" class=\"anchor-link\"><\/a>Creation of the database<\/h2>\n<p>Creating of the database is a collaboration between 2 different type of packages:<\/p>\n<ul>\n<li>A Lifecycle Hook (<code>tenancy\/hooks-database<\/code> in this case)<\/li>\n<li>A Database Driver (<code>tenancy\/db-driver-mysql<\/code> for example). There are more Database Driver to choose from, in case you need one for a different Database.<\/li>\n<\/ul>\n<h3 id=\"setting-up\"><a href=\"#setting-up\" class=\"anchor-link\"><\/a>Setting Up<\/h3>\n<p>We will first focus on installing <code>hooks-database<\/code>. You can install this package by simply running the following command in your project:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/hooks-database\n<\/code><\/pre>\n<p>After that is done, we will focus on configuring the creation of the database.<\/p>\n<p>Configuring the database is fairly easy. It starts of with creating a new listener that listens to the <code>Tenancy\\Hooks\\Database\\Events\\Drivers\\Configuring<\/code> event. Once you've created a listener, we will go to the actual configuration.<\/p>\n<p>There are multiple ways to configure the Database Creation. In this tutorial we will use tenancy's default functionality in order to make it work. In your listener use the following code:<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Hooks\\Database\\Events\\Drivers\\Configuring;\n\nclass ConfigureTenantDatabase\n{\n    public function handle(Configuring $event)\n    {\n        $event-&gt;useConnection('mysql', $event-&gt;defaults($event-&gt;tenant));\n    }\n}\n<\/code><\/pre>\n<p>What this code will do is quite simple:<\/p>\n<ul>\n<li>It will use the <code>mysql<\/code> configuration provided in the <code>config\/database.php<\/code> of your application.<\/li>\n<li>It will use the <code>tenant_key<\/code> for a database name and database username<\/li>\n<li>It will use some information on the tenant for generating a secret password<\/li>\n<\/ul>\n<p>You've now completely configured the creating of the database, but now it's time to actually create the database.<\/p>\n<p>Creating the database is really easy, simply install the database driver of your choice (we recommend <code>tenancy\/db-driver-mysql<\/code>) through composer.<\/p>\n<p>You should now be able to create a new Database, by simply creating a new tenant.<\/p>\n<h2 id=\"changing-the-connection\"><a href=\"#changing-the-connection\" class=\"anchor-link\"><\/a>Changing the connection<\/h2>\n<p>There's one package responsible for changing of the connection and that is <code>affects-connections<\/code>. Once a tenant is identified, it will creating a new <code>tenant<\/code> connection which will direct to the database that we setup earlier. So let's get started on this installation.<\/p>\n<p>First, install the package by running:<\/p>\n<pre><code class=\"language-bash\">composer require tenancy\/affects-connections\n<\/code><\/pre>\n<p>After the installation, we will focusing on <code>Resolving<\/code> the connection. This is simply us telling tenancy what class it should use in order to get a configuration for the connection. Create a new listener that listens to the <code>Tenancy\\Affects\\Connections\\Events\\Resolving<\/code> event.<\/p>\n<div class=\"alert alert-info\"><p>Important: This event expects to <strong>return<\/strong> an instance\/class that will provide the configuration of the connection, not the configuration itself.<\/p><\/div>\n<p>In this example, we will tell tenancy that this listener is responsible for configuring that connection. We do this by simply returning the instance like shown below.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Affects\\Connections\\Events\\Resolving;\n\nclass ResolveTenantConnection\n{\n    public function handle(Resolving $event)\n    {\n        return $this;\n    }\n}\n<\/code><\/pre>\n<p>However, this class does not implements the <code>ProvidesConfiguration<\/code> contract which is responsible for providing a connection configuration to Tenant, so we will do that.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Identification\\Contracts\\Tenant;\nuse Tenancy\\Affects\\Connections\\Contracts\\ProvidesConfiguration;\nuse Tenancy\\Affects\\Connections\\Events\\Resolving;\n\nclass ResolveTenantConnection implements ProvidesConfiguration\n{\n    public function handle(Resolving $event)\n    {\n        return $this;\n    }\n\n    public function configure(Tenant $tenant): array\n    {\n        return [];\n    }\n}\n<\/code><\/pre>\n<p>Right now we're providing an empty array as a connection setting. This won't work, and we will have to implement some logic in order to provide an actual connection configuration. You can do 2 different types of setups in this case:<\/p>\n<ul>\n<li>You can put all the logic for a connection here.<\/li>\n<li>You can fire off a <code>Configuring<\/code> event in order to configure it in a different listener.<\/li>\n<\/ul>\n<p>In this tutorial we decided to fire off a <code>Configuring<\/code> event. You can do that by looking at the example below.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Identification\\Contracts\\Tenant;\nuse Tenancy\\Affects\\Connections\\Events\\Resolving;\nuse Tenancy\\Affects\\Connections\\Events\\Drivers\\Configuring;\nuse Tenancy\\Affects\\Connections\\Contracts\\ProvidesConfiguration;\n\nclass ResolveTenantConnection implements ProvidesConfiguration\n{\n    public function handle(Resolving $event)\n    {\n        return $this;\n    }\n\n    public function configure(Tenant $tenant): array\n    {\n        $config = [];\n\n        event(new Configuring($tenant, $config, $this));\n\n        return $config;\n    }\n}\n<\/code><\/pre>\n<p>After you've done this, we will move to the actual configuring of the connection. Create a new listener that listens to the <code>Tenancy\\Affects\\Connections\\Events\\Drivers\\Configuring<\/code> event. This event is basically the same event as the event we used for the database.\nThis allows us to use the exact same code that we used then in order to configure the database. You can see an example below.<\/p>\n<pre><code class=\"language-php\">namespace App\\Listeners;\n\nuse Tenancy\\Affects\\Connections\\Events\\Drivers\\Configuring;\n\nclass ConfigureTenantConnection\n{\n    public function handle(Configuring $event)\n    {\n        $event-&gt;useConnection('mysql', $event-&gt;defaults($event-&gt;tenant));\n    }\n}\n<\/code><\/pre>\n<h2 id=\"done\"><a href=\"#done\" class=\"anchor-link\"><\/a>Done!<\/h2>\n<p>You're all done now, congratulations! You've now setup your own multi tenancy setup using the Tenancy Ecosystem!<\/p>\n<p>You should have the following result:<\/p>\n<ul>\n<li>Creating a new Customer (or your own tenant model), will result in a new database creation<\/li>\n<li>Switching to the tenant will create a new <code>tenant<\/code> connection.<\/li>\n<\/ul>\n","updated_at":{"date":"2020-08-29 19:59:39.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/tenancy\/1.x\/tutorial-multi-database.md"}]}],"hidden_articles":[]}}},"hyn":{"slug":"hyn","name":"Hyn","description":"Run multiple websites using the same Laravel installation while keeping tenant specific data separated for fully independent multi-domain setups.\n","repository":"https:\/\/github.com\/tenancy\/multi-tenant","downloads":null,"stargazers":{"2015-07":6,"2015-09":18,"2015-10":24,"2015-11":33,"2015-12":43,"2016-01":45,"2016-02":56,"2016-03":61,"2016-04":92,"2016-05":132,"2016-06":140,"2016-07":151,"2016-08":164,"2016-09":181,"2016-10":194,"2016-11":206,"2016-12":220,"2017-01":225,"2017-02":231,"2017-03":249,"2017-04":264,"2017-05":274,"2017-06":291,"2017-07":313,"2017-08":326,"2017-09":357,"2017-10":407,"2017-11":429,"2017-12":448,"2018-01":470,"2018-02":512,"2018-03":549,"2018-04":627,"2018-05":681,"2018-06":818,"2018-07":887,"2018-08":952,"2018-09":997,"2018-10":1042,"2018-11":1080,"2018-12":1119,"2019-01":1163,"2019-02":1204,"2019-03":1315,"2019-04":1370,"2019-05":1419,"2019-06":1459,"2019-07":1502,"2019-08":1546,"2019-09":1587,"2019-10":1621,"2019-11":1658,"2019-12":1703,"2020-01":1751,"2020-02":1784,"2020-03":1817,"2020-04":1877,"2020-05":1919,"2020-06":1942,"2020-07":1963,"2020-08":1993,"2020-09":2014,"2020-10":2044,"2020-11":2073,"2020-12":2097,"2021-01":2118,"2021-02":2137,"2021-03":2156,"2021-04":2179,"2021-05":2197,"2021-06":2207,"2021-07":2219,"2021-08":2231,"2021-09":2246,"2021-10":2262,"2021-11":2272,"2021-12":2283,"2022-01":2297,"2022-02":2312,"2022-03":2322,"2022-04":2334,"2022-05":2344,"2022-06":2357,"2022-07":2365,"2022-08":2374,"2022-09":2380,"2022-10":2387},"versions":{"5.6":{"slug":"5.6","name":5.6,"status":"Stable","suggestion_using":true,"branch":"5.x","package":"hyn","tree":[{"name":"getting started","links":["requirements","upgrade-from-5.5","installation","configuration"],"slug":"getting-started","articles":[{"title":"Requirements","icon":"fal fa-clipboard-check","path":"docs\/hyn\/5.6\/requirements.md","slug":"requirements","package":"hyn","version":"5.6","contents":"<ul>\n<li>Laravel 7.*.<\/li>\n<li>PHP 7.2 or up.<\/li>\n<li>MySQL 5.7+, MariaDB 10.2.0+ or PostgreSQL 9+.<\/li>\n<li>Optionally Apache 2.4+ or Nginx 1.12+.<\/li>\n<li>\n<a href=\"#experience\">Applied experience with Laravel<\/a>.<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>Please note that MySQL limits username and database length to 32. Enable this in the <code>tenancy.php<\/code> configuration file:  <code>website &gt; uuid-limit-length-to-32<\/code> to accommodate this.<\/p><\/div>\n<h2 id=\"experience\"><a href=\"#experience\" class=\"anchor-link\"><\/a>Experience<\/h2>\n<p>In case you are new to Laravel we urge you to get familiar with that\nbefore jumping into building something with this package. Having built\nat least one project with the framework (for fun) makes it much easier\ngrasping the concepts at hand.<\/p>\n<p>The following resources we recommend:<\/p>\n<ul>\n<li>\n<a href=\"https:\/\/laravel.com\/docs\">Laravel documentation<\/a>\n<\/li>\n<li>\n<a href=\"https:\/\/laracasts.com\/series\/laravel-from-scratch-2017\">Laravel from scratch free series at Laracasts<\/a>\n<\/li>\n<\/ul>\n","updated_at":{"date":"2020-07-18 18:34:01.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.6\/requirements.md"},{"title":"Upgrading from 5.5","icon":"fal fa-level-up-alt","path":"docs\/hyn\/5.6\/upgrade-from-5.5.md","slug":"upgrade-from-5.5","package":"hyn","version":"5.6","contents":"<p>The 5.6 version adds compatibility with Laravel 7.0 and drops support for all previous versions.<\/p>\n<p>See the <a href=\"https:\/\/github.com\/tenancy\/multi-tenant\/blob\/5.x\/changelog.md\">changelog<\/a> for\nall modifications.<\/p>\n","updated_at":{"date":"2020-07-18 18:34:01.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.6\/upgrade-from-5.5.md"},{"title":"Installation","icon":"fal fa-arrow-alt-to-bottom","path":"docs\/hyn\/5.6\/installation.md","slug":"installation","package":"hyn","version":"5.6","contents":"<h1 id=\"elevated-database-user\"><a href=\"#elevated-database-user\" class=\"anchor-link\"><\/a>Elevated database user<\/h1>\n<p>Tenancy requires a <code>system<\/code> connection that allows creating new databases for\ntenants. In order to do so, we need to have a database user with elevated\npermissions.<\/p>\n<p>A user for both <a href=\"https:\/\/mariadb.com\/kb\/en\/library\/grant\/#the-grant-option-privilege\">MariaDB or MySQL<\/a> and <a href=\"https:\/\/www.postgresql.org\/docs\/9.6\/static\/sql-grant.html\">PostgreSQL<\/a> would require the &quot;GRANT OPTION&quot; to be\napplied. You can either use the root user (for PostgreSQL that is user postgres) or create\nyour own (recommended):<\/p>\n<p>For MariaDB or MySQL:<\/p>\n<pre><code class=\"language-sql\">CREATE DATABASE IF NOT EXISTS tenancy;\nCREATE USER IF NOT EXISTS tenancy@localhost IDENTIFIED BY 'someRandomPassword';\nGRANT ALL PRIVILEGES ON *.* TO tenancy@localhost WITH GRANT OPTION;\n<\/code><\/pre>\n<p>For PostgreSQL:<\/p>\n<pre><code class=\"language-sql\">CREATE DATABASE tenancy;\nCREATE USER tenancy WITH CREATEDB CREATEROLE PASSWORD 'someRandomPassword';\nGRANT ALL PRIVILEGES ON DATABASE tenancy to tenancy WITH GRANT OPTION;\n<\/code><\/pre>\n<p>Make sure you configure this user as your <code>system<\/code> connection in your <code>database.php<\/code>.\nUnder <code>connections<\/code>:<\/p>\n<pre><code class=\"language-php\">'system' =&gt; [\n    'driver' =&gt; 'mysql',\n    'host' =&gt; env('TENANCY_HOST', '127.0.0.1'),\n    'port' =&gt; env('TENANCY_PORT', '3306'),\n    'database' =&gt; env('TENANCY_DATABASE', 'tenancy'),\n    'username' =&gt; env('TENANCY_USERNAME', 'tenancy'),\n    'password' =&gt; env('TENANCY_PASSWORD', ''),\n    'unix_socket' =&gt; env('DB_SOCKET', ''),\n    'charset' =&gt; 'utf8mb4',\n    'collation' =&gt; 'utf8mb4_unicode_ci',\n    'prefix' =&gt; '',\n    'strict' =&gt; true,\n    'engine' =&gt; null,\n]\n<\/code><\/pre>\n<p>Most often it makes sense to use either <code>system<\/code> or <code>tenant<\/code> as your default database connection setting. For example, Laravel assigns the value from <code>DB_CONNECTION<\/code> in your <code>.env<\/code> file to the <code>default<\/code> key in the <code>config\/database.php<\/code> configuration file.<\/p>\n<p>In case you use <code>tenant<\/code> make sure to enable <a href=\"identification\">early identification<\/a> and configure\na decent <a href=\"fallback\">fallback<\/a> later on.<\/p>\n<div class=\"alert alert-info\"><p>There is no need to configure the <code>tenant<\/code> connection in the <code>database.php<\/code>\nconfiguration file. This connection is set up automatically during runtime. Pre-\nconfiguring this connection may cause unwanted behaviour.<\/p><\/div>\n<h1 id=\"package-installation\"><a href=\"#package-installation\" class=\"anchor-link\"><\/a>Package installation<\/h1>\n<p>Run the composer command to add the tenancy package as dependency:<\/p>\n<pre><code class=\"language-bash\">composer require &quot;hyn\/multi-tenant:5.6.*&quot;\n<\/code><\/pre>\n<p>Laravel's <a href=\"https:\/\/medium.com\/@taylorotwell\/package-auto-discovery-in-laravel-5-5-ea9e3ab20518\">package auto discovery<\/a> will register the service provider automatically.<\/p>\n<p>Publish the configuration files and migrations for Tenancy, which allow you\nto configure the behavior of the package.<\/p>\n<pre><code class=\"language-bash\">php artisan vendor:publish --tag=tenancy\n<\/code><\/pre>\n<p>Then edit <code>config\/tenancy.php<\/code> accordingly.<\/p>\n<p>Adapt the system migrations to your liking inside <code>database\/migrations<\/code>, make sure to run them:<\/p>\n<pre><code class=\"language-bash\">php artisan migrate --database=system\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Change <code>system<\/code> to your system connection name.<\/p><\/div>\n","updated_at":{"date":"2020-07-18 18:34:01.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.6\/installation.md"},{"title":"Configuration","icon":"fal fa-sliders-v","path":"docs\/hyn\/5.6\/configuration.md","slug":"configuration","package":"hyn","version":"5.6","contents":"<h1 id=\"system-connection\"><a href=\"#system-connection\" class=\"anchor-link\"><\/a>System connection<\/h1>\n<p>Tenancy needs a database connection with elevated permission to create databases\nto be used by its tenants.<\/p>\n<p>Make sure you set up this connection by following the instructions\nin the <a href=\"requirements#elevated-database-user\">requirements<\/a>, it also explains how to publish\nthe configuration files.<\/p>\n<h1 id=\"configuration-files\"><a href=\"#configuration-files\" class=\"anchor-link\"><\/a>Configuration Files<\/h1>\n<p>The inline documentation in both files should be self explanatory. Nevertheless,\nI've listed some of the basic settings below.<\/p>\n<h2 id=\"tenancyphp\"><a href=\"#tenancyphp\" class=\"anchor-link\"><\/a>tenancy.php<\/h2>\n<p>The <code>tenancy.php<\/code> configuration file holds every setting related to tenants.\nThis includes how to generate a unique website, but also how database connections are set up.\nIn addition, it allows for:<\/p>\n<ul>\n<li>custom random id logic<\/li>\n<li>manual tenant identification<\/li>\n<li>on what disk (see <code>config\/filesystems.php<\/code>) to store the tenant-specific files<\/li>\n<li>specifying tenant database division mode<\/li>\n<li>specifying the password generator<\/li>\n<li>specifying the migrations path<\/li>\n<li>forcing models to a specific connection<\/li>\n<li>overriding your configs<\/li>\n<li>overriding your routes<\/li>\n<li>overriding translations<\/li>\n<li>overriding views<\/li>\n<li>and much, much more.<\/li>\n<\/ul>\n<h2 id=\"webserverphp\"><a href=\"#webserverphp\" class=\"anchor-link\"><\/a>webserver.php<\/h2>\n<p>The <code>webserver.php<\/code> configuration file allows one to more closely fine tune integration of this package with your webserver.\nPorts, vhost configuration files and the location to save these files are all contained in this config.<\/p>\n<p>The settings in this configuration file are:<\/p>\n<ul>\n<li>enabled; whether the service is enabled and thus the package will write files for it and reload the service.<\/li>\n<li>ports; which ports we should use, this is required to configure the vhost files properly.<\/li>\n<li>generator; the class handling the generation of vhost files.<\/li>\n<li>disk; the disk to write the vhost files to, you can have it point to any configured disk in your <code>config\/filesystems.php<\/code>.<\/li>\n<li>paths; specific locations we need to know about to in order to mutate the webserver behavior.<\/li>\n<\/ul>\n","updated_at":{"date":"2020-07-18 18:34:01.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.6\/configuration.md"}]},{"name":"tenant principles","links":["concepts","identification","connections","fallback","middleware"],"slug":"tenant-principles","articles":[{"title":"Concepts","icon":"fal fa-vials","path":"docs\/hyn\/5.6\/concepts.md","slug":"concepts","package":"hyn","version":"5.6","contents":"<h1 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h1>\n<p>The principle of multi tenancy is about a single instance of software running\non a server and serving multiple tenants. The interpretation of such a tenancy\napplication is quite diverse.<\/p>\n<p>Hyn tenancy is focused on providing a drop-in solution for Laravel without\nsacrificing flexibility or requiring extensive hacks of the Laravel ecosystem.<\/p>\n<p>Make sure you understand that the <code>Website<\/code> model is the subject of tenancy.<\/p>\n<p>The default method for identifying such a tenant website is by using the requested\ndomain aka <code>hostname<\/code>. Taking a URL <code>http:\/\/yourdomain.com\/foo\/bar<\/code> only <code>yourdomain.com<\/code>\nis taken into account, although modifications to this logic are easy to implement. The\n<code>yourdomain.com<\/code> part of the URL is called a Fully Qualified Domain Name or <code>fqdn<\/code> for short.<\/p>\n<p>A website can have zero or more hostnames connected to it. This allows for easier\nattachment of additional hostnames or serving, for instance an ad campaign page,\non different domains.<\/p>\n<h1 id=\"website\"><a href=\"#website\" class=\"anchor-link\"><\/a>Website<\/h1>\n<p>You can think of a website as a single mirror of the code base, re-using your default\napp code. In addition it is also possible to have very <a href=\"structure\">tenant specific logic<\/a>,\nfor instance routes, a vendor folder, media and language files.<\/p>\n<h1 id=\"hostname\"><a href=\"#hostname\" class=\"anchor-link\"><\/a>Hostname<\/h1>\n<p>A hostname is a <a href=\"https:\/\/www.godaddy.com\/garage\/industry\/tech-svcs\/it\/whats-a-fully-qualified-domain-name-fqdn-and-whats-it-good-for\/\">Fully Qualified Domain Name<\/a> (for instance <code>sub.example.com<\/code>).\nYour application handles incoming requests to specific hostnames. Tenancy inspects\nthese requests and <a href=\"identification\">sets up the tenancy environment<\/a> according to a\nmatching hostname or falls back to the default one.<\/p>\n<h1 id=\"runtime\"><a href=\"#runtime\" class=\"anchor-link\"><\/a>Runtime<\/h1>\n<p>By default, the package will identify the current requested <code>hostname<\/code> and bind it\ninto the <code>Hyn\\Tenancy\\Contracts\\CurrentHostname<\/code> contract. In case that <code>hostname<\/code> belongs to\na website, the latter will be bound into the <code>Hyn\\Tenancy\\Contracts\\Tenant<\/code> contract. Whenever\na Tenant is identified or switched the package will automatically infuse additional functionality\ninto Laravel, including <a href=\"fallback#tenant-routes-override\">global tenant routes<\/a>, <a href=\"structure\">tenant overrides<\/a>\nand <a href=\"queues\">queues<\/a>.<\/p>\n","updated_at":{"date":"2020-07-18 18:34:01.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.6\/concepts.md"},{"title":"Identification","icon":"fal fa-street-view","path":"docs\/hyn\/5.6\/identification.md","slug":"identification","package":"hyn","version":"5.6","contents":"<p>During runtime, the <code>Environment<\/code> class is bound into Laravel's container. The\ntenancy environment holds one single responsibility, which is telling our code\nwhat <code>hostname<\/code> is currently identified and resolving the related website.<\/p>\n<h1 id=\"early-identification\"><a href=\"#early-identification\" class=\"anchor-link\"><\/a>Early identification<\/h1>\n<p>By default Tenancy will identify the tenant after all Middleware has been processed.\nYou can resolve the Environment class through the service container\ninside a middleware to force identification of the tenant early on. If you want the\npackage to handle this on your behalf you can enable the <code>early-identification<\/code> flag in\nyour <code>tenancy.php<\/code> configuration file under <code>hostname<\/code>.<\/p>\n<h1 id=\"manual-identification\"><a href=\"#manual-identification\" class=\"anchor-link\"><\/a>Manual identification<\/h1>\n<p>The environment can be used to manually set any active tenant. This is one of the\nreasons why the tenancy configuration file has the <code>hostname &gt; auto-identification<\/code>\nsetting. Turn it off to implement your own tenancy identification.<\/p>\n<p>Manual identification is pretty straightforward. Take for example the following\nsnippet for a custom (app) service provider:<\/p>\n<pre><code class=\"language-php\">public function boot()\n{\n    $environment = $this-&gt;app-&gt;make(\\Hyn\\Tenancy\\Environment::class);\n\n    \/\/ Retrieve your website\n\n    \/\/ Now switch the environment to a new tenant.\n    $environment-&gt;tenant($website);\n}\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Be wary about switching tenants. It is recommend switching only once during code\nexecution. Use a background job to run mass changes on tenant databases.<\/p><\/div>\n<h1 id=\"retrieve-current-tenant\"><a href=\"#retrieve-current-tenant\" class=\"anchor-link\"><\/a>Retrieve current tenant<\/h1>\n<p>To work with the current environment, you can do the following:<\/p>\n<pre><code class=\"language-php\"> \n \/\/ Get current Website (Tenant)\n $website   = \\Hyn\\Tenancy\\Facades\\TenancyFacade::website();\n \n \/\/ prefered option\n $website   = app(\\Hyn\\Tenancy\\Environment::class)-&gt;tenant();\n \n \/\/ alternative (outdated) \n $website   = app(\\Hyn\\Tenancy\\Environment::class)-&gt;website();\n \n $websiteId = $website-&gt;id;\n \n \/\/ Get current Hostname\n $hostname  = app(\\Hyn\\Tenancy\\Environment::class)-&gt;hostname();\n \n \/\/ Get FQDN (Fully-Qualified Domain Name) by current hostname\n $fqdn      = $hostname-&gt;fqdn;\n\n \n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 18:34:01.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.6\/identification.md"},{"title":"Connections","icon":"fal fa-warehouse-alt","path":"docs\/hyn\/5.6\/connections.md","slug":"connections","package":"hyn","version":"5.6","contents":"<h1 id=\"database-connections\"><a href=\"#database-connections\" class=\"anchor-link\"><\/a>Database Connections<\/h1>\n<p>One of the core aspects of tenancy is the database connection. Tenancy\ngives you access to two key database connections; <code>tenant<\/code> and <code>system<\/code>.<\/p>\n<h2 id=\"system-connection\"><a href=\"#system-connection\" class=\"anchor-link\"><\/a>System Connection<\/h2>\n<p>Out of the box, the package gives you a <code>system<\/code> database connection which acts as\nthe master database where <code>hostnames<\/code> and <code>websites<\/code> are stored.<\/p>\n<p>If for some reason you need to create an Eloquent Model that would need to connect\nto the system connection, you can apply the <code>Hyn\\Tenancy\\Traits\\UsesSystemConnection<\/code>\ntrait on your given Model. In doing so, the model\u2019s connection will always default to use the <code>system<\/code>.<\/p>\n<p>One reason for using the <code>system<\/code> connection is for storing data which you'd like\nto share between all tenants or which you need to use to influence the tenant identification\nprocess. For instance when you are creating an admin portal that would manage all of your\ntenants in one place.<\/p>\n<h2 id=\"tenant-connection\"><a href=\"#tenant-connection\" class=\"anchor-link\"><\/a>Tenant Connection<\/h2>\n<p>This is maybe the most used database connection. Data in use by single tenant instances,\nnot shared with others, is persisted into the database using the <code>tenant<\/code> connection. The\nimplementation of the <code>tenant<\/code> connection ensures that no tenant can access another tenant's data.<\/p>\n<p>By using the <code>Hyn\\Tenancy\\Traits\\UsesTenantConnection<\/code> trait, the package will make sure\nthat it is using the right database connection.<\/p>\n<p>All tenant related models should use the <code>UsesTenantConnection<\/code> trait.<\/p>\n<h3 id=\"forcing-the-connection\"><a href=\"#forcing-the-connection\" class=\"anchor-link\"><\/a>Forcing The Connection<\/h3>\n<p>If you want to set the default connection to <code>tenant<\/code> (when a tenant website has been identified), you can use the snippet below.\nThis is also helpful for 3rd party packages models to force their connection to <code>tenant<\/code>.<\/p>\n<p>Add the following code to the <code>boot()<\/code> method of your <code>AppServiceProvider.php<\/code> file.<\/p>\n<pre><code class=\"language-php\">$env = app(Environment::class);\n\nif ($fqdn = optional($env-&gt;hostname())-&gt;fqdn) {\n    config(['database.default' =&gt; 'tenant']);\n}\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Please understand the risks involved of setting your default connection during runtime. All Eloquent models will from then on use the <code>tenant<\/code> connection instead of your previously configured default connection.<\/p><\/div>\n<hr \/>\n<p>More information about applying these connections can be found in the <a href=\"models\">models<\/a> article.<\/p>\n<h3 id=\"password-generation\"><a href=\"#password-generation\" class=\"anchor-link\"><\/a>Password generation<\/h3>\n<p>The password of the tenant is generated using several components mashed up as md5 hash.<\/p>\n<ul>\n<li>\n<code>tenancy.key<\/code> with a fallback to <code>app.key<\/code>. You can specify an empty string <code>&quot;&quot;<\/code> if you don't want to use this key.<\/li>\n<li>Website Id.<\/li>\n<li>Website UUID.<\/li>\n<li>Website created_at.<\/li>\n<\/ul>\n<p>In case you wish to change\/update the <code>tenancy.key<\/code> we provide a useful command <code>tenancy:key:update<\/code>\nwhich will update the tenant password with the new md5 value. This allows for easier key rotation.<\/p>\n","updated_at":{"date":"2020-07-18 18:34:01.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.6\/connections.md"},{"title":"Fallback","excerpt":"Configure a landing page using different approaches","icon":"fal fa-compass","path":"docs\/hyn\/5.6\/fallback.md","slug":"fallback","package":"hyn","version":"5.6","contents":"<p>There are several ways to organize a fallback domain. These are commonly used to offer\na landing page and\/or admin area for your clients to configure their tenant website.<\/p>\n<h1 id=\"disabling-abort-to-pass-through\"><a href=\"#disabling-abort-to-pass-through\" class=\"anchor-link\"><\/a>Disabling abort to pass through<\/h1>\n<p>By default a 404 not found is served whenever auto identification is enabled and no\nmatching hostname entry was found in the system database.<\/p>\n<p>You can disable this in the <code>tenancy.php<\/code> configuration file by setting the\n<code>abort-without-identified-hostname<\/code> option to <code>false<\/code>. This will prevent tenancy\nfrom throwing a 404 (not found) whenever it failed to identify a registered hostname.<\/p>\n<p>Depending on how you set up your app, the code will now pass through to any registered routes.\nFor applications that have global routes defined for tenant specific functionality, you'll\nrun into the issue that no &quot;tenant&quot; connection was defined.<\/p>\n<h1 id=\"tenant-routes-override\"><a href=\"#tenant-routes-override\" class=\"anchor-link\"><\/a>Tenant routes override<\/h1>\n<p>Whenever you create a file <code>routes\/tenants.php<\/code> and you have <code>tenancy.hostname.auto-identification<\/code>\nenabled, all routes contained in that file will automatically override any declared global routes\nfrom <code>routes\/web.php<\/code> or <code>routes\/api.php<\/code>. Make sure to apply the proper middleware to those routes.<\/p>\n<p>In case you enable <code>tenancy.routes.replace-global<\/code> all previously declared routes\nwill be removed and replaced with the contents of the <code>routes\/tenants.php<\/code> file.<\/p>\n<div class=\"alert alert-info\"><p>Understand unlike the default <code>web.php<\/code> and <code>api.php<\/code> files no group is set around this file. You need\nto apply your own <code>namespace<\/code>, <code>middleware<\/code> and other group settings inside the <code>tenants.php<\/code>.<\/p><\/div>\n<p>An example <code>routes\/tenants.php<\/code> file:<\/p>\n<pre><code class=\"language-php\">Route::middleware('web')\n    -&gt;namespace('App\\\\Http\\\\Controllers\\\\Tenant\\\\')\n    -&gt;group(function () \n{\n    Route::get('\/', 'HomeController');\n});\n<\/code><\/pre>\n<h1 id=\"routing-with-domain\"><a href=\"#routing-with-domain\" class=\"anchor-link\"><\/a>Routing with domain<\/h1>\n<p>One of the easiest solutions is using the <code>::domain()<\/code> option in routing called\n<a href=\"https:\/\/laravel.com\/docs\/7.x\/routing#route-group-sub-domain-routing\">sub domain routing in Laravel<\/a>.<\/p>\n<pre><code class=\"language-php\">Route::domain('master.your.app')-&gt;group(function () {\n    \/\/ .. your landing page routes\n});\n<\/code><\/pre>\n<h1 id=\"create-a-tenant-as-fallback\"><a href=\"#create-a-tenant-as-fallback\" class=\"anchor-link\"><\/a>Create a tenant as fallback<\/h1>\n<p>Another quick method is to simply seed a default tenant that has a specific\nhostname. Set the environment <code>TENANCY_DEFAULT_HOSTNAME<\/code> to the exact FQDN used\nfor that tenant.<\/p>\n<p>Now every time no other tenant was identified, it will revert to this tenant. A\ndrawback of this method is the need to set up a tenant hostname.<\/p>\n","updated_at":{"date":"2020-07-18 18:34:01.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.6\/fallback.md"},{"title":"Middleware","icon":"fal fa-shield-alt","excerpt":"Automatic actions per tenant","path":"docs\/hyn\/5.6\/middleware.md","slug":"middleware","package":"hyn","version":"5.6","contents":"<p>This package offers additional automation to make your life easier. Using\nmiddleware you can mutate how specific requests are handled.<\/p>\n<h1 id=\"maintenance\"><a href=\"#maintenance\" class=\"anchor-link\"><\/a>Maintenance<\/h1>\n<p>Set the property <code>under_maintenance_since<\/code> of the <code>hostname<\/code> to show a\nLaravel generic maintenance page.<\/p>\n<h1 id=\"redirection\"><a href=\"#redirection\" class=\"anchor-link\"><\/a>Redirection<\/h1>\n<p>Set the property <code>redirect_to<\/code> to a valid URL to automatically redirect all\nrequests to this hostname.<\/p>\n<h1 id=\"secure\"><a href=\"#secure\" class=\"anchor-link\"><\/a>Secure<\/h1>\n<p>Set the property <code>force_https<\/code> to <code>true<\/code> to force all connections on this\nhostname to be handled using a SSL encrypted connection.<\/p>\n<h1 id=\"abort\"><a href=\"#abort\" class=\"anchor-link\"><\/a>Abort<\/h1>\n<p>In case no tenant was identified the application will generate a default\nnot found page. You can disable this functionality globally in\nthe tenancy configuration file <code>hostname &gt; abort-without-identified-hostname<\/code>.<\/p>\n","updated_at":{"date":"2020-07-18 18:34:01.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.6\/middleware.md"}]},{"name":"implementation","links":["creating-tenants","models","structure"],"slug":"implementation","articles":[{"title":"Creating tenants","icon":"fal fa-dolly-flatbed","path":"docs\/hyn\/5.6\/creating-tenants.md","slug":"creating-tenants","package":"hyn","version":"5.6","contents":"<p>Tenancy is heavily driven by events. For event listeners to properly work, you\nhave to use the provided repositories to create new websites and hostnames.<\/p>\n<h1 id=\"create-website\"><a href=\"#create-website\" class=\"anchor-link\"><\/a>Create website<\/h1>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Models\\Website;\nuse Hyn\\Tenancy\\Contracts\\Repositories\\WebsiteRepository;\n\n$website = new Website;\napp(WebsiteRepository::class)-&gt;create($website);\ndd($website-&gt;uuid); \/\/ Unique id\n<\/code><\/pre>\n<h2 id=\"uuid\"><a href=\"#uuid\" class=\"anchor-link\"><\/a>UUID<\/h2>\n<p>Each website will be given a unique identifier automatically. To prevent\nguessing URLs and to add a slight increased level of security this is a\nrandom hash.<\/p>\n<p>The UUID is used for the database username and database name. In addition\nI'd recommend using this unique string for every public facing URL, eg\nan admin dashboard.<\/p>\n<p>By default this package will create a <code>uuid<\/code> automatically\nusing a UUID generator. You can replace that class in the\n<code>tenancy.php &gt; website &gt; random-id-generator<\/code>, as long as it implements\n<code>Hyn\\Tenancy\\Contracts\\Website\\UuidGenerator<\/code>.<\/p>\n<p>If you want to force your own UUID for the website, without creating a full\nfledged UUID generator, set the <code>uuid<\/code> property of your website before passing\nit to the repository.<\/p>\n<pre><code class=\"language-php\">$website = new Website;\n\/\/ Implement custom random hash using Laravels Str::random\n$website-&gt;uuid = Str::random(10);\napp(WebsiteRepository::class)-&gt;create($website);\ndd($website-&gt;uuid); \/\/ Random string of length 10\n<\/code><\/pre>\n<h2 id=\"managing-connection\"><a href=\"#managing-connection\" class=\"anchor-link\"><\/a>Managing connection<\/h2>\n<p>Whenever you are using multiple databases, to separate tenants over different\nregions for instance, you can easily specify the connection with which tenancy\nshould create, update and delete tenant databases and users.<\/p>\n<pre><code class=\"language-php\">$website = new Website;\n$website-&gt;managed_by_database_connection = 'system.asia';\napp(WebsiteRepository::class)-&gt;create($website);\n\/\/ Information of website is stored in the default system connection,\n\/\/ the tenant database is created using the system.asia connection.\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Make sure the provided connection name is configured in your <code>config\/database.php<\/code>.<\/p><\/div>\n<h1 id=\"create-and-connect-hostname\"><a href=\"#create-and-connect-hostname\" class=\"anchor-link\"><\/a>Create and connect hostname<\/h1>\n<p>A hostname allows the package to map a requested hostname to a website. Websites\nthat have no (active) hostnames connected to it will never be visible. So make\nsure to connect a hostname to any tenant website you'd like to work on.<\/p>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Models\\Hostname;\nuse Hyn\\Tenancy\\Contracts\\Repositories\\HostnameRepository;\n\n$hostname = new Hostname;\n$hostname-&gt;fqdn = 'luceos.demo.app';\n$hostname = app(HostnameRepository::class)-&gt;create($hostname);\napp(HostnameRepository::class)-&gt;attach($hostname, $website);\ndd($website-&gt;hostnames); \/\/ Collection with $hostname\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>The <code>fqdn<\/code> property of the hostname is crucial. It stands for\nFully Qualified Domain Name and can be something like <code>yourapp.com<\/code> or\n<code>demo.yourapp.com<\/code> but can never include protocol (eg <code>http:\/\/<\/code>) or paths\n(eg <code>yourapp.com\/tenant<\/code>).<\/p><\/div>\n<h1 id=\"switch-to-new-tenant\"><a href=\"#switch-to-new-tenant\" class=\"anchor-link\"><\/a>Switch to new tenant<\/h1>\n<p>For the package to set up Laravel for the specific tenant, the environment has to be\n&quot;switched&quot;. This switching will set up things like the tenant database connection and\nfilesystem logic like custom config files.<\/p>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Environment;\n$tenancy = app(Environment::class);\n\n$tenancy-&gt;hostname($hostname);\n\n$tenancy-&gt;hostname(); \/\/ resolves $hostname as currently active hostname\n\n$tenancy-&gt;tenant($website); \/\/ switches the tenant and reconfigures the app\n\n$tenancy-&gt;website(); \/\/ resolves $website\n$tenancy-&gt;tenant(); \/\/ resolves $website\n\n$tenancy-&gt;identifyHostname(); \/\/ resets resolving $hostname by using the Request\n<\/code><\/pre>\n<h1 id=\"querying\"><a href=\"#querying\" class=\"anchor-link\"><\/a>Querying<\/h1>\n<p>In case you would like to query the database for hostnames or websites. Use the\n<code>query()<\/code> method of the repositories, this will return a <a href=\"https:\/\/laravel.com\/docs\/7.x\/queries\"><code>Illuminate\\Database\\Eloquent\\Builder<\/code><\/a>\ninstance.<\/p>\n","updated_at":{"date":"2020-07-18 18:34:01.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.6\/creating-tenants.md"},{"title":"Models","icon":"fal fa-hand-holding-box","path":"docs\/hyn\/5.6\/models.md","slug":"models","package":"hyn","version":"5.6","contents":"<p>Tenancy offers a few ways to more easily connect with the correct database.<\/p>\n<h4 id=\"traits\"><a href=\"#traits\" class=\"anchor-link\"><\/a>Traits<\/h4>\n<p>Two traits exist to force a model onto either the <code>tenant<\/code> or <code>system<\/code> connection.<\/p>\n<ul>\n<li>\n<code>Hyn\\Tenancy\\Traits\\UsesSystemConnection<\/code> to make a model use the system connection.<\/li>\n<li>\n<code>Hyn\\Tenancy\\Traits\\UsesTenantConnection<\/code> to make a model use the tenant connection.<\/li>\n<\/ul>\n<p>The below snippet shows an example of how to force the User model to use the tenant\nconnection.<\/p>\n<pre><code class=\"language-php\">namespace App;\n\nuse Hyn\\Tenancy\\Traits\\UsesTenantConnection;\nuse Illuminate\\Notifications\\Notifiable;\nuse Illuminate\\Foundation\\Auth\\User as Authenticatable;\n\nclass User extends Authenticatable\n{\n    use Notifiable, UsesTenantConnection;\n    \n    \/\/ ..\n}\n<\/code><\/pre>\n<h4 id=\"abstract-models\"><a href=\"#abstract-models\" class=\"anchor-link\"><\/a>Abstract models<\/h4>\n<p>Instead of using the traits directly one can also simply have the models extend the abstract\nmodels provided in the package.<\/p>\n<ul>\n<li>\n<code>Hyn\\Tenancy\\Abstracts\\SystemModel<\/code> can be extended to give easy access to\nthe system database connection.<\/li>\n<li>\n<code>Hyn\\Tenancy\\Abstracts\\TenantModel<\/code> can be extended to have your Eloquent models\nuse the connection of the identified tenant per default.<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>Please note these abstract models are using the respective traits mentioned above.<\/p><\/div>\n<h4 id=\"relationships\"><a href=\"#relationships\" class=\"anchor-link\"><\/a>Relationships<\/h4>\n<p>Model eloquent relations are possible from tenant to system and vice versa. One thing to remember\nwith intermediate tables involved, for instance on the belongsToMany relationship, is that you can\nprefix the intermediate table with the connection.<\/p>\n<p>For instance, when you have your User model on the system database - acting as a global user - you can\nstore the user roles on the tenant database by prefixing that intermediate table with the tenant database\nname and assigning the Role model to the tenant connection.<\/p>\n<pre><code class=\"language-php\">    public function roles() {\n        $config = app(\\Hyn\\Tenancy\\Database\\Connection::class)-&gt;configuration();\n        return $this-&gt;belongsToMany('App\\Role', &quot;{$config['database']}.role_user&quot;);\n    }\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>This only works if tenant databases are on the same server as the system database! You cannot\nuse the managing system connection feature in this scenario.<\/p><\/div>\n","updated_at":{"date":"2020-07-18 18:34:01.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.6\/models.md"},{"title":"Structure","icon":"fal fa-sitemap","path":"docs\/hyn\/5.6\/structure.md","slug":"structure","package":"hyn","version":"5.6","contents":"<h1 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h1>\n<p>The location of the tenant specific files is configured inside the <code>config\/tenancy.php<\/code>\nfile under <code>website &gt; disk<\/code>. By default tenant files\nare stored in <code>storage\/app\/tenancy\/tenants<\/code>.<\/p>\n<p>Inside this tenant directory you are able to override global logic by\ngenerating the necessary files. Check the <code>config\/tenancy.php<\/code> file under\n<code>folders<\/code> to see which ones are enabled by default.<\/p>\n<h2 id=\"config\"><a href=\"#config\" class=\"anchor-link\"><\/a>Config<\/h2>\n<p>Any php files stored inside a <code>config\/<\/code> directory of the tenant are read\nduring runtime. Existing configuration values are replaced and new ones\nare appended.<\/p>\n<p>A great use case for this feature is the ability to configure client\nspecific mail settings.<\/p>\n<p>The <code>config\/tenancy.php<\/code> configuration file allows you to refuse overrides of specific\nconfiguration settings using the <code>folders &gt; config &gt; blacklist<\/code> setting.\nBy default it disallows database, tenancy and webserver changes.<\/p>\n<h2 id=\"routes\"><a href=\"#routes\" class=\"anchor-link\"><\/a>Routes<\/h2>\n<p>Create a <code>routes.php<\/code> file inside your tenant directory to configure\nnew routes during runtime. Using a configurable prefix, any unique\nurl's will be matched for this specific tenant only.<\/p>\n<h2 id=\"trans\"><a href=\"#trans\" class=\"anchor-link\"><\/a>Trans<\/h2>\n<p>New translations can be added easily by creating a <code>lang\/<\/code> folder.\nThe native Laravel translator will parse any files contained here\nto be used in the application of this specific tenant.<\/p>\n<p>You are able to specify whether these language files should override\nthe global, system-wide translation. In case you decide against that\nfeel free to set up a translation namespace.<\/p>\n<h2 id=\"views\"><a href=\"#views\" class=\"anchor-link\"><\/a>Views<\/h2>\n<p>Additional or overriding views is possible by creating a <code>views\/<\/code> folder\ninside the tenant directory. There are three possible scenarios to\nconfigure how views are picked up by Laravel:<\/p>\n<ol>\n<li>By adding views inside the global namespace, overriding existing\nglobal views.<\/li>\n<li>By adding views inside the global namespace, but where existing\nglobal views take precedence.<\/li>\n<li>By adding views inside their own namespace.<\/li>\n<\/ol>\n<h2 id=\"vendor\"><a href=\"#vendor\" class=\"anchor-link\"><\/a>Vendor<\/h2>\n<p>A very powerful addition is the ability to inject new packages and code.\nWhenever the tenant directory has a <code>vendor\/autoload.php<\/code> file it will\nbe loaded during runtime. Using that specific file allows you to fully\nutilize the power of composer inside your tenant directories.<\/p>\n<div class=\"alert alert-info\"><p>Please be aware that no compatibility checks are executed against your app.\nIdentifying whether a composer conflict could happen is something you should test\noutside production environments.<\/p><\/div>\n<h2 id=\"media\"><a href=\"#media\" class=\"anchor-link\"><\/a>Media<\/h2>\n<p>The media folder can be used by creating a <code>media\/<\/code> folder inside the\ntenant directory. Files inside that directory will become automatically\navailable as a public directory inside an equally named directory <code>media\/<\/code>.<\/p>\n<p>Eg: storing a file <code>media\/bg.jpg<\/code> will allow you to use <code>\/media\/bg.jpg<\/code> inside\nyour html. This applies to any file you store.<\/p>\n<h3 id=\"media-webserver\"><a href=\"#media-webserver\" class=\"anchor-link\"><\/a>\/media webserver<\/h3>\n<p>An alias is set up binding the private tenant media directory to the public\nmedia directory. This is implemented using the auto generated web server\nconfiguration files for apache and nginx.<\/p>\n<h3 id=\"media-fallback-controller\"><a href=\"#media-fallback-controller\" class=\"anchor-link\"><\/a>\/media fallback controller<\/h3>\n<p>In case you're not using the webserver vhost configuration files provided\nby this package you can choose to map the <code>MediaController<\/code> to the path, eg:<\/p>\n<pre><code class=\"language-php\">Route::get('\/media\/{path}', '\\Hyn\\Tenancy\\Controllers\\MediaController')\n    -&gt;where('path', '.+')\n    -&gt;name('tenant.media');\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 18:34:01.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.6\/structure.md"}]},{"name":"tenant aware","links":["filesystem","migrations","validation","queues","events","cache","commands"],"slug":"tenant-aware","articles":[{"title":"Filesystem","icon":"fal fa-hdd","path":"docs\/hyn\/5.6\/filesystem.md","slug":"filesystem","package":"hyn","version":"5.6","contents":"<p>Tenancy offers a strategic <a href=\"structure\">directory structure<\/a> for tenants.<\/p>\n<h1 id=\"tenant-disk\"><a href=\"#tenant-disk\" class=\"anchor-link\"><\/a>Tenant disk<\/h1>\n<p>To access the directory of the active tenant, you can use the <code>tenant<\/code> disk.<\/p>\n<pre><code class=\"language-php\">Storage::disk('tenant')-&gt;put('readme.md', 'Hi John.');\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Tenants files are by default stored to <code>storage\/app\/tenancy<\/code>, but this can be reconfigured\nin the <code>tenancy.php<\/code> under <code>website &gt; disk<\/code>.<\/p><\/div>\n<p>Read more about disks on the <a href=\"https:\/\/laravel.com\/docs\/7.x\/filesystem\">Laravel documentation<\/a>.<\/p>\n<h1 id=\"directory\"><a href=\"#directory\" class=\"anchor-link\"><\/a>Directory<\/h1>\n<p>In order to assist with mutating these contents, you can use the\nDirectory class available in this package.<\/p>\n<pre><code class=\"language-php\">$directory = app(\\Hyn\\Tenancy\\Website\\Directory::class);\n<\/code><\/pre>\n<p>This class is set to use the tenant currently active, but also allows you to activate\nany other tenant whenever you need to use the <code>setWebsite(Website $website)<\/code> method.<\/p>\n<p>The Directory class implements <code>Illuminate\\Contracts\\Filesystem\\Filesystem<\/code> which offers\nthe same methods you are used to, including; <code>get<\/code>, <code>put<\/code> and <code>setVisibility<\/code>.<\/p>\n<h1 id=\"tenancy-directory\"><a href=\"#tenancy-directory\" class=\"anchor-link\"><\/a>Tenancy directory<\/h1>\n<p>In case you prefer having a higher level access to the files for tenants you can use the Filesystem bound to Laravel's container.<\/p>\n<pre><code class=\"language-php\">\/** @var \\Illuminate\\Contracts\\Filesystem\\Filesystem $tenancy *\/\n$tenancy = app('tenancy.disk');\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 18:34:01.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.6\/filesystem.md"},{"title":"Migrations","icon":"fal fa-pallet-alt","path":"docs\/hyn\/5.6\/migrations.md","slug":"migrations","package":"hyn","version":"5.6","contents":"<p>Migrations are extremely important in the Laravel ecosystem.\nMigration commands for tenants have the Artisan prefix <code>tenancy:<\/code>.<\/p>\n<h1 id=\"about-the-databasemigrations-path\"><a href=\"#about-the-databasemigrations-path\" class=\"anchor-link\"><\/a>About the database\/migrations path<\/h1>\n<p>It's not wise to store the tenants migrations inside your global\n<code>database\/migrations<\/code> directory. Laravel by default runs these migrations\nwhen calling the <code>php artisan migrate<\/code> command. Even though you can suggest\na connection during that command, it's much cleaner to store these migrations\ninside a separate directory, e.g. <code>database\/migrations\/tenant<\/code>.\nThe migrations for the system database can stay in <code>database\/migrations<\/code>.<\/p>\n<h1 id=\"default-migrations-for-new-tenants\"><a href=\"#default-migrations-for-new-tenants\" class=\"anchor-link\"><\/a>Default migrations for new tenants<\/h1>\n<p>If you want new tenants to be migrated by default, you can easily do so. In\nyour <code>tenancy.php<\/code> configuration set <code>db &gt; tenant-migrations-path<\/code> to a valid\nabsolute path and all your new tenants will run these migrations by default.<\/p>\n<pre><code class=\"language-php\">  \/\/ ..\n  &quot;tenant-migrations-path&quot; =&gt; database_path('migrations\/tenant'),\n  \/\/ ..\n<\/code><\/pre>\n<h1 id=\"default-seeds-for-newly-auto-migrated-tenants\"><a href=\"#default-seeds-for-newly-auto-migrated-tenants\" class=\"anchor-link\"><\/a>Default seeds for newly auto-migrated tenants<\/h1>\n<p>In case you would also like to seed the databases of your newly created\nand migrated tenants, you can enable <code>db &gt; tenant-seed-class<\/code> in your <code>tenancy.php<\/code>\nconfiguration file. Change this setting to a fully namespaced class name\nand the package will automatically run this seed after it has run the\nautomatic migrations.<\/p>\n<h1 id=\"migration-related-commands\"><a href=\"#migration-related-commands\" class=\"anchor-link\"><\/a>Migration related commands<\/h1>\n<p>Tenancy is also able to run migrations through Artisan commands.<\/p>\n<p>Tenancy has added the <code>--website_id[=WEBSITE_ID]<\/code> option to each of the following native Laravel migrate and seed\ncommand and namespaced it accordingly, for instance.<\/p>\n<ul>\n<li>\n<code>tenancy:migrate<\/code> - Run the database migrations<\/li>\n<li>\n<code>tenancy:migrate:refresh<\/code> - Reset and re-run all migrations<\/li>\n<li>\n<code>tenancy:migrate:reset<\/code> - Rollback all database migrations<\/li>\n<li>\n<code>tenancy:migrate:rollback<\/code> - Rollback the last database migration<\/li>\n<li>\n<code>tenancy:db:seed<\/code> - Seed the database with records<\/li>\n<\/ul>\n<p>The --website_id optional option accepts multiple values. Though optional, if you leave the option out it will\nrun the command against all tenants. For example:<\/p>\n<ul>\n<li>\n<code>php artisan tenancy:migrate --website_id=1<\/code> to migrate just tenant website 1.<\/li>\n<li>\n<code>php artisan tenancy:migrate --website_id=1 --website_id=2<\/code> to migrate tenant website 1 &amp; 2.<\/li>\n<li>\n<code>php artisan tenancy:migrate<\/code> to migrate all tenant websites.<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>The <code>website_id<\/code> reflects the auto incremented <code>id<\/code> column of the Website and <strong>NOT<\/strong> the UUID.<\/p><\/div>\n<p>Please check the separate signatures for more information of valid arguments\nand options.<\/p>\n<div class=\"alert alert-info\"><p>Running <code>tenancy:migrate<\/code> without any path or realpath option and\nwithout having configured <code>tenant-migrations-path<\/code> will migrate your\ntenants with the files inside the <code>database\/migrations<\/code> directory.<\/p><\/div>\n<h1 id=\"reconstructing-tenant-databases\"><a href=\"#reconstructing-tenant-databases\" class=\"anchor-link\"><\/a>Reconstructing tenant databases<\/h1>\n<p>As long as your system database is intact, there's a way to recreate all tenant databases. You can use the <code>tenancy:recreate<\/code> artisan command to recreate all tenant databases that do not exist. The command will run the migrations and seeds according to your configuration in <code>tenancy.php<\/code>.<\/p>\n<div class=\"alert alert-info\"><p>Though the structure of all of your tenant databases will be recreated, the data in it won't.<\/p><\/div>\n","updated_at":{"date":"2020-07-18 18:34:01.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.6\/migrations.md"},{"title":"Validations","icon":"fal fa-file-check","path":"docs\/hyn\/5.6\/validation.md","slug":"validation","package":"hyn","version":"5.6","contents":"<h2 id=\"exists-and-unique-validation-rule\"><a href=\"#exists-and-unique-validation-rule\" class=\"anchor-link\"><\/a>Exists and Unique Validation Rule<\/h2>\n<p>Among all the built-in validation in Laravel, only the <a href=\"https:\/\/laravel.com\/docs\/7.x\/validation#rule-exists\">exists<\/a> and <a href=\"https:\/\/laravel.com\/docs\/7.x\/validation#rule-unique\">unique<\/a> validation rules interact with the database.<\/p>\n<p>We can leverage these two rules with tenancy by adding the connection parameter. Both use the same validation rule\nsignature which is <code>rule:connection.table,column<\/code>.<\/p>\n<p>So for example, to use <code>Exists (Database)<\/code> use <code>'email' =&gt; 'exists:tenant.staff,email'<\/code> where <code>tenant<\/code> is the <code>'tenant-connection-name'<\/code> you specified in your <code>tenancy.php<\/code> config file.<\/p>\n<p>Similarly, you can substitute the <code>exists<\/code> keyword to <code>unique<\/code> to use the <code>unique<\/code> rule instead, eg: <code>'email' =&gt; 'unique:tenant.staff,email'<\/code>.<\/p>\n<div class=\"alert alert-info\"><p>Validating against the system database is possible using the method described above but replacing <code>tenant<\/code> with <code>system<\/code>.<\/p><\/div>\n","updated_at":{"date":"2020-07-18 18:34:01.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.6\/validation.md"},{"title":"Queues","icon":"fal fa-conveyor-belt","path":"docs\/hyn\/5.6\/queues.md","slug":"queues","package":"hyn","version":"5.6","contents":"<p>One of the strongest features of Laravel is its queues. One drawback of sending\nJobs into the Queue is that these are executed in a completely different process\ndepending on your queue configuration, including redis and beanstalk.<\/p>\n<p>In order to assist you with tenant aware jobs, this package automatically identifies\nwhether a tenant website is active before processing the job. This ensures that\njobs are always tenant aware. In case you wish to override the tenant for which the job\nis executed, make sure to set the <code>website_id<\/code> property on the Job before dispatching it.<\/p>\n<pre><code class=\"language-php\">namespace App\\Jobs;\n\nuse Illuminate\\Bus\\Queueable;\nuse Illuminate\\Queue\\InteractsWithQueue;\nuse Illuminate\\Contracts\\Queue\\ShouldQueue;\nuse Illuminate\\Foundation\\Bus\\Dispatchable;\nuse Illuminate\\Queue\\SerializesModels;\n\nclass ProcessPodcast implements ShouldQueue\n{\n    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;\n    \n    public $website_id;\n    \n    public function __construct(int $website_id) {\n        $this-&gt;website_id = $website_id;\n    }\n}\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 18:34:01.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.6\/queues.md"},{"title":"Events","icon":"fal fa-hourglass-end","path":"docs\/hyn\/5.6\/events.md","slug":"events","package":"hyn","version":"5.6","contents":"<p>To create a fluid ecosystem around Laravel, this package uses events heavily.<\/p>\n<div class=\"alert alert-info\"><p>It's highly recommended to read up on the native <a href=\"https:\/\/laravel.com\/docs\/7.x\/events\">events<\/a> in Laravel.<\/p><\/div>\n<h1 id=\"model-events\"><a href=\"#model-events\" class=\"anchor-link\"><\/a>Model events<\/h1>\n<p>Namespaces:<\/p>\n<ul>\n<li>\n<code>Hyn\\Tenancy\\Events\\Hostnames<\/code>\n<\/li>\n<li>\n<code>Hyn\\Tenancy\\Events\\Websites<\/code>\n<\/li>\n<\/ul>\n<p>All of the models have the following events, whose purposes mirror Laravel's own model events.<\/p>\n<ul>\n<li>Creating<\/li>\n<li>Created<\/li>\n<li>Updating<\/li>\n<li>Updated<\/li>\n<li>Deleting<\/li>\n<li>Deleted<\/li>\n<\/ul>\n<h2 id=\"websites\"><a href=\"#websites\" class=\"anchor-link\"><\/a>Websites<\/h2>\n<p>Namespace: <code>Hyn\\Tenancy\\Events\\Websites<\/code>.<\/p>\n<ul>\n<li>Identified: a tenant website was identified.<\/li>\n<li>NoneFound: no tenant website was identified.<\/li>\n<li>Migrated: a website was auto migrated (not fired from console commands).<\/li>\n<li>Switched: the current tenant website was changed.<\/li>\n<\/ul>\n<h2 id=\"hostnames\"><a href=\"#hostnames\" class=\"anchor-link\"><\/a>Hostnames<\/h2>\n<p>Namespace: <code>Hyn\\Tenancy\\Events\\Hostnames<\/code>.<\/p>\n<p>The hostname model has a few additional events:<\/p>\n<ul>\n<li>Attached: the hostname was attached to a website.<\/li>\n<li>Detached: the hostname was removed from a website.<\/li>\n<li>Identified: the hostname is identified based on the request.<\/li>\n<li>NoneFound: no hostname was found during identification.<\/li>\n<li>Redirected: the hostname is configured to redirect to another url.<\/li>\n<li>Secured: the hostname is configured to upgrade the request to https.<\/li>\n<li>Switched: currently active hostname was changed.<\/li>\n<li>UnderMaintenance: the hostname is configured to be in maintenance.<\/li>\n<\/ul>\n<h1 id=\"database\"><a href=\"#database\" class=\"anchor-link\"><\/a>Database<\/h1>\n<p>Namespace: <code>Hyn\\Tenancy\\Events\\Database<\/code>.<\/p>\n<ul>\n<li>Creating<\/li>\n<li>Created<\/li>\n<li>Deleting<\/li>\n<li>Deleted<\/li>\n<li>Renaming<\/li>\n<li>Renamed<\/li>\n<li>ConfigurationLoading: the configuration for a tenant database connection\nis loading.<\/li>\n<li>ConfigurationLoaded: the configuration for a tenant database connection\nwas loaded.<\/li>\n<li>ConnectionSet: a connection was set and possibly an old one purged.<\/li>\n<\/ul>\n<h1 id=\"webservers\"><a href=\"#webservers\" class=\"anchor-link\"><\/a>Webservers<\/h1>\n<p>Namespace: <code>Hyn\\Tenancy\\Events\\Webservers<\/code>.<\/p>\n<ul>\n<li>ConfigurationSaved: the configuration for the webserver was saved to disk.<\/li>\n<\/ul>\n","updated_at":{"date":"2020-07-18 18:34:01.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.6\/events.md"},{"title":"Cache","icon":"fal fa-window-restore","path":"docs\/hyn\/5.6\/cache.md","slug":"cache","package":"hyn","version":"5.6","contents":"<p>Currently the Laravel cache will use the same cache key for all tenants.\nThis can and will cause issues in the long run. The config key for tenants\nshould be automatically changed and the ability to disable overriding the cache key should be configurable inside <code>tenancy.php<\/code>.<\/p>\n<p>The following is an easy implementation to allow per-tenant prefixes.<\/p>\n<p>Add a <code>CacheServiceProvider<\/code> with these contents in boot method:<\/p>\n<pre><code class=\"language-php\">public function boot()\n{\n    Cache::extend('redis_tenancy', function ($app) {\n        if (PHP_SAPI === 'cli') {\n            $uuid = $app['config']['driver'];\n        } else {\n            \/\/ ok, this is basically a hack to set the redis cache store\n            \/\/ prefix to the UUID of the current website being called\n            $fqdn = request()-&gt;getHost();\n\n            $uuid = DB::table('hostnames')\n                -&gt;select('websites.uuid')\n                -&gt;join('websites', 'hostnames.website_id', '=', 'websites.id')\n                -&gt;where('fqdn', $fqdn)\n                -&gt;value('uuid');\n        }\n\n        return Cache::repository(new RedisStore(\n            $app['redis'],\n            $uuid,\n            $app['config']['cache.stores.redis.connection']\n        ));\n    });\n}\n<\/code><\/pre>\n<p>This does not require a new Cache driver, as it's re-using\nthe existing Redis driver. All this does is override the default prefix and\nallows you to set a custom cache driver in <code>config\/cache.php<\/code>:<\/p>\n<pre><code class=\"language-php\">'redis' =&gt; [\n    'driver'     =&gt; 'redis_tenancy',\n    'connection' =&gt; 'default',\n],\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Make sure the CacheServiceProvider is registered in <code>config\/app.php<\/code> or else your driver will\nnot be available for use.<\/p><\/div>\n","updated_at":{"date":"2020-07-18 18:34:01.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.6\/cache.md"},{"title":"Commands","icon":"fal fa-screwdriver","path":"docs\/hyn\/5.6\/commands.md","slug":"commands","package":"hyn","version":"5.6","contents":"<p>Aside from the tenant aware <a href=\"migrations\">migration<\/a> command, the following\nis a list of additional commands provided by this package.<\/p>\n<h1 id=\"run-proxy-command\"><a href=\"#run-proxy-command\" class=\"anchor-link\"><\/a>Run proxy command<\/h1>\n<p>If you'd like to run any command for a tenant, you can use the <code>tenancy:run<\/code> command.<\/p>\n<p>You can execute and check the signature with<\/p>\n<pre><code class=\"language-bash\">$ php artisan tenancy:run --help\n<\/code><\/pre>\n<p>How it works:<\/p>\n<ul>\n<li>Using the <code>--tenant<\/code> option is optional. If you leave it out the command will be run on all tenants.<\/li>\n<li>The <code>--tenant<\/code> option accepts either a single website id or a comma separated list of website ids.<\/li>\n<li>If your target command requires options or arguments, you can add them like this:<\/li>\n<\/ul>\n<pre><code class=\"language-bash\">$ php artisan tenancy:run &lt;command&gt; --option=&quot;key=value&quot; --option=&quot;live=1&quot; --argument=&quot;key=value&quot;\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Make sure you include the argument or option key!<\/p><\/div>\n<p>Example:<\/p>\n<p>Execute Artisan command permission:update for website id 2 and 3<\/p>\n<pre><code class=\"language-bash\">php artisan tenancy:run permission:update --tenant=2,3\n<\/code><\/pre>\n<p>Please note this command does not do any checking and will forward any exceptions it hits.<\/p>\n<p>Also, <strong>don't<\/strong> run tenancy:run like this:<\/p>\n<pre><code class=\"language-bash\">$ php artisan tenancy:run tenancy:run --argument=&quot;run=tenancy:run&quot;\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Note: <code>tenancy:run<\/code> should not be called when running migrations. Use the <code>tenancy:migrate<\/code> command instead.<\/p><\/div>\n<h1 id=\"programmatic-artisan-calls\"><a href=\"#programmatic-artisan-calls\" class=\"anchor-link\"><\/a>Programmatic Artisan calls<\/h1>\n<pre><code class=\"language-php\">Artisan::call('tenancy:run', [\n        'run' =&gt; 'permission:update',\n        '--tenant' =&gt; [1,2,3]\n        ]);\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Make sure --tenant value is always an array. An integer value will fail.<\/p><\/div>\n<h1 id=\"recreate-command\"><a href=\"#recreate-command\" class=\"anchor-link\"><\/a>Recreate command<\/h1>\n<p>The recreate command allows you to create databases and filesystem directories for\nall tenants. It will check whether each tenant database already exists, create it if necessary\nand then dispatch a &quot;Created&quot; event that causes the folders and possible vhost configurations\nto be made.<\/p>\n<pre><code class=\"language-bash\">$ php artisan tenancy:recreate\n<\/code><\/pre>\n<h1 id=\"tenant-aware-tinker-command\"><a href=\"#tenant-aware-tinker-command\" class=\"anchor-link\"><\/a>Tenant Aware Tinker Command<\/h1>\n<p>This section describes how to enable tenant awareness for the native Laravel <code>tinker<\/code> command.<\/p>\n<p>First, create a trait named <code>MutatesTinkerCommand<\/code> with the following content:<\/p>\n<pre><code class=\"language-php\">namespace App\\Traits;\n\nuse Hyn\\Tenancy\\Contracts\\Repositories\\WebsiteRepository;\nuse Hyn\\Tenancy\\Database\\Connection;\nuse Illuminate\\Database\\Eloquent\\ModelNotFoundException;\nuse Symfony\\Component\\Console\\Exception\\RuntimeException;\nuse Symfony\\Component\\Console\\Input\\InputOption;\n\ntrait MutatesTinkerCommand\n{\n    \/**\n     * @var Connection\n     *\/\n    private $connection;\n\n    \/**\n     * @var WebsiteRepository\n     *\/\n    private $websites;\n\n    public function __construct()\n    {\n        parent::__construct();\n        $this-&gt;setName('tenancy:' . $this-&gt;getName());\n        $this-&gt;websites = app(WebsiteRepository::class);\n        $this-&gt;connection = app(Connection::class);\n    }\n\n    \/**\n     * Execute the console command.\n     *\n     * @return void\n     *\n     * @throws \\Hyn\\Tenancy\\Exceptions\\ConnectionException\n     *\/\n    public function handle()\n    {\n        $website_id = $this-&gt;option('website_id');\n        try{\n            $website = $this-&gt;websites-&gt;query()-&gt;where('id', $website_id)-&gt;firstOrFail();\n            $this-&gt;connection-&gt;set($website);\n            $this-&gt;info('Running Tinker on website_id: ' . $website_id);\n\n            parent::handle();\n            \n            $this-&gt;connection-&gt;purge();\n        } catch (ModelNotFoundException $e) {\n            throw new RuntimeException(sprintf('The tenancy website_id=%d does not exist.', $website_id));\n        }\n    }\n\n    protected function getOptions()\n    {\n        return array_merge([$this-&gt;addWebsiteOption()], parent::getOptions());\n    }\n\n    protected function addWebsiteOption()\n    {\n        return ['website_id', null, InputOption::VALUE_REQUIRED, 'The tenancy website_id (not uuid) to tinker specifically.', null];\n    }\n}\n<\/code><\/pre>\n<p>You can only tinker on one database at a time. Therefore the <code>website_id<\/code> needs to be a required option. Utilizing the <code>AddWebsiteFilterOnCommand<\/code> trait available in the Tenancy package would not work in this instance as it is tailored to run processes on multiple websites and makes the <code>website_id<\/code> parameter optional.<\/p>\n<p>Second, create a new console command <code>TinkerCommand<\/code> that uses the trait above.<\/p>\n<pre><code class=\"language-php\">namespace App\\Console\\Commands;\n\nuse Laravel\\Tinker\\Console\\TinkerCommand as BaseCommand;\nuse App\\Traits\\MutatesTinkerCommand;\n\nclass TinkerCommand extends BaseCommand\n{\n    use MutatesTinkerCommand;\n}\n<\/code><\/pre>\n<p>Now we have created a new <code>tenancy:tinker<\/code> artisan command. The <code>tenancy:tinker<\/code> requires the <code>--website_id=<\/code> option as a parameter. So, in order to run tinker on a <code>website_id<\/code> of 1, you\u2019ll need to run:<\/p>\n<pre><code class=\"language-bash\">$ php artisan tenancy:tinker --website_id=1\n\nRunning Tinker on website_id: 1\nPsy Shell v0.9.6 (PHP 7.2.7 \u2014 cli) by Justin Hileman\n&gt;&gt;&gt;\n<\/code><\/pre>\n<p>It will throw an error if the <code>--website_id=<\/code> option is missing:<\/p>\n<pre><code class=\"language-bash\">$ php artisan tenancy:tinker\n\n\n  The tenancy website_id=0 does not exist.\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 18:34:01.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.6\/commands.md"}]},{"name":"customization","links":["custom-models","logging"],"slug":"customization","articles":[{"title":"Custom system models","icon":"fal fa-theater-masks","path":"docs\/hyn\/5.6\/custom-models.md","slug":"custom-models","package":"hyn","version":"5.6","contents":"<p>This package allows you to specify different models to be used for the\nHostname and Website models. Tenancy will take care of the relationships on the\npackage-end. You also need to implement <code>Hyn\\Tenancy\\Contracts\\{Model}<\/code><\/p>\n<p>Take this example:<\/p>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Contracts\\Website as Contract;\n\nclass Website implements Contract\n{\n}\n<\/code><\/pre>\n<p>All you need to do is update the <code>tenancy.php<\/code> configuration file:<\/p>\n<pre><code class=\"language-php\">return [\n  'models' =&gt; [\n      \/\/ ..\n      \/\/ Must implement \\Hyn\\Tenancy\\Contracts\\Hostname\n      'hostname' =&gt; \\Hyn\\Tenancy\\Models\\Hostname::class,\n      \/\/ Must implement \\Hyn\\Tenancy\\Contracts\\Website\n      'website' =&gt; \\App\\Website::class\n  ],\n  \/\/ ...\n];\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 18:34:01.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.6\/custom-models.md"},{"title":"Logging","icon":"fal fa-book","path":"docs\/hyn\/5.6\/logging.md","slug":"logging","package":"hyn","version":"5.6","contents":"<p>Especially in production you might want to split the default Laravel log by tenants.\nTenancy ships with a custom tenant aware logger which you can register in the <code>logging.php<\/code> config.<\/p>\n<ul>\n<li>If a tenant is detected it will create a <code>logs<\/code> folder within the tenant directory:\n<code>storage\/app\/tenancy\/tenants\/&lt;tenant uuid&gt;\/logs\/&lt;log_level&gt;_&lt;YYYY&gt;-&lt;MM&gt;-&lt;DD&gt;.log<\/code>\n<\/li>\n<li>If no tenant is detected it will store the log file to:\n<code>storage\/logs\/<\/code>.<\/li>\n<\/ul>\n<p>Add a new <code>tenant<\/code> channel to the channels array in your <code>config\/logging.php<\/code> like below:<\/p>\n<pre><code class=\"language-php\">\/\/ ...\n'channels' =&gt; [\n        \/\/ ...\n        'tenant' =&gt; [\n            'driver' =&gt; 'custom',\n            'via' =&gt; \\Hyn\\Tenancy\\Logging\\TenantAwareLogger::class,\n            'level' =&gt; 'debug',\n        ],\n\/\/ ...\n<\/code><\/pre>\n<p>Then just change the 'single' channel to 'tenant' channel your stack channel:<\/p>\n<pre><code class=\"language-php\">\/\/ ...\n'stack' =&gt; [\n            'driver' =&gt; 'stack',\n            'channels' =&gt; ['tenant'],\n        ],\n\/\/ ...\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 18:34:01.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.6\/logging.md"}]},{"name":"webserver","links":["apache","nginx"],"slug":"webserver","articles":[{"title":"Apache","icon":"fal fa-server","path":"docs\/hyn\/5.6\/apache.md","slug":"apache","package":"hyn","version":"5.6","contents":"<h1 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h1>\n<p>Tenancy natively integrates with the Apache webserver. For that to work you need\nto do a minor configuration.<\/p>\n<p>Edit the <code>\/etc\/apache2\/apache2.conf<\/code> and below the last <code>IncludeOptional<\/code> statement\nadd:<\/p>\n<pre><code class=\"language-apacheconfig\">IncludeOptional &lt;path&gt;\/*.conf\n<\/code><\/pre>\n<p>Where <code>&lt;path&gt;<\/code> has to be replaced by the location of your vhost files generated by this package.<\/p>\n<div class=\"alert alert-info\"><p>Your vhost files are saved by default inside the <code>storage\/app\/tenancy\/webserver\/apache<\/code> and\ncan be reconfigured in the <code>webserver.php<\/code> configuration file.<\/p><\/div>\n<p>Make sure to reload apache afterwards:<\/p>\n<pre><code class=\"language-bash\">sudo apache2ctl graceful\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 18:34:01.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.6\/apache.md"},{"title":"Nginx","icon":"fal fa-server","path":"docs\/hyn\/5.6\/nginx.md","slug":"nginx","package":"hyn","version":"5.6","contents":"<h1 id=\"set-up\"><a href=\"#set-up\" class=\"anchor-link\"><\/a>Set up<\/h1>\n<p>You need to set up your own PHP FPM. The preferred way of running php is through a <a href=\"https:\/\/coderwall.com\/p\/hmsr5a\/have-php-fpm-listen-on-unix-socket\">socket<\/a> by\nconfiguring the <code>listen<\/code> value in your pool correctly. Make sure to copy the path of your\nsock and update your <code>webserver.php<\/code> configuration file to reflect that value, for instance:<\/p>\n<pre><code class=\"language-php\">    \/**\n     * Nginx webserver support.\n     *\n     * @see http:\/\/nginx.org\n     *\/\n    'nginx' =&gt; [\n        \/\/ ..\n\n        \/**\n         * The php sock to be used.\n         *\/\n        'php-sock' =&gt; 'unix:\/var\/run\/php\/php-fpm.sock',\n        \n        \/\/ ..\n    ],\n<\/code><\/pre>\n<h1 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h1>\n<p>Tenancy natively integrates with the Nginx webserver. For that to work you need\nto do a minor configuration.<\/p>\n<p>Edit the <code>\/etc\/nginx\/nginx.conf<\/code> and below the last <code>include<\/code> statement\nadd:<\/p>\n<pre><code class=\"language-apacheconfig\">include &lt;path&gt;\/*.conf;\n<\/code><\/pre>\n<p>Where <code>&lt;path&gt;<\/code> has to be replaced by the location of your vhost files generated by this package.<\/p>\n<div class=\"alert alert-info\"><p>Your vhost files are saved by default inside the <code>storage\/app\/tenancy\/webserver\/nginx<\/code> and\ncan be reconfigured in the <code>webserver.php<\/code> configuration file.<\/p><\/div>\n<p>Make sure to restart nginx afterwards:<\/p>\n<pre><code class=\"language-bash\">sudo systemctl restart nginx\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 18:34:01.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.6\/nginx.md"}]},{"name":"tutorials","links":["spatie-laravel-permission","spatie-medialibrary","laravel-scheduler"],"slug":"tutorials","articles":[{"title":"Spatie permission","excerpt":"A tutorial on setting up spatie\/laravel-permission.","icon":"fal fa-file-archive","tags":["spatie","permission","tutorial"],"path":"docs\/hyn\/5.6\/spatie-laravel-permission.md","slug":"spatie-laravel-permission","package":"hyn","version":"5.6","contents":"<h2 id=\"prerequisite\"><a href=\"#prerequisite\" class=\"anchor-link\"><\/a>Prerequisite<\/h2>\n<p>You need a fresh Laravel app with Hyn Multi-Tenant installed. Briefly here are the basics:<\/p>\n<ol>\n<li>Create a fresh install of Laravel.  If you have installed the Laravel Terminal Installer run: <code>$ laravel new app<\/code>\n<\/li>\n<li>\n<code>$ cd app<\/code>\n<\/li>\n<li>Install <code>hyn\/multi-tenant<\/code> package by running:<\/li>\n<\/ol>\n<pre><code class=\"language-bash\">composer require hyn\/multi-tenant\n<\/code><\/pre>\n<ol start=\"4\">\n<li>Follow the instructions until &quot;Deploy configuration&quot; section.<\/li>\n<li>If you are using MySQL DB, you need to add the entry <code>LIMIT_UUID_LENGTH_32=true<\/code> in your <code>.env<\/code> file.<\/li>\n<\/ol>\n<h2 id=\"install-spatie-permissions-package\"><a href=\"#install-spatie-permissions-package\" class=\"anchor-link\"><\/a>Install Spatie Permissions Package<\/h2>\n<p>To install the package follow the entire installation section\nat <a href=\"https:\/\/github.com\/spatie\/laravel-permission#installation\">GitHub - spatie\/laravel-permission: Associate users with roles and permissions<\/a>.<\/p>\n<h2 id=\"integration\"><a href=\"#integration\" class=\"anchor-link\"><\/a>Integration<\/h2>\n<p>This section of the tutorial assumes that you have successfully <a href=\"creating-tenants\">created at least 2 hostnames<\/a>\nand have successfully accessed them via your local environment setup.<\/p>\n<p>We need to extend the two eloquent models (<code>Permission<\/code>, <code>Role<\/code>) of the Permissions\npackage so that we can add the necessary changes we need in order for these two models\nto be tenant aware.<\/p>\n<ol>\n<li>Create a <code>Permission.php<\/code> and <code>Role.php<\/code> file and place them inside your <code>app<\/code> directory,\nnext to your <code>User.php<\/code>. Make sure that these files extend <code>Spatie\\Permission\\Models\\Permission::class<\/code>\nand <code>Spatie\\Permission\\Models\\Role::class<\/code> respectively.<\/li>\n<\/ol>\n<p><code>App\\Permission.php<\/code> - extends from <code>SpatiePermission<\/code> and uses the <code>UsesTenantConnection<\/code> trait.<\/p>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Traits\\UsesTenantConnection;\nuse Spatie\\Permission\\Models\\Permission as SpatiePermission;\n\nclass Permission extends SpatiePermission\n{\n    use UsesTenantConnection;\n}\n<\/code><\/pre>\n<p><code>App\\Role.php<\/code> - extends from <code>SpatieRole<\/code> and uses the <code>UsesTenantConnection<\/code> trait.<\/p>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Traits\\UsesTenantConnection;\nuse Spatie\\Permission\\Models\\Role as SpatieRole;\n\nclass Role extends SpatieRole\n{\n    use UsesTenantConnection;\n}\n<\/code><\/pre>\n<p><code>App\\User.php<\/code> - notice the <code>HasRoles<\/code>, <code>UsesTenantConnection<\/code> traits we added.<\/p>\n<pre><code class=\"language-php\">use Spatie\\Permission\\Traits\\HasRoles;\nuse Illuminate\\Notifications\\Notifiable;\nuse Hyn\\Tenancy\\Traits\\UsesTenantConnection;\nuse Illuminate\\Foundation\\Auth\\User as Authenticatable;\n\nclass User extends Authenticatable\n{\n    use Notifiable, UsesTenantConnection, HasRoles;\n\n    \/**\n     * The attributes that are mass assignable.\n     *\n     * @var array\n     *\/\n    protected $fillable = [\n        'name', 'email', 'password',\n    ];\n\n    \/**\n     * The attributes that should be hidden for arrays.\n     *\n     * @var array\n     *\/\n    protected $hidden = [\n        'password', 'remember_token',\n    ];\n}\n<\/code><\/pre>\n<ol start=\"3\">\n<li>Modify your <code>config\/permission.php<\/code> file and modify the <code>permission<\/code> and <code>role<\/code> models to point to your newly created models. e.g. <code>App\\Permission::class<\/code>\n<\/li>\n<\/ol>\n<p><code>config\\permission.php<\/code><\/p>\n<pre><code class=\"language-php\">return [\n\n    'models' =&gt; [\n\n        'permission' =&gt; App\\Permission::class,\n\n        'role' =&gt; App\\Role::class,\n\n    ],\n\n    ...\n];\n<\/code><\/pre>\n<ol start=\"4\">\n<li>Creating a user in your first hostname. (We're using the first hostname here merely as an example.)<\/li>\n<\/ol>\n<pre><code class=\"language-php\">use App\\User;\nuse App\\Role;\nuse App\\Permission;\nuse Hyn\\Tenancy\\Models\\Hostname;\n\n\/\/ Switch the environment to use first hostname\n$environment = app(\\Hyn\\Tenancy\\Environment::class);\n$hostname = Hostname::find(1);\n$environment-&gt;hostname($hostname);\n\n\/\/ creates role and permission on your first hostname\n$role = Role::create(['name' =&gt; 'writer']);\n$permission = Permission::create(['name' =&gt; 'edit articles']);\n\n\/\/ Retrieve user and check to make sure it has no roles yet\n$user = User::find(1);\n$user-&gt;getRoleNames();\n\n\/\/ Assign writer role\n$user-&gt;assignRole('writer');\n\n\/\/ Requery and see that the newly assigned roles exists.\n$user = User::find(1);\n$user-&gt;getRoleNames();\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 18:34:01.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.6\/spatie-laravel-permission.md"},{"title":"Spatie media library","excerpt":"A tutorial on setting up spatie\/laravel-medialibrary.","icon":"fal fa-file-archive","tags":["spatie","medialibrary","tutorial"],"path":"docs\/hyn\/5.6\/spatie-medialibrary.md","slug":"spatie-medialibrary","package":"hyn","version":"5.6","contents":"<ol>\n<li>Create a fresh install of Laravel.  If you have installed the Laravel Terminal Installer run:<\/li>\n<\/ol>\n<pre><code class=\"language-bash\">$ laravel new app\n<\/code><\/pre>\n<ol start=\"2\">\n<li>\n<code>$ cd app<\/code>\n<\/li>\n<li>Install <code>hyn\/multi-tenant<\/code> package by running: <code>composer require hyn\/multi-tenant<\/code>\n<\/li>\n<li>Follow the instructions until the &quot;Deploy configuration&quot; section.<\/li>\n<li>If you are using MySQL as a database, make sure to add the entry <code>LIMIT_UUID_LENGTH_32=true<\/code> in your <code>.env<\/code> file.<\/li>\n<\/ol>\n<h2 id=\"install-spatie-medialibrary\"><a href=\"#install-spatie-medialibrary\" class=\"anchor-link\"><\/a>Install Spatie Medialibrary<\/h2>\n<p>Install this package via composer.<\/p>\n<pre><code class=\"language-bash\">$ composer require spatie\/laravel-medialibrary\n<\/code><\/pre>\n<p>Publish the migration with:<\/p>\n<pre><code class=\"language-bash\">$ php artisan vendor:publish --provider=&quot;Spatie\\MediaLibrary\\MediaLibraryServiceProvider&quot; --tag=&quot;migrations&quot;\n<\/code><\/pre>\n<p>Move the migration file (<code>2018_10_10_085035_create_media_table.php<\/code>) from <code>database\/migrations\/<\/code> to <code>database\/migrations\/tenant\/<\/code>.<\/p>\n<p>After the migration has been published you can create the media-table in your tenant databases by running the migrations:<\/p>\n<pre><code class=\"language-bash\">$ php artisan tenancy:migrate\n<\/code><\/pre>\n<p>You need to publish the config-file with:<\/p>\n<pre><code class=\"language-bash\">$ php artisan vendor:publish --provider=&quot;Spatie\\MediaLibrary\\MediaLibraryServiceProvider&quot; --tag=&quot;config&quot;\n<\/code><\/pre>\n<h2 id=\"integration\"><a href=\"#integration\" class=\"anchor-link\"><\/a>Integration<\/h2>\n<p>This section of the tutorial assumes that you have successfully <a href=\"creating-tenants\">created at least 2 hostnames<\/a>\nand have successfully accessed them via your local environment setup.<\/p>\n<p>We need to extend the <code>Media<\/code> eloquent model of the Medialibrary package so that we can add the\nnecessary changes for these two models to be tenant aware.<\/p>\n<ol>\n<li>Create a Media.php file and place it inside your <code>app<\/code> directory,\nnext to your <code>User.php<\/code>. Make sure that this class extends <code>Spatie\\MediaLibrary\\Models\\Media::class<\/code>.<\/li>\n<\/ol>\n<p><code>App\\Media.php<\/code> - extends from <code>SpatieMedia<\/code> and uses the <code>UsesTenantConnection<\/code> trait.<\/p>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Traits\\UsesTenantConnection;\nuse Spatie\\MediaLibrary\\Models\\Media as SpatieMedia;\n\nclass Media extends SpatieMedia\n{\n    use UsesTenantConnection;\n}\n<\/code><\/pre>\n<ol start=\"2\">\n<li>Prepare your model<\/li>\n<\/ol>\n<p>To associate media with a model, the tenant aware model must implement the following interface and traits, as shown below:<\/p>\n<pre><code class=\"language-php\">use Illuminate\\Database\\Eloquent\\Model;\nuse Spatie\\MediaLibrary\\HasMedia\\HasMedia;\nuse Hyn\\Tenancy\\Traits\\UsesTenantConnection;\nuse Spatie\\MediaLibrary\\HasMedia\\HasMediaTrait;\n\nclass User extends Model implements HasMedia\n{\n    use UsesTenantConnection, HasMediaTrait;\n   ...\n}\n<\/code><\/pre>\n<ol start=\"3\">\n<li>Modify your <code>config\/medialibrary.php<\/code> file and modify the <code>media_model<\/code> to point to your newly created model. e.g. <code>App\\Media::class<\/code>\n<\/li>\n<\/ol>\n<p><code>config\\medialibrary.php<\/code><\/p>\n<pre><code class=\"language-php\">return [\n\n    \/*\n     * The fully qualified class name of the media model.\n     *\/\n    'media_model' =&gt; App\\Media::class,\n\n    ...\n];\n<\/code><\/pre>\n<ol start=\"4\">\n<li>Attaching a media to your user model.<\/li>\n<\/ol>\n<pre><code class=\"language-php\">\/\/ Retrieve your user model.\n$user = App\\User::find(1);\n\n\/\/ Add a media from url and attach it to your model.\n$user-&gt;addMediaFromUrl('http:\/\/url-to-your-media-to-attach.png')-&gt;toMediaCollection();\n\n\/\/ Retrieve the media you just attached.\n$media = $user-&gt;media-&gt;last();\n<\/code><\/pre>\n<p>That's about it. You can read more on how to customize the medialibrary on their website: <a href=\"https:\/\/docs.spatie.be\/laravel-medialibrary\">https:\/\/docs.spatie.be\/laravel-medialibrary<\/a><\/p>\n","updated_at":{"date":"2020-07-18 18:34:01.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.6\/spatie-medialibrary.md"},{"title":"Laravel Scheduler","excerpt":"A tutorial on setting up Laravel's Scheduler to be Tenant Aware.","icon":"fal fa-file-archive","tags":["laravel","scheduler","tutorial"],"path":"docs\/hyn\/5.6\/laravel-scheduler.md","slug":"laravel-scheduler","package":"hyn","version":"5.6","contents":"<h1 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h1>\n<p>Laravel's command scheduler allows you to fluently and expressively define your command schedule within Laravel itself. When using the scheduler, only a single Cron entry is needed on your server.<\/p>\n<p>Your task schedule is defined in the <code>app\/Console\/Kernel.php<\/code> file's <code>schedule<\/code> method.<\/p>\n<p>By making Laravel's Scheduler tenant aware, we will unlock the possibilty to run multiple commands on all our tenants, without having to worry about setting numerous Cron jobs on your server.<\/p>\n<h1 id=\"prerequisite\"><a href=\"#prerequisite\" class=\"anchor-link\"><\/a>Prerequisite<\/h1>\n<p>You need a fresh Laravel app with Hyn Multi-Tenant installed. Briefly here are the basics:<\/p>\n<ol>\n<li>Create a fresh install of Laravel.  If you have installed the Laravel Terminal Installer run: <code>$ laravel new app<\/code>\n<\/li>\n<li>\n<code>$ cd app<\/code>\n<\/li>\n<li>Install <code>hyn\/multi-tenant<\/code> package by running:<\/li>\n<\/ol>\n<pre><code class=\"language-bash\">composer require hyn\/multi-tenant\n<\/code><\/pre>\n<ol start=\"4\">\n<li>Follow the <a href=\"https:\/\/tenancy.dev\/docs\/hyn\/5.6\/installation\">installation instructions<\/a>.<\/li>\n<\/ol>\n<h1 id=\"create-a-command\"><a href=\"#create-a-command\" class=\"anchor-link\"><\/a>Create a Command<\/h1>\n<p>To create a new command, use the <code>make:command<\/code> Artisan command. This command will create a new command class in the <code>app\/Console\/Commands<\/code> directory<\/p>\n<pre><code class=\"language-bash\">php artisan make:command ExampleCommand\n<\/code><\/pre>\n<p>We are going to make this command Tenant Aware. We need to change the signature to accept a <code>website_id<\/code> option:<\/p>\n<pre><code class=\"language-php\">protected $signature = 'example:command {--website_id=}';\n<\/code><\/pre>\n<p>We will take tenant awareness code from <a href=\"https:\/\/tenancy.dev\/docs\/hyn\/5.6\/commands#tenant-aware-tinker-command\">Tenant Aware Tinker Command<\/a>. The ExampleCommand should now look like this:<\/p>\n<pre><code class=\"language-php\">namespace App\\Console\\Commands;\n\nuse Illuminate\\Console\\Command;\nuse Hyn\\Tenancy\\Contracts\\Repositories\\WebsiteRepository;\nuse Hyn\\Tenancy\\Database\\Connection;\nuse Illuminate\\Database\\Eloquent\\ModelNotFoundException;\nuse Symfony\\Component\\Console\\Exception\\RuntimeException;\n\nclass ExampleCommand extends Command\n{\n    \/**\n     * The name and signature of the console command.\n     *\n     * @var string\n     *\/\n    protected $signature = 'example:command {--website_id=}';\n\n    \/**\n     * The console command description.\n     *\n     * @var string\n     *\/\n    protected $description = 'Example Command - Tenant Aware';\n\n    \/**\n     * @var Connection\n     *\/\n    private $connection;\n\n    \/**\n     * @var WebsiteRepository\n     *\/\n    private $websites;\n\n    \/**\n     * Create a new command instance.\n     *\n     * @return void\n     *\/\n    public function __construct()\n    {\n        parent::__construct();\n        $this-&gt;websites = app(WebsiteRepository::class);\n        $this-&gt;connection = app(Connection::class);\n    }\n\n    \/**\n     * Execute the console command.\n     *\n     * @return mixed\n     *\/\n    public function handle()\n    {\n        $website_id = $this-&gt;option('website_id');\n        try{\n            $website = $this-&gt;websites-&gt;query()-&gt;where('id', $website_id)-&gt;firstOrFail();\n            $this-&gt;connection-&gt;set($website);\n            $this-&gt;info('Running Command on website_id: ' . $website_id);\n\n            $this-&gt;tenantHandle();\n\n            $this-&gt;connection-&gt;purge();\n        } catch (ModelNotFoundException $e) {\n            throw new RuntimeException(\n                sprintf(\n                    'The tenancy website_id=%d does not exist.',\n                    $website_id\n                )\n            );\n        }\n    }\n\n    \/**\n     * Execute the console command. Tenant Aware.\n     *\n     * @return mixed\n     *\/\n    public function tenantHandle()\n    {\n        \/\/ You are now Tenant Aware\n        \/\/ Execute something, dispatch a Job, or anything else\n    }\n}\n<\/code><\/pre>\n<h1 id=\"integration\"><a href=\"#integration\" class=\"anchor-link\"><\/a>Integration<\/h1>\n<div class=\"alert alert-info\"><p>This section of the tutorial assumes that you have successfully created one or more tenant aware commands.<\/p><\/div>\n<p>We now need to register our <code>ExampleCommand<\/code> into our schedule. Laravel's Scheduler is set into <code>app\/Console\/Kernel.php<\/code>.<\/p>\n<ol>\n<li>First, we need to tell Laravel which commands will be used in the scheduler<\/li>\n<\/ol>\n<pre><code class=\"language-php\">protected $commands = [\n    ExampleCommand::class,\n    MySecondCommand::class,\n    ...\n];\n\n<\/code><\/pre>\n<ol start=\"2\">\n<li>Create a method for each command you need to run. We will be using the <code>before<\/code> <a href=\"https:\/\/laravel.com\/docs\/7.x\/scheduling#task-hooks\">Task Hook<\/a> to specify code to be executed before the scheduled task is launched. Here is an example:<\/li>\n<\/ol>\n<pre><code class=\"language-php\">\/**\n * Example Command Schedule\n * @param  Illuminate\\Console\\Scheduling\\Schedule   $schedule   Instance of schedule\n * @return void\n *\/\nprotected function scheduleExampleCommand(Schedule $schedule)\n{\n    \/\/ Set the Scheduler to our Tenant Aware Command. Store the returned Event.\n    $scheduledEvent = $schedule-&gt;command(ExampleCommand::class);\n\n    \/\/ Init a new variable to alter the Event's command string\n    $commandString = null;\n\n    \/\/ Setup your schedule\n    $scheduledEvent\n        \/\/ Setup our `before` Hook\n        -&gt;before(function () use ($scheduledEvent, &amp;$commandString) {\n            \/\/ Retreive current tenant\n            $tenant = app(\\Hyn\\Tenancy\\Environment::class)-&gt;tenant();\n\n            \/\/ Retreive and store the inital generated command. See note below*\n            if ($commandString === null) {\n                $commandString = $scheduledEvent-&gt;command;\n            }\n\n            \/\/ Replace the Event's generated command\n            \/\/ Adding our tenant's `website_id` option\n            $scheduledEvent-&gt;command = sprintf(\n                &quot;%s --website_id=%d&quot;,\n                $commandString,\n                $tenant-&gt;id\n            );\n        })\n\n        \/\/ Define your schedule as you would normally do\n        \/\/-&gt;everyHour()\n        \/\/-&gt;runInBackground()\n        \/\/-&gt;evenInMaintenanceMode();\n}\n<\/code><\/pre>\n<p>Your can find all available schedule options on <a href=\"https:\/\/laravel.com\/docs\/6.x\/scheduling#schedule-frequency-options\">Laravel's Official Documentation<\/a> page.<\/p>\n<div class=\"alert alert-info\"><p>*<em>Note: Without this, <code>--website_id<\/code> option would be added one after the other.<\/em><\/p><\/div>\n<ol start=\"3\">\n<li>Set our <code>schedule<\/code> method to run our new methods. Use the <code>Tenancy\\Environment<\/code> to define whether you're running with <code>tenancy:run<\/code> or not.<\/li>\n<\/ol>\n<pre><code class=\"language-php\">\/**\n * Define the application's command schedule.\n *\n * @param  \\Illuminate\\Console\\Scheduling\\Schedule $schedule\n * @return void\n *\/\nprotected function schedule(Schedule $schedule)\n{\n    if (app(\\Hyn\\Tenancy\\Environment::class)-&gt;tenant()) {\n        \/\/ Run your tenant aware schedules\n        $this-&gt;scheduleExampleCommand($schedule);\n        $this-&gt;scheduleMySecondCommand($schedule);\n        ...\n    } else {\n        \/\/ Run your system schedules\n        \/\/ ...\n    }\n}\n<\/code><\/pre>\n<ol start=\"4\">\n<li>Setup your server Cron<\/li>\n<\/ol>\n<pre><code class=\"language-bash\"># Tenant\n* * * * * cd \/path-to-your-project &amp;&amp; php artisan tenancy:run schedule:run &gt;&gt; \/dev\/null 2&gt;&amp;1\n\n# System\n# * * * * * cd \/path-to-your-project &amp;&amp; php artisan schedule:run &gt;&gt; \/dev\/null 2&gt;&amp;1\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 18:34:01.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.6\/laravel-scheduler.md"}]}],"hidden_articles":{"index":{"title":"Hyn documentation","path":"docs\/hyn\/5.6\/index.md","slug":"index","package":"hyn","version":"5.6","contents":"","updated_at":{"date":"2020-07-18 18:34:01.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.6\/index.md"}}},"5.5":{"slug":"5.5","name":5.5,"status":"Deprecated","suggestion_using":null,"branch":"5.x","package":"hyn","tree":[{"name":"getting started","links":["requirements","upgrade-from-5.4","installation","configuration"],"slug":"getting-started","articles":[{"title":"Requirements","icon":"fal fa-clipboard-check","path":"docs\/hyn\/5.5\/requirements.md","slug":"requirements","package":"hyn","version":"5.5","contents":"<ul>\n<li>Laravel 6.0.<\/li>\n<li>PHP 7.2 or up.<\/li>\n<li>MySQL 5.7+, MariaDB 10.2.0+ or PostgreSQL 9+.<\/li>\n<li>Optionally Apache 2.4+ or Nginx 1.12+.<\/li>\n<li>\n<a href=\"#experience\">Applied experience with Laravel<\/a>.<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>Please note that MySQL limits username and database length to 32. Enable this in the <code>tenancy.php<\/code> configuration file:  <code>website &gt; uuid-limit-length-to-32<\/code> to accommodate this.<\/p><\/div>\n<h2 id=\"experience\"><a href=\"#experience\" class=\"anchor-link\"><\/a>Experience<\/h2>\n<p>In case you are new to Laravel we urge you to get familiar with that\nbefore jumping into building something with this package. Having built\nat least one project with the framework (for fun) makes it much easier\ngrasping the concepts at hand.<\/p>\n<p>The following resources we recommend:<\/p>\n<ul>\n<li>\n<a href=\"https:\/\/laravel.com\/docs\">Laravel documentation<\/a>\n<\/li>\n<li>\n<a href=\"https:\/\/laracasts.com\/series\/laravel-from-scratch-2017\">Laravel from scratch free series at Laracasts<\/a>\n<\/li>\n<\/ul>\n","updated_at":{"date":"2020-07-18 16:49:31.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.5\/requirements.md"},{"title":"Upgrading from 5.4","icon":"fal fa-level-up-alt","path":"docs\/hyn\/5.5\/upgrade-from-5.4.md","slug":"upgrade-from-5.4","package":"hyn","version":"5.5","contents":"<p>The 5.5 version adds compatibility with Laravel 6.0 and drops support for all previous versions.<\/p>\n<p>See the <a href=\"https:\/\/github.com\/tenancy\/multi-tenant\/blob\/5.x\/changelog.md\">changelog<\/a> for\nall modifications.<\/p>\n","updated_at":{"date":"2020-07-18 16:49:31.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.5\/upgrade-from-5.4.md"},{"title":"Installation","icon":"fal fa-arrow-alt-to-bottom","path":"docs\/hyn\/5.5\/installation.md","slug":"installation","package":"hyn","version":"5.5","contents":"<h1 id=\"elevated-database-user\"><a href=\"#elevated-database-user\" class=\"anchor-link\"><\/a>Elevated database user<\/h1>\n<p>Tenancy requires a <code>system<\/code> connection that allows creating new databases for\ntenants. In order to do so, we need to have a database user with elevated\npermissions.<\/p>\n<p>A user for both <a href=\"https:\/\/mariadb.com\/kb\/en\/library\/grant\/#the-grant-option-privilege\">MariaDB or MySQL<\/a> and <a href=\"https:\/\/www.postgresql.org\/docs\/9.6\/static\/sql-grant.html\">PostgreSQL<\/a> would require the &quot;GRANT OPTION&quot; to be\napplied. You can either use the root user (for PostgreSQL that is user postgres) or create\nyour own (recommended):<\/p>\n<p>For MariaDB or MySQL:<\/p>\n<pre><code class=\"language-sql\">CREATE DATABASE IF NOT EXISTS tenancy;\nCREATE USER IF NOT EXISTS tenancy@localhost IDENTIFIED BY 'someRandomPassword';\nGRANT ALL PRIVILEGES ON *.* TO tenancy@localhost WITH GRANT OPTION;\n<\/code><\/pre>\n<p>For PostgreSQL:<\/p>\n<pre><code class=\"language-sql\">CREATE DATABASE tenancy;\nCREATE USER tenancy WITH CREATEDB CREATEROLE PASSWORD 'someRandomPassword';\nGRANT ALL PRIVILEGES ON DATABASE tenancy to tenancy WITH GRANT OPTION;\n<\/code><\/pre>\n<p>Make sure you configure this user as your <code>system<\/code> connection in your <code>database.php<\/code>.\nUnder <code>connections<\/code>:<\/p>\n<pre><code class=\"language-php\">'system' =&gt; [\n    'driver' =&gt; 'mysql',\n    'host' =&gt; env('TENANCY_HOST', '127.0.0.1'),\n    'port' =&gt; env('TENANCY_PORT', '3306'),\n    'database' =&gt; env('TENANCY_DATABASE', 'tenancy'),\n    'username' =&gt; env('TENANCY_USERNAME', 'tenancy'),\n    'password' =&gt; env('TENANCY_PASSWORD', ''),\n    'unix_socket' =&gt; env('DB_SOCKET', ''),\n    'charset' =&gt; 'utf8mb4',\n    'collation' =&gt; 'utf8mb4_unicode_ci',\n    'prefix' =&gt; '',\n    'strict' =&gt; true,\n    'engine' =&gt; null,\n]\n<\/code><\/pre>\n<p>Most often it makes sense to use either <code>system<\/code> or <code>tenant<\/code> as your default database connection setting. For example, Laravel assigns the value from <code>DB_CONNECTION<\/code> in your <code>.env<\/code> file to the <code>default<\/code> key in the <code>config\/database.php<\/code> configuration file.<\/p>\n<p>In case you use <code>tenant<\/code> make sure to enable <a href=\"identification\">early identification<\/a> and configure\na decent <a href=\"fallback\">fallback<\/a> later on.<\/p>\n<div class=\"alert alert-info\"><p>There is no need to configure the <code>tenant<\/code> connection in the <code>database.php<\/code>\nconfiguration file. This connection is set up automatically during runtime. Pre-\nconfiguring this connection may cause unwanted behaviour.<\/p><\/div>\n<h1 id=\"package-installation\"><a href=\"#package-installation\" class=\"anchor-link\"><\/a>Package installation<\/h1>\n<p>Run the composer command to add the tenancy package as dependency:<\/p>\n<pre><code class=\"language-bash\">composer require &quot;hyn\/multi-tenant:5.5.*&quot;\n<\/code><\/pre>\n<p>Laravel's <a href=\"https:\/\/medium.com\/@taylorotwell\/package-auto-discovery-in-laravel-5-5-ea9e3ab20518\">package auto discovery<\/a> will register the service provider automatically.<\/p>\n<p>Publish the configuration files and migrations for Tenancy, which allow you\nto configure the behavior of the package.<\/p>\n<pre><code class=\"language-bash\">php artisan vendor:publish --tag=tenancy\n<\/code><\/pre>\n<p>Then edit <code>config\/tenancy.php<\/code> accordingly.<\/p>\n<p>Adapt the system migrations to your liking inside <code>database\/migrations<\/code>, make sure to run them:<\/p>\n<pre><code class=\"language-bash\">php artisan migrate --database=system\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Change <code>system<\/code> to your system connection name.<\/p><\/div>\n","updated_at":{"date":"2020-07-18 16:49:31.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.5\/installation.md"},{"title":"Configuration","icon":"fal fa-sliders-v","path":"docs\/hyn\/5.5\/configuration.md","slug":"configuration","package":"hyn","version":"5.5","contents":"<h1 id=\"system-connection\"><a href=\"#system-connection\" class=\"anchor-link\"><\/a>System connection<\/h1>\n<p>Tenancy needs a database connection with elevated permission to create databases\nto be used by its tenants.<\/p>\n<p>Make sure you set up this connection by following the instructions\nin the <a href=\"requirements#elevated-database-user\">requirements<\/a>, it also explains how to publish\nthe configuration files.<\/p>\n<h1 id=\"configuration-files\"><a href=\"#configuration-files\" class=\"anchor-link\"><\/a>Configuration Files<\/h1>\n<p>The inline documentation in both files should be self explanatory. Nevertheless,\nI've listed some of the basic settings below.<\/p>\n<h2 id=\"tenancyphp\"><a href=\"#tenancyphp\" class=\"anchor-link\"><\/a>tenancy.php<\/h2>\n<p>The <code>tenancy.php<\/code> configuration file holds every setting related to tenants.\nThis includes how to generate a unique website, but also how database connections are set up.\nIn addition, it allows for:<\/p>\n<ul>\n<li>custom random id logic<\/li>\n<li>manual tenant identification<\/li>\n<li>on what disk (see <code>config\/filesystems.php<\/code>) to store the tenant-specific files<\/li>\n<li>specifying tenant database division mode<\/li>\n<li>specifying the password generator<\/li>\n<li>specifying the migrations path<\/li>\n<li>forcing models to a specific connection<\/li>\n<li>overriding your configs<\/li>\n<li>overriding your routes<\/li>\n<li>overriding translations<\/li>\n<li>overriding views<\/li>\n<li>and much, much more.<\/li>\n<\/ul>\n<h2 id=\"webserverphp\"><a href=\"#webserverphp\" class=\"anchor-link\"><\/a>webserver.php<\/h2>\n<p>The <code>webserver.php<\/code> configuration file allows one to more closely fine tune integration of this package with your webserver.\nPorts, vhost configuration files and the location to save these files are all contained in this config.<\/p>\n<p>The settings in this configuration file are:<\/p>\n<ul>\n<li>enabled; whether the service is enabled and thus the package will write files for it and reload the service.<\/li>\n<li>ports; which ports we should use, this is required to configure the vhost files properly.<\/li>\n<li>generator; the class handling the generation of vhost files.<\/li>\n<li>disk; the disk to write the vhost files to, you can have it point to any configured disk in your <code>config\/filesystems.php<\/code>.<\/li>\n<li>paths; specific locations we need to know about to in order to mutate the webserver behavior.<\/li>\n<\/ul>\n","updated_at":{"date":"2020-07-18 16:49:31.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.5\/configuration.md"}]},{"name":"tenant principles","links":["concepts","identification","connections","fallback","middleware"],"slug":"tenant-principles","articles":[{"title":"Concepts","icon":"fal fa-vials","path":"docs\/hyn\/5.5\/concepts.md","slug":"concepts","package":"hyn","version":"5.5","contents":"<h1 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h1>\n<p>The principle of multi tenancy is about a single instance of software running\non a server and serving multiple tenants. The interpretation of such a tenancy\napplication is quite diverse.<\/p>\n<p>Hyn tenancy is focused on providing a drop-in solution for Laravel without\nsacrificing flexibility or requiring extensive hacks of the Laravel ecosystem.<\/p>\n<p>Make sure you understand that the <code>Website<\/code> model is the subject of tenancy.<\/p>\n<p>The default method for identifying such a tenant website is by using the requested\ndomain aka <code>hostname<\/code>. Taking a URL <code>http:\/\/yourdomain.com\/foo\/bar<\/code> only <code>yourdomain.com<\/code>\nis taken into account, although modifications to this logic are easy to implement. The\n<code>yourdomain.com<\/code> part of the URL is called a Fully Qualified Domain Name or <code>fqdn<\/code> for short.<\/p>\n<p>A website can have zero or more hostnames connected to it. This allows for easier\nattachment of additional hostnames or serving, for instance an ad campaign page,\non different domains.<\/p>\n<h1 id=\"website\"><a href=\"#website\" class=\"anchor-link\"><\/a>Website<\/h1>\n<p>You can think of a website as a single mirror of the code base, re-using your default\napp code. In addition it is also possible to have very <a href=\"structure\">tenant specific logic<\/a>,\nfor instance routes, a vendor folder, media and language files.<\/p>\n<h1 id=\"hostname\"><a href=\"#hostname\" class=\"anchor-link\"><\/a>Hostname<\/h1>\n<p>A hostname is a <a href=\"https:\/\/www.godaddy.com\/garage\/industry\/tech-svcs\/it\/whats-a-fully-qualified-domain-name-fqdn-and-whats-it-good-for\/\">Fully Qualified Domain Name<\/a> (for instance <code>sub.example.com<\/code>).\nYour application handles incoming requests to specific hostnames. Tenancy inspects\nthese requests and <a href=\"identification\">sets up the tenancy environment<\/a> according to a\nmatching hostname or falls back to the default one.<\/p>\n<h1 id=\"runtime\"><a href=\"#runtime\" class=\"anchor-link\"><\/a>Runtime<\/h1>\n<p>By default, the package will identify the current requested <code>hostname<\/code> and bind it\ninto the <code>Hyn\\Tenancy\\Contracts\\CurrentHostname<\/code> contract. In case that <code>hostname<\/code> belongs to\na website, the latter will be bound into the <code>Hyn\\Tenancy\\Contracts\\Tenant<\/code> contract. Whenever\na Tenant is identified or switched the package will automatically infuse additional functionality\ninto Laravel, including <a href=\"fallback#tenant-routes-override\">global tenant routes<\/a>, <a href=\"structure\">tenant overrides<\/a>\nand <a href=\"queues\">queues<\/a>.<\/p>\n","updated_at":{"date":"2020-07-18 16:49:31.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.5\/concepts.md"},{"title":"Identification","icon":"fal fa-street-view","path":"docs\/hyn\/5.5\/identification.md","slug":"identification","package":"hyn","version":"5.5","contents":"<p>During runtime, the <code>Environment<\/code> class is bound into Laravel's container. The\ntenancy environment holds one single responsibility, which is telling our code\nwhat <code>hostname<\/code> is currently identified and resolving the related website.<\/p>\n<h1 id=\"early-identification\"><a href=\"#early-identification\" class=\"anchor-link\"><\/a>Early identification<\/h1>\n<p>By default Tenancy will identify the tenant after all Middleware has been processed.\nYou can resolve the Environment class through the service container\ninside a middleware to force identification of the tenant early on. If you want the\npackage to handle this on your behalf you can enable the <code>early-identification<\/code> flag in\nyour <code>tenancy.php<\/code> configuration file under <code>hostname<\/code>.<\/p>\n<h1 id=\"manual-identification\"><a href=\"#manual-identification\" class=\"anchor-link\"><\/a>Manual identification<\/h1>\n<p>The environment can be used to manually set any active tenant. This is one of the\nreasons why the tenancy configuration file has the <code>hostname &gt; auto-identification<\/code>\nsetting. Turn it off to implement your own tenancy identification.<\/p>\n<p>Manual identification is pretty straightforward. Take for example the following\nsnippet for a custom (app) service provider:<\/p>\n<pre><code class=\"language-php\">public function boot()\n{\n    $environment = $this-&gt;app-&gt;make(\\Hyn\\Tenancy\\Environment::class);\n\n    \/\/ Retrieve your website\n\n    \/\/ Now switch the environment to a new tenant.\n    $environment-&gt;tenant($website);\n}\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Be wary about switching tenants. It is recommend switching only once during code\nexecution. Use a background job to run mass changes on tenant databases.<\/p><\/div>\n<h1 id=\"retrieve-current-tenant\"><a href=\"#retrieve-current-tenant\" class=\"anchor-link\"><\/a>Retrieve current tenant<\/h1>\n<p>To work with the current environment, you can do the following:<\/p>\n<pre><code class=\"language-php\"> \n \/\/ Get current Website (Tenant)\n $website   = \\Hyn\\Tenancy\\Facades\\TenancyFacade::website();\n \n \/\/ prefered option\n $website   = app(\\Hyn\\Tenancy\\Environment::class)-&gt;tenant();\n \n \/\/ alternative (outdated) \n $website   = app(\\Hyn\\Tenancy\\Environment::class)-&gt;website();\n \n $websiteId = $website-&gt;id;\n \n \/\/ Get current Hostname\n $hostname  = app(\\Hyn\\Tenancy\\Environment::class)-&gt;hostname();\n \n \/\/ Get FQDN (Fully-Qualified Domain Name) by current hostname\n $fqdn      = $hostname-&gt;fqdn;\n\n \n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 16:49:31.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.5\/identification.md"},{"title":"Connections","icon":"fal fa-warehouse-alt","path":"docs\/hyn\/5.5\/connections.md","slug":"connections","package":"hyn","version":"5.5","contents":"<h1 id=\"database-connections\"><a href=\"#database-connections\" class=\"anchor-link\"><\/a>Database Connections<\/h1>\n<p>One of the core aspects of tenancy is the database connection. Tenancy\ngives you access to two key database connections; <code>tenant<\/code> and <code>system<\/code>.<\/p>\n<h2 id=\"system-connection\"><a href=\"#system-connection\" class=\"anchor-link\"><\/a>System Connection<\/h2>\n<p>Out of the box, the package gives you a <code>system<\/code> database connection which acts as\nthe master database where <code>hostnames<\/code> and <code>websites<\/code> are stored.<\/p>\n<p>If for some reason you need to create an Eloquent Model that would need to connect\nto the system connection, you can apply the <code>Hyn\\Tenancy\\Traits\\UsesSystemConnection<\/code>\ntrait on your given Model. In doing so, the model\u2019s connection will always default to use the <code>system<\/code>.<\/p>\n<p>One reason for using the <code>system<\/code> connection is for storing data which you'd like\nto share between all tenants or which you need to use to influence the tenant identification\nprocess. For instance when you are creating an admin portal that would manage all of your\ntenants in one place.<\/p>\n<h2 id=\"tenant-connection\"><a href=\"#tenant-connection\" class=\"anchor-link\"><\/a>Tenant Connection<\/h2>\n<p>This is maybe the most used database connection. Data in use by single tenant instances,\nnot shared with others, is persisted into the database using the <code>tenant<\/code> connection. The\nimplementation of the <code>tenant<\/code> connection ensures that no tenant can access another tenant's data.<\/p>\n<p>By using the <code>Hyn\\Tenancy\\Traits\\UsesTenantConnection<\/code> trait, the package will make sure\nthat it is using the right database connection.<\/p>\n<p>All tenant related models should use the <code>UsesTenantConnection<\/code> trait.<\/p>\n<h3 id=\"forcing-the-connection\"><a href=\"#forcing-the-connection\" class=\"anchor-link\"><\/a>Forcing The Connection<\/h3>\n<p>If you want to set the default connection to <code>tenant<\/code> (when a tenant website has been identified), you can use the snippet below.\nThis is also helpful for 3rd party packages models to force their connection to <code>tenant<\/code>.<\/p>\n<p>Add the following code to the <code>boot()<\/code> method of your <code>AppServiceProvider.php<\/code> file.<\/p>\n<pre><code class=\"language-php\">$env = app(Environment::class);\n\nif ($fqdn = optional($env-&gt;hostname())-&gt;fqdn) {\n    config(['database.default' =&gt; 'tenant']);\n}\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Please understand the risks involved of setting your default connection during runtime. All Eloquent models will from then on use the <code>tenant<\/code> connection instead of your previously configured default connection.<\/p><\/div>\n<hr \/>\n<p>More information about applying these connections can be found in the <a href=\"models\">models<\/a> article.<\/p>\n<h3 id=\"password-generation\"><a href=\"#password-generation\" class=\"anchor-link\"><\/a>Password generation<\/h3>\n<p>The password of the tenant is generated using several components mashed up as md5 hash.<\/p>\n<ul>\n<li>\n<code>tenancy.key<\/code> with a fallback to <code>app.key<\/code>. You can specify an empty string <code>&quot;&quot;<\/code> if you don't want to use this key.<\/li>\n<li>Website Id.<\/li>\n<li>Website UUID.<\/li>\n<li>Website created_at.<\/li>\n<\/ul>\n<p>In case you wish to change\/update the <code>tenancy.key<\/code> we provide a useful command <code>tenancy:key:update<\/code>\nwhich will update the tenant password with the new md5 value. This allows for easier key rotation.<\/p>\n","updated_at":{"date":"2020-07-18 16:49:31.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.5\/connections.md"},{"title":"Fallback","excerpt":"Configure a landing page using different approaches","icon":"fal fa-compass","path":"docs\/hyn\/5.5\/fallback.md","slug":"fallback","package":"hyn","version":"5.5","contents":"<p>There are several ways to organize a fallback domain. These are commonly used to offer\na landing page and\/or admin area for your clients to configure their tenant website.<\/p>\n<h1 id=\"disabling-abort-to-pass-through\"><a href=\"#disabling-abort-to-pass-through\" class=\"anchor-link\"><\/a>Disabling abort to pass through<\/h1>\n<p>By default a 404 not found is served whenever auto identification is enabled and no\nmatching hostname entry was found in the system database.<\/p>\n<p>You can disable this in the <code>tenancy.php<\/code> configuration file by setting the\n<code>abort-without-identified-hostname<\/code> option to <code>false<\/code>. This will prevent tenancy\nfrom throwing a 404 (not found) whenever it failed to identify a registered hostname.<\/p>\n<p>Depending on how you set up your app, the code will now pass through to any registered routes.\nFor applications that have global routes defined for tenant specific functionality, you'll\nrun into the issue that no &quot;tenant&quot; connection was defined.<\/p>\n<h1 id=\"tenant-routes-override\"><a href=\"#tenant-routes-override\" class=\"anchor-link\"><\/a>Tenant routes override<\/h1>\n<p>Whenever you create a file <code>routes\/tenants.php<\/code> and you have <code>tenancy.hostname.auto-identification<\/code>\nenabled, all routes contained in that file will automatically override any declared global routes\nfrom <code>routes\/web.php<\/code> or <code>routes\/api.php<\/code>. Make sure to apply the proper middleware to those routes.<\/p>\n<p>In case you enable <code>tenancy.routes.replace-global<\/code> all previously declared routes\nwill be removed and replaced with the contents of the <code>routes\/tenants.php<\/code> file.<\/p>\n<div class=\"alert alert-info\"><p>Understand unlike the default <code>web.php<\/code> and <code>api.php<\/code> files no group is set around this file. You need\nto apply your own <code>namespace<\/code>, <code>middleware<\/code> and other group settings inside the <code>tenants.php<\/code>.<\/p><\/div>\n<p>An example <code>routes\/tenants.php<\/code> file:<\/p>\n<pre><code class=\"language-php\">Route::middleware('web')\n    -&gt;namespace('App\\\\Http\\\\Controllers\\\\Tenant\\\\')\n    -&gt;group(function () \n{\n    Route::get('\/', 'HomeController');\n});\n<\/code><\/pre>\n<h1 id=\"routing-with-domain\"><a href=\"#routing-with-domain\" class=\"anchor-link\"><\/a>Routing with domain<\/h1>\n<p>One of the easiest solutions is using the <code>::domain()<\/code> option in routing called\n<a href=\"https:\/\/laravel.com\/docs\/6.x\/routing#route-group-sub-domain-routing\">sub domain routing in Laravel<\/a>.<\/p>\n<pre><code class=\"language-php\">Route::domain('master.your.app')-&gt;group(function () {\n    \/\/ .. your landing page routes\n});\n<\/code><\/pre>\n<h1 id=\"create-a-tenant-as-fallback\"><a href=\"#create-a-tenant-as-fallback\" class=\"anchor-link\"><\/a>Create a tenant as fallback<\/h1>\n<p>Another quick method is to simply seed a default tenant that has a specific\nhostname. Set the environment <code>TENANCY_DEFAULT_HOSTNAME<\/code> to the exact FQDN used\nfor that tenant.<\/p>\n<p>Now every time no other tenant was identified, it will revert to this tenant. A\ndrawback of this method is the need to set up a tenant hostname.<\/p>\n","updated_at":{"date":"2020-07-18 18:29:42.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.5\/fallback.md"},{"title":"Middleware","icon":"fal fa-shield-alt","excerpt":"Automatic actions per tenant","path":"docs\/hyn\/5.5\/middleware.md","slug":"middleware","package":"hyn","version":"5.5","contents":"<p>This package offers additional automation to make your life easier. Using\nmiddleware you can mutate how specific requests are handled.<\/p>\n<h1 id=\"maintenance\"><a href=\"#maintenance\" class=\"anchor-link\"><\/a>Maintenance<\/h1>\n<p>Set the property <code>under_maintenance_since<\/code> of the <code>hostname<\/code> to show a\nLaravel generic maintenance page.<\/p>\n<h1 id=\"redirection\"><a href=\"#redirection\" class=\"anchor-link\"><\/a>Redirection<\/h1>\n<p>Set the property <code>redirect_to<\/code> to a valid URL to automatically redirect all\nrequests to this hostname.<\/p>\n<h1 id=\"secure\"><a href=\"#secure\" class=\"anchor-link\"><\/a>Secure<\/h1>\n<p>Set the property <code>force_https<\/code> to <code>true<\/code> to force all connections on this\nhostname to be handled using a SSL encrypted connection.<\/p>\n<h1 id=\"abort\"><a href=\"#abort\" class=\"anchor-link\"><\/a>Abort<\/h1>\n<p>In case no tenant was identified the application will generate a default\nnot found page. You can disable this functionality globally in\nthe tenancy configuration file <code>hostname &gt; abort-without-identified-hostname<\/code>.<\/p>\n","updated_at":{"date":"2020-07-18 16:49:31.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.5\/middleware.md"}]},{"name":"implementation","links":["creating-tenants","models","structure"],"slug":"implementation","articles":[{"title":"Creating tenants","icon":"fal fa-dolly-flatbed","path":"docs\/hyn\/5.5\/creating-tenants.md","slug":"creating-tenants","package":"hyn","version":"5.5","contents":"<p>Tenancy is heavily driven by events. For event listeners to properly work, you\nhave to use the provided repositories to create new websites and hostnames.<\/p>\n<h1 id=\"create-website\"><a href=\"#create-website\" class=\"anchor-link\"><\/a>Create website<\/h1>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Models\\Website;\nuse Hyn\\Tenancy\\Contracts\\Repositories\\WebsiteRepository;\n\n$website = new Website;\napp(WebsiteRepository::class)-&gt;create($website);\ndd($website-&gt;uuid); \/\/ Unique id\n<\/code><\/pre>\n<h2 id=\"uuid\"><a href=\"#uuid\" class=\"anchor-link\"><\/a>UUID<\/h2>\n<p>Each website will be given a unique identifier automatically. To prevent\nguessing URLs and to add a slight increased level of security this is a\nrandom hash.<\/p>\n<p>The UUID is used for the database username and database name. In addition\nI'd recommend using this unique string for every public facing URL, eg\nan admin dashboard.<\/p>\n<p>By default this package will create a <code>uuid<\/code> automatically\nusing a UUID generator. You can replace that class in the\n<code>tenancy.php &gt; website &gt; random-id-generator<\/code>, as long as it implements\n<code>Hyn\\Tenancy\\Contracts\\Website\\UuidGenerator<\/code>.<\/p>\n<p>If you want to force your own UUID for the website, without creating a full\nfledged UUID generator, set the <code>uuid<\/code> property of your website before passing\nit to the repository.<\/p>\n<pre><code class=\"language-php\">$website = new Website;\n\/\/ Implement custom random hash using Laravels Str::random\n$website-&gt;uuid = Str::random(10);\napp(WebsiteRepository::class)-&gt;create($website);\ndd($website-&gt;uuid); \/\/ Random string of length 10\n<\/code><\/pre>\n<h2 id=\"managing-connection\"><a href=\"#managing-connection\" class=\"anchor-link\"><\/a>Managing connection<\/h2>\n<p>Whenever you are using multiple databases, to separate tenants over different\nregions for instance, you can easily specify the connection with which tenancy\nshould create, update and delete tenant databases and users.<\/p>\n<pre><code class=\"language-php\">$website = new Website;\n$website-&gt;managed_by_database_connection = 'system.asia';\napp(WebsiteRepository::class)-&gt;create($website);\n\/\/ Information of website is stored in the default system connection,\n\/\/ the tenant database is created using the system.asia connection.\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Make sure the provided connection name is configured in your <code>config\/database.php<\/code>.<\/p><\/div>\n<h1 id=\"create-and-connect-hostname\"><a href=\"#create-and-connect-hostname\" class=\"anchor-link\"><\/a>Create and connect hostname<\/h1>\n<p>A hostname allows the package to map a requested hostname to a website. Websites\nthat have no (active) hostnames connected to it will never be visible. So make\nsure to connect a hostname to any tenant website you'd like to work on.<\/p>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Models\\Hostname;\nuse Hyn\\Tenancy\\Contracts\\Repositories\\HostnameRepository;\n\n$hostname = new Hostname;\n$hostname-&gt;fqdn = 'luceos.demo.app';\n$hostname = app(HostnameRepository::class)-&gt;create($hostname);\napp(HostnameRepository::class)-&gt;attach($hostname, $website);\ndd($website-&gt;hostnames); \/\/ Collection with $hostname\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>The <code>fqdn<\/code> property of the hostname is crucial. It stands for\nFully Qualified Domain Name and can be something like <code>yourapp.com<\/code> or\n<code>demo.yourapp.com<\/code> but can never include protocol (eg <code>http:\/\/<\/code>) or paths\n(eg <code>yourapp.com\/tenant<\/code>).<\/p><\/div>\n<h1 id=\"switch-to-new-tenant\"><a href=\"#switch-to-new-tenant\" class=\"anchor-link\"><\/a>Switch to new tenant<\/h1>\n<p>For the package to set up Laravel for the specific tenant, the environment has to be\n&quot;switched&quot;. This switching will set up things like the tenant database connection and\nfilesystem logic like custom config files.<\/p>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Environment;\n$tenancy = app(Environment::class);\n\n$tenancy-&gt;hostname($hostname);\n\n$tenancy-&gt;hostname(); \/\/ resolves $hostname as currently active hostname\n\n$tenancy-&gt;tenant($website); \/\/ switches the tenant and reconfigures the app\n\n$tenancy-&gt;website(); \/\/ resolves $website\n$tenancy-&gt;tenant(); \/\/ resolves $website\n\n$tenancy-&gt;identifyHostname(); \/\/ resets resolving $hostname by using the Request\n<\/code><\/pre>\n<h1 id=\"querying\"><a href=\"#querying\" class=\"anchor-link\"><\/a>Querying<\/h1>\n<p>In case you would like to query the database for hostnames or websites. Use the\n<code>query()<\/code> method of the repositories, this will return a <a href=\"https:\/\/laravel.com\/docs\/6.x\/queries\"><code>Illuminate\\Database\\Eloquent\\Builder<\/code><\/a>\ninstance.<\/p>\n","updated_at":{"date":"2020-07-18 16:49:31.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.5\/creating-tenants.md"},{"title":"Models","icon":"fal fa-hand-holding-box","path":"docs\/hyn\/5.5\/models.md","slug":"models","package":"hyn","version":"5.5","contents":"<p>Tenancy offers a few ways to more easily connect with the correct database.<\/p>\n<h4 id=\"traits\"><a href=\"#traits\" class=\"anchor-link\"><\/a>Traits<\/h4>\n<p>Two traits exist to force a model onto either the <code>tenant<\/code> or <code>system<\/code> connection.<\/p>\n<ul>\n<li>\n<code>Hyn\\Tenancy\\Traits\\UsesSystemConnection<\/code> to make a model use the system connection.<\/li>\n<li>\n<code>Hyn\\Tenancy\\Traits\\UsesTenantConnection<\/code> to make a model use the tenant connection.<\/li>\n<\/ul>\n<p>The below snippet shows an example of how to force the User model to use the tenant\nconnection.<\/p>\n<pre><code class=\"language-php\">namespace App;\n\nuse Hyn\\Tenancy\\Traits\\UsesTenantConnection;\nuse Illuminate\\Notifications\\Notifiable;\nuse Illuminate\\Foundation\\Auth\\User as Authenticatable;\n\nclass User extends Authenticatable\n{\n    use Notifiable, UsesTenantConnection;\n    \n    \/\/ ..\n}\n<\/code><\/pre>\n<h4 id=\"abstract-models\"><a href=\"#abstract-models\" class=\"anchor-link\"><\/a>Abstract models<\/h4>\n<p>Instead of using the traits directly one can also simply have the models extend the abstract\nmodels provided in the package.<\/p>\n<ul>\n<li>\n<code>Hyn\\Tenancy\\Abstracts\\SystemModel<\/code> can be extended to give easy access to\nthe system database connection.<\/li>\n<li>\n<code>Hyn\\Tenancy\\Abstracts\\TenantModel<\/code> can be extended to have your Eloquent models\nuse the connection of the identified tenant per default.<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>Please note these abstract models are using the respective traits mentioned above.<\/p><\/div>\n<h4 id=\"relationships\"><a href=\"#relationships\" class=\"anchor-link\"><\/a>Relationships<\/h4>\n<p>Model eloquent relations are possible from tenant to system and vice versa. One thing to remember\nwith intermediate tables involved, for instance on the belongsToMany relationship, is that you can\nprefix the intermediate table with the connection.<\/p>\n<p>For instance, when you have your User model on the system database - acting as a global user - you can\nstore the user roles on the tenant database by prefixing that intermediate table with the tenant database\nname and assigning the Role model to the tenant connection.<\/p>\n<pre><code class=\"language-php\">    public function roles() {\n        $config = app(\\Hyn\\Tenancy\\Database\\Connection::class)-&gt;configuration();\n        return $this-&gt;belongsToMany('App\\Role', &quot;{$config['database']}.role_user&quot;);\n    }\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>This only works if tenant databases are on the same server as the system database! You cannot\nuse the managing system connection feature in this scenario.<\/p><\/div>\n","updated_at":{"date":"2020-07-18 16:49:31.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.5\/models.md"},{"title":"Structure","icon":"fal fa-sitemap","path":"docs\/hyn\/5.5\/structure.md","slug":"structure","package":"hyn","version":"5.5","contents":"<h1 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h1>\n<p>The location of the tenant specific files is configured inside the <code>config\/tenancy.php<\/code>\nfile under <code>website &gt; disk<\/code>. By default tenant files\nare stored in <code>storage\/app\/tenancy\/tenants<\/code>.<\/p>\n<p>Inside this tenant directory you are able to override global logic by\ngenerating the necessary files. Check the <code>config\/tenancy.php<\/code> file under\n<code>folders<\/code> to see which ones are enabled by default.<\/p>\n<h2 id=\"config\"><a href=\"#config\" class=\"anchor-link\"><\/a>Config<\/h2>\n<p>Any php files stored inside a <code>config\/<\/code> directory of the tenant are read\nduring runtime. Existing configuration values are replaced and new ones\nare appended.<\/p>\n<p>A great use case for this feature is the ability to configure client\nspecific mail settings.<\/p>\n<p>The <code>config\/tenancy.php<\/code> configuration file allows you to refuse overrides of specific\nconfiguration settings using the <code>folders &gt; config &gt; blacklist<\/code> setting.\nBy default it disallows database, tenancy and webserver changes.<\/p>\n<h2 id=\"routes\"><a href=\"#routes\" class=\"anchor-link\"><\/a>Routes<\/h2>\n<p>Create a <code>routes.php<\/code> file inside your tenant directory to configure\nnew routes during runtime. Using a configurable prefix, any unique\nurl's will be matched for this specific tenant only.<\/p>\n<h2 id=\"trans\"><a href=\"#trans\" class=\"anchor-link\"><\/a>Trans<\/h2>\n<p>New translations can be added easily by creating a <code>lang\/<\/code> folder.\nThe native Laravel translator will parse any files contained here\nto be used in the application of this specific tenant.<\/p>\n<p>You are able to specify whether these language files should override\nthe global, system-wide translation. In case you decide against that\nfeel free to set up a translation namespace.<\/p>\n<h2 id=\"views\"><a href=\"#views\" class=\"anchor-link\"><\/a>Views<\/h2>\n<p>Additional or overriding views is possible by creating a <code>views\/<\/code> folder\ninside the tenant directory. There are three possible scenarios to\nconfigure how views are picked up by Laravel:<\/p>\n<ol>\n<li>By adding views inside the global namespace, overriding existing\nglobal views.<\/li>\n<li>By adding views inside the global namespace, but where existing\nglobal views take precedence.<\/li>\n<li>By adding views inside their own namespace.<\/li>\n<\/ol>\n<h2 id=\"vendor\"><a href=\"#vendor\" class=\"anchor-link\"><\/a>Vendor<\/h2>\n<p>A very powerful addition is the ability to inject new packages and code.\nWhenever the tenant directory has a <code>vendor\/autoload.php<\/code> file it will\nbe loaded during runtime. Using that specific file allows you to fully\nutilize the power of composer inside your tenant directories.<\/p>\n<div class=\"alert alert-info\"><p>Please be aware that no compatibility checks are executed against your app.\nIdentifying whether a composer conflict could happen is something you should test\noutside production environments.<\/p><\/div>\n<h2 id=\"media\"><a href=\"#media\" class=\"anchor-link\"><\/a>Media<\/h2>\n<p>The media folder can be used by creating a <code>media\/<\/code> folder inside the\ntenant directory. Files inside that directory will become automatically\navailable as a public directory inside an equally named directory <code>media\/<\/code>.<\/p>\n<p>Eg: storing a file <code>media\/bg.jpg<\/code> will allow you to use <code>\/media\/bg.jpg<\/code> inside\nyour html. This applies to any file you store.<\/p>\n<h3 id=\"media-webserver\"><a href=\"#media-webserver\" class=\"anchor-link\"><\/a>\/media webserver<\/h3>\n<p>An alias is set up binding the private tenant media directory to the public\nmedia directory. This is implemented using the auto generated web server\nconfiguration files for apache and nginx.<\/p>\n<h3 id=\"media-fallback-controller\"><a href=\"#media-fallback-controller\" class=\"anchor-link\"><\/a>\/media fallback controller<\/h3>\n<p>In case you're not using the webserver vhost configuration files provided\nby this package you can choose to map the <code>MediaController<\/code> to the path, eg:<\/p>\n<pre><code class=\"language-php\">Route::get('\/media\/{path}', '\\Hyn\\Tenancy\\Controllers\\MediaController')\n    -&gt;where('path', '.+')\n    -&gt;name('tenant.media');\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 16:49:31.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.5\/structure.md"}]},{"name":"tenant aware","links":["filesystem","migrations","validation","queues","events","cache","commands"],"slug":"tenant-aware","articles":[{"title":"Filesystem","icon":"fal fa-hdd","path":"docs\/hyn\/5.5\/filesystem.md","slug":"filesystem","package":"hyn","version":"5.5","contents":"<p>Tenancy offers a strategic <a href=\"structure\">directory structure<\/a> for tenants.<\/p>\n<h1 id=\"tenant-disk\"><a href=\"#tenant-disk\" class=\"anchor-link\"><\/a>Tenant disk<\/h1>\n<p>To access the directory of the active tenant, you can use the <code>tenant<\/code> disk.<\/p>\n<pre><code class=\"language-php\">Storage::disk('tenant')-&gt;put('readme.md', 'Hi John.');\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Tenants files are by default stored to <code>storage\/app\/tenancy<\/code>, but this can be reconfigured\nin the <code>tenancy.php<\/code> under <code>website &gt; disk<\/code>.<\/p><\/div>\n<p>Read more about disks on the <a href=\"https:\/\/laravel.com\/docs\/6.x\/filesystem\">Laravel documentation<\/a>.<\/p>\n<h1 id=\"directory\"><a href=\"#directory\" class=\"anchor-link\"><\/a>Directory<\/h1>\n<p>In order to assist with mutating these contents, you can use the\nDirectory class available in this package.<\/p>\n<pre><code class=\"language-php\">$directory = app(\\Hyn\\Tenancy\\Website\\Directory::class);\n<\/code><\/pre>\n<p>This class is set to use the tenant currently active, but also allows you to activate\nany other tenant whenever you need to use the <code>setWebsite(Website $website)<\/code> method.<\/p>\n<p>The Directory class implements <code>Illuminate\\Contracts\\Filesystem\\Filesystem<\/code> which offers\nthe same methods you are used to, including; <code>get<\/code>, <code>put<\/code> and <code>setVisibility<\/code>.<\/p>\n<h1 id=\"tenancy-directory\"><a href=\"#tenancy-directory\" class=\"anchor-link\"><\/a>Tenancy directory<\/h1>\n<p>In case you prefer having a higher level access to the files for tenants you can use the Filesystem bound to Laravel's container.<\/p>\n<pre><code class=\"language-php\">\/** @var \\Illuminate\\Contracts\\Filesystem\\Filesystem $tenancy *\/\n$tenancy = app('tenancy.disk');\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 16:49:31.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.5\/filesystem.md"},{"title":"Migrations","icon":"fal fa-pallet-alt","path":"docs\/hyn\/5.5\/migrations.md","slug":"migrations","package":"hyn","version":"5.5","contents":"<p>Migrations are extremely important in the Laravel ecosystem.\nMigration commands for tenants have the Artisan prefix <code>tenancy:<\/code>.<\/p>\n<h1 id=\"about-the-databasemigrations-path\"><a href=\"#about-the-databasemigrations-path\" class=\"anchor-link\"><\/a>About the database\/migrations path<\/h1>\n<p>It's not wise to store the tenants migrations inside your global\n<code>database\/migrations<\/code> directory. Laravel by default runs these migrations\nwhen calling the <code>php artisan migrate<\/code> command. Even though you can suggest\na connection during that command, it's much cleaner to store these migrations\ninside a separate directory, e.g. <code>database\/migrations\/tenant<\/code>.\nThe migrations for the system database can stay in <code>database\/migrations<\/code>.<\/p>\n<h1 id=\"default-migrations-for-new-tenants\"><a href=\"#default-migrations-for-new-tenants\" class=\"anchor-link\"><\/a>Default migrations for new tenants<\/h1>\n<p>If you want new tenants to be migrated by default, you can easily do so. In\nyour <code>tenancy.php<\/code> configuration set <code>db &gt; tenant-migrations-path<\/code> to a valid\nabsolute path and all your new tenants will run these migrations by default.<\/p>\n<pre><code class=\"language-php\">  \/\/ ..\n  &quot;tenant-migrations-path&quot; =&gt; database_path('migrations\/tenant'),\n  \/\/ ..\n<\/code><\/pre>\n<h1 id=\"default-seeds-for-newly-auto-migrated-tenants\"><a href=\"#default-seeds-for-newly-auto-migrated-tenants\" class=\"anchor-link\"><\/a>Default seeds for newly auto-migrated tenants<\/h1>\n<p>In case you would also like to seed the databases of your newly created\nand migrated tenants, you can enable <code>db &gt; tenant-seed-class<\/code> in your <code>tenancy.php<\/code>\nconfiguration file. Change this setting to a fully namespaced class name\nand the package will automatically run this seed after it has run the\nautomatic migrations.<\/p>\n<h1 id=\"migration-related-commands\"><a href=\"#migration-related-commands\" class=\"anchor-link\"><\/a>Migration related commands<\/h1>\n<p>Tenancy is also able to run migrations through Artisan commands.<\/p>\n<p>Tenancy has added the <code>--website_id[=WEBSITE_ID]<\/code> option to each of the following native Laravel migrate and seed\ncommand and namespaced it accordingly, for instance.<\/p>\n<ul>\n<li>\n<code>tenancy:migrate<\/code> - Run the database migrations<\/li>\n<li>\n<code>tenancy:migrate:refresh<\/code> - Reset and re-run all migrations<\/li>\n<li>\n<code>tenancy:migrate:reset<\/code> - Rollback all database migrations<\/li>\n<li>\n<code>tenancy:migrate:rollback<\/code> - Rollback the last database migration<\/li>\n<li>\n<code>tenancy:db:seed<\/code> - Seed the database with records<\/li>\n<\/ul>\n<p>The --website_id optional option accepts multiple values. Though optional, if you leave the option out it will\nrun the command against all tenants. For example:<\/p>\n<ul>\n<li>\n<code>php artisan tenancy:migrate --website_id=1<\/code> to migrate just tenant website 1.<\/li>\n<li>\n<code>php artisan tenancy:migrate --website_id=1 --website_id=2<\/code> to migrate tenant website 1 &amp; 2.<\/li>\n<li>\n<code>php artisan tenancy:migrate<\/code> to migrate all tenant websites.<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>The <code>website_id<\/code> reflects the auto incremented <code>id<\/code> column of the Website and <strong>NOT<\/strong> the UUID.<\/p><\/div>\n<p>Please check the separate signatures for more information of valid arguments\nand options.<\/p>\n<div class=\"alert alert-info\"><p>Running <code>tenancy:migrate<\/code> without any path or realpath option and\nwithout having configured <code>tenant-migrations-path<\/code> will migrate your\ntenants with the files inside the <code>database\/migrations<\/code> directory.<\/p><\/div>\n<h1 id=\"reconstructing-tenant-databases\"><a href=\"#reconstructing-tenant-databases\" class=\"anchor-link\"><\/a>Reconstructing tenant databases<\/h1>\n<p>As long as your system database is intact, there's a way to recreate all tenant databases. You can use the <code>tenancy:recreate<\/code> artisan command to recreate all tenant databases that do not exist. The command will run the migrations and seeds according to your configuration in <code>tenancy.php<\/code>.<\/p>\n<div class=\"alert alert-info\"><p>Though the structure of all of your tenant databases will be recreated, the data in it won't.<\/p><\/div>\n","updated_at":{"date":"2020-07-18 16:49:31.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.5\/migrations.md"},{"title":"Validations","icon":"fal fa-file-check","path":"docs\/hyn\/5.5\/validation.md","slug":"validation","package":"hyn","version":"5.5","contents":"<h2 id=\"exists-and-unique-validation-rule\"><a href=\"#exists-and-unique-validation-rule\" class=\"anchor-link\"><\/a>Exists and Unique Validation Rule<\/h2>\n<p>Among all the built-in validation in Laravel, only the <a href=\"https:\/\/laravel.com\/docs\/6.x\/validation#rule-exists\">exists<\/a> and <a href=\"https:\/\/laravel.com\/docs\/6.0\/validation#rule-unique\">unique<\/a> validation rules interact with the database.<\/p>\n<p>We can leverage these two rules with tenancy by adding the connection parameter. Both use the same validation rule\nsignature which is <code>rule:connection.table,column<\/code>.<\/p>\n<p>So for example, to use <code>Exists (Database)<\/code> use <code>'email' =&gt; 'exists:tenant.staff,email'<\/code> where <code>tenant<\/code> is the <code>'tenant-connection-name'<\/code> you specified in your <code>tenancy.php<\/code> config file.<\/p>\n<p>Similarly, you can substitute the <code>exists<\/code> keyword to <code>unique<\/code> to use the <code>unique<\/code> rule instead, eg: <code>'email' =&gt; 'unique:tenant.staff,email'<\/code>.<\/p>\n<div class=\"alert alert-info\"><p>Validating against the system database is possible using the method described above but replacing <code>tenant<\/code> with <code>system<\/code>.<\/p><\/div>\n","updated_at":{"date":"2020-07-18 16:49:31.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.5\/validation.md"},{"title":"Queues","icon":"fal fa-conveyor-belt","path":"docs\/hyn\/5.5\/queues.md","slug":"queues","package":"hyn","version":"5.5","contents":"<p>One of the strongest features of Laravel is its queues. One drawback of sending\nJobs into the Queue is that these are executed in a completely different process\ndepending on your queue configuration, including redis and beanstalk.<\/p>\n<p>In order to assist you with tenant aware jobs, this package automatically identifies\nwhether a tenant website is active before processing the job. This ensures that\njobs are always tenant aware. In case you wish to override the tenant for which the job\nis executed, make sure to set the <code>website_id<\/code> property on the Job before dispatching it.<\/p>\n<pre><code class=\"language-php\">namespace App\\Jobs;\n\nuse Illuminate\\Bus\\Queueable;\nuse Illuminate\\Queue\\InteractsWithQueue;\nuse Illuminate\\Contracts\\Queue\\ShouldQueue;\nuse Illuminate\\Foundation\\Bus\\Dispatchable;\nuse Illuminate\\Queue\\SerializesModels;\n\nclass ProcessPodcast implements ShouldQueue\n{\n    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;\n    \n    public $website_id;\n    \n    public function __construct(int $website_id) {\n        $this-&gt;website_id = $website_id;\n    }\n}\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 18:29:42.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.5\/queues.md"},{"title":"Events","icon":"fal fa-hourglass-end","path":"docs\/hyn\/5.5\/events.md","slug":"events","package":"hyn","version":"5.5","contents":"<p>To create a fluid ecosystem around Laravel, this package uses events heavily.<\/p>\n<div class=\"alert alert-info\"><p>It's highly recommended to read up on the native <a href=\"https:\/\/laravel.com\/docs\/6.x\/events\">events<\/a> in Laravel.<\/p><\/div>\n<h1 id=\"model-events\"><a href=\"#model-events\" class=\"anchor-link\"><\/a>Model events<\/h1>\n<p>Namespaces:<\/p>\n<ul>\n<li>\n<code>Hyn\\Tenancy\\Events\\Hostnames<\/code>\n<\/li>\n<li>\n<code>Hyn\\Tenancy\\Events\\Websites<\/code>\n<\/li>\n<\/ul>\n<p>All of the models have the following events, whose purposes mirror Laravel's own model events.<\/p>\n<ul>\n<li>Creating<\/li>\n<li>Created<\/li>\n<li>Updating<\/li>\n<li>Updated<\/li>\n<li>Deleting<\/li>\n<li>Deleted<\/li>\n<\/ul>\n<h2 id=\"websites\"><a href=\"#websites\" class=\"anchor-link\"><\/a>Websites<\/h2>\n<p>Namespace: <code>Hyn\\Tenancy\\Events\\Websites<\/code>.<\/p>\n<ul>\n<li>Identified: a tenant website was identified.<\/li>\n<li>NoneFound: no tenant website was identified.<\/li>\n<li>Migrated: a website was auto migrated (not fired from console commands).<\/li>\n<li>Switched: the current tenant website was changed.<\/li>\n<\/ul>\n<h2 id=\"hostnames\"><a href=\"#hostnames\" class=\"anchor-link\"><\/a>Hostnames<\/h2>\n<p>Namespace: <code>Hyn\\Tenancy\\Events\\Hostnames<\/code>.<\/p>\n<p>The hostname model has a few additional events:<\/p>\n<ul>\n<li>Attached: the hostname was attached to a website.<\/li>\n<li>Detached: the hostname was removed from a website.<\/li>\n<li>Identified: the hostname is identified based on the request.<\/li>\n<li>NoneFound: no hostname was found during identification.<\/li>\n<li>Redirected: the hostname is configured to redirect to another url.<\/li>\n<li>Secured: the hostname is configured to upgrade the request to https.<\/li>\n<li>Switched: currently active hostname was changed.<\/li>\n<li>UnderMaintenance: the hostname is configured to be in maintenance.<\/li>\n<\/ul>\n<h1 id=\"database\"><a href=\"#database\" class=\"anchor-link\"><\/a>Database<\/h1>\n<p>Namespace: <code>Hyn\\Tenancy\\Events\\Database<\/code>.<\/p>\n<ul>\n<li>Creating<\/li>\n<li>Created<\/li>\n<li>Deleting<\/li>\n<li>Deleted<\/li>\n<li>Renaming<\/li>\n<li>Renamed<\/li>\n<li>ConfigurationLoading: the configuration for a tenant database connection\nis loading.<\/li>\n<li>ConfigurationLoaded: the configuration for a tenant database connection\nwas loaded.<\/li>\n<li>ConnectionSet: a connection was set and possibly an old one purged.<\/li>\n<\/ul>\n<h1 id=\"webservers\"><a href=\"#webservers\" class=\"anchor-link\"><\/a>Webservers<\/h1>\n<p>Namespace: <code>Hyn\\Tenancy\\Events\\Webservers<\/code>.<\/p>\n<ul>\n<li>ConfigurationSaved: the configuration for the webserver was saved to disk.<\/li>\n<\/ul>\n","updated_at":{"date":"2020-07-18 16:49:31.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.5\/events.md"},{"title":"Cache","icon":"fal fa-window-restore","path":"docs\/hyn\/5.5\/cache.md","slug":"cache","package":"hyn","version":"5.5","contents":"<p>Currently the Laravel cache will use the same cache key for all tenants.\nThis can and will cause issues in the long run. The config key for tenants\nshould be automatically changed and the ability to disable overriding the cache key should be configurable inside <code>tenancy.php<\/code>.<\/p>\n<p>The following is an easy implementation to allow per-tenant prefixes.<\/p>\n<p>Add a <code>CacheServiceProvider<\/code> with these contents in boot method:<\/p>\n<pre><code class=\"language-php\">public function boot()\n{\n    Cache::extend('redis_tenancy', function ($app) {\n        if (PHP_SAPI === 'cli') {\n            $uuid = $app['config']['driver'];\n        } else {\n            \/\/ ok, this is basically a hack to set the redis cache store\n            \/\/ prefix to the UUID of the current website being called\n            $fqdn = request()-&gt;getHost();\n\n            $uuid = DB::table('hostnames')\n                -&gt;select('websites.uuid')\n                -&gt;join('websites', 'hostnames.website_id', '=', 'websites.id')\n                -&gt;where('fqdn', $fqdn)\n                -&gt;value('uuid');\n        }\n\n        return Cache::repository(new RedisStore(\n            $app['redis'],\n            $uuid,\n            $app['config']['cache.stores.redis.connection']\n        ));\n    });\n}\n<\/code><\/pre>\n<p>This does not require a new Cache driver, as it's re-using\nthe existing Redis driver. All this does is override the default prefix and\nallows you to set a custom cache driver in <code>config\/cache.php<\/code>:<\/p>\n<pre><code class=\"language-php\">'redis' =&gt; [\n    'driver'     =&gt; 'redis_tenancy',\n    'connection' =&gt; 'default',\n],\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Make sure the CacheServiceProvider is registered in <code>config\/app.php<\/code> or else your driver will\nnot be available for use.<\/p><\/div>\n","updated_at":{"date":"2020-07-18 16:49:31.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.5\/cache.md"},{"title":"Commands","icon":"fal fa-screwdriver","path":"docs\/hyn\/5.5\/commands.md","slug":"commands","package":"hyn","version":"5.5","contents":"<p>Aside from the tenant aware <a href=\"migrations\">migration<\/a> command, the following\nis a list of additional commands provided by this package.<\/p>\n<h1 id=\"run-proxy-command\"><a href=\"#run-proxy-command\" class=\"anchor-link\"><\/a>Run proxy command<\/h1>\n<p>If you'd like to run any command for a tenant, you can use the <code>tenancy:run<\/code> command.<\/p>\n<p>You can execute and check the signature with<\/p>\n<pre><code class=\"language-bash\">$ php artisan tenancy:run --help\n<\/code><\/pre>\n<p>How it works:<\/p>\n<ul>\n<li>Using the <code>--tenant<\/code> option is optional. If you leave it out the command will be run on all tenants.<\/li>\n<li>The <code>--tenant<\/code> option accepts either a single website id or a comma separated list of website ids.<\/li>\n<li>If your target command requires options or arguments, you can add them like this:<\/li>\n<\/ul>\n<pre><code class=\"language-bash\">$ php artisan tenancy:run &lt;command&gt; --option=&quot;key=value&quot; --option=&quot;live=1&quot; --argument=&quot;key=value&quot;\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Make sure you include the argument or option key!<\/p><\/div>\n<p>Example:<\/p>\n<p>Execute Artisan command permission:update for website id 2 and 3<\/p>\n<pre><code class=\"language-bash\">php artisan tenancy:run permission:update --tenant=2,3\n<\/code><\/pre>\n<p>Please note this command does not do any checking and will forward any exceptions it hits.<\/p>\n<p>Also, <strong>don't<\/strong> run tenancy:run like this:<\/p>\n<pre><code class=\"language-bash\">$ php artisan tenancy:run tenancy:run --argument=&quot;run=tenancy:run&quot;\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Note: <code>tenancy:run<\/code> should not be called when running migrations. Use the <code>tenancy:migrate<\/code> command instead.<\/p><\/div>\n<h1 id=\"programmatic-artisan-calls\"><a href=\"#programmatic-artisan-calls\" class=\"anchor-link\"><\/a>Programmatic Artisan calls<\/h1>\n<pre><code class=\"language-php\">Artisan::call('tenancy:run', [\n        'run' =&gt; 'permission:update',\n        '--tenant' =&gt; [1,2,3]\n        ]);\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Make sure --tenant value is always an array. An integer value will fail.<\/p><\/div>\n<h1 id=\"recreate-command\"><a href=\"#recreate-command\" class=\"anchor-link\"><\/a>Recreate command<\/h1>\n<p>The recreate command allows you to create databases and filesystem directories for\nall tenants. It will check whether each tenant database already exists, create it if necessary\nand then dispatch a &quot;Created&quot; event that causes the folders and possible vhost configurations\nto be made.<\/p>\n<pre><code class=\"language-bash\">$ php artisan tenancy:recreate\n<\/code><\/pre>\n<h1 id=\"tenant-aware-tinker-command\"><a href=\"#tenant-aware-tinker-command\" class=\"anchor-link\"><\/a>Tenant Aware Tinker Command<\/h1>\n<p>This section describes how to enable tenant awareness for the native Laravel <code>tinker<\/code> command.<\/p>\n<p>First, create a trait named <code>MutatesTinkerCommand<\/code> with the following content:<\/p>\n<pre><code class=\"language-php\">namespace App\\Traits;\n\nuse Hyn\\Tenancy\\Contracts\\Repositories\\WebsiteRepository;\nuse Hyn\\Tenancy\\Database\\Connection;\nuse Illuminate\\Database\\Eloquent\\ModelNotFoundException;\nuse Symfony\\Component\\Console\\Exception\\RuntimeException;\nuse Symfony\\Component\\Console\\Input\\InputOption;\n\ntrait MutatesTinkerCommand\n{\n    \/**\n     * @var Connection\n     *\/\n    private $connection;\n\n    \/**\n     * @var WebsiteRepository\n     *\/\n    private $websites;\n\n    public function __construct()\n    {\n        parent::__construct();\n        $this-&gt;setName('tenancy:' . $this-&gt;getName());\n        $this-&gt;websites = app(WebsiteRepository::class);\n        $this-&gt;connection = app(Connection::class);\n    }\n\n    \/**\n     * Execute the console command.\n     *\n     * @return void\n     *\n     * @throws \\Hyn\\Tenancy\\Exceptions\\ConnectionException\n     *\/\n    public function handle()\n    {\n        $website_id = $this-&gt;option('website_id');\n        try{\n            $website = $this-&gt;websites-&gt;query()-&gt;where('id', $website_id)-&gt;firstOrFail();\n            $this-&gt;connection-&gt;set($website);\n            $this-&gt;info('Running Tinker on website_id: ' . $website_id);\n\n            parent::handle();\n            \n            $this-&gt;connection-&gt;purge();\n        } catch (ModelNotFoundException $e) {\n            throw new RuntimeException(sprintf('The tenancy website_id=%d does not exist.', $website_id));\n        }\n    }\n\n    protected function getOptions()\n    {\n        return array_merge([$this-&gt;addWebsiteOption()], parent::getOptions());\n    }\n\n    protected function addWebsiteOption()\n    {\n        return ['website_id', null, InputOption::VALUE_REQUIRED, 'The tenancy website_id (not uuid) to tinker specifically.', null];\n    }\n}\n<\/code><\/pre>\n<p>You can only tinker on one database at a time. Therefore the <code>website_id<\/code> needs to be a required option. Utilizing the <code>AddWebsiteFilterOnCommand<\/code> trait available in the Tenancy package would not work in this instance as it is tailored to run processes on multiple websites and makes the <code>website_id<\/code> parameter optional.<\/p>\n<p>Second, create a new console command <code>TinkerCommand<\/code> that uses the trait above.<\/p>\n<pre><code class=\"language-php\">namespace App\\Console\\Commands;\n\nuse Laravel\\Tinker\\Console\\TinkerCommand as BaseCommand;\nuse App\\Traits\\MutatesTinkerCommand;\n\nclass TinkerCommand extends BaseCommand\n{\n    use MutatesTinkerCommand;\n}\n<\/code><\/pre>\n<p>Now we have created a new <code>tenancy:tinker<\/code> artisan command. The <code>tenancy:tinker<\/code> requires the <code>--website_id=<\/code> option as a parameter. So, in order to run tinker on a <code>website_id<\/code> of 1, you\u2019ll need to run:<\/p>\n<pre><code class=\"language-bash\">$ php artisan tenancy:tinker --website_id=1\n\nRunning Tinker on website_id: 1\nPsy Shell v0.9.6 (PHP 7.2.7 \u2014 cli) by Justin Hileman\n&gt;&gt;&gt;\n<\/code><\/pre>\n<p>It will throw an error if the <code>--website_id=<\/code> option is missing:<\/p>\n<pre><code class=\"language-bash\">$ php artisan tenancy:tinker\n\n\n  The tenancy website_id=0 does not exist.\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 18:29:42.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.5\/commands.md"}]},{"name":"customization","links":["custom-models","logging"],"slug":"customization","articles":[{"title":"Custom system models","icon":"fal fa-theater-masks","path":"docs\/hyn\/5.5\/custom-models.md","slug":"custom-models","package":"hyn","version":"5.5","contents":"<p>This package allows you to specify different models to be used for the\nHostname and Website models. Tenancy will take care of the relationships on the\npackage-end. You also need to implement <code>Hyn\\Tenancy\\Contracts\\{Model}<\/code><\/p>\n<p>Take this example:<\/p>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Contracts\\Website as Contract;\n\nclass Website implements Contract\n{\n}\n<\/code><\/pre>\n<p>All you need to do is update the <code>tenancy.php<\/code> configuration file:<\/p>\n<pre><code class=\"language-php\">return [\n  'models' =&gt; [\n      \/\/ ..\n      \/\/ Must implement \\Hyn\\Tenancy\\Contracts\\Hostname\n      'hostname' =&gt; \\Hyn\\Tenancy\\Models\\Hostname::class,\n      \/\/ Must implement \\Hyn\\Tenancy\\Contracts\\Website\n      'website' =&gt; \\App\\Website::class\n  ],\n  \/\/ ...\n];\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 18:29:42.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.5\/custom-models.md"},{"title":"Logging","icon":"fal fa-book","path":"docs\/hyn\/5.5\/logging.md","slug":"logging","package":"hyn","version":"5.5","contents":"<p>Especially in production you might want to split the default Laravel log by tenants.\nTenancy ships with a custom tenant aware logger which you can register in the <code>logging.php<\/code> config.<\/p>\n<ul>\n<li>If a tenant is detected it will create a <code>logs<\/code> folder within the tenant directory:\n<code>storage\/app\/tenancy\/tenants\/&lt;tenant uuid&gt;\/logs\/&lt;log_level&gt;_&lt;YYYY&gt;-&lt;MM&gt;-&lt;DD&gt;.log<\/code>\n<\/li>\n<li>If no tenant is detected it will store the log file to:\n<code>storage\/logs\/<\/code>.<\/li>\n<\/ul>\n<p>Add a new <code>tenant<\/code> channel to the channels array in your <code>config\/logging.php<\/code> like below:<\/p>\n<pre><code class=\"language-php\">\/\/ ...\n'channels' =&gt; [\n        \/\/ ...\n        'tenant' =&gt; [\n            'driver' =&gt; 'custom',\n            'via' =&gt; \\Hyn\\Tenancy\\Logging\\TenantAwareLogger::class,\n            'level' =&gt; 'debug',\n        ],\n\/\/ ...\n<\/code><\/pre>\n<p>Then just change the 'single' channel to 'tenant' channel your stack channel:<\/p>\n<pre><code class=\"language-php\">\/\/ ...\n'stack' =&gt; [\n            'driver' =&gt; 'stack',\n            'channels' =&gt; ['tenant'],\n        ],\n\/\/ ...\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 16:49:31.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.5\/logging.md"}]},{"name":"webserver","links":["apache","nginx"],"slug":"webserver","articles":[{"title":"Apache","icon":"fal fa-server","path":"docs\/hyn\/5.5\/apache.md","slug":"apache","package":"hyn","version":"5.5","contents":"<h1 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h1>\n<p>Tenancy natively integrates with the Apache webserver. For that to work you need\nto do a minor configuration.<\/p>\n<p>Edit the <code>\/etc\/apache2\/apache2.conf<\/code> and below the last <code>IncludeOptional<\/code> statement\nadd:<\/p>\n<pre><code class=\"language-apacheconfig\">IncludeOptional &lt;path&gt;\/*.conf\n<\/code><\/pre>\n<p>Where <code>&lt;path&gt;<\/code> has to be replaced by the location of your vhost files generated by this package.<\/p>\n<div class=\"alert alert-info\"><p>Your vhost files are saved by default inside the <code>storage\/app\/tenancy\/webserver\/apache<\/code> and\ncan be reconfigured in the <code>webserver.php<\/code> configuration file.<\/p><\/div>\n<p>Make sure to reload apache afterwards:<\/p>\n<pre><code class=\"language-bash\">sudo apache2ctl graceful\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 16:49:31.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.5\/apache.md"},{"title":"Nginx","icon":"fal fa-server","path":"docs\/hyn\/5.5\/nginx.md","slug":"nginx","package":"hyn","version":"5.5","contents":"<h1 id=\"set-up\"><a href=\"#set-up\" class=\"anchor-link\"><\/a>Set up<\/h1>\n<p>You need to set up your own PHP FPM. The preferred way of running php is through a <a href=\"https:\/\/coderwall.com\/p\/hmsr5a\/have-php-fpm-listen-on-unix-socket\">socket<\/a> by\nconfiguring the <code>listen<\/code> value in your pool correctly. Make sure to copy the path of your\nsock and update your <code>webserver.php<\/code> configuration file to reflect that value, for instance:<\/p>\n<pre><code class=\"language-php\">    \/**\n     * Nginx webserver support.\n     *\n     * @see http:\/\/nginx.org\n     *\/\n    'nginx' =&gt; [\n        \/\/ ..\n\n        \/**\n         * The php sock to be used.\n         *\/\n        'php-sock' =&gt; 'unix:\/var\/run\/php\/php-fpm.sock',\n        \n        \/\/ ..\n    ],\n<\/code><\/pre>\n<h1 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h1>\n<p>Tenancy natively integrates with the Nginx webserver. For that to work you need\nto do a minor configuration.<\/p>\n<p>Edit the <code>\/etc\/nginx\/nginx.conf<\/code> and below the last <code>include<\/code> statement\nadd:<\/p>\n<pre><code class=\"language-apacheconfig\">include &lt;path&gt;\/*.conf;\n<\/code><\/pre>\n<p>Where <code>&lt;path&gt;<\/code> has to be replaced by the location of your vhost files generated by this package.<\/p>\n<div class=\"alert alert-info\"><p>Your vhost files are saved by default inside the <code>storage\/app\/tenancy\/webserver\/nginx<\/code> and\ncan be reconfigured in the <code>webserver.php<\/code> configuration file.<\/p><\/div>\n<p>Make sure to restart nginx afterwards:<\/p>\n<pre><code class=\"language-bash\">sudo systemctl restart nginx\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 16:49:31.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.5\/nginx.md"}]},{"name":"tutorials","links":["spatie-laravel-permission","spatie-medialibrary","laravel-scheduler"],"slug":"tutorials","articles":[{"title":"Spatie permission","excerpt":"A tutorial on setting up spatie\/laravel-permission.","icon":"fal fa-file-archive","tags":["spatie","permission","tutorial"],"path":"docs\/hyn\/5.5\/spatie-laravel-permission.md","slug":"spatie-laravel-permission","package":"hyn","version":"5.5","contents":"<h2 id=\"prerequisite\"><a href=\"#prerequisite\" class=\"anchor-link\"><\/a>Prerequisite<\/h2>\n<p>You need a fresh Laravel app with Hyn Multi-Tenant installed. Briefly here are the basics:<\/p>\n<ol>\n<li>Create a fresh install of Laravel.  If you have installed the Laravel Terminal Installer run: <code>$ laravel new app<\/code>\n<\/li>\n<li>\n<code>$ cd app<\/code>\n<\/li>\n<li>Install <code>hyn\/multi-tenant<\/code> package by running:<\/li>\n<\/ol>\n<pre><code class=\"language-bash\">composer require hyn\/multi-tenant\n<\/code><\/pre>\n<ol start=\"4\">\n<li>Follow the instructions until &quot;Deploy configuration&quot; section.<\/li>\n<li>If you are using MySQL DB, you need to add the entry <code>LIMIT_UUID_LENGTH_32=true<\/code> in your <code>.env<\/code> file.<\/li>\n<\/ol>\n<h2 id=\"install-spatie-permissions-package\"><a href=\"#install-spatie-permissions-package\" class=\"anchor-link\"><\/a>Install Spatie Permissions Package<\/h2>\n<p>To install the package follow the entire installation section\nat <a href=\"https:\/\/github.com\/spatie\/laravel-permission#installation\">GitHub - spatie\/laravel-permission: Associate users with roles and permissions<\/a>.<\/p>\n<h2 id=\"integration\"><a href=\"#integration\" class=\"anchor-link\"><\/a>Integration<\/h2>\n<p>This section of the tutorial assumes that you have successfully <a href=\"creating-tenants\">created at least 2 hostnames<\/a>\nand have successfully accessed them via your local environment setup.<\/p>\n<p>We need to extend the two eloquent models (<code>Permission<\/code>, <code>Role<\/code>) of the Permissions\npackage so that we can add the necessary changes we need in order for these two models\nto be tenant aware.<\/p>\n<ol>\n<li>Create a <code>Permission.php<\/code> and <code>Role.php<\/code> file and place them inside your <code>app<\/code> directory,\nnext to your <code>User.php<\/code>. Make sure that these files extend <code>Spatie\\Permission\\Models\\Permission::class<\/code>\nand <code>Spatie\\Permission\\Models\\Role::class<\/code> respectively.<\/li>\n<\/ol>\n<p><code>App\\Permission.php<\/code> - extends from <code>SpatiePermission<\/code> and uses the <code>UsesTenantConnection<\/code> trait.<\/p>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Traits\\UsesTenantConnection;\nuse Spatie\\Permission\\Models\\Permission as SpatiePermission;\n\nclass Permission extends SpatiePermission\n{\n    use UsesTenantConnection;\n}\n<\/code><\/pre>\n<p><code>App\\Role.php<\/code> - extends from <code>SpatieRole<\/code> and uses the <code>UsesTenantConnection<\/code> trait.<\/p>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Traits\\UsesTenantConnection;\nuse Spatie\\Permission\\Models\\Role as SpatieRole;\n\nclass Role extends SpatieRole\n{\n    use UsesTenantConnection;\n}\n<\/code><\/pre>\n<p><code>App\\User.php<\/code> - notice the <code>HasRoles<\/code>, <code>UsesTenantConnection<\/code> traits we added.<\/p>\n<pre><code class=\"language-php\">use Spatie\\Permission\\Traits\\HasRoles;\nuse Illuminate\\Notifications\\Notifiable;\nuse Hyn\\Tenancy\\Traits\\UsesTenantConnection;\nuse Illuminate\\Foundation\\Auth\\User as Authenticatable;\n\nclass User extends Authenticatable\n{\n    use Notifiable, UsesTenantConnection, HasRoles;\n\n    \/**\n     * The attributes that are mass assignable.\n     *\n     * @var array\n     *\/\n    protected $fillable = [\n        'name', 'email', 'password',\n    ];\n\n    \/**\n     * The attributes that should be hidden for arrays.\n     *\n     * @var array\n     *\/\n    protected $hidden = [\n        'password', 'remember_token',\n    ];\n}\n<\/code><\/pre>\n<ol start=\"3\">\n<li>Modify your <code>config\/permission.php<\/code> file and modify the <code>permission<\/code> and <code>role<\/code> models to point to your newly created models. e.g. <code>App\\Permission::class<\/code>\n<\/li>\n<\/ol>\n<p><code>config\\permission.php<\/code><\/p>\n<pre><code class=\"language-php\">return [\n\n    'models' =&gt; [\n\n        'permission' =&gt; App\\Permission::class,\n\n        'role' =&gt; App\\Role::class,\n\n    ],\n\n    ...\n];\n<\/code><\/pre>\n<ol start=\"4\">\n<li>Creating a user in your first hostname. (We're using the first hostname here merely as an example.)<\/li>\n<\/ol>\n<pre><code class=\"language-php\">use App\\User;\nuse App\\Role;\nuse App\\Permission;\nuse Hyn\\Tenancy\\Models\\Hostname;\n\n\/\/ Switch the environment to use first hostname\n$environment = app(\\Hyn\\Tenancy\\Environment::class);\n$hostname = Hostname::find(1);\n$environment-&gt;hostname($hostname);\n\n\/\/ creates role and permission on your first hostname\n$role = Role::create(['name' =&gt; 'writer']);\n$permission = Permission::create(['name' =&gt; 'edit articles']);\n\n\/\/ Retrieve user and check to make sure it has no roles yet\n$user = User::find(1);\n$user-&gt;getRoleNames();\n\n\/\/ Assign writer role\n$user-&gt;assignRole('writer');\n\n\/\/ Requery and see that the newly assigned roles exists.\n$user = User::find(1);\n$user-&gt;getRoleNames();\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 18:29:42.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.5\/spatie-laravel-permission.md"},{"title":"Spatie media library","excerpt":"A tutorial on setting up spatie\/laravel-medialibrary.","icon":"fal fa-file-archive","tags":["spatie","medialibrary","tutorial"],"path":"docs\/hyn\/5.5\/spatie-medialibrary.md","slug":"spatie-medialibrary","package":"hyn","version":"5.5","contents":"<ol>\n<li>Create a fresh install of Laravel.  If you have installed the Laravel Terminal Installer run:<\/li>\n<\/ol>\n<pre><code class=\"language-bash\">$ laravel new app\n<\/code><\/pre>\n<ol start=\"2\">\n<li>\n<code>$ cd app<\/code>\n<\/li>\n<li>Install <code>hyn\/multi-tenant<\/code> package by running: <code>composer require hyn\/multi-tenant<\/code>\n<\/li>\n<li>Follow the instructions until the &quot;Deploy configuration&quot; section.<\/li>\n<li>If you are using MySQL as a database, make sure to add the entry <code>LIMIT_UUID_LENGTH_32=true<\/code> in your <code>.env<\/code> file.<\/li>\n<\/ol>\n<h2 id=\"install-spatie-medialibrary\"><a href=\"#install-spatie-medialibrary\" class=\"anchor-link\"><\/a>Install Spatie Medialibrary<\/h2>\n<p>Install this package via composer.<\/p>\n<pre><code class=\"language-bash\">$ composer require spatie\/laravel-medialibrary\n<\/code><\/pre>\n<p>Publish the migration with:<\/p>\n<pre><code class=\"language-bash\">$ php artisan vendor:publish --provider=&quot;Spatie\\MediaLibrary\\MediaLibraryServiceProvider&quot; --tag=&quot;migrations&quot;\n<\/code><\/pre>\n<p>Move the migration file (<code>2018_10_10_085035_create_media_table.php<\/code>) from <code>database\/migrations\/<\/code> to <code>database\/migrations\/tenant\/<\/code>.<\/p>\n<p>After the migration has been published you can create the media-table in your tenant databases by running the migrations:<\/p>\n<pre><code class=\"language-bash\">$ php artisan tenancy:migrate\n<\/code><\/pre>\n<p>You need to publish the config-file with:<\/p>\n<pre><code class=\"language-bash\">$ php artisan vendor:publish --provider=&quot;Spatie\\MediaLibrary\\MediaLibraryServiceProvider&quot; --tag=&quot;config&quot;\n<\/code><\/pre>\n<h2 id=\"integration\"><a href=\"#integration\" class=\"anchor-link\"><\/a>Integration<\/h2>\n<p>This section of the tutorial assumes that you have successfully <a href=\"creating-tenants\">created at least 2 hostnames<\/a>\nand have successfully accessed them via your local environment setup.<\/p>\n<p>We need to extend the <code>Media<\/code> eloquent model of the Medialibrary package so that we can add the\nnecessary changes for these two models to be tenant aware.<\/p>\n<ol>\n<li>Create a Media.php file and place it inside your <code>app<\/code> directory,\nnext to your <code>User.php<\/code>. Make sure that this class extends <code>Spatie\\MediaLibrary\\Models\\Media::class<\/code>.<\/li>\n<\/ol>\n<p><code>App\\Media.php<\/code> - extends from <code>SpatieMedia<\/code> and uses the <code>UsesTenantConnection<\/code> trait.<\/p>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Traits\\UsesTenantConnection;\nuse Spatie\\MediaLibrary\\Models\\Media as SpatieMedia;\n\nclass Media extends SpatieMedia\n{\n    use UsesTenantConnection;\n}\n<\/code><\/pre>\n<ol start=\"2\">\n<li>Prepare your model<\/li>\n<\/ol>\n<p>To associate media with a model, the tenant aware model must implement the following interface and traits, as shown below:<\/p>\n<pre><code class=\"language-php\">use Illuminate\\Database\\Eloquent\\Model;\nuse Spatie\\MediaLibrary\\HasMedia\\HasMedia;\nuse Hyn\\Tenancy\\Traits\\UsesTenantConnection;\nuse Spatie\\MediaLibrary\\HasMedia\\HasMediaTrait;\n\nclass User extends Model implements HasMedia\n{\n    use UsesTenantConnection, HasMediaTrait;\n   ...\n}\n<\/code><\/pre>\n<ol start=\"3\">\n<li>Modify your <code>config\/medialibrary.php<\/code> file and modify the <code>media_model<\/code> to point to your newly created model. e.g. <code>App\\Media::class<\/code>\n<\/li>\n<\/ol>\n<p><code>config\\medialibrary.php<\/code><\/p>\n<pre><code class=\"language-php\">return [\n\n    \/*\n     * The fully qualified class name of the media model.\n     *\/\n    'media_model' =&gt; App\\Media::class,\n\n    ...\n];\n<\/code><\/pre>\n<ol start=\"4\">\n<li>Attaching a media to your user model.<\/li>\n<\/ol>\n<pre><code class=\"language-php\">\/\/ Retrieve your user model.\n$user = App\\User::find(1);\n\n\/\/ Add a media from url and attach it to your model.\n$user-&gt;addMediaFromUrl('http:\/\/url-to-your-media-to-attach.png')-&gt;toMediaCollection();\n\n\/\/ Retrieve the media you just attached.\n$media = $user-&gt;media-&gt;last();\n<\/code><\/pre>\n<p>That's about it. You can read more on how to customize the medialibrary on their website: <a href=\"https:\/\/docs.spatie.be\/laravel-medialibrary\">https:\/\/docs.spatie.be\/laravel-medialibrary<\/a><\/p>\n","updated_at":{"date":"2020-07-18 18:29:42.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.5\/spatie-medialibrary.md"},{"title":"Laravel Scheduler","excerpt":"A tutorial on setting up Laravel's Scheduler to be Tenant Aware.","icon":"fal fa-file-archive","tags":["laravel","scheduler","tutorial"],"path":"docs\/hyn\/5.5\/laravel-scheduler.md","slug":"laravel-scheduler","package":"hyn","version":"5.5","contents":"<h1 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h1>\n<p>Laravel's command scheduler allows you to fluently and expressively define your command schedule within Laravel itself. When using the scheduler, only a single Cron entry is needed on your server.<\/p>\n<p>Your task schedule is defined in the <code>app\/Console\/Kernel.php<\/code> file's <code>schedule<\/code> method.<\/p>\n<p>By making Laravel's Scheduler tenant aware, we will unlock the possibilty to run multiple commands on all our tenants, without having to worry about setting numerous Cron jobs on your server.<\/p>\n<h1 id=\"prerequisite\"><a href=\"#prerequisite\" class=\"anchor-link\"><\/a>Prerequisite<\/h1>\n<p>You need a fresh Laravel app with Hyn Multi-Tenant installed. Briefly here are the basics:<\/p>\n<ol>\n<li>Create a fresh install of Laravel.  If you have installed the Laravel Terminal Installer run: <code>$ laravel new app<\/code>\n<\/li>\n<li>\n<code>$ cd app<\/code>\n<\/li>\n<li>Install <code>hyn\/multi-tenant<\/code> package by running:<\/li>\n<\/ol>\n<pre><code class=\"language-bash\">composer require hyn\/multi-tenant\n<\/code><\/pre>\n<ol start=\"4\">\n<li>Follow the <a href=\"https:\/\/tenancy.dev\/docs\/hyn\/5.5\/installation\">installation instructions<\/a>.<\/li>\n<\/ol>\n<h1 id=\"create-a-command\"><a href=\"#create-a-command\" class=\"anchor-link\"><\/a>Create a Command<\/h1>\n<p>To create a new command, use the <code>make:command<\/code> Artisan command. This command will create a new command class in the <code>app\/Console\/Commands<\/code> directory<\/p>\n<pre><code class=\"language-bash\">php artisan make:command ExampleCommand\n<\/code><\/pre>\n<p>We are going to make this command Tenant Aware. We need to change the signature to accept a <code>website_id<\/code> option:<\/p>\n<pre><code class=\"language-php\">protected $signature = 'example:command {--website_id=}';\n<\/code><\/pre>\n<p>We will take tenant awereness code from <a href=\"https:\/\/tenancy.dev\/docs\/hyn\/5.5\/commands#tenant-aware-tinker-command\">Tenant Aware Tinker Command<\/a>. The ExampleCommand should now look like this:<\/p>\n<pre><code class=\"language-php\">namespace App\\Console\\Commands;\n\nuse Illuminate\\Console\\Command;\nuse Hyn\\Tenancy\\Contracts\\Repositories\\WebsiteRepository;\nuse Hyn\\Tenancy\\Database\\Connection;\nuse Illuminate\\Database\\Eloquent\\ModelNotFoundException;\nuse Symfony\\Component\\Console\\Exception\\RuntimeException;\n\nclass ExampleCommand extends Command\n{\n    \/**\n     * The name and signature of the console command.\n     *\n     * @var string\n     *\/\n    protected $signature = 'example:command {--website_id=}';\n\n    \/**\n     * The console command description.\n     *\n     * @var string\n     *\/\n    protected $description = 'Example Command - Tenant Aware';\n\n    \/**\n     * @var Connection\n     *\/\n    private $connection;\n\n    \/**\n     * @var WebsiteRepository\n     *\/\n    private $websites;\n\n    \/**\n     * Create a new command instance.\n     *\n     * @return void\n     *\/\n    public function __construct()\n    {\n        parent::__construct();\n        $this-&gt;websites = app(WebsiteRepository::class);\n        $this-&gt;connection = app(Connection::class);\n    }\n\n    \/**\n     * Execute the console command.\n     *\n     * @return mixed\n     *\/\n    public function handle()\n    {\n        $website_id = $this-&gt;option('website_id');\n        try{\n            $website = $this-&gt;websites-&gt;query()-&gt;where('id', $website_id)-&gt;firstOrFail();\n            $this-&gt;connection-&gt;set($website);\n            $this-&gt;info('Running Command on website_id: ' . $website_id);\n\n            $this-&gt;tenantHandle();\n\n            $this-&gt;connection-&gt;purge();\n        } catch (ModelNotFoundException $e) {\n            throw new RuntimeException(\n                sprintf(\n                    'The tenancy website_id=%d does not exist.',\n                    $website_id\n                )\n            );\n        }\n    }\n\n    \/**\n     * Execute the console command. Tenant Aware.\n     *\n     * @return mixed\n     *\/\n    public function tenantHandle()\n    {\n        \/\/ You are now Tenant Aware\n        \/\/ Execute something, dispatch a Job, or anything else\n    }\n}\n<\/code><\/pre>\n<h1 id=\"integration\"><a href=\"#integration\" class=\"anchor-link\"><\/a>Integration<\/h1>\n<div class=\"alert alert-info\"><p>This section of the tutorial assumes that you have successfully created one or more tenant aware commands.<\/p><\/div>\n<p>We now need to register our <code>ExampleCommand<\/code> into our schedule. Laravel's Scheduler is set into <code>app\/Console\/Kernel.php<\/code>.<\/p>\n<ol>\n<li>First, we need to tell Laravel which commands will be used in the scheduler<\/li>\n<\/ol>\n<pre><code class=\"language-php\">protected $commands = [\n    ExampleCommand::class,\n    MySecondCommand::class,\n    ...\n];\n\n<\/code><\/pre>\n<ol start=\"2\">\n<li>Create a method for each command you need to run. We will be using the <code>before<\/code> <a href=\"https:\/\/laravel.com\/docs\/6.x\/scheduling#task-hooks\">Task Hook<\/a> to specify code to be executed before the scheduled task is launched. Here is an example:<\/li>\n<\/ol>\n<pre><code class=\"language-php\">\/**\n * Example Command Schedule\n * @param  Illuminate\\Console\\Scheduling\\Schedule   $schedule   Instance of schedule\n * @return void\n *\/\nprotected function scheduleExampleCommand(Schedule $schedule)\n{\n    \/\/ Set the Scheduler to our Tenant Aware Command. Store the returned Event.\n    $scheduledEvent = $schedule-&gt;command(ExampleCommand::class);\n\n    \/\/ Init a new variable to alter the Event's command string\n    $commandString = null;\n\n    \/\/ Setup your schedule\n    $scheduledEvent\n        \/\/ Setup our `before` Hook\n        -&gt;before(function () use ($scheduledEvent, &amp;$commandString) {\n            \/\/ Retreive current tenant\n            $tenant = app(\\Hyn\\Tenancy\\Environment::class)-&gt;tenant();\n\n            \/\/ Retreive and store the inital generated command. See note below*\n            if ($commandString === null) {\n                $commandString = $scheduledEvent-&gt;command;\n            }\n\n            \/\/ Replace the Event's generated command\n            \/\/ Adding our tenant's `website_id` option\n            $scheduledEvent-&gt;command = sprintf(\n                &quot;%s --website_id=%d&quot;,\n                $commandString,\n                $tenant-&gt;id\n            );\n        })\n\n        \/\/ Define your schedule as you would normally do\n        \/\/-&gt;everyHour()\n        \/\/-&gt;runInBackground()\n        \/\/-&gt;evenInMaintenanceMode();\n}\n<\/code><\/pre>\n<p>Your can find all available schedule options on <a href=\"https:\/\/laravel.com\/docs\/6.x\/scheduling#schedule-frequency-options\">Laravel's Official Documentation<\/a> page.<\/p>\n<div class=\"alert alert-info\"><p>*<em>Note: Without this, <code>--website_id<\/code> option would be added one after the other.<\/em><\/p><\/div>\n<ol start=\"3\">\n<li>Set our <code>schedule<\/code> method to run our new methods. Use the <code>Tenancy\\Environment<\/code> to define whether you're running with <code>tenancy:run<\/code> or not.<\/li>\n<\/ol>\n<pre><code class=\"language-php\">\/**\n * Define the application's command schedule.\n *\n * @param  \\Illuminate\\Console\\Scheduling\\Schedule $schedule\n * @return void\n *\/\nprotected function schedule(Schedule $schedule)\n{\n    if (app(\\Hyn\\Tenancy\\Environment::class)-&gt;tenant()) {\n        \/\/ Run your tenant aware schedules\n        $this-&gt;scheduleExampleCommand($schedule);\n        $this-&gt;scheduleMySecondCommand($schedule);\n        ...\n    } else {\n        \/\/ Run your system schedules\n        \/\/ ...\n    }\n}\n<\/code><\/pre>\n<ol start=\"4\">\n<li>Setup your server Cron<\/li>\n<\/ol>\n<pre><code class=\"language-bash\"># Tenant\n* * * * * cd \/path-to-your-project &amp;&amp; php artisan tenancy:run schedule:run &gt;&gt; \/dev\/null 2&gt;&amp;1\n\n# System\n# * * * * * cd \/path-to-your-project &amp;&amp; php artisan schedule:run &gt;&gt; \/dev\/null 2&gt;&amp;1\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 16:49:31.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.5\/laravel-scheduler.md"}]}],"hidden_articles":{"index":{"title":"Hyn documentation","path":"docs\/hyn\/5.5\/index.md","slug":"index","package":"hyn","version":"5.5","contents":"","updated_at":{"date":"2020-07-18 16:49:31.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.5\/index.md"}}},"5.4":{"slug":"5.4","name":5.4,"status":"Deprecated","suggestion_using":null,"branch":"5.x","package":"hyn","tree":[{"name":"getting started","links":["requirements","upgrade-from-5.3","installation","configuration"],"slug":"getting-started","articles":[{"title":"Requirements","icon":"fal fa-clipboard-check","path":"docs\/hyn\/5.4\/requirements.md","slug":"requirements","package":"hyn","version":"5.4","contents":"<ul>\n<li>Laravel 5.8.<\/li>\n<li>PHP 7.2 or up.<\/li>\n<li>MySQL 5.7+, MariaDB 10.2.0+ or PostgreSQL 9+.<\/li>\n<li>Optionally Apache 2.4+ or Nginx 1.12+.<\/li>\n<li>\n<a href=\"#experience\">Applied experience with Laravel<\/a>.<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>Please note that MySQL limits username and database length to 32. Enable this in the <code>tenancy.php<\/code> configuration file:  <code>website &gt; uuid-limit-length-to-32<\/code> to accommodate this.<\/p><\/div>\n<h2 id=\"experience\"><a href=\"#experience\" class=\"anchor-link\"><\/a>Experience<\/h2>\n<p>In case you are new to Laravel we urge you to get familiar with that\nbefore jumping into building something with this package. Having built\nat least one project with the framework (for fun) makes it much easier\ngrasping the concepts at hand.<\/p>\n<p>The following resources we recommend:<\/p>\n<ul>\n<li>\n<a href=\"https:\/\/laravel.com\/docs\">Laravel documentation<\/a>\n<\/li>\n<li>\n<a href=\"https:\/\/laracasts.com\/series\/laravel-from-scratch-2017\">Laravel from scratch free series at Laracasts<\/a>\n<\/li>\n<\/ul>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.4\/requirements.md"},{"title":"Upgrading from 5.3","icon":"fal fa-level-up-alt","path":"docs\/hyn\/5.4\/upgrade-from-5.3.md","slug":"upgrade-from-5.3","package":"hyn","version":"5.4","contents":"<p>The 5.4 version adds compatibility with Laravel 5.8 while fixing minor issues and adding\nmore features.<\/p>\n<h2 id=\"backward-breaking-changes\"><a href=\"#backward-breaking-changes\" class=\"anchor-link\"><\/a>Backward breaking changes<\/h2>\n<ul>\n<li>Minimum PHP requirement now 7.2.<\/li>\n<li>The tenant database password is now generated differently. If <code>tenancy.key<\/code> is <code>null<\/code> it will use\nthe password generation seen in previous versions by generating an md5 hash of the app.key and the website Id.\nHowever if you set it to the recommended <code>env('TENANCY_KEY')<\/code> or a string of any kind, the password is now generated\nwith this value, the website Id, Uuid and creation date. In addition this <code>tenancy.key<\/code> can be rotated more easily\nby using the new <code>tenancy:key:update<\/code> command. <strong>Make sure you configure this setting before upgrading!<\/strong>\n<\/li>\n<li>The <code>TenantAwareJob<\/code> trait has been completely removed. Instead before dispatching any Job into the queue it will identify\npossible active tenants and remember\/unserialize it when processing the job. You can still manually set the tenant website\nby giving the property <code>website_id<\/code> on the Job a value before dispatching it.<\/li>\n<\/ul>\n<h2 id=\"new-features\"><a href=\"#new-features\" class=\"anchor-link\"><\/a>New features<\/h2>\n<ul>\n<li>Added a <code>tenancy:key:update<\/code> command which allows rotating the <code>tenancy.key<\/code> value more easily.<\/li>\n<\/ul>\n<h2 id=\"minor\"><a href=\"#minor\" class=\"anchor-link\"><\/a>Minor<\/h2>\n<ul>\n<li>Moved forcing app url to listener, so it applies to console and queue too.<\/li>\n<li>ConfigurationLoading, -Loaded events now know about current active tenant website.<\/li>\n<li>Allow configurable database privileges for tenant databases.<\/li>\n<li>Fixed website filter on commands.<\/li>\n<li>Improved hostname validation. Preventing common errors with ports and incorrect FQDN's.<\/li>\n<li>Website related events now also contain hostname in case one was identified.<\/li>\n<li>Upgraded to phpunit 8.<\/li>\n<\/ul>\n<p>See the <a href=\"https:\/\/github.com\/tenancy\/multi-tenant\/blob\/5.x\/changelog.md\">changelog<\/a> for\nall modifications.<\/p>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.4\/upgrade-from-5.3.md"},{"title":"Installation","icon":"fal fa-arrow-alt-to-bottom","path":"docs\/hyn\/5.4\/installation.md","slug":"installation","package":"hyn","version":"5.4","contents":"<h1 id=\"elevated-database-user\"><a href=\"#elevated-database-user\" class=\"anchor-link\"><\/a>Elevated database user<\/h1>\n<p>Tenancy requires a <code>system<\/code> connection that allows creating new databases for\ntenants. In order to do so, we need to have a database user with elevated\npermissions.<\/p>\n<p>A user for both <a href=\"https:\/\/mariadb.com\/kb\/en\/library\/grant\/#the-grant-option-privilege\">MariaDB or MySQL<\/a> and <a href=\"https:\/\/www.postgresql.org\/docs\/9.6\/static\/sql-grant.html\">PostgreSQL<\/a> would require the &quot;GRANT OPTION&quot; to be\napplied. You can either use the root user (for PostgreSQL that is user postgres) or create\nyour own (recommended):<\/p>\n<p>For MariaDB or MySQL:<\/p>\n<pre><code class=\"language-sql\">CREATE DATABASE IF NOT EXISTS tenancy;\nCREATE USER IF NOT EXISTS tenancy@localhost IDENTIFIED BY 'someRandomPassword';\nGRANT ALL PRIVILEGES ON *.* TO tenancy@localhost WITH GRANT OPTION;\n<\/code><\/pre>\n<p>For PostgreSQL:<\/p>\n<pre><code class=\"language-sql\">CREATE DATABASE tenancy;\nCREATE USER tenancy WITH CREATEDB CREATEROLE PASSWORD 'someRandomPassword';\nGRANT ALL PRIVILEGES ON DATABASE tenancy to tenancy WITH GRANT OPTION;\n<\/code><\/pre>\n<p>Make sure you configure this user as your <code>system<\/code> connection in your <code>database.php<\/code>.\nUnder <code>connections<\/code>:<\/p>\n<pre><code class=\"language-php\">'system' =&gt; [\n    'driver' =&gt; 'mysql',\n    'host' =&gt; env('TENANCY_HOST', '127.0.0.1'),\n    'port' =&gt; env('TENANCY_PORT', '3306'),\n    'database' =&gt; env('TENANCY_DATABASE', 'tenancy'),\n    'username' =&gt; env('TENANCY_USERNAME', 'tenancy'),\n    'password' =&gt; env('TENANCY_PASSWORD', ''),\n    'unix_socket' =&gt; env('DB_SOCKET', ''),\n    'charset' =&gt; 'utf8mb4',\n    'collation' =&gt; 'utf8mb4_unicode_ci',\n    'prefix' =&gt; '',\n    'strict' =&gt; true,\n    'engine' =&gt; null,\n]\n<\/code><\/pre>\n<p>Most often it makes sense to use either <code>system<\/code> or <code>tenant<\/code> as your default database connection setting. For example, Laravel assigns the value from <code>DB_CONNECTION<\/code> in your <code>.env<\/code> file to the <code>default<\/code> key in the <code>config\/database.php<\/code> configuration file.<\/p>\n<p>In case you use <code>tenant<\/code> make sure to enable <a href=\"identification\">early identification<\/a> and configure\na decent <a href=\"fallback\">fallback<\/a> later on.<\/p>\n<div class=\"alert alert-info\"><p>There is no need to configure the <code>tenant<\/code> connection in the <code>database.php<\/code>\nconfiguration file. This connection is set up automatically during runtime. Pre-\nconfiguring this connection may cause unwanted behaviour.<\/p><\/div>\n<h1 id=\"package-installation\"><a href=\"#package-installation\" class=\"anchor-link\"><\/a>Package installation<\/h1>\n<p>Run the composer command to add the tenancy package as dependency:<\/p>\n<pre><code class=\"language-bash\">composer require hyn\/multi-tenant\n<\/code><\/pre>\n<p>Laravel's <a href=\"https:\/\/medium.com\/@taylorotwell\/package-auto-discovery-in-laravel-5-5-ea9e3ab20518\">package auto discovery<\/a> will register the service provider automatically.<\/p>\n<p>Publish the configuration files and migrations for Tenancy, which allow you\nto configure the behavior of the package.<\/p>\n<pre><code class=\"language-bash\">php artisan vendor:publish --tag=tenancy\n<\/code><\/pre>\n<p>Then edit <code>config\/tenancy.php<\/code> accordingly.<\/p>\n<p>Adapt the system migrations to your liking inside <code>database\/migrations<\/code>, make sure to run them:<\/p>\n<pre><code class=\"language-bash\">php artisan migrate --database=system\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Change <code>system<\/code> to your system connection name.<\/p><\/div>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.4\/installation.md"},{"title":"Configuration","icon":"fal fa-sliders-v","path":"docs\/hyn\/5.4\/configuration.md","slug":"configuration","package":"hyn","version":"5.4","contents":"<h1 id=\"system-connection\"><a href=\"#system-connection\" class=\"anchor-link\"><\/a>System connection<\/h1>\n<p>Tenancy needs a database connection with elevated permission to create databases\nto be used by its tenants.<\/p>\n<p>Make sure you set up this connection by following the instructions\nin the <a href=\"requirements#elevated-database-user\">requirements<\/a>, it also explains how to publish\nthe configuration files.<\/p>\n<h1 id=\"configuration-files\"><a href=\"#configuration-files\" class=\"anchor-link\"><\/a>Configuration Files<\/h1>\n<p>The inline documentation in both files should be self explanatory. Nevertheless,\nI've listed some of the basic settings below.<\/p>\n<h2 id=\"tenancyphp\"><a href=\"#tenancyphp\" class=\"anchor-link\"><\/a>tenancy.php<\/h2>\n<p>The <code>tenancy.php<\/code> configuration file holds every setting related to tenants.\nThis includes how to generate a unique website, but also how database connections are set up.\nIn addition, it allows for:<\/p>\n<ul>\n<li>custom random id logic<\/li>\n<li>manual tenant identification<\/li>\n<li>on what disk (see <code>config\/filesystems.php<\/code>) to store the tenant-specific files<\/li>\n<li>specifying tenant database division mode<\/li>\n<li>specifying the password generator<\/li>\n<li>specifying the migrations path<\/li>\n<li>forcing models to a specific connection<\/li>\n<li>overriding your configs<\/li>\n<li>overriding your routes<\/li>\n<li>overriding translations<\/li>\n<li>overriding views<\/li>\n<li>and much, much more.<\/li>\n<\/ul>\n<h2 id=\"webserverphp\"><a href=\"#webserverphp\" class=\"anchor-link\"><\/a>webserver.php<\/h2>\n<p>The <code>webserver.php<\/code> configuration file allows one to more closely fine tune integration of this package with your webserver.\nPorts, vhost configuration files and the location to save these files are all contained in this config.<\/p>\n<p>The settings in this configuration file are:<\/p>\n<ul>\n<li>enabled; whether the service is enabled and thus the package will write files for it and reload the service.<\/li>\n<li>ports; which ports we should use, this is required to configure the vhost files properly.<\/li>\n<li>generator; the class handling the generation of vhost files.<\/li>\n<li>disk; the disk to write the vhost files to, you can have it point to any configured disk in your <code>config\/filesystems.php<\/code>.<\/li>\n<li>paths; specific locations we need to know about to in order to mutate the webserver behavior.<\/li>\n<\/ul>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.4\/configuration.md"}]},{"name":"tenant principles","links":["concepts","identification","connections","fallback","middleware"],"slug":"tenant-principles","articles":[{"title":"Concepts","icon":"fal fa-vials","path":"docs\/hyn\/5.4\/concepts.md","slug":"concepts","package":"hyn","version":"5.4","contents":"<h1 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h1>\n<p>The principle of multi tenancy is about a single instance of software running\non a server and serving multiple tenants. The interpretation of such a tenancy\napplication is quite diverse.<\/p>\n<p>Hyn tenancy is focused on providing a drop-in solution for Laravel without\nsacrificing flexibility or requiring extensive hacks of the Laravel ecosystem.<\/p>\n<p>Make sure you understand that the <code>Website<\/code> model is the subject of tenancy.<\/p>\n<p>The default method for identifying such a tenant website is by using the requested\ndomain aka <code>hostname<\/code>. Taking a URL <code>http:\/\/yourdomain.com\/foo\/bar<\/code> only <code>yourdomain.com<\/code>\nis taken into account, although modifications to this logic are easy to implement. The\n<code>yourdomain.com<\/code> part of the URL is called a Fully Qualified Domain Name or <code>fqdn<\/code> for short.<\/p>\n<p>A website can have zero or more hostnames connected to it. This allows for easier\nattachment of additional hostnames or serving, for instance an ad campaign page,\non different domains.<\/p>\n<h1 id=\"website\"><a href=\"#website\" class=\"anchor-link\"><\/a>Website<\/h1>\n<p>You can think of a website as a single mirror of the code base, re-using your default\napp code. In addition it is also possible to have very <a href=\"structure\">tenant specific logic<\/a>,\nfor instance routes, a vendor folder, media and language files.<\/p>\n<h1 id=\"hostname\"><a href=\"#hostname\" class=\"anchor-link\"><\/a>Hostname<\/h1>\n<p>A hostname is a <a href=\"https:\/\/www.godaddy.com\/garage\/industry\/tech-svcs\/it\/whats-a-fully-qualified-domain-name-fqdn-and-whats-it-good-for\/\">Fully Qualified Domain Name<\/a> (for instance <code>sub.example.com<\/code>).\nYour application handles incoming requests to specific hostnames. Tenancy inspects\nthese requests and <a href=\"identification\">sets up the tenancy environment<\/a> according to a\nmatching hostname or falls back to the default one.<\/p>\n<h1 id=\"runtime\"><a href=\"#runtime\" class=\"anchor-link\"><\/a>Runtime<\/h1>\n<p>By default, the package will identify the current requested <code>hostname<\/code> and bind it\ninto the <code>Hyn\\Tenancy\\Contracts\\CurrentHostname<\/code> contract. In case that <code>hostname<\/code> belongs to\na website, the latter will be bound into the <code>Hyn\\Tenancy\\Contracts\\Tenant<\/code> contract. Whenever\na Tenant is identified or switched the package will automatically infuse additional functionality\ninto Laravel, including <a href=\"fallback#tenant-routes-override\">global tenant routes<\/a>, <a href=\"structure\">tenant overrides<\/a>\nand <a href=\"queues\">queues<\/a>.<\/p>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.4\/concepts.md"},{"title":"Identification","icon":"fal fa-street-view","path":"docs\/hyn\/5.4\/identification.md","slug":"identification","package":"hyn","version":"5.4","contents":"<p>During runtime, the <code>Environment<\/code> class is bound into Laravel's container. The\ntenancy environment holds one single responsibility, which is telling our code\nwhat <code>hostname<\/code> is currently identified and resolving the related website.<\/p>\n<h1 id=\"early-identification\"><a href=\"#early-identification\" class=\"anchor-link\"><\/a>Early identification<\/h1>\n<p>By default Tenancy will identify the tenant after all Middleware has been processed.\nYou can resolve the Environment class through the service container\ninside a middleware to force identification of the tenant early on. If you want the\npackage to handle this on your behalf you can enable the <code>early-identification<\/code> flag in\nyour <code>tenancy.php<\/code> configuration file under <code>hostname<\/code>.<\/p>\n<h1 id=\"manual-identification\"><a href=\"#manual-identification\" class=\"anchor-link\"><\/a>Manual identification<\/h1>\n<p>The environment can be used to manually set any active tenant. This is one of the\nreasons why the tenancy configuration file has the <code>hostname &gt; auto-identification<\/code>\nsetting. Turn it off to implement your own tenancy identification.<\/p>\n<p>Manual identification is pretty straightforward. Take for example the following\nsnippet for a custom (app) service provider:<\/p>\n<pre><code class=\"language-php\">public function boot()\n{\n    $environment = $this-&gt;app-&gt;make(\\Hyn\\Tenancy\\Environment::class);\n\n    \/\/ Retrieve your website\n\n    \/\/ Now switch the environment to a new tenant.\n    $environment-&gt;tenant($website);\n}\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Be wary about switching tenants. It is recommend switching only once during code\nexecution. Use a background job to run mass changes on tenant databases.<\/p><\/div>\n<h1 id=\"retrieve-current-tenant\"><a href=\"#retrieve-current-tenant\" class=\"anchor-link\"><\/a>Retrieve current tenant<\/h1>\n<p>To work with the current environment, you can do the following:<\/p>\n<pre><code class=\"language-php\"> \n \/\/ Get current Website (Tenant)\n $website   = \\Hyn\\Tenancy\\Facades\\TenancyFacade::website();\n \n \/\/ prefered option\n $website   = app(\\Hyn\\Tenancy\\Environment::class)-&gt;tenant();\n \n \/\/ alternative (outdated) \n $website   = app(\\Hyn\\Tenancy\\Environment::class)-&gt;website();\n \n $websiteId = $website-&gt;id;\n \n \/\/ Get current Hostname\n $hostname  = app(\\Hyn\\Tenancy\\Environment::class)-&gt;hostname();\n \n \/\/ Get FQDN (Fully-Qualified Domain Name) by current hostname\n $fqdn      = $hostname-&gt;fqdn;\n\n \n<\/code><\/pre>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.4\/identification.md"},{"title":"Connections","icon":"fal fa-warehouse-alt","path":"docs\/hyn\/5.4\/connections.md","slug":"connections","package":"hyn","version":"5.4","contents":"<h1 id=\"database-connections\"><a href=\"#database-connections\" class=\"anchor-link\"><\/a>Database Connections<\/h1>\n<p>One of the core aspects of tenancy is the database connection. Tenancy\ngives you access to two key database connections; <code>tenant<\/code> and <code>system<\/code>.<\/p>\n<h2 id=\"system-connection\"><a href=\"#system-connection\" class=\"anchor-link\"><\/a>System Connection<\/h2>\n<p>Out of the box, the package gives you a <code>system<\/code> database connection which acts as\nthe master database where <code>hostnames<\/code> and <code>websites<\/code> are stored.<\/p>\n<p>If for some reason you need to create an Eloquent Model that would need to connect\nto the system connection, you can apply the <code>Hyn\\Tenancy\\Traits\\UsesSystemConnection<\/code>\ntrait on your given Model. In doing so, the model\u2019s connection will always default to use the <code>system<\/code>.<\/p>\n<p>One reason for using the <code>system<\/code> connection is for storing data which you'd like\nto share between all tenants or which you need to use to influence the tenant identification\nprocess. For instance when you are creating an admin portal that would manage all of your\ntenants in one place.<\/p>\n<h2 id=\"tenant-connection\"><a href=\"#tenant-connection\" class=\"anchor-link\"><\/a>Tenant Connection<\/h2>\n<p>This is maybe the most used database connection. Data in use by single tenant instances,\nnot shared with others, is persisted into the database using the <code>tenant<\/code> connection. The\nimplementation of the <code>tenant<\/code> connection ensures that no tenant can access another tenant's data.<\/p>\n<p>By using the <code>Hyn\\Tenancy\\Traits\\UsesTenantConnection<\/code> trait, the package will make sure\nthat it is using the right database connection.<\/p>\n<p>All tenant related models should use the <code>UsesTenantConnection<\/code> trait.<\/p>\n<h3 id=\"forcing-the-connection\"><a href=\"#forcing-the-connection\" class=\"anchor-link\"><\/a>Forcing The Connection<\/h3>\n<p>If you want to set the default connection to <code>tenant<\/code> (when a tenant website has been identified), you can use the snippet below.\nThis is also helpful for 3rd party packages models to force their connection to <code>tenant<\/code>.<\/p>\n<p>Add the following code to the <code>boot()<\/code> method of your <code>AppServiceProvider.php<\/code> file.<\/p>\n<pre><code class=\"language-php\">$env = app(Environment::class);\n\nif ($fqdn = optional($env-&gt;hostname())-&gt;fqdn) {\n    config(['database.default' =&gt; 'tenant']);\n}\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Please understand the risks involved of setting your default connection during runtime. All Eloquent models will from then on use the <code>tenant<\/code> connection instead of your previously configured default connection.<\/p><\/div>\n<hr \/>\n<p>More information about applying these connections can be found in the <a href=\"models\">models<\/a> article.<\/p>\n<h3 id=\"password-generation\"><a href=\"#password-generation\" class=\"anchor-link\"><\/a>Password generation<\/h3>\n<p>The password of the tenant is generated using several components mashed up as md5 hash.<\/p>\n<ul>\n<li>\n<code>tenancy.key<\/code> with a fallback to <code>app.key<\/code>. You can specify an empty string <code>&quot;&quot;<\/code> if you don't want to use this key.<\/li>\n<li>Website Id.<\/li>\n<li>Website UUID.<\/li>\n<li>Website created_at.<\/li>\n<\/ul>\n<p>In case you wish to change\/update the <code>tenancy.key<\/code> we provide a useful command <code>tenancy:key:update<\/code>\nwhich will update the tenant password with the new md5 value. This allows for easier key rotation.<\/p>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.4\/connections.md"},{"title":"Fallback","excerpt":"Configure a landing page using different approaches","icon":"fal fa-compass","path":"docs\/hyn\/5.4\/fallback.md","slug":"fallback","package":"hyn","version":"5.4","contents":"<p>There are several ways to organize a fallback domain. These are commonly used to offer\na landing page and\/or admin area for your clients to configure their tenant website.<\/p>\n<h1 id=\"disabling-abort-to-pass-through\"><a href=\"#disabling-abort-to-pass-through\" class=\"anchor-link\"><\/a>Disabling abort to pass through<\/h1>\n<p>By default a 404 not found is served whenever auto identification is enabled and no\nmatching hostname entry was found in the system database.<\/p>\n<p>You can disable this in the <code>tenancy.php<\/code> configuration file by setting the\n<code>abort-without-identified-hostname<\/code> option to <code>false<\/code>. This will prevent tenancy\nfrom throwing a 404 (not found) whenever it failed to identify a registered hostname.<\/p>\n<p>Depending on how you set up your app, the code will now pass through to any registered routes.\nFor applications that have global routes defined for tenant specific functionality, you'll\nrun into the issue that no &quot;tenant&quot; connection was defined.<\/p>\n<h1 id=\"tenant-routes-override\"><a href=\"#tenant-routes-override\" class=\"anchor-link\"><\/a>Tenant routes override<\/h1>\n<p>Whenever you create a file <code>routes\/tenants.php<\/code> and you have <code>tenancy.hostname.auto-identification<\/code>\nenabled, all routes contained in that file will automatically override any declared global routes\nfrom <code>routes\/web.php<\/code> or <code>routes\/api.php<\/code>. Make sure to apply the proper middleware to those routes.<\/p>\n<p>In case you enable <code>tenancy.routes.replace-global<\/code> all previously declared routes\nwill be removed and replaced with the contents of the <code>routes\/tenants.php<\/code> file.<\/p>\n<div class=\"alert alert-info\"><p>Understand unlike the default <code>web.php<\/code> and <code>api.php<\/code> files no group is set around this file. You need\nto apply your own <code>namespace<\/code>, <code>middleware<\/code> and other group settings inside the <code>tenants.php<\/code>.<\/p><\/div>\n<p>An example <code>routes\/tenants.php<\/code> file:<\/p>\n<pre><code class=\"language-php\">Route::middleware('web')\n    -&gt;namespace('App\\\\Http\\\\Controllers\\\\Tenant\\\\')\n    -&gt;group(function () \n{\n    Route::get('\/', 'HomeController');\n});\n<\/code><\/pre>\n<h1 id=\"routing-with-domain\"><a href=\"#routing-with-domain\" class=\"anchor-link\"><\/a>Routing with domain<\/h1>\n<p>One of the easiest solutions is using the <code>::domain()<\/code> option in routing called\n<a href=\"https:\/\/laravel.com\/docs\/5.6\/routing#route-group-sub-domain-routing\">sub domain routing in Laravel<\/a>.<\/p>\n<pre><code class=\"language-php\">Route::domain('master.your.app')-&gt;group(function () {\n    \/\/ .. your landing page routes\n});\n<\/code><\/pre>\n<h1 id=\"create-a-tenant-as-fallback\"><a href=\"#create-a-tenant-as-fallback\" class=\"anchor-link\"><\/a>Create a tenant as fallback<\/h1>\n<p>Another quick method is to simply seed a default tenant that has a specific\nhostname. Set the environment <code>TENANCY_DEFAULT_HOSTNAME<\/code> to the exact FQDN used\nfor that tenant.<\/p>\n<p>Now every time no other tenant was identified, it will revert to this tenant. A\ndrawback of this method is the need to set up a tenant hostname.<\/p>\n","updated_at":{"date":"2020-07-18 18:29:42.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.4\/fallback.md"},{"title":"Middleware","icon":"fal fa-shield-alt","excerpt":"Automatic actions per tenant","path":"docs\/hyn\/5.4\/middleware.md","slug":"middleware","package":"hyn","version":"5.4","contents":"<p>This package offers additional automation to make your life easier. Using\nmiddleware you can mutate how specific requests are handled.<\/p>\n<h1 id=\"maintenance\"><a href=\"#maintenance\" class=\"anchor-link\"><\/a>Maintenance<\/h1>\n<p>Set the property <code>under_maintenance_since<\/code> of the <code>hostname<\/code> to show a\nLaravel generic maintenance page.<\/p>\n<h1 id=\"redirection\"><a href=\"#redirection\" class=\"anchor-link\"><\/a>Redirection<\/h1>\n<p>Set the property <code>redirect_to<\/code> to a valid URL to automatically redirect all\nrequests to this hostname.<\/p>\n<h1 id=\"secure\"><a href=\"#secure\" class=\"anchor-link\"><\/a>Secure<\/h1>\n<p>Set the property <code>force_https<\/code> to <code>true<\/code> to force all connections on this\nhostname to be handled using a SSL encrypted connection.<\/p>\n<h1 id=\"abort\"><a href=\"#abort\" class=\"anchor-link\"><\/a>Abort<\/h1>\n<p>In case no tenant was identified the application will generate a default\nnot found page. You can disable this functionality globally in\nthe tenancy configuration file <code>hostname &gt; abort-without-identified-hostname<\/code>.<\/p>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.4\/middleware.md"}]},{"name":"implementation","links":["creating-tenants","models","structure"],"slug":"implementation","articles":[{"title":"Creating tenants","icon":"fal fa-dolly-flatbed","path":"docs\/hyn\/5.4\/creating-tenants.md","slug":"creating-tenants","package":"hyn","version":"5.4","contents":"<p>Tenancy is heavily driven by events. For event listeners to properly work, you\nhave to use the provided repositories to create new websites and hostnames.<\/p>\n<h1 id=\"create-website\"><a href=\"#create-website\" class=\"anchor-link\"><\/a>Create website<\/h1>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Models\\Website;\nuse Hyn\\Tenancy\\Contracts\\Repositories\\WebsiteRepository;\n\n$website = new Website;\napp(WebsiteRepository::class)-&gt;create($website);\ndd($website-&gt;uuid); \/\/ Unique id\n<\/code><\/pre>\n<h2 id=\"uuid\"><a href=\"#uuid\" class=\"anchor-link\"><\/a>UUID<\/h2>\n<p>Each website will be given a unique identifier automatically. To prevent\nguessing URLs and to add a slight increased level of security this is a\nrandom hash.<\/p>\n<p>The UUID is used for the database username and database name. In addition\nI'd recommend using this unique string for every public facing URL, eg\nan admin dashboard.<\/p>\n<p>By default this package will create a <code>uuid<\/code> automatically\nusing a UUID generator. You can replace that class in the\n<code>tenancy.php &gt; website &gt; random-id-generator<\/code>, as long as it implements\n<code>Hyn\\Tenancy\\Contracts\\Website\\UuidGenerator<\/code>.<\/p>\n<p>If you want to force your own UUID for the website, without creating a full\nfledged UUID generator, set the <code>uuid<\/code> property of your website before passing\nit to the repository.<\/p>\n<pre><code class=\"language-php\">$website = new Website;\n\/\/ Implement custom random hash using Laravels Str::random\n$website-&gt;uuid = Str::random(10);\napp(WebsiteRepository::class)-&gt;create($website);\ndd($website-&gt;uuid); \/\/ Random string of length 10\n<\/code><\/pre>\n<h2 id=\"managing-connection\"><a href=\"#managing-connection\" class=\"anchor-link\"><\/a>Managing connection<\/h2>\n<p>Whenever you are using multiple databases, to separate tenants over different\nregions for instance, you can easily specify the connection with which tenancy\nshould create, update and delete tenant databases and users.<\/p>\n<pre><code class=\"language-php\">$website = new Website;\n$website-&gt;managed_by_database_connection = 'system.asia';\napp(WebsiteRepository::class)-&gt;create($website);\n\/\/ Information of website is stored in the default system connection,\n\/\/ the tenant database is created using the system.asia connection.\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Make sure the provided connection name is configured in your <code>config\/database.php<\/code>.<\/p><\/div>\n<h1 id=\"create-and-connect-hostname\"><a href=\"#create-and-connect-hostname\" class=\"anchor-link\"><\/a>Create and connect hostname<\/h1>\n<p>A hostname allows the package to map a requested hostname to a website. Websites\nthat have no (active) hostnames connected to it will never be visible. So make\nsure to connect a hostname to any tenant website you'd like to work on.<\/p>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Models\\Hostname;\nuse Hyn\\Tenancy\\Contracts\\Repositories\\HostnameRepository;\n\n$hostname = new Hostname;\n$hostname-&gt;fqdn = 'luceos.demo.app';\n$hostname = app(HostnameRepository::class)-&gt;create($hostname);\napp(HostnameRepository::class)-&gt;attach($hostname, $website);\ndd($website-&gt;hostnames); \/\/ Collection with $hostname\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>The <code>fqdn<\/code> property of the hostname is crucial. It stands for\nFully Qualified Domain Name and can be something like <code>yourapp.com<\/code> or\n<code>demo.yourapp.com<\/code> but can never include protocol (eg <code>http:\/\/<\/code>) or paths\n(eg <code>yourapp.com\/tenant<\/code>).<\/p><\/div>\n<h1 id=\"switch-to-new-tenant\"><a href=\"#switch-to-new-tenant\" class=\"anchor-link\"><\/a>Switch to new tenant<\/h1>\n<p>For the package to set up Laravel for the specific tenant, the environment has to be\n&quot;switched&quot;. This switching will set up things like the tenant database connection and\nfilesystem logic like custom config files.<\/p>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Environment;\n$tenancy = app(Environment::class);\n\n$tenancy-&gt;hostname($hostname);\n\n$tenancy-&gt;hostname(); \/\/ resolves $hostname as currently active hostname\n\n$tenancy-&gt;tenant($website); \/\/ switches the tenant and reconfigures the app\n\n$tenancy-&gt;website(); \/\/ resolves $website\n$tenancy-&gt;tenant(); \/\/ resolves $website\n\n$tenancy-&gt;identifyHostname(); \/\/ resets resolving $hostname by using the Request\n<\/code><\/pre>\n<h1 id=\"querying\"><a href=\"#querying\" class=\"anchor-link\"><\/a>Querying<\/h1>\n<p>In case you would like to query the database for hostnames or websites. Use the\n<code>query()<\/code> method of the repositories, this will return a <a href=\"https:\/\/laravel.com\/docs\/5.8\/queries\"><code>Illuminate\\Database\\Eloquent\\Builder<\/code><\/a>\ninstance.<\/p>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.4\/creating-tenants.md"},{"title":"Models","icon":"fal fa-hand-holding-box","path":"docs\/hyn\/5.4\/models.md","slug":"models","package":"hyn","version":"5.4","contents":"<p>Tenancy offers a few ways to more easily connect with the correct database.<\/p>\n<h4 id=\"traits\"><a href=\"#traits\" class=\"anchor-link\"><\/a>Traits<\/h4>\n<p>Two traits exist to force a model onto either the <code>tenant<\/code> or <code>system<\/code> connection.<\/p>\n<ul>\n<li>\n<code>Hyn\\Tenancy\\Traits\\UsesSystemConnection<\/code> to make a model use the system connection.<\/li>\n<li>\n<code>Hyn\\Tenancy\\Traits\\UsesTenantConnection<\/code> to make a model use the tenant connection.<\/li>\n<\/ul>\n<p>The below snippet shows an example of how to force the User model to use the tenant\nconnection.<\/p>\n<pre><code class=\"language-php\">namespace App;\n\nuse Hyn\\Tenancy\\Traits\\UsesTenantConnection;\nuse Illuminate\\Notifications\\Notifiable;\nuse Illuminate\\Foundation\\Auth\\User as Authenticatable;\n\nclass User extends Authenticatable\n{\n    use Notifiable, UsesTenantConnection;\n    \n    \/\/ ..\n}\n<\/code><\/pre>\n<h4 id=\"abstract-models\"><a href=\"#abstract-models\" class=\"anchor-link\"><\/a>Abstract models<\/h4>\n<p>Instead of using the traits directly one can also simply have the models extend the abstract\nmodels provided in the package.<\/p>\n<ul>\n<li>\n<code>Hyn\\Tenancy\\Abstracts\\SystemModel<\/code> can be extended to give easy access to\nthe system database connection.<\/li>\n<li>\n<code>Hyn\\Tenancy\\Abstracts\\TenantModel<\/code> can be extended to have your Eloquent models\nuse the connection of the identified tenant per default.<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>Please note these abstract models are using the respective traits mentioned above.<\/p><\/div>\n<h4 id=\"relationships\"><a href=\"#relationships\" class=\"anchor-link\"><\/a>Relationships<\/h4>\n<p>Model eloquent relations are possible from tenant to system and vice versa. One thing to remember\nwith intermediate tables involved, for instance on the belongsToMany relationship, is that you can\nprefix the intermediate table with the connection.<\/p>\n<p>For instance, when you have your User model on the system database - acting as a global user - you can\nstore the user roles on the tenant database by prefixing that intermediate table with the tenant database\nname and assigning the Role model to the tenant connection.<\/p>\n<pre><code class=\"language-php\">    public function roles() {\n        $config = app(\\Hyn\\Tenancy\\Database\\Connection::class)-&gt;configuration();\n        return $this-&gt;belongsToMany('App\\Role', &quot;{$config['database']}.role_user&quot;);\n    }\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>This only works if tenant databases are on the same server as the system database! You cannot\nuse the managing system connection feature in this scenario.<\/p><\/div>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.4\/models.md"},{"title":"Structure","icon":"fal fa-sitemap","path":"docs\/hyn\/5.4\/structure.md","slug":"structure","package":"hyn","version":"5.4","contents":"<h1 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h1>\n<p>The location of the tenant specific files is configured inside the <code>config\/tenancy.php<\/code>\nfile under <code>website &gt; disk<\/code>. By default tenant files\nare stored in <code>storage\/app\/tenancy\/tenants<\/code>.<\/p>\n<p>Inside this tenant directory you are able to override global logic by\ngenerating the necessary files. Check the <code>config\/tenancy.php<\/code> file under\n<code>folders<\/code> to see which ones are enabled by default.<\/p>\n<h2 id=\"config\"><a href=\"#config\" class=\"anchor-link\"><\/a>Config<\/h2>\n<p>Any php files stored inside a <code>config\/<\/code> directory of the tenant are read\nduring runtime. Existing configuration values are replaced and new ones\nare appended.<\/p>\n<p>A great use case for this feature is the ability to configure client\nspecific mail settings.<\/p>\n<p>The <code>config\/tenancy.php<\/code> configuration file allows you to refuse overrides of specific\nconfiguration settings using the <code>folders &gt; config &gt; blacklist<\/code> setting.\nBy default it disallows database, tenancy and webserver changes.<\/p>\n<h2 id=\"routes\"><a href=\"#routes\" class=\"anchor-link\"><\/a>Routes<\/h2>\n<p>Create a <code>routes.php<\/code> file inside your tenant directory to configure\nnew routes during runtime. Using a configurable prefix, any unique\nurl's will be matched for this specific tenant only.<\/p>\n<h2 id=\"trans\"><a href=\"#trans\" class=\"anchor-link\"><\/a>Trans<\/h2>\n<p>New translations can be added easily by creating a <code>lang\/<\/code> folder.\nThe native Laravel translator will parse any files contained here\nto be used in the application of this specific tenant.<\/p>\n<p>You are able to specify whether these language files should override\nthe global, system-wide translation. In case you decide against that\nfeel free to set up a translation namespace.<\/p>\n<h2 id=\"views\"><a href=\"#views\" class=\"anchor-link\"><\/a>Views<\/h2>\n<p>Additional or overriding views is possible by creating a <code>views\/<\/code> folder\ninside the tenant directory. There are three possible scenarios to\nconfigure how views are picked up by Laravel:<\/p>\n<ol>\n<li>By adding views inside the global namespace, overriding existing\nglobal views.<\/li>\n<li>By adding views inside the global namespace, but where existing\nglobal views take precedence.<\/li>\n<li>By adding views inside their own namespace.<\/li>\n<\/ol>\n<h2 id=\"vendor\"><a href=\"#vendor\" class=\"anchor-link\"><\/a>Vendor<\/h2>\n<p>A very powerful addition is the ability to inject new packages and code.\nWhenever the tenant directory has a <code>vendor\/autoload.php<\/code> file it will\nbe loaded during runtime. Using that specific file allows you to fully\nutilize the power of composer inside your tenant directories.<\/p>\n<div class=\"alert alert-info\"><p>Please be aware that no compatibility checks are executed against your app.\nIdentifying whether a composer conflict could happen is something you should test\noutside production environments.<\/p><\/div>\n<h2 id=\"media\"><a href=\"#media\" class=\"anchor-link\"><\/a>Media<\/h2>\n<p>The media folder can be used by creating a <code>media\/<\/code> folder inside the\ntenant directory. Files inside that directory will become automatically\navailable as a public directory inside an equally named directory <code>media\/<\/code>.<\/p>\n<p>Eg: storing a file <code>media\/bg.jpg<\/code> will allow you to use <code>\/media\/bg.jpg<\/code> inside\nyour html. This applies to any file you store.<\/p>\n<h3 id=\"media-webserver\"><a href=\"#media-webserver\" class=\"anchor-link\"><\/a>\/media webserver<\/h3>\n<p>An alias is set up binding the private tenant media directory to the public\nmedia directory. This is implemented using the auto generated web server\nconfiguration files for apache and nginx.<\/p>\n<h3 id=\"media-fallback-controller\"><a href=\"#media-fallback-controller\" class=\"anchor-link\"><\/a>\/media fallback controller<\/h3>\n<p>In case you're not using the webserver vhost configuration files provided\nby this package you can choose to map the <code>MediaController<\/code> to the path, eg:<\/p>\n<pre><code class=\"language-php\">Route::get('\/media\/{path}', '\\Hyn\\Tenancy\\Controllers\\MediaController')\n    -&gt;where('path', '.+')\n    -&gt;name('tenant.media');\n<\/code><\/pre>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.4\/structure.md"}]},{"name":"tenant aware","links":["filesystem","migrations","validation","queues","events","cache","commands"],"slug":"tenant-aware","articles":[{"title":"Filesystem","icon":"fal fa-hdd","path":"docs\/hyn\/5.4\/filesystem.md","slug":"filesystem","package":"hyn","version":"5.4","contents":"<p>Tenancy offers a strategic <a href=\"structure\">directory structure<\/a> for tenants.<\/p>\n<h1 id=\"tenant-disk\"><a href=\"#tenant-disk\" class=\"anchor-link\"><\/a>Tenant disk<\/h1>\n<p>To access the directory of the active tenant, you can use the <code>tenant<\/code> disk.<\/p>\n<pre><code class=\"language-php\">Storage::disk('tenant')-&gt;put('readme.md', 'Hi John.');\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Tenants files are by default stored to <code>storage\/app\/tenancy<\/code>, but this can be reconfigured\nin the <code>tenancy.php<\/code> under <code>website &gt; disk<\/code>.<\/p><\/div>\n<p>Read more about disks on the <a href=\"https:\/\/laravel.com\/docs\/5.8\/filesystem\">Laravel documentation<\/a>.<\/p>\n<h1 id=\"directory\"><a href=\"#directory\" class=\"anchor-link\"><\/a>Directory<\/h1>\n<p>In order to assist with mutating these contents, you can use the\nDirectory class available in this package.<\/p>\n<pre><code class=\"language-php\">$directory = app(\\Hyn\\Tenancy\\Website\\Directory::class);\n<\/code><\/pre>\n<p>This class is set to use the tenant currently active, but also allows you to activate\nany other tenant whenever you need to use the <code>setWebsite(Website $website)<\/code> method.<\/p>\n<p>The Directory class implements <code>Illuminate\\Contracts\\Filesystem\\Filesystem<\/code> which offers\nthe same methods you are used to, including; <code>get<\/code>, <code>put<\/code> and <code>setVisibility<\/code>.<\/p>\n<h1 id=\"tenancy-directory\"><a href=\"#tenancy-directory\" class=\"anchor-link\"><\/a>Tenancy directory<\/h1>\n<p>In case you prefer having a higher level access to the files for tenants you can use the Filesystem bound to Laravel's container.<\/p>\n<pre><code class=\"language-php\">\/** @var \\Illuminate\\Contracts\\Filesystem\\Filesystem $tenancy *\/\n$tenancy = app('tenancy.disk');\n<\/code><\/pre>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.4\/filesystem.md"},{"title":"Migrations","icon":"fal fa-pallet-alt","path":"docs\/hyn\/5.4\/migrations.md","slug":"migrations","package":"hyn","version":"5.4","contents":"<p>Migrations are extremely important in the Laravel ecosystem.\nMigration commands for tenants have the Artisan prefix <code>tenancy:<\/code>.<\/p>\n<h1 id=\"about-the-databasemigrations-path\"><a href=\"#about-the-databasemigrations-path\" class=\"anchor-link\"><\/a>About the database\/migrations path<\/h1>\n<p>It's not wise to store the tenants migrations inside your global\n<code>database\/migrations<\/code> directory. Laravel by default runs these migrations\nwhen calling the <code>php artisan migrate<\/code> command. Even though you can suggest\na connection during that command, it's much cleaner to store these migrations\ninside a separate directory, e.g. <code>database\/migrations\/tenant<\/code>.\nThe migrations for the system database can stay in <code>database\/migrations<\/code>.<\/p>\n<h1 id=\"default-migrations-for-new-tenants\"><a href=\"#default-migrations-for-new-tenants\" class=\"anchor-link\"><\/a>Default migrations for new tenants<\/h1>\n<p>If you want new tenants to be migrated by default, you can easily do so. In\nyour <code>tenancy.php<\/code> configuration set <code>db &gt; tenant-migrations-path<\/code> to a valid\nabsolute path and all your new tenants will run these migrations by default.<\/p>\n<pre><code class=\"language-php\">  \/\/ ..\n  &quot;tenant-migrations-path&quot; =&gt; database_path('migrations\/tenant'),\n  \/\/ ..\n<\/code><\/pre>\n<h1 id=\"default-seeds-for-newly-auto-migrated-tenants\"><a href=\"#default-seeds-for-newly-auto-migrated-tenants\" class=\"anchor-link\"><\/a>Default seeds for newly auto-migrated tenants<\/h1>\n<p>In case you would also like to seed the databases of your newly created\nand migrated tenants, you can enable <code>db &gt; tenant-seed-class<\/code> in your <code>tenancy.php<\/code>\nconfiguration file. Change this setting to a fully namespaced class name\nand the package will automatically run this seed after it has run the\nautomatic migrations.<\/p>\n<h1 id=\"migration-related-commands\"><a href=\"#migration-related-commands\" class=\"anchor-link\"><\/a>Migration related commands<\/h1>\n<p>Tenancy is also able to run migrations through Artisan commands.<\/p>\n<p>Tenancy has added the <code>--website_id[=WEBSITE_ID]<\/code> option to each of the following native Laravel migrate and seed\ncommand and namespaced it accordingly, for instance.<\/p>\n<ul>\n<li>\n<code>tenancy:migrate<\/code> - Run the database migrations<\/li>\n<li>\n<code>tenancy:migrate:refresh<\/code> - Reset and re-run all migrations<\/li>\n<li>\n<code>tenancy:migrate:reset<\/code> - Rollback all database migrations<\/li>\n<li>\n<code>tenancy:migrate:rollback<\/code> - Rollback the last database migration<\/li>\n<li>\n<code>tenancy:db:seed<\/code> - Seed the database with records<\/li>\n<\/ul>\n<p>The --website_id optional option accepts multiple values. Though optional, if you leave the option out it will\nrun the command against all tenants. For example:<\/p>\n<ul>\n<li>\n<code>php artisan tenancy:migrate --website_id=1<\/code> to migrate just tenant website 1.<\/li>\n<li>\n<code>php artisan tenancy:migrate --website_id=1 --website_id=2<\/code> to migrate tenant website 1 &amp; 2.<\/li>\n<li>\n<code>php artisan tenancy:migrate<\/code> to migrate all tenant websites.<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>The <code>website_id<\/code> reflects the auto incremented <code>id<\/code> column of the Website and <strong>NOT<\/strong> the UUID.<\/p><\/div>\n<p>Please check the separate signatures for more information of valid arguments\nand options.<\/p>\n<div class=\"alert alert-info\"><p>Running <code>tenancy:migrate<\/code> without any path or realpath option and\nwithout having configured <code>tenant-migrations-path<\/code> will migrate your\ntenants with the files inside the <code>database\/migrations<\/code> directory.<\/p><\/div>\n<h1 id=\"reconstructing-tenant-databases\"><a href=\"#reconstructing-tenant-databases\" class=\"anchor-link\"><\/a>Reconstructing tenant databases<\/h1>\n<p>As long as your system database is intact, there's a way to recreate all tenant databases. You can use the <code>tenancy:recreate<\/code> artisan command to recreate all tenant databases that do not exist. The command will run the migrations and seeds according to your configuration in <code>tenancy.php<\/code>.<\/p>\n<div class=\"alert alert-info\"><p>Though the structure of all of your tenant databases will be recreated, the data in it won't.<\/p><\/div>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.4\/migrations.md"},{"title":"Validations","icon":"fal fa-file-check","path":"docs\/hyn\/5.4\/validation.md","slug":"validation","package":"hyn","version":"5.4","contents":"<h2 id=\"exists-and-unique-validation-rule\"><a href=\"#exists-and-unique-validation-rule\" class=\"anchor-link\"><\/a>Exists and Unique Validation Rule<\/h2>\n<p>Among all the built-in validation in Laravel, only the <a href=\"https:\/\/laravel.com\/docs\/5.6\/validation#rule-exists\">exists<\/a> and <a href=\"https:\/\/laravel.com\/docs\/5.6\/validation#rule-unique\">unique<\/a> validation rules interact with the database.<\/p>\n<p>We can leverage these two rules with tenancy by adding the connection parameter. Both use the same validation rule\nsignature which is <code>rule:connection.table,column<\/code>.<\/p>\n<p>So for example, to use <code>Exists (Database)<\/code> use <code>'email' =&gt; 'exists:tenant.staff,email'<\/code> where <code>tenant<\/code> is the <code>'tenant-connection-name'<\/code> you specified in your <code>tenancy.php<\/code> config file.<\/p>\n<p>Similarly, you can substitute the <code>exists<\/code> keyword to <code>unique<\/code> to use the <code>unique<\/code> rule instead, eg: <code>'email' =&gt; 'unique:tenant.staff,email'<\/code>.<\/p>\n<div class=\"alert alert-info\"><p>Validating against the system database is possible using the method described above but replacing <code>tenant<\/code> with <code>system<\/code>.<\/p><\/div>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.4\/validation.md"},{"title":"Queues","icon":"fal fa-conveyor-belt","path":"docs\/hyn\/5.4\/queues.md","slug":"queues","package":"hyn","version":"5.4","contents":"<p>One of the strongest features of Laravel is its queues. One drawback of sending\nJobs into the Queue is that these are executed in a completely different process\ndepending on your queue configuration, including redis and beanstalk.<\/p>\n<p>In order to assist you with tenant aware jobs, this package automatically identifies\nwhether a tenant website is active before processing the job. This ensures that\njobs are always tenant aware. In case you wish to override the tenant for which the job\nis executed, make sure to set the <code>website_id<\/code> property on the Job before dispatching it.<\/p>\n<pre><code class=\"language-php\">namespace App\\Jobs;\n\nuse Illuminate\\Bus\\Queueable;\nuse Illuminate\\Queue\\InteractsWithQueue;\nuse Illuminate\\Contracts\\Queue\\ShouldQueue;\nuse Illuminate\\Foundation\\Bus\\Dispatchable;\nuse Illuminate\\Queue\\SerializesModels;\n\nclass ProcessPodcast implements ShouldQueue\n{\n    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;\n    \n    public $website_id;\n    \n    public function __construct(int $website_id) {\n        $this-&gt;website_id = $website_id;\n    }\n}\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 18:29:42.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.4\/queues.md"},{"title":"Events","icon":"fal fa-hourglass-end","path":"docs\/hyn\/5.4\/events.md","slug":"events","package":"hyn","version":"5.4","contents":"<p>To create a fluid ecosystem around Laravel, this package uses events heavily.<\/p>\n<div class=\"alert alert-info\"><p>It's highly recommended to read up on the native <a href=\"https:\/\/laravel.com\/docs\/5.8\/events\">events<\/a> in Laravel.<\/p><\/div>\n<h1 id=\"model-events\"><a href=\"#model-events\" class=\"anchor-link\"><\/a>Model events<\/h1>\n<p>Namespaces:<\/p>\n<ul>\n<li>\n<code>Hyn\\Tenancy\\Events\\Hostnames<\/code>\n<\/li>\n<li>\n<code>Hyn\\Tenancy\\Events\\Websites<\/code>\n<\/li>\n<\/ul>\n<p>All of the models have the following events, whose purposes mirror Laravel's own model events.<\/p>\n<ul>\n<li>Creating<\/li>\n<li>Created<\/li>\n<li>Updating<\/li>\n<li>Updated<\/li>\n<li>Deleting<\/li>\n<li>Deleted<\/li>\n<\/ul>\n<h2 id=\"websites\"><a href=\"#websites\" class=\"anchor-link\"><\/a>Websites<\/h2>\n<p>Namespace: <code>Hyn\\Tenancy\\Events\\Websites<\/code>.<\/p>\n<ul>\n<li>Identified: a tenant website was identified.<\/li>\n<li>NoneFound: no tenant website was identified.<\/li>\n<li>Migrated: a website was auto migrated (not fired from console commands).<\/li>\n<li>Switched: the current tenant website was changed.<\/li>\n<\/ul>\n<h2 id=\"hostnames\"><a href=\"#hostnames\" class=\"anchor-link\"><\/a>Hostnames<\/h2>\n<p>Namespace: <code>Hyn\\Tenancy\\Events\\Hostnames<\/code>.<\/p>\n<p>The hostname model has a few additional events:<\/p>\n<ul>\n<li>Attached: the hostname was attached to a website.<\/li>\n<li>Detached: the hostname was removed from a website.<\/li>\n<li>Identified: the hostname is identified based on the request.<\/li>\n<li>NoneFound: no hostname was found during identification.<\/li>\n<li>Redirected: the hostname is configured to redirect to another url.<\/li>\n<li>Secured: the hostname is configured to upgrade the request to https.<\/li>\n<li>Switched: currently active hostname was changed.<\/li>\n<li>UnderMaintenance: the hostname is configured to be in maintenance.<\/li>\n<\/ul>\n<h1 id=\"database\"><a href=\"#database\" class=\"anchor-link\"><\/a>Database<\/h1>\n<p>Namespace: <code>Hyn\\Tenancy\\Events\\Database<\/code>.<\/p>\n<ul>\n<li>Creating<\/li>\n<li>Created<\/li>\n<li>Deleting<\/li>\n<li>Deleted<\/li>\n<li>Renaming<\/li>\n<li>Renamed<\/li>\n<li>ConfigurationLoading: the configuration for a tenant database connection\nis loading.<\/li>\n<li>ConfigurationLoaded: the configuration for a tenant database connection\nwas loaded.<\/li>\n<li>ConnectionSet: a connection was set and possibly an old one purged.<\/li>\n<\/ul>\n<h1 id=\"webservers\"><a href=\"#webservers\" class=\"anchor-link\"><\/a>Webservers<\/h1>\n<p>Namespace: <code>Hyn\\Tenancy\\Events\\Webservers<\/code>.<\/p>\n<ul>\n<li>ConfigurationSaved: the configuration for the webserver was saved to disk.<\/li>\n<\/ul>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.4\/events.md"},{"title":"Cache","icon":"fal fa-window-restore","path":"docs\/hyn\/5.4\/cache.md","slug":"cache","package":"hyn","version":"5.4","contents":"<p>Currently the Laravel cache will use the same cache key for all tenants.\nThis can and will cause issues in the long run. The config key for tenants\nshould be automatically changed and the ability to disable overriding the cache key should be configurable inside <code>tenancy.php<\/code>.<\/p>\n<p>The following is an easy implementation to allow per-tenant prefixes.<\/p>\n<p>Add a <code>CacheServiceProvider<\/code> with these contents in boot method:<\/p>\n<pre><code class=\"language-php\">public function boot()\n{\n    Cache::extend('redis_tenancy', function ($app) {\n        if (PHP_SAPI === 'cli') {\n            $uuid = $app['config']['driver'];\n        } else {\n            \/\/ ok, this is basically a hack to set the redis cache store\n            \/\/ prefix to the UUID of the current website being called\n            $fqdn = request()-&gt;getHost();\n\n            $uuid = DB::table('hostnames')\n                -&gt;select('websites.uuid')\n                -&gt;join('websites', 'hostnames.website_id', '=', 'websites.id')\n                -&gt;where('fqdn', $fqdn)\n                -&gt;value('uuid');\n        }\n\n        return Cache::repository(new RedisStore(\n            $app['redis'],\n            $uuid,\n            $app['config']['cache.stores.redis.connection']\n        ));\n    });\n}\n<\/code><\/pre>\n<p>This does not require a new Cache driver, as it's re-using\nthe existing Redis driver. All this does is override the default prefix and\nallows you to set a custom cache driver in <code>config\/cache.php<\/code>:<\/p>\n<pre><code class=\"language-php\">'redis' =&gt; [\n    'driver'     =&gt; 'redis_tenancy',\n    'connection' =&gt; 'default',\n],\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Make sure the CacheServiceProvider is registered in <code>config\/app.php<\/code> or else your driver will\nnot be available for use.<\/p><\/div>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.4\/cache.md"},{"title":"Commands","icon":"fal fa-screwdriver","path":"docs\/hyn\/5.4\/commands.md","slug":"commands","package":"hyn","version":"5.4","contents":"<p>Aside from the tenant aware <a href=\"migrations\">migration<\/a> command, the following\nis a list of additional commands provided by this package.<\/p>\n<h1 id=\"run-proxy-command\"><a href=\"#run-proxy-command\" class=\"anchor-link\"><\/a>Run proxy command<\/h1>\n<p>If you'd like to run any command for a tenant, you can use the <code>tenancy:run<\/code> command.<\/p>\n<p>You can execute and check the signature with<\/p>\n<pre><code class=\"language-bash\">$ php artisan tenancy:run --help\n<\/code><\/pre>\n<p>How it works:<\/p>\n<ul>\n<li>Using the <code>--tenant<\/code> option is optional. If you leave it out the command will be run on all tenants.<\/li>\n<li>The <code>--tenant<\/code> option accepts either a single website id or a comma separated list of website ids.<\/li>\n<li>If your target command requires options or arguments, you can add them like this:<\/li>\n<\/ul>\n<pre><code class=\"language-bash\">$ php artisan tenancy:run &lt;command&gt; --option=&quot;key=value&quot; --option=&quot;live=1&quot; --argument=&quot;key=value&quot;\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Make sure you include the argument or option key!<\/p><\/div>\n<p>Example:<\/p>\n<p>Execute Artisan command permission:update for website id 2 and 3<\/p>\n<pre><code class=\"language-bash\">php artisan tenancy:run permission:update --tenant=2,3\n<\/code><\/pre>\n<p>Please note this command does not do any checking and will forward any exceptions it hits.<\/p>\n<p>Also, <strong>don't<\/strong> run tenancy:run like this:<\/p>\n<pre><code class=\"language-bash\">$ php artisan tenancy:run tenancy:run --argument=&quot;run=tenancy:run&quot;\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Note: <code>tenancy:run<\/code> should not be called when running migrations. Use the <code>tenancy:migrate<\/code> command instead.<\/p><\/div>\n<h1 id=\"programmatic-artisan-calls\"><a href=\"#programmatic-artisan-calls\" class=\"anchor-link\"><\/a>Programmatic Artisan calls<\/h1>\n<pre><code class=\"language-php\">Artisan::call('tenancy:run', [\n        'run' =&gt; 'permission:update',\n        '--tenant' =&gt; [1,2,3]\n        ]);\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Make sure --tenant value is always an array. An integer value will fail.<\/p><\/div>\n<h1 id=\"recreate-command\"><a href=\"#recreate-command\" class=\"anchor-link\"><\/a>Recreate command<\/h1>\n<p>The recreate command allows you to create databases and filesystem directories for\nall tenants. It will check whether each tenant database already exists, create it if necessary\nand then dispatch a &quot;Created&quot; event that causes the folders and possible vhost configurations\nto be made.<\/p>\n<pre><code class=\"language-bash\">$ php artisan tenancy:recreate\n<\/code><\/pre>\n<h1 id=\"tenant-aware-tinker-command\"><a href=\"#tenant-aware-tinker-command\" class=\"anchor-link\"><\/a>Tenant Aware Tinker Command<\/h1>\n<p>This section describes how to enable tenant awareness for the native Laravel <code>tinker<\/code> command.<\/p>\n<p>First, create a trait named <code>MutatesTinkerCommand<\/code> with the following content:<\/p>\n<pre><code class=\"language-php\">namespace App\\Traits;\n\nuse Hyn\\Tenancy\\Contracts\\Repositories\\WebsiteRepository;\nuse Hyn\\Tenancy\\Database\\Connection;\nuse Illuminate\\Database\\Eloquent\\ModelNotFoundException;\nuse Symfony\\Component\\Console\\Exception\\RuntimeException;\nuse Symfony\\Component\\Console\\Input\\InputOption;\n\ntrait MutatesTinkerCommand\n{\n    \/**\n     * @var Connection\n     *\/\n    private $connection;\n\n    \/**\n     * @var WebsiteRepository\n     *\/\n    private $websites;\n\n    public function __construct()\n    {\n        parent::__construct();\n        $this-&gt;setName('tenancy:' . $this-&gt;getName());\n        $this-&gt;websites = app(WebsiteRepository::class);\n        $this-&gt;connection = app(Connection::class);\n    }\n\n    \/**\n     * Execute the console command.\n     *\n     * @return void\n     *\n     * @throws \\Hyn\\Tenancy\\Exceptions\\ConnectionException\n     *\/\n    public function handle()\n    {\n        $website_id = $this-&gt;option('website_id');\n        try{\n            $website = $this-&gt;websites-&gt;query()-&gt;where('id', $website_id)-&gt;firstOrFail();\n            $this-&gt;connection-&gt;set($website);\n            $this-&gt;info('Running Tinker on website_id: ' . $website_id);\n\n            parent::handle();\n            \n            $this-&gt;connection-&gt;purge();\n        } catch (ModelNotFoundException $e) {\n            throw new RuntimeException(sprintf('The tenancy website_id=%d does not exist.', $website_id));\n        }\n    }\n\n    protected function getOptions()\n    {\n        return array_merge([$this-&gt;addWebsiteOption()], parent::getOptions());\n    }\n\n    protected function addWebsiteOption()\n    {\n        return ['website_id', null, InputOption::VALUE_REQUIRED, 'The tenancy website_id (not uuid) to tinker specifically.', null];\n    }\n}\n<\/code><\/pre>\n<p>You can only tinker on one database at a time. Therefore the <code>website_id<\/code> needs to be a required option. Utilizing the <code>AddWebsiteFilterOnCommand<\/code> trait available in the Tenancy package would not work in this instance as it is tailored to run processes on multiple websites and makes the <code>website_id<\/code> parameter optional.<\/p>\n<p>Second, create a new console command <code>TinkerCommand<\/code> that uses the trait above.<\/p>\n<pre><code class=\"language-php\">namespace App\\Console\\Commands;\n\nuse Laravel\\Tinker\\Console\\TinkerCommand as BaseCommand;\nuse App\\Traits\\MutatesTinkerCommand;\n\nclass TinkerCommand extends BaseCommand\n{\n    use MutatesTinkerCommand;\n}\n<\/code><\/pre>\n<p>Now we have created a new <code>tenancy:tinker<\/code> artisan command. The <code>tenancy:tinker<\/code> requires the <code>--website_id=<\/code> option as a parameter. So, in order to run tinker on a <code>website_id<\/code> of 1, you\u2019ll need to run:<\/p>\n<pre><code class=\"language-bash\">$ php artisan tenancy:tinker --website_id=1\n\nRunning Tinker on website_id: 1\nPsy Shell v0.9.6 (PHP 7.2.7 \u2014 cli) by Justin Hileman\n&gt;&gt;&gt;\n<\/code><\/pre>\n<p>It will throw an error if the <code>--website_id=<\/code> option is missing:<\/p>\n<pre><code class=\"language-bash\">$ php artisan tenancy:tinker\n\n\n  The tenancy website_id=0 does not exist.\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 18:29:42.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.4\/commands.md"}]},{"name":"customization","links":["custom-models","logging"],"slug":"customization","articles":[{"title":"Custom system models","icon":"fal fa-theater-masks","path":"docs\/hyn\/5.4\/custom-models.md","slug":"custom-models","package":"hyn","version":"5.4","contents":"<p>This package allows you to specify different models to be used for the\nHostname and Website models. Tenancy will take care of the relationships on the\npackage-end. You also need to implement <code>Hyn\\Tenancy\\Contracts\\{Model}<\/code><\/p>\n<p>Take this example:<\/p>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Contracts\\Website as Contract;\n\nclass Website implements Contract\n{\n}\n<\/code><\/pre>\n<p>All you need to do is update the <code>tenancy.php<\/code> configuration file:<\/p>\n<pre><code class=\"language-php\">return [\n  'models' =&gt; [\n      \/\/ ..\n      \/\/ Must implement \\Hyn\\Tenancy\\Contracts\\Hostname\n      'hostname' =&gt; \\Hyn\\Tenancy\\Models\\Hostname::class,\n      \/\/ Must implement \\Hyn\\Tenancy\\Contracts\\Website\n      'website' =&gt; \\App\\Website::class\n  ],\n  \/\/ ...\n];\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 18:29:42.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.4\/custom-models.md"},{"title":"Logging","icon":"fal fa-book","path":"docs\/hyn\/5.4\/logging.md","slug":"logging","package":"hyn","version":"5.4","contents":"<p>Especially in production you might want to split the default Laravel log by tenants.\nTenancy ships with a custom tenant aware logger which you can register in the <code>logging.php<\/code> config.<\/p>\n<ul>\n<li>If a tenant is detected it will create a <code>logs<\/code> folder within the tenant directory:\n<code>storage\/app\/tenancy\/tenants\/&lt;tenant uuid&gt;\/logs\/&lt;log_level&gt;_&lt;YYYY&gt;-&lt;MM&gt;-&lt;DD&gt;.log<\/code>\n<\/li>\n<li>If no tenant is detected it will store the log file to:\n<code>storage\/logs\/<\/code>.<\/li>\n<\/ul>\n<p>Add a new <code>tenant<\/code> channel to the channels array in your <code>config\/logging.php<\/code> like below:<\/p>\n<pre><code class=\"language-php\">\/\/ ...\n'channels' =&gt; [\n        \/\/ ...\n        'tenant' =&gt; [\n            'driver' =&gt; 'custom',\n            'via' =&gt; \\Hyn\\Tenancy\\Logging\\TenantAwareLogger::class,\n            'level' =&gt; 'debug',\n        ],\n\/\/ ...\n<\/code><\/pre>\n<p>Then just change the 'single' channel to 'tenant' channel your stack channel:<\/p>\n<pre><code class=\"language-php\">\/\/ ...\n'stack' =&gt; [\n            'driver' =&gt; 'stack',\n            'channels' =&gt; ['tenant'],\n        ],\n\/\/ ...\n<\/code><\/pre>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.4\/logging.md"}]},{"name":"webserver","links":["apache","nginx"],"slug":"webserver","articles":[{"title":"Apache","icon":"fal fa-server","path":"docs\/hyn\/5.4\/apache.md","slug":"apache","package":"hyn","version":"5.4","contents":"<h1 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h1>\n<p>Tenancy natively integrates with the Apache webserver. For that to work you need\nto do a minor configuration.<\/p>\n<p>Edit the <code>\/etc\/apache2\/apache2.conf<\/code> and below the last <code>IncludeOptional<\/code> statement\nadd:<\/p>\n<pre><code class=\"language-apacheconfig\">IncludeOptional &lt;path&gt;\/*.conf\n<\/code><\/pre>\n<p>Where <code>&lt;path&gt;<\/code> has to be replaced by the location of your vhost files generated by this package.<\/p>\n<div class=\"alert alert-info\"><p>Your vhost files are saved by default inside the <code>storage\/app\/tenancy\/webserver\/apache<\/code> and\ncan be reconfigured in the <code>webserver.php<\/code> configuration file.<\/p><\/div>\n<p>Make sure to reload apache afterwards:<\/p>\n<pre><code class=\"language-bash\">sudo apache2ctl graceful\n<\/code><\/pre>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.4\/apache.md"},{"title":"Nginx","icon":"fal fa-server","path":"docs\/hyn\/5.4\/nginx.md","slug":"nginx","package":"hyn","version":"5.4","contents":"<h1 id=\"set-up\"><a href=\"#set-up\" class=\"anchor-link\"><\/a>Set up<\/h1>\n<p>You need to set up your own PHP FPM. The preferred way of running php is through a <a href=\"https:\/\/coderwall.com\/p\/hmsr5a\/have-php-fpm-listen-on-unix-socket\">socket<\/a> by\nconfiguring the <code>listen<\/code> value in your pool correctly. Make sure to copy the path of your\nsock and update your <code>webserver.php<\/code> configuration file to reflect that value, for instance:<\/p>\n<pre><code class=\"language-php\">    \/**\n     * Nginx webserver support.\n     *\n     * @see http:\/\/nginx.org\n     *\/\n    'nginx' =&gt; [\n        \/\/ ..\n\n        \/**\n         * The php sock to be used.\n         *\/\n        'php-sock' =&gt; 'unix:\/var\/run\/php\/php-fpm.sock',\n        \n        \/\/ ..\n    ],\n<\/code><\/pre>\n<h1 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h1>\n<p>Tenancy natively integrates with the Nginx webserver. For that to work you need\nto do a minor configuration.<\/p>\n<p>Edit the <code>\/etc\/nginx\/nginx.conf<\/code> and below the last <code>include<\/code> statement\nadd:<\/p>\n<pre><code class=\"language-apacheconfig\">include &lt;path&gt;\/*.conf;\n<\/code><\/pre>\n<p>Where <code>&lt;path&gt;<\/code> has to be replaced by the location of your vhost files generated by this package.<\/p>\n<div class=\"alert alert-info\"><p>Your vhost files are saved by default inside the <code>storage\/app\/tenancy\/webserver\/nginx<\/code> and\ncan be reconfigured in the <code>webserver.php<\/code> configuration file.<\/p><\/div>\n<p>Make sure to restart nginx afterwards:<\/p>\n<pre><code class=\"language-bash\">sudo systemctl restart nginx\n<\/code><\/pre>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.4\/nginx.md"}]},{"name":"tutorials","links":["spatie-laravel-permission","spatie-medialibrary","laravel-scheduler"],"slug":"tutorials","articles":[{"title":"Spatie permission","excerpt":"A tutorial on setting up spatie\/laravel-permission.","icon":"fal fa-file-archive","tags":["spatie","permission","tutorial"],"path":"docs\/hyn\/5.4\/spatie-laravel-permission.md","slug":"spatie-laravel-permission","package":"hyn","version":"5.4","contents":"<h2 id=\"prerequisite\"><a href=\"#prerequisite\" class=\"anchor-link\"><\/a>Prerequisite<\/h2>\n<p>You need a fresh Laravel app with Hyn Multi-Tenant installed. Briefly here are the basics:<\/p>\n<ol>\n<li>Create a fresh install of Laravel.  If you have installed the Laravel Terminal Installer run: <code>$ laravel new app<\/code>\n<\/li>\n<li>\n<code>$ cd app<\/code>\n<\/li>\n<li>Install <code>hyn\/multi-tenant<\/code> package by running:<\/li>\n<\/ol>\n<pre><code class=\"language-bash\">composer require hyn\/multi-tenant\n<\/code><\/pre>\n<ol start=\"4\">\n<li>Follow the instructions until &quot;Deploy configuration&quot; section.<\/li>\n<li>If you are using MySQL DB, you need to add the entry <code>LIMIT_UUID_LENGTH_32=true<\/code> in your <code>.env<\/code> file.<\/li>\n<\/ol>\n<h2 id=\"install-spatie-permissions-package\"><a href=\"#install-spatie-permissions-package\" class=\"anchor-link\"><\/a>Install Spatie Permissions Package<\/h2>\n<p>To install the package follow the entire installation section\nat <a href=\"https:\/\/github.com\/spatie\/laravel-permission#installation\">GitHub - spatie\/laravel-permission: Associate users with roles and permissions<\/a>.<\/p>\n<h2 id=\"integration\"><a href=\"#integration\" class=\"anchor-link\"><\/a>Integration<\/h2>\n<p>This section of the tutorial assumes that you have successfully <a href=\"creating-tenants\">created at least 2 hostnames<\/a>\nand have successfully accessed them via your local environment setup.<\/p>\n<p>We need to extend the two eloquent models (<code>Permission<\/code>, <code>Role<\/code>) of the Permissions\npackage so that we can add the necessary changes we need in order for these two models\nto be tenant aware.<\/p>\n<ol>\n<li>Create a <code>Permission.php<\/code> and <code>Role.php<\/code> file and place them inside your <code>app<\/code> directory,\nnext to your <code>User.php<\/code>. Make sure that these files extend <code>Spatie\\Permission\\Models\\Permission::class<\/code>\nand <code>Spatie\\Permission\\Models\\Role::class<\/code> respectively.<\/li>\n<\/ol>\n<p><code>App\\Permission.php<\/code> - extends from <code>SpatiePermission<\/code> and uses the <code>UsesTenantConnection<\/code> trait.<\/p>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Traits\\UsesTenantConnection;\nuse Spatie\\Permission\\Models\\Permission as SpatiePermission;\n\nclass Permission extends SpatiePermission\n{\n    use UsesTenantConnection;\n}\n<\/code><\/pre>\n<p><code>App\\Role.php<\/code> - extends from <code>SpatieRole<\/code> and uses the <code>UsesTenantConnection<\/code> trait.<\/p>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Traits\\UsesTenantConnection;\nuse Spatie\\Permission\\Models\\Role as SpatieRole;\n\nclass Role extends SpatieRole\n{\n    use UsesTenantConnection;\n}\n<\/code><\/pre>\n<p><code>App\\User.php<\/code> - notice the <code>HasRoles<\/code>, <code>UsesTenantConnection<\/code> traits we added.<\/p>\n<pre><code class=\"language-php\">use Spatie\\Permission\\Traits\\HasRoles;\nuse Illuminate\\Notifications\\Notifiable;\nuse Hyn\\Tenancy\\Traits\\UsesTenantConnection;\nuse Illuminate\\Foundation\\Auth\\User as Authenticatable;\n\nclass User extends Authenticatable\n{\n    use Notifiable, UsesTenantConnection, HasRoles;\n\n    \/**\n     * The attributes that are mass assignable.\n     *\n     * @var array\n     *\/\n    protected $fillable = [\n        'name', 'email', 'password',\n    ];\n\n    \/**\n     * The attributes that should be hidden for arrays.\n     *\n     * @var array\n     *\/\n    protected $hidden = [\n        'password', 'remember_token',\n    ];\n}\n<\/code><\/pre>\n<ol start=\"3\">\n<li>Modify your <code>config\/permission.php<\/code> file and modify the <code>permission<\/code> and <code>role<\/code> models to point to your newly created models. e.g. <code>App\\Permission::class<\/code>\n<\/li>\n<\/ol>\n<p><code>config\\permission.php<\/code><\/p>\n<pre><code class=\"language-php\">return [\n\n    'models' =&gt; [\n\n        'permission' =&gt; App\\Permission::class,\n\n        'role' =&gt; App\\Role::class,\n\n    ],\n\n    ...\n];\n<\/code><\/pre>\n<ol start=\"4\">\n<li>Creating a user in your first hostname. (We're using the first hostname here merely as an example.)<\/li>\n<\/ol>\n<pre><code class=\"language-php\">use App\\User;\nuse App\\Role;\nuse App\\Permission;\nuse Hyn\\Tenancy\\Models\\Hostname;\n\n\/\/ Switch the environment to use first hostname\n$environment = app(\\Hyn\\Tenancy\\Environment::class);\n$hostname = Hostname::find(1);\n$environment-&gt;hostname($hostname);\n\n\/\/ creates role and permission on your first hostname\n$role = Role::create(['name' =&gt; 'writer']);\n$permission = Permission::create(['name' =&gt; 'edit articles']);\n\n\/\/ Retrieve user and check to make sure it has no roles yet\n$user = User::find(1);\n$user-&gt;getRoleNames();\n\n\/\/ Assign writer role\n$user-&gt;assignRole('writer');\n\n\/\/ Requery and see that the newly assigned roles exists.\n$user = User::find(1);\n$user-&gt;getRoleNames();\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 18:29:42.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.4\/spatie-laravel-permission.md"},{"title":"Spatie media library","excerpt":"A tutorial on setting up spatie\/laravel-medialibrary.","icon":"fal fa-file-archive","tags":["spatie","medialibrary","tutorial"],"path":"docs\/hyn\/5.4\/spatie-medialibrary.md","slug":"spatie-medialibrary","package":"hyn","version":"5.4","contents":"<ol>\n<li>Create a fresh install of Laravel.  If you have installed the Laravel Terminal Installer run:<\/li>\n<\/ol>\n<pre><code class=\"language-bash\">$ laravel new app\n<\/code><\/pre>\n<ol start=\"2\">\n<li>\n<code>$ cd app<\/code>\n<\/li>\n<li>Install <code>hyn\/multi-tenant<\/code> package by running: <code>composer require hyn\/multi-tenant<\/code>\n<\/li>\n<li>Follow the instructions until the &quot;Deploy configuration&quot; section.<\/li>\n<li>If you are using MySQL as a database, make sure to add the entry <code>LIMIT_UUID_LENGTH_32=true<\/code> in your <code>.env<\/code> file.<\/li>\n<\/ol>\n<h2 id=\"install-spatie-medialibrary\"><a href=\"#install-spatie-medialibrary\" class=\"anchor-link\"><\/a>Install Spatie Medialibrary<\/h2>\n<p>Install this package via composer.<\/p>\n<pre><code class=\"language-bash\">$ composer require spatie\/laravel-medialibrary\n<\/code><\/pre>\n<p>Publish the migration with:<\/p>\n<pre><code class=\"language-bash\">$ php artisan vendor:publish --provider=&quot;Spatie\\MediaLibrary\\MediaLibraryServiceProvider&quot; --tag=&quot;migrations&quot;\n<\/code><\/pre>\n<p>Move the migration file (<code>2018_10_10_085035_create_media_table.php<\/code>) from <code>database\/migrations\/<\/code> to <code>database\/migrations\/tenant\/<\/code>.<\/p>\n<p>After the migration has been published you can create the media-table in your tenant databases by running the migrations:<\/p>\n<pre><code class=\"language-bash\">$ php artisan tenancy:migrate\n<\/code><\/pre>\n<p>You need to publish the config-file with:<\/p>\n<pre><code class=\"language-bash\">$ php artisan vendor:publish --provider=&quot;Spatie\\MediaLibrary\\MediaLibraryServiceProvider&quot; --tag=&quot;config&quot;\n<\/code><\/pre>\n<h2 id=\"integration\"><a href=\"#integration\" class=\"anchor-link\"><\/a>Integration<\/h2>\n<p>This section of the tutorial assumes that you have successfully <a href=\"creating-tenants\">created at least 2 hostnames<\/a>\nand have successfully accessed them via your local environment setup.<\/p>\n<p>We need to extend the <code>Media<\/code> eloquent model of the Medialibrary package so that we can add the\nnecessary changes for these two models to be tenant aware.<\/p>\n<ol>\n<li>Create a Media.php file and place it inside your <code>app<\/code> directory,\nnext to your <code>User.php<\/code>. Make sure that this class extends <code>Spatie\\MediaLibrary\\Models\\Media::class<\/code>.<\/li>\n<\/ol>\n<p><code>App\\Media.php<\/code> - extends from <code>SpatieMedia<\/code> and uses the <code>UsesTenantConnection<\/code> trait.<\/p>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Traits\\UsesTenantConnection;\nuse Spatie\\MediaLibrary\\Models\\Media as SpatieMedia;\n\nclass Media extends SpatieMedia\n{\n    use UsesTenantConnection;\n}\n<\/code><\/pre>\n<ol start=\"2\">\n<li>Prepare your model<\/li>\n<\/ol>\n<p>To associate media with a model, the tenant aware model must implement the following interface and traits, as shown below:<\/p>\n<pre><code class=\"language-php\">use Illuminate\\Database\\Eloquent\\Model;\nuse Spatie\\MediaLibrary\\HasMedia\\HasMedia;\nuse Hyn\\Tenancy\\Traits\\UsesTenantConnection;\nuse Spatie\\MediaLibrary\\HasMedia\\HasMediaTrait;\n\nclass User extends Model implements HasMedia\n{\n    use UsesTenantConnection, HasMediaTrait;\n   ...\n}\n<\/code><\/pre>\n<ol start=\"3\">\n<li>Modify your <code>config\/medialibrary.php<\/code> file and modify the <code>media_model<\/code> to point to your newly created model. e.g. <code>App\\Media::class<\/code>\n<\/li>\n<\/ol>\n<p><code>config\\medialibrary.php<\/code><\/p>\n<pre><code class=\"language-php\">return [\n\n    \/*\n     * The fully qualified class name of the media model.\n     *\/\n    'media_model' =&gt; App\\Media::class,\n\n    ...\n];\n<\/code><\/pre>\n<ol start=\"4\">\n<li>Attaching a media to your user model.<\/li>\n<\/ol>\n<pre><code class=\"language-php\">\/\/ Retrieve your user model.\n$user = App\\User::find(1);\n\n\/\/ Add a media from url and attach it to your model.\n$user-&gt;addMediaFromUrl('http:\/\/url-to-your-media-to-attach.png')-&gt;toMediaCollection();\n\n\/\/ Retrieve the media you just attached.\n$media = $user-&gt;media-&gt;last();\n<\/code><\/pre>\n<p>That's about it. You can read more on how to customize the medialibrary on their website: <a href=\"https:\/\/docs.spatie.be\/laravel-medialibrary\">https:\/\/docs.spatie.be\/laravel-medialibrary<\/a><\/p>\n","updated_at":{"date":"2020-07-18 18:29:42.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.4\/spatie-medialibrary.md"},{"title":"Laravel Scheduler","excerpt":"A tutorial on setting up Laravel's Scheduler to be Tenant Aware.","icon":"fal fa-file-archive","tags":["laravel","scheduler","tutorial"],"path":"docs\/hyn\/5.4\/laravel-scheduler.md","slug":"laravel-scheduler","package":"hyn","version":"5.4","contents":"<h1 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h1>\n<p>Laravel's command scheduler allows you to fluently and expressively define your command schedule within Laravel itself. When using the scheduler, only a single Cron entry is needed on your server.<\/p>\n<p>Your task schedule is defined in the <code>app\/Console\/Kernel.php<\/code> file's <code>schedule<\/code> method.<\/p>\n<p>By making Laravel's Scheduler tenant aware, we will unlock the possibilty to run multiple commands on all our tenants, without having to worry about setting numerous Cron jobs on your server.<\/p>\n<h1 id=\"prerequisite\"><a href=\"#prerequisite\" class=\"anchor-link\"><\/a>Prerequisite<\/h1>\n<p>You need a fresh Laravel app with Hyn Multi-Tenant installed. Briefly here are the basics:<\/p>\n<ol>\n<li>Create a fresh install of Laravel.  If you have installed the Laravel Terminal Installer run: <code>$ laravel new app<\/code>\n<\/li>\n<li>\n<code>$ cd app<\/code>\n<\/li>\n<li>Install <code>hyn\/multi-tenant<\/code> package by running:<\/li>\n<\/ol>\n<pre><code class=\"language-bash\">composer require hyn\/multi-tenant\n<\/code><\/pre>\n<ol start=\"4\">\n<li>Follow the <a href=\"https:\/\/tenancy.dev\/docs\/hyn\/5.4\/installation\">installation instructions<\/a>.<\/li>\n<\/ol>\n<h1 id=\"create-a-command\"><a href=\"#create-a-command\" class=\"anchor-link\"><\/a>Create a Command<\/h1>\n<p>To create a new command, use the <code>make:command<\/code> Artisan command. This command will create a new command class in the <code>app\/Console\/Commands<\/code> directory<\/p>\n<pre><code class=\"language-bash\">php artisan make:command ExampleCommand\n<\/code><\/pre>\n<p>We are going to make this command Tenant Aware. We need to change the signature to accept a <code>website_id<\/code> option:<\/p>\n<pre><code class=\"language-php\">protected $signature = 'example:command {--website_id=}';\n<\/code><\/pre>\n<p>We will take tenant awereness code from <a href=\"https:\/\/tenancy.dev\/docs\/hyn\/5.4\/commands#tenant-aware-tinker-command\">Tenant Aware Tinker Command<\/a>. The ExampleCommand should now look like this:<\/p>\n<pre><code class=\"language-php\">namespace App\\Console\\Commands;\n\nuse Illuminate\\Console\\Command;\nuse Hyn\\Tenancy\\Contracts\\Repositories\\WebsiteRepository;\nuse Hyn\\Tenancy\\Database\\Connection;\nuse Illuminate\\Database\\Eloquent\\ModelNotFoundException;\nuse Symfony\\Component\\Console\\Exception\\RuntimeException;\n\nclass ExampleCommand extends Command\n{\n    \/**\n     * The name and signature of the console command.\n     *\n     * @var string\n     *\/\n    protected $signature = 'example:command {--website_id=}';\n\n    \/**\n     * The console command description.\n     *\n     * @var string\n     *\/\n    protected $description = 'Example Command - Tenant Aware';\n\n    \/**\n     * @var Connection\n     *\/\n    private $connection;\n\n    \/**\n     * @var WebsiteRepository\n     *\/\n    private $websites;\n\n    \/**\n     * Create a new command instance.\n     *\n     * @return void\n     *\/\n    public function __construct()\n    {\n        parent::__construct();\n        $this-&gt;websites = app(WebsiteRepository::class);\n        $this-&gt;connection = app(Connection::class);\n    }\n\n    \/**\n     * Execute the console command.\n     *\n     * @return mixed\n     *\/\n    public function handle()\n    {\n        $website_id = $this-&gt;option('website_id');\n        try{\n            $website = $this-&gt;websites-&gt;query()-&gt;where('id', $website_id)-&gt;firstOrFail();\n            $this-&gt;connection-&gt;set($website);\n            $this-&gt;info('Running Command on website_id: ' . $website_id);\n\n            $this-&gt;tenantHandle();\n\n            $this-&gt;connection-&gt;purge();\n        } catch (ModelNotFoundException $e) {\n            throw new RuntimeException(\n                sprintf(\n                    'The tenancy website_id=%d does not exist.',\n                    $website_id\n                )\n            );\n        }\n    }\n\n    \/**\n     * Execute the console command. Tenant Aware.\n     *\n     * @return mixed\n     *\/\n    public function tenantHandle()\n    {\n        \/\/ You are now Tenant Aware\n        \/\/ Execute something, dispatch a Job, or anything else\n    }\n}\n<\/code><\/pre>\n<h1 id=\"integration\"><a href=\"#integration\" class=\"anchor-link\"><\/a>Integration<\/h1>\n<div class=\"alert alert-info\"><p>This section of the tutorial assumes that you have successfully created one or more tenant aware commands.<\/p><\/div>\n<p>We now need to register our <code>ExampleCommand<\/code> into our schedule. Laravel's Scheduler is set into <code>app\/Console\/Kernel.php<\/code>.<\/p>\n<ol>\n<li>First, we need to tell Laravel which commands will be used in the scheduler<\/li>\n<\/ol>\n<pre><code class=\"language-php\">protected $commands = [\n    ExampleCommand::class,\n    MySecondCommand::class,\n    ...\n];\n\n<\/code><\/pre>\n<ol start=\"2\">\n<li>Create a method for each command you need to run. We will be using the <code>before<\/code> <a href=\"https:\/\/laravel.com\/docs\/master\/scheduling#task-hooks\">Task Hook<\/a> to specify code to be executed before the scheduled task is launched. Here is an example:<\/li>\n<\/ol>\n<pre><code class=\"language-php\">\/**\n * Example Command Schedule\n * @param  Illuminate\\Console\\Scheduling\\Schedule   $schedule   Instance of schedule\n * @return void\n *\/\nprotected function scheduleExampleCommand(Schedule $schedule)\n{\n    \/\/ Set the Scheduler to our Tenant Aware Command. Store the returned Event.\n    $scheduledEvent = $schedule-&gt;command(ExampleCommand::class);\n\n    \/\/ Init a new variable to alter the Event's command string\n    $commandString = null;\n\n    \/\/ Setup your schedule\n    $scheduledEvent\n        \/\/ Setup our `before` Hook\n        -&gt;before(function () use ($scheduledEvent, &amp;$commandString) {\n            \/\/ Retreive current tenant\n            $tenant = app(\\Hyn\\Tenancy\\Environment::class)-&gt;tenant();\n\n            \/\/ Retreive and store the inital generated command. See note below*\n            if ($commandString === null) {\n                $commandString = $scheduledEvent-&gt;command;\n            }\n\n            \/\/ Replace the Event's generated command\n            \/\/ Adding our tenant's `website_id` option\n            $scheduledEvent-&gt;command = sprintf(\n                &quot;%s --website_id=%d&quot;,\n                $commandString,\n                $tenant-&gt;id\n            );\n        })\n\n        \/\/ Define your schedule as you would normally do\n        \/\/-&gt;everyHour()\n        \/\/-&gt;runInBackground()\n        \/\/-&gt;evenInMaintenanceMode();\n}\n<\/code><\/pre>\n<p>Your can find all available schedule options on <a href=\"https:\/\/laravel.com\/docs\/master\/scheduling#schedule-frequency-options\">Laravel's Official Documentation<\/a> page.<\/p>\n<div class=\"alert alert-info\"><p>*<em>Note: Without this, <code>--website_id<\/code> option would be added one after the other.<\/em><\/p><\/div>\n<ol start=\"3\">\n<li>Set our <code>schedule<\/code> method to run our new methods. Use the <code>Tenancy\\Environment<\/code> to define whether you're running with <code>tenancy:run<\/code> or not.<\/li>\n<\/ol>\n<pre><code class=\"language-php\">\/**\n * Define the application's command schedule.\n *\n * @param  \\Illuminate\\Console\\Scheduling\\Schedule $schedule\n * @return void\n *\/\nprotected function schedule(Schedule $schedule)\n{\n    if (app(\\Hyn\\Tenancy\\Environment::class)-&gt;tenant()) {\n        \/\/ Run your tenant aware schedules\n        $this-&gt;scheduleExampleCommand($schedule);\n        $this-&gt;scheduleMySecondCommand($schedule);\n        ...\n    } else {\n        \/\/ Run your system schedules\n        \/\/ ...\n    }\n}\n<\/code><\/pre>\n<ol start=\"4\">\n<li>Setup your server Cron<\/li>\n<\/ol>\n<pre><code class=\"language-bash\"># Tenant\n* * * * * cd \/path-to-your-project &amp;&amp; php artisan tenancy:run schedule:run &gt;&gt; \/dev\/null 2&gt;&amp;1\n\n# System\n# * * * * * cd \/path-to-your-project &amp;&amp; php artisan schedule:run &gt;&gt; \/dev\/null 2&gt;&amp;1\n<\/code><\/pre>\n","updated_at":{"date":"2020-02-22 10:56:04.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.4\/laravel-scheduler.md"}]}],"hidden_articles":{"index":{"title":"Hyn documentation","path":"docs\/hyn\/5.4\/index.md","slug":"index","package":"hyn","version":"5.4","contents":"","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.4\/index.md"}}},"5.3":{"slug":"5.3","name":5.3,"status":"Deprecated","suggestion_using":null,"branch":"5.x","package":"hyn","tree":[{"name":"getting started","links":["requirements","upgrade-from-5.2","installation","configuration"],"slug":"getting-started","articles":[{"title":"Requirements","icon":"fal fa-clipboard-check","path":"docs\/hyn\/5.3\/requirements.md","slug":"requirements","package":"hyn","version":"5.3","contents":"<ul>\n<li>Laravel 5.6 or 5.7.<\/li>\n<li>PHP 7.1 or up.<\/li>\n<li>MySQL 5.7+, MariaDB 10.1.13+ or PostgreSQL 9+.<\/li>\n<li>Optionally Apache 2.4+ or Nginx 1.12+.<\/li>\n<li>\n<a href=\"#experience\">Applied experience with Laravel<\/a>.<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>Please note that MySQL limits username and database length to 32,\nenable in the <code>tenancy.php<\/code> configuration file:  <code>website &gt; uuid-limit-length-to-32<\/code>\nto fix this.<\/p><\/div>\n<h2 id=\"experience\"><a href=\"#experience\" class=\"anchor-link\"><\/a>Experience<\/h2>\n<p>In case you are new to Laravel we urge you to get familiar with that\nbefore jumping into building something with this package. Having built\nat least one project with the framework (for fun) makes it much easier\ngrasping the concepts at hand.<\/p>\n<p>The following resources we recommend:<\/p>\n<ul>\n<li>\n<a href=\"https:\/\/laravel.com\/docs\">Laravel documentation<\/a>\n<\/li>\n<li>\n<a href=\"https:\/\/laracasts.com\/series\/laravel-from-scratch-2017\">Laravel from scratch free series at Laracasts<\/a>\n<\/li>\n<\/ul>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.3\/requirements.md"},{"title":"Upgrading from 5.2","icon":"fal fa-level-up-alt","path":"docs\/hyn\/5.3\/upgrade-from-5.2.md","slug":"upgrade-from-5.2","package":"hyn","version":"5.3","contents":"<p>The 5.3 adds compatibility with Laravel 5.7 while fixing minor issues and adding\nmore features.<\/p>\n<h2 id=\"backward-breaking-changes\"><a href=\"#backward-breaking-changes\" class=\"anchor-link\"><\/a>Backward breaking changes<\/h2>\n<ul>\n<li>The configuration <code>tenancy.hostname.abort-without-identified-hostname<\/code> is\nnow default false.<\/li>\n<\/ul>\n<h2 id=\"new-features\"><a href=\"#new-features\" class=\"anchor-link\"><\/a>New features<\/h2>\n<ul>\n<li>Added a <code>tenancy:run<\/code> command that allows using any other artisan command within\none or more tenant-enabled environments.<\/li>\n<li>Multi schema support for PostgreSQL.<\/li>\n<\/ul>\n<h2 id=\"minor\"><a href=\"#minor\" class=\"anchor-link\"><\/a>Minor<\/h2>\n<ul>\n<li>Fixed hardcoded tables in validators.<\/li>\n<li>\n<code>route()<\/code> helper now is able to generate urls when using the <code>routes\/tenants.php<\/code> file.<\/li>\n<li>Fixed grants being given on users we weren't creating.<\/li>\n<li>More minor bug fixes and improvements.<\/li>\n<\/ul>\n<p>See the <a href=\"https:\/\/github.com\/tenancy\/multi-tenant\/blob\/5.x\/changelog.md\">changelog<\/a> for\nall modifications.<\/p>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.3\/upgrade-from-5.2.md"},{"title":"Installation","icon":"fal fa-arrow-alt-to-bottom","path":"docs\/hyn\/5.3\/installation.md","slug":"installation","package":"hyn","version":"5.3","contents":"<h1 id=\"elevated-database-user\"><a href=\"#elevated-database-user\" class=\"anchor-link\"><\/a>Elevated database user<\/h1>\n<p>Tenancy requires a system connection that allows creating new databases for her\ntenants. In order to do so, we need to have a database user with elevated\npermissions.<\/p>\n<p>A user for both <a href=\"https:\/\/mariadb.com\/kb\/en\/library\/grant\/#the-grant-option-privilege\">MariaDB or MySQL<\/a> and <a href=\"https:\/\/www.postgresql.org\/docs\/9.6\/static\/sql-grant.html\">PostgreSQL<\/a> would require the &quot;GRANT OPTION&quot; to be\napplied. You can either use the root user (for PostgreSQL that is user postgres) or create\nyour own (recommended):<\/p>\n<p>For MariaDB or MySQL:<\/p>\n<pre><code class=\"language-sql\">CREATE DATABASE IF NOT EXISTS tenancy;\nCREATE USER IF NOT EXISTS tenancy@localhost IDENTIFIED BY 'someRandomPassword';\nGRANT ALL PRIVILEGES ON *.* TO tenancy@localhost WITH GRANT OPTION;\n<\/code><\/pre>\n<p>For PostgreSQL:<\/p>\n<pre><code class=\"language-sql\">CREATE DATABASE tenancy;\nCREATE USER tenancy WITH CREATEDB CREATEROLE PASSWORD 'someRandomPassword';\nGRANT ALL PRIVILEGES ON DATABASE tenancy to tenancy WITH GRANT OPTION;\n<\/code><\/pre>\n<p>Make sure you configure this user as your system connection in your <code>database.php<\/code>.\nUnder connections:<\/p>\n<pre><code class=\"language-php\">'system' =&gt; [\n    'driver' =&gt; 'mysql',\n    'host' =&gt; env('TENANCY_HOST', '127.0.0.1'),\n    'port' =&gt; env('TENANCY_PORT', '3306'),\n    'database' =&gt; env('TENANCY_DATABASE', 'tenancy'),\n    'username' =&gt; env('TENANCY_USERNAME', 'tenancy'),\n    'password' =&gt; env('TENANCY_PASSWORD', ''),\n    'unix_socket' =&gt; env('DB_SOCKET', ''),\n    'charset' =&gt; 'utf8mb4',\n    'collation' =&gt; 'utf8mb4_unicode_ci',\n    'prefix' =&gt; '',\n    'strict' =&gt; true,\n    'engine' =&gt; null,\n]\n<\/code><\/pre>\n<p>Most often it makes sense to use either <code>system<\/code> or <code>tenant<\/code> as your default database connection setting; this is <code>DB_CONNECTION<\/code> in your <code>.env<\/code> file. This environment variable is assigned to the <code>default<\/code> key in the <code>config\/database.php<\/code> configuration file.<\/p>\n<p>In case you use the <code>tenant<\/code> make sure to enable <a href=\"identification\">early identification<\/a> and configure\na decent <a href=\"fallback\">fallback<\/a> later on.<\/p>\n<div class=\"alert alert-info\"><p>There is no need to configure the <code>tenant<\/code> connection in the <code>database.php<\/code>\nconfiguration file. This connection is set up automatically during runtime. Pre-\nconfiguring this connection may cause unwanted behaviour.<\/p><\/div>\n<h1 id=\"package-installation\"><a href=\"#package-installation\" class=\"anchor-link\"><\/a>Package installation<\/h1>\n<p>Run the composer command to add the tenancy package as dependency:<\/p>\n<pre><code class=\"language-bash\">composer require &quot;hyn\/multi-tenant:5.3.*&quot;\n<\/code><\/pre>\n<p>Laravel offers <a href=\"https:\/\/medium.com\/@taylorotwell\/package-auto-discovery-in-laravel-5-5-ea9e3ab20518\">package auto discovery<\/a>\nin version 5.6. So that's all you need to do; no need to register any\nservice providers manually in your <code>config\/app.php<\/code>.<\/p>\n<p>Publish the configuration files and migrations for tenancy, which allows you\nto configure the behavior of the package.<\/p>\n<pre><code class=\"language-bash\">php artisan vendor:publish --tag=tenancy\n<\/code><\/pre>\n<p>Then edit <code>config\/tenancy.php<\/code> accordingly.<\/p>\n<p>Adapt the system migrations to your liking inside <code>database\/migrations<\/code>, make sure to run them:<\/p>\n<pre><code class=\"language-bash\">php artisan migrate --database=system\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Change <code>system<\/code> to your system connection name.<\/p><\/div>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.3\/installation.md"},{"title":"Configuration","icon":"fal fa-sliders-v","path":"docs\/hyn\/5.3\/configuration.md","slug":"configuration","package":"hyn","version":"5.3","contents":"<h1 id=\"system-connection\"><a href=\"#system-connection\" class=\"anchor-link\"><\/a>System connection<\/h1>\n<p>Tenancy needs a database connection with elevated permission to create databases\nto be used by its tenants.<\/p>\n<p>Make sure you set up this connection by following the instructions\nin the <a href=\"requirements#elevated-database-user\">requirements<\/a>, it also explains how to publish\nthe configuration files.<\/p>\n<h1 id=\"configuration-files\"><a href=\"#configuration-files\" class=\"anchor-link\"><\/a>Configuration Files<\/h1>\n<p>The inline documentation in both files should be self explanatory. Nevertheless,\nI've listed some of the basic settings below.<\/p>\n<h2 id=\"tenancyphp\"><a href=\"#tenancyphp\" class=\"anchor-link\"><\/a>tenancy.php<\/h2>\n<p>The tenancy configuration file holds every setting related to tenants. This includes how to generate a unique\nwebsite, but also how database connections are set up. In addition, it allows for;<\/p>\n<ul>\n<li>custom random id logic.<\/li>\n<li>manual tenant identification.<\/li>\n<li>on what disk (see <code>config\/filesystems.php<\/code>) to store the tenant-specific files.<\/li>\n<li>specifying tenant database division mode<\/li>\n<li>specifying the password generator<\/li>\n<li>specifying the migrations path<\/li>\n<li>forcing models to a specific connection<\/li>\n<li>overriding your configs<\/li>\n<li>overriding your routes<\/li>\n<li>overriding translations<\/li>\n<li>overriding views<\/li>\n<li>and much, much more.<\/li>\n<\/ul>\n<h2 id=\"webserverphp\"><a href=\"#webserverphp\" class=\"anchor-link\"><\/a>webserver.php<\/h2>\n<p>With the webserver.php one can more closely fine tune integration of this package with your webserver.\nPorts, vhost configuration files and the location to save these files are all contained in this config.<\/p>\n<p>In general you can expect the following settings for each webserver;<\/p>\n<ul>\n<li>enabled; whether the service is enabled and thus the package will write files for it and reload the service.<\/li>\n<li>ports; which ports we should use, this is required to configure the vhost files properly.<\/li>\n<li>generator; the class handling the generation of vhost files.<\/li>\n<li>disk; the disk to write the vhost files to, you can have it point to any configured disk in your <code>config\/filesystems.php<\/code>.<\/li>\n<li>paths; specific locations we need to know about to in order to mutate the webserver behavior.<\/li>\n<\/ul>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.3\/configuration.md"}]},{"name":"tenant principles","links":["concepts","identification","connections","fallback","middleware"],"slug":"tenant-principles","articles":[{"title":"Concepts","icon":"fal fa-vials","path":"docs\/hyn\/5.3\/concepts.md","slug":"concepts","package":"hyn","version":"5.3","contents":"<h1 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h1>\n<p>The principle of multi tenancy is about a single instance of software running\non a server and serving multiple tenants. The interpretation of such a tenancy\napplication is quite diverse.<\/p>\n<p>Hyn tenancy is focused on providing a drop-in solution for Laravel without\nsacrificing flexibility or hacks of the Laravel ecosystem.<\/p>\n<p>Make sure you understand that the <code>Website<\/code> model is the subject of tenancy.<\/p>\n<p>The default method for identifying such a tenant website is by using the requested\ndomain aka hostname. Taking a URL <code>http:\/\/yourdomain.com\/foo\/bar<\/code> only <code>yourdomain.com<\/code>\nis taken into account although modifications to this logic is easy to implement. The\n<code>yourdomain.com<\/code> part of the URL is called a Fully Qualified Domain Name or <code>fqdn<\/code> for short.<\/p>\n<p>A website can have zero or more hostnames connected to it. This allows for easier\nattachment of additional hostnames or serving, for instance, an ad campaign page\non different domains.<\/p>\n<h1 id=\"website\"><a href=\"#website\" class=\"anchor-link\"><\/a>Website<\/h1>\n<p>You can think of a website as a single mirror of the code base, re-using your default\napp code. In addition it is also possible to have very <a href=\"structure\">tenant specific logic<\/a>,\nfor instance routes, a vendor folder, media and language files.<\/p>\n<h1 id=\"hostname\"><a href=\"#hostname\" class=\"anchor-link\"><\/a>Hostname<\/h1>\n<p>A hostname is a <a href=\"https:\/\/www.godaddy.com\/garage\/industry\/tech-svcs\/it\/whats-a-fully-qualified-domain-name-fqdn-and-whats-it-good-for\/\">Fully Qualified Domain Name<\/a> (for instance <code>sub.example.com<\/code>).\nYour application handles incoming requests to specific hostnames. Tenancy inspects\nthese requests and <a href=\"identification\">sets up the tenancy environment<\/a> according to a\nmatching hostname or falls back to the default one.<\/p>\n<h1 id=\"runtime\"><a href=\"#runtime\" class=\"anchor-link\"><\/a>Runtime<\/h1>\n<p>By default, the package will identify the current requested hostname and bind it\ninto the <code>Hyn\\Tenancy\\Contracts\\CurrentHostname<\/code> contract. In case that hostname belongs to\na website, the latter will be bound into the <code>Hyn\\Tenancy\\Contracts\\Tenant<\/code> contract. Whenever\na Tenant is identified or switched the package will automatically infuse additional functionality\ninto Laravel, including <a href=\"fallback#tenant-routes-override\">global tenant routes<\/a>, <a href=\"structure\">tenant overrides<\/a>\nand <a href=\"queues\">queues<\/a>.<\/p>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.3\/concepts.md"},{"title":"Identification","icon":"fal fa-street-view","path":"docs\/hyn\/5.3\/identification.md","slug":"identification","package":"hyn","version":"5.3","contents":"<p>During runtime, the <code>Environment<\/code> class is bound into Laravel's container. The\ntenancy environment holds one single responsibility, which is telling our code\nwhat hostname was currently identified and resolving the related website.<\/p>\n<h1 id=\"early-identification\"><a href=\"#early-identification\" class=\"anchor-link\"><\/a>Early identification<\/h1>\n<p>By default tenancy will identify the tenant after all Middleware has been processed.\nOne could simply resolve the Environment class through the service container\ninside a middleware to force identification of the tenant early on. If you want the\npackage to handle this on your behalf you can now simply enable the <code>early-identification<\/code> flag in\nyour <code>tenancy.php<\/code> configuration file under <code>hostname<\/code>.<\/p>\n<h1 id=\"manual-identification\"><a href=\"#manual-identification\" class=\"anchor-link\"><\/a>Manual identification<\/h1>\n<p>The environment can be used to manually set any active tenant. This is one of the\nreasons why the tenancy configuration file has the <code>hostname &gt; auto-identification<\/code>\nsetting. Turn it off to implement your own tenancy identification.<\/p>\n<p>Manual identification is pretty straightforward. Take for example the following\nsnippet for a custom (app) service provider:<\/p>\n<pre><code class=\"language-php\">public function boot()\n{\n    $environment = $this-&gt;app-&gt;make(\\Hyn\\Tenancy\\Environment::class);\n\n    \/\/ Retrieve your website\n\n    \/\/ Now switch the environment to a new tenant.\n    $environment-&gt;tenant($website);\n}\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Be wary about switching tenants. It is recommend switching only once during code\nexecution. Use a background job to run mass changes on tenant databases.<\/p><\/div>\n<h1 id=\"retrieve-current-tenant\"><a href=\"#retrieve-current-tenant\" class=\"anchor-link\"><\/a>Retrieve current tenant<\/h1>\n<p>In case you like to work with the current environment, you can do the following:<\/p>\n<pre><code class=\"language-php\"> \n \/\/ Get current Website (Tenant)\n $website   = \\Hyn\\Tenancy\\Facades\\TenancyFacade::website();\n \n \/\/ prefered option\n $website   = app(\\Hyn\\Tenancy\\Environment::class)-&gt;tenant();\n \n \/\/ alternative (outdated) \n $website   = app(\\Hyn\\Tenancy\\Environment::class)-&gt;website();\n \n $websiteId = $website-&gt;id;\n \n \/\/ Get current Hostname\n $hostname  = app(\\Hyn\\Tenancy\\Environment::class)-&gt;hostname();\n \n \/\/ Get FQDN (Fully-Qualified Domain Name) by current hostname\n $fqdn      = $hostname-&gt;fqdn;\n\n \n<\/code><\/pre>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.3\/identification.md"},{"title":"Connections","icon":"fal fa-warehouse-alt","path":"docs\/hyn\/5.3\/connections.md","slug":"connections","package":"hyn","version":"5.3","contents":"<h1 id=\"database-connections\"><a href=\"#database-connections\" class=\"anchor-link\"><\/a>Database Connections<\/h1>\n<p>One of the core aspects of tenancy is the database connection. Tenancy\ngives you access to two key database connections; <code>tenant<\/code> and <code>system<\/code>.<\/p>\n<h2 id=\"system-connection\"><a href=\"#system-connection\" class=\"anchor-link\"><\/a>System Connection<\/h2>\n<p>Out of the box, the package gives you a <code>system<\/code> database connection which acts as\nthe master database where <code>hostnames<\/code> and <code>websites<\/code> are stored.<\/p>\n<p>If for some reason you need to create an Eloquent Model that would need to connect\nto the system connection, you can apply the <code>Hyn\\Tenancy\\Traits\\UsesSystemConnection<\/code>\ntrait on your given Model. In doing so, the model\u2019s connection will always default to use the <code>system<\/code>.<\/p>\n<p>One reason for using the <code>system<\/code> connection is when you have data which you'd like\nto share between all tenants or which you need to influence the tenant identification\nprocess. For instance when you are creating an admin portal that would manage all of your\ntenants in one place.<\/p>\n<h2 id=\"tenant-connection\"><a href=\"#tenant-connection\" class=\"anchor-link\"><\/a>Tenant Connection<\/h2>\n<p>This is maybe the most used database connection. Data in use by single tenant instances,\nnot shared with others, is persisted into the database using the tenant connection. The\nimplementation of the tenant connection ensures that no tenant can access another tenants data.<\/p>\n<p>By using the <code>Hyn\\Tenancy\\Traits\\UsesTenantConnection<\/code> trait, the package will make sure\nthat it is using the right database connection.<\/p>\n<p>All tenant related models should use the <code>UsesTenantConnection<\/code> trait.<\/p>\n<h3 id=\"forcing-the-connection\"><a href=\"#forcing-the-connection\" class=\"anchor-link\"><\/a>Forcing The Connection<\/h3>\n<p>If you want to set the default connection to <code>tenant<\/code> (when a tenant website has been identified), you can use the snippet below.\nThis is also helpful for 3rd party packages models to force their connection to <code>tenant<\/code>.<\/p>\n<p>Add the following code to the <code>boot()<\/code> method of your <code>AppServiceProvider.php<\/code> file.<\/p>\n<pre><code class=\"language-php\">$env = app(Environment::class);\n\nif ($fqdn = optional($env-&gt;hostname())-&gt;fqdn) {\n    config(['database.default' =&gt; 'tenant']);\n}\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Please understand the risks involved of setting your default connection during runtime. All Eloquent models will from then on use the <code>tenant<\/code> connection instead of your previously configured default connection.<\/p><\/div>\n<hr \/>\n<p>More information about applying these connections can be found in the <a href=\"models\">models<\/a> article.<\/p>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.3\/connections.md"},{"title":"Fallback","excerpt":"Configure a landing page using different approaches","icon":"fal fa-compass","path":"docs\/hyn\/5.3\/fallback.md","slug":"fallback","package":"hyn","version":"5.3","contents":"<p>There are several ways to organize a fallback domain. These are commonly used to offer\na landing page and\/or admin area for your clients to configure their tenant website.<\/p>\n<h1 id=\"disabling-abort-to-pass-through\"><a href=\"#disabling-abort-to-pass-through\" class=\"anchor-link\"><\/a>Disabling abort to pass through<\/h1>\n<p>By default a 404 not found is served whenever auto identification is enabled and no\nmatching hostname entry was found in the system database.<\/p>\n<p>You can disable this in the <code>tenancy.php<\/code> configuration file by setting the\n<code>abort-without-identified-hostname<\/code> option to <code>false<\/code>. This will prevent tenancy\nfrom throwing a 404 (not found) whenever it failed to identify a registered hostname.<\/p>\n<p>Depending on how you set up your app, the code will now pass through to any registered routes.\nFor applications that have global routes defined for tenant specific functionality, you'll\nrun into the issue that no &quot;tenant&quot; connection was defined.<\/p>\n<h1 id=\"tenant-routes-override\"><a href=\"#tenant-routes-override\" class=\"anchor-link\"><\/a>Tenant routes override<\/h1>\n<p>Whenever you create a file <code>routes\/tenants.php<\/code> and you have <code>tenancy.hostname.auto-identification<\/code>\nenabled, all routes contained in that file will automatically override any declared global routes\nfrom <code>routes\/web.php<\/code> or <code>routes\/api.php<\/code>. Make sure to apply the proper middleware to those routes.<\/p>\n<p>In case you enable <code>tenancy.routes.replace-global<\/code> all previously declared routes\nwill be removed and replaced with the contents of the tenants.php routes file.<\/p>\n<div class=\"alert alert-info\"><p>Understand unlike the default <code>web.php<\/code> and <code>api.php<\/code> files no group is set around this file. You need\nto apply your own <code>namespace<\/code>, <code>middleware<\/code> and other group settings inside the <code>tenants.php<\/code>.<\/p><\/div>\n<p>An example <code>tenants.php<\/code> file:<\/p>\n<pre><code class=\"language-php\">Route::middleware('web')\n    -&gt;namespace('App\\\\Http\\\\Controllers\\\\Tenant\\\\')\n    -&gt;group(function () \n{\n    Route::get('\/', 'HomeController');\n});\n<\/code><\/pre>\n<h1 id=\"routing-with-domain\"><a href=\"#routing-with-domain\" class=\"anchor-link\"><\/a>Routing with domain<\/h1>\n<p>One of the easiest solutions is using the <code>::domain()<\/code> option in routing called\n<a href=\"https:\/\/laravel.com\/docs\/5.6\/routing#route-group-sub-domain-routing\">sub domain routing in Laravel<\/a>.<\/p>\n<pre><code class=\"language-php\">Route::domain('master.your.app')-&gt;group(function () {\n    \/\/ .. your landing page routes\n});\n<\/code><\/pre>\n<h1 id=\"create-a-tenant-as-fallback\"><a href=\"#create-a-tenant-as-fallback\" class=\"anchor-link\"><\/a>Create a tenant as fallback<\/h1>\n<p>Another quick method is to simply seed a default tenant that has a specific\nhostname. Set the environment <code>TENANCY_DEFAULT_HOSTNAME<\/code> to the exact FQDN used\nfor that tenant.<\/p>\n<p>Now every time no other tenant was identified, it will revert to this tenant. A\ndrawback of this method is the need to set up a tenant hostname.<\/p>\n","updated_at":{"date":"2020-07-18 18:29:42.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.3\/fallback.md"},{"title":"Middleware","icon":"fal fa-shield-alt","excerpt":"Automatic actions per tenant","path":"docs\/hyn\/5.3\/middleware.md","slug":"middleware","package":"hyn","version":"5.3","contents":"<p>This package offers additional automation to make your life easier. Using\nmiddleware, you can mutate how specific requests are handled.<\/p>\n<h1 id=\"maintenance\"><a href=\"#maintenance\" class=\"anchor-link\"><\/a>Maintenance<\/h1>\n<p>Set the property <code>under_maintenance_since<\/code> of the hostname to show a\nLaravel generic maintenance page.<\/p>\n<h1 id=\"redirection\"><a href=\"#redirection\" class=\"anchor-link\"><\/a>Redirection<\/h1>\n<p>Set the property <code>redirect_to<\/code> to a valid URL to automatically redirect all\nrequests to this hostname.<\/p>\n<h1 id=\"secure\"><a href=\"#secure\" class=\"anchor-link\"><\/a>Secure<\/h1>\n<p>Set the property <code>force_https<\/code> to true to force all connections on this\nhostname to be handled using a SSL encrypted connection.<\/p>\n<h1 id=\"abort\"><a href=\"#abort\" class=\"anchor-link\"><\/a>Abort<\/h1>\n<p>In case no tenant was identified the application will generate a default\nnot found page. You can disable this functionality globally in\nthe tenancy configuration file <code>hostname &gt; abort-without-identified-hostname<\/code>.<\/p>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.3\/middleware.md"}]},{"name":"implementation","links":["creating-tenants","models","structure"],"slug":"implementation","articles":[{"title":"Creating tenants","icon":"fal fa-dolly-flatbed","path":"docs\/hyn\/5.3\/creating-tenants.md","slug":"creating-tenants","package":"hyn","version":"5.3","contents":"<p>Tenancy is heavily driven by events. For event listeners to properly work, you\nhave to use the repositories to create new websites and hostnames.<\/p>\n<h1 id=\"create-website\"><a href=\"#create-website\" class=\"anchor-link\"><\/a>Create website<\/h1>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Models\\Website;\nuse Hyn\\Tenancy\\Contracts\\Repositories\\WebsiteRepository;\n\n$website = new Website;\napp(WebsiteRepository::class)-&gt;create($website);\ndd($website-&gt;uuid); \/\/ Unique id\n<\/code><\/pre>\n<h2 id=\"uuid\"><a href=\"#uuid\" class=\"anchor-link\"><\/a>UUID<\/h2>\n<p>Each website will be given a unique identifier automatically. To prevent\nguessing URLs and to add a slight increased level of security this is a\nrandom hash.<\/p>\n<p>The UUID is used for the database username and database name. In addition\nI'd recommend using this unique string for every public facing URL, eg\nan admin dashboard.<\/p>\n<p>By default tenancy will create a <code>uuid<\/code> automatically\nusing a UUID generator, you can replace that class in the\n<code>tenancy.php &gt; website &gt; random-id-generator<\/code>, make sure it implements\n<code>Hyn\\Tenancy\\Contracts\\Website\\UuidGenerator<\/code>.<\/p>\n<p>If you want to force your own UUID for the website, without creating a full\nfledged UUID generator, set the <code>uuid<\/code> property of your website before passing\nit to the repository.<\/p>\n<pre><code class=\"language-php\">$website = new Website;\n\/\/ Implement custom random hash using Laravels Str::random\n$website-&gt;uuid = str_random(10);\napp(WebsiteRepository::class)-&gt;create($website);\ndd($website-&gt;uuid); \/\/ Random string of length 10\n<\/code><\/pre>\n<h2 id=\"managing-connection\"><a href=\"#managing-connection\" class=\"anchor-link\"><\/a>Managing connection<\/h2>\n<p>Whenever you are using multiple databases, to separate tenants over different\nregions for instance, you can easily specify the connection with which tenancy\nshould create, update and delete tenant databases and users.<\/p>\n<pre><code class=\"language-php\">$website = new Website;\n$website-&gt;managed_by_database_connection = 'system.asia';\napp(WebsiteRepository::class)-&gt;create($website);\n\/\/ Information of website is stored in the default system connection,\n\/\/ the tenant database is created using the system.asia connection.\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Make sure the provided connection name is configured in your <code>config\/database.php<\/code>.<\/p><\/div>\n<h1 id=\"create-and-connect-hostname\"><a href=\"#create-and-connect-hostname\" class=\"anchor-link\"><\/a>Create and connect hostname<\/h1>\n<p>A hostname allows the package to map a requested hostname to a website. Websites\nthat have no (active) hostnames connected to it will never be visible. So make\nsure to connect a hostname to any tenant website you'd like to work on.<\/p>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Models\\Hostname;\nuse Hyn\\Tenancy\\Contracts\\Repositories\\HostnameRepository;\n\n$hostname = new Hostname;\n$hostname-&gt;fqdn = 'luceos.demo.app';\n$hostname = app(HostnameRepository::class)-&gt;create($hostname);\napp(HostnameRepository::class)-&gt;attach($hostname, $website);\ndd($website-&gt;hostnames); \/\/ Collection with $hostname\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>The <code>fqdn<\/code> property of the hostname is crucial. It stands for\nFully Qualified Domain Name and can be something like <code>yourapp.com<\/code> or\n<code>demo.yourapp.com<\/code> but can never include protocol (eg <code>http:\/\/<\/code>) or paths\n(eg <code>yourapp.com\/tenant<\/code>).<\/p><\/div>\n<h1 id=\"switch-to-new-tenant\"><a href=\"#switch-to-new-tenant\" class=\"anchor-link\"><\/a>Switch to new tenant<\/h1>\n<p>For the package to set up Laravel for the specific tenant, the environment has to be\n&quot;switched&quot;. This switching will set up amongst other the tenant database connection and\nfilesystem logic like custom config files.<\/p>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Environment;\n$tenancy = app(Environment::class);\n\n$tenancy-&gt;hostname($hostname);\n\n$tenancy-&gt;hostname(); \/\/ resolves $hostname as currently active hostname\n\n$tenancy-&gt;tenant($website); \/\/ switches the tenant and reconfigures the app\n\n$tenancy-&gt;website(); \/\/ resolves $website\n$tenancy-&gt;tenant(); \/\/ resolves $website\n\n$tenancy-&gt;identifyHostname(); \/\/ resets resolving $hostname by using the Request\n<\/code><\/pre>\n<h1 id=\"querying\"><a href=\"#querying\" class=\"anchor-link\"><\/a>Querying<\/h1>\n<p>In case you would like to query the database for hostnames or websites. Use the\n<code>query()<\/code> method of the repositories, this will return a <a href=\"https:\/\/laravel.com\/docs\/5.6\/queries\"><code>Illuminate\\Database\\Eloquent\\Builder<\/code><\/a>\ninstance.<\/p>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.3\/creating-tenants.md"},{"title":"Models","icon":"fal fa-hand-holding-box","path":"docs\/hyn\/5.3\/models.md","slug":"models","package":"hyn","version":"5.3","contents":"<p>For you to more easily connect with the correct database a few ways are possible.<\/p>\n<h4 id=\"traits\"><a href=\"#traits\" class=\"anchor-link\"><\/a>Traits<\/h4>\n<p>Two traits exist to force a model onto either the tenant or system connection.<\/p>\n<ul>\n<li>\n<code>Hyn\\Tenancy\\Traits\\UsesSystemConnection<\/code> to make a model use the system connection.<\/li>\n<li>\n<code>Hyn\\Tenancy\\Traits\\UsesTenantConnection<\/code> to make a model use the tenant connection.<\/li>\n<\/ul>\n<p>The below snippet shows an example of how to force the User model to use the tenant\nconnection.<\/p>\n<pre><code class=\"language-php\">namespace App;\n\nuse Hyn\\Tenancy\\Traits\\UsesTenantConnection;\nuse Illuminate\\Notifications\\Notifiable;\nuse Illuminate\\Foundation\\Auth\\User as Authenticatable;\n\nclass User extends Authenticatable\n{\n    use Notifiable, UsesTenantConnection;\n    \n    \/\/ ..\n}\n<\/code><\/pre>\n<h4 id=\"abstract-models\"><a href=\"#abstract-models\" class=\"anchor-link\"><\/a>Abstract models<\/h4>\n<p>Instead of using the traits one can also simply have the models extend the abstract\nmodels provided in the package.<\/p>\n<ul>\n<li>\n<code>Hyn\\Tenancy\\Abstracts\\SystemModel<\/code> can be extended to give easy access to\nthe system database connection.<\/li>\n<li>\n<code>Hyn\\Tenancy\\Abstracts\\TenantModel<\/code> can be extended to have your Eloquent models\nuse the connection of the identified tenant per default.<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>Please note these models are using their respective traits.<\/p><\/div>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.3\/models.md"},{"title":"Structure","icon":"fal fa-sitemap","path":"docs\/hyn\/5.3\/structure.md","slug":"structure","package":"hyn","version":"5.3","contents":"<h1 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h1>\n<p>The location of the tenant specific files is configured inside the <code>config\/tenancy.php<\/code>\nfile under <code>website &gt; disk<\/code>. By default tenant files\nare stored in <code>storage\/app\/tenancy\/tenants<\/code>.<\/p>\n<p>Inside this tenant directory you are able to override global logic by\ngenerating the necessary files. Check the tenancy configuration file under\n<code>folders<\/code> to see which ones are enabled by default.<\/p>\n<h2 id=\"config\"><a href=\"#config\" class=\"anchor-link\"><\/a>Config<\/h2>\n<p>Any php files stored inside a <code>config\/<\/code> directory of the tenant is read\nduring runtime. Existing configuration values are replaced and new ones\nare appended.<\/p>\n<p>A great use case for this feature is the ability to configure client\nspecific mail settings.<\/p>\n<p>The tenancy configuration file allows you to refuse overrides of specific\nconfiguration settings using the <code>folders &gt; config &gt; blacklist<\/code> setting.\nBy default it disallows database, tenancy and webserver changes.<\/p>\n<h2 id=\"routes\"><a href=\"#routes\" class=\"anchor-link\"><\/a>Routes<\/h2>\n<p>Create a <code>routes.php<\/code> file inside your tenant directory to configure\nnew routes during runtime. Using a configurable prefix, any unique\nurl's will be matched for this specific tenant only.<\/p>\n<h2 id=\"trans\"><a href=\"#trans\" class=\"anchor-link\"><\/a>Trans<\/h2>\n<p>New translations can be easily added by creating a <code>lang\/<\/code> folder.\nThe native Laravel translator will parse any files contained within\nto be used in the application of this specific tenant.<\/p>\n<p>You are able to specify whether these language files should override\nthe global, system-wide translation. In case you decide against that\nfeel free to set up a translation namespace.<\/p>\n<h2 id=\"views\"><a href=\"#views\" class=\"anchor-link\"><\/a>Views<\/h2>\n<p>Additional or overriding views is possible by creating a <code>views\/<\/code> folder\ninside the tenant directory. There are three possible scenarios to\nconfigure how views are picked up by Laravel:<\/p>\n<ol>\n<li>By adding views inside the global namespace, overriding existing\nglobal views.<\/li>\n<li>By adding views inside the global namespace, but where existing\nglobal views take precedence.<\/li>\n<li>By adding views inside their own namespace.<\/li>\n<\/ol>\n<h2 id=\"vendor\"><a href=\"#vendor\" class=\"anchor-link\"><\/a>Vendor<\/h2>\n<p>A very powerful addition is the ability to inject new packages and code.\nWhenever the tenant directory has a <code>vendor\/autoload.php<\/code> file it will\nbe loaded during runtime. Using that specific file allows you to fully\nutilize the power of composer inside your tenant directories.<\/p>\n<div class=\"alert alert-info\"><p>Please be aware that no compatibility checks are executed against your app.\nIdentifying whether a composer conflict could happen is something you should test\noutside production environments.<\/p><\/div>\n<h2 id=\"media\"><a href=\"#media\" class=\"anchor-link\"><\/a>Media<\/h2>\n<p>The media folder can be used by creating a <code>media\/<\/code> folder inside the\ntenant directory. Files inside that directory will become automatically\navailable as a public directory inside an equally named directory <code>media\/<\/code>.<\/p>\n<p>Eg, storing a file <code>media\/bg.jpg<\/code> will allow you to use <code>\/media\/bg.jpg<\/code> inside\nyour html. This applies to any file you store.<\/p>\n<h2 id=\"media-webserver\"><a href=\"#media-webserver\" class=\"anchor-link\"><\/a>\/media webserver<\/h2>\n<p>An alias is set up binding the private tenant media directory to the public\nmedia directory. This is implemented using the auto generated web server\nconfiguration files for apache and nginx.<\/p>\n<h2 id=\"media-fallback-controller\"><a href=\"#media-fallback-controller\" class=\"anchor-link\"><\/a>\/media fallback controller<\/h2>\n<p>In case you're not using the webserver vhost configuration files provided\nby this package you can choose to map the <code>MediaController<\/code> to the path, eg:<\/p>\n<pre><code class=\"language-php\">Route::get('\/media\/{path}', '\\Hyn\\Tenancy\\Controllers\\MediaController')\n    -&gt;where('path', '.+')\n    -&gt;name('tenant.media');\n<\/code><\/pre>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.3\/structure.md"}]},{"name":"tenant aware","links":["filesystem","migrations","validation","queues","events","cache","commands"],"slug":"tenant-aware","articles":[{"title":"Filesystem","icon":"fal fa-hdd","path":"docs\/hyn\/5.3\/filesystem.md","slug":"filesystem","package":"hyn","version":"5.3","contents":"<p>You are now, most likely, aware about the <a href=\"structure\">directory structure<\/a>\navailable to tenants.<\/p>\n<h1 id=\"tenant-disk\"><a href=\"#tenant-disk\" class=\"anchor-link\"><\/a>Tenant disk<\/h1>\n<p>To access the directory of the active tenant, you can use the <code>tenant<\/code> disk.<\/p>\n<pre><code class=\"language-php\">Storage::disk('tenant')-&gt;put('readme.md', 'Hi John.');\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Tenants files are by default stored to <code>storage\/app\/tenancy<\/code>, but this can be reconfigured\nin the <code>tenancy.php<\/code> under <code>website &gt; disk<\/code>.<\/p><\/div>\n<p>Read more about disks on the <a href=\"https:\/\/laravel.com\/docs\/5.6\/filesystem\">Laravel documentation<\/a>.<\/p>\n<h1 id=\"directory\"><a href=\"#directory\" class=\"anchor-link\"><\/a>Directory<\/h1>\n<p>In order to assist with mutating these contents, you can use the\nDirectory class available in this package.<\/p>\n<pre><code class=\"language-php\">$directory = app(\\Hyn\\Tenancy\\Website\\Directory::class);\n<\/code><\/pre>\n<p>This class is set to use the tenant currently active, but also allows you to activate\nany other tenant whenever you need to use the <code>setWebsite(Website $website)<\/code> method.<\/p>\n<p>The Directory class implements <code>Illuminate\\Contracts\\Filesystem\\Filesystem<\/code> which offers\nthe same methods you are used to, including; <code>get<\/code>, <code>put<\/code> and <code>setVisibility<\/code>.<\/p>\n<h1 id=\"tenancy-directory\"><a href=\"#tenancy-directory\" class=\"anchor-link\"><\/a>Tenancy directory<\/h1>\n<p>In case you prefer having a higher level access to the files for tenants. You can use the ioc bound\nFilesystem.<\/p>\n<pre><code class=\"language-php\">\/** @var \\Illuminate\\Contracts\\Filesystem\\Filesystem $tenancy *\/\n$tenancy = app('tenancy.disk');\n<\/code><\/pre>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.3\/filesystem.md"},{"title":"Migrations","icon":"fal fa-pallet-alt","path":"docs\/hyn\/5.3\/migrations.md","slug":"migrations","package":"hyn","version":"5.3","contents":"<p>Migrations are extremely important in the Laravel ecosystem. To facilitate\ntenants with this flow, without interfering with its logic migration commands\nfor tenants have been given their own namespace <code>tenancy:<\/code>.<\/p>\n<h1 id=\"about-the-databasemigrations-path\"><a href=\"#about-the-databasemigrations-path\" class=\"anchor-link\"><\/a>About the database\/migrations path<\/h1>\n<p>It's not wise to store the tenants migrations inside your global\n<code>database\/migrations<\/code> directory. Laravel by default runs these migrations\nwhen calling the <code>php artisan migrate<\/code> command. Even though you can suggest\na connection during that command, it's much cleaner to store these migrations\ninside a separate directory, e.g. <code>database\/migrations\/tenant<\/code>.\nThe migrations for the system database can stay in <code>database\/migrations<\/code>.<\/p>\n<h1 id=\"default-migrations-for-new-tenants\"><a href=\"#default-migrations-for-new-tenants\" class=\"anchor-link\"><\/a>Default migrations for new tenants<\/h1>\n<p>If you want new tenants to be migrated by default, you can easily do so. In\nyour <code>tenancy.php<\/code> configuration set <code>db &gt; tenant-migrations-path<\/code> to a valid\nabsolute path and all your new tenants will run these migrations per default.<\/p>\n<pre><code class=\"language-php\">  \/\/ ..\n  &quot;tenant-migrations-path&quot; =&gt; database_path('migrations\/tenant'),\n  \/\/ ..\n<\/code><\/pre>\n<h1 id=\"default-seeds-for-newly-auto-migrated-tenants\"><a href=\"#default-seeds-for-newly-auto-migrated-tenants\" class=\"anchor-link\"><\/a>Default seeds for newly auto-migrated tenants<\/h1>\n<p>In case you would also like to seed the databases of your newly created\nand migrated tenants, you can enable <code>db &gt; tenant-seed-class<\/code> in your <code>tenancy.php<\/code>\nconfiguration file. Change this setting to a fully namespaced class name\nand the package will automatically run this seed after it has ran the\nautomatic migrations.<\/p>\n<h1 id=\"migration-related-commands\"><a href=\"#migration-related-commands\" class=\"anchor-link\"><\/a>Migration related commands<\/h1>\n<p>Obviously tenancy is also able to run migrations running through artisan.<\/p>\n<p>Tenancy has added the <code>--website_id[=WEBSITE_ID]<\/code> option to each of the following native Laravel migrate and seed\ncommand and namespaced it accordingly, for instance.<\/p>\n<ul>\n<li>\n<code>tenancy:migrate<\/code> - Run the database migrations<\/li>\n<li>\n<code>tenancy:migrate:refresh<\/code> - Reset and re-run all migrations<\/li>\n<li>\n<code>tenancy:migrate:reset<\/code> - Rollback all database migrations<\/li>\n<li>\n<code>tenancy:migrate:rollback<\/code> - Rollback the last database migration<\/li>\n<li>\n<code>tenancy:db:seed<\/code> - Seed the database with records<\/li>\n<\/ul>\n<p>The --website_id optional option accepts multiple values. Though optional, but if you leave the option out it will\nrun the command against all tenant. For example:<\/p>\n<ul>\n<li>\n<code>php artisan tenancy:migrate --website_id=1<\/code> to migrate just tenant website 1.<\/li>\n<li>\n<code>php artisan tenancy:migrate --website_id=1 --website_id=2<\/code> to migrate tenant website 1 &amp; 2.<\/li>\n<li>\n<code>php artisan tenancy:migrate<\/code> to migrate all tenant websites.<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>The website_id reflects the auto incremented <code>id<\/code> column of the Website and <strong>NOT<\/strong> the UUID.<\/p><\/div>\n<p>Please check the separate signatures for more information of valid arguments\nand options.<\/p>\n<div class=\"alert alert-info\"><p>Running tenancy:migrate without any path or realpath option and\nwithout having configured tenant-migrations-path will migrate your\ntenants with the files inside the database\/migrations directory.<\/p><\/div>\n<h1 id=\"reconstructing-tenant-databases\"><a href=\"#reconstructing-tenant-databases\" class=\"anchor-link\"><\/a>Reconstructing tenant databases<\/h1>\n<p>As long as your system database is intact, there's a way to recreate all tenant databases. You can use the <code>tenancy:recreate<\/code> artisan command to recreate all tenant databases that do not exist. The command will run the migrations and seeds according to your configuration in <code>tenancy.php<\/code>.<\/p>\n<div class=\"alert alert-info\"><p>Though the structure of all of your tenant databases will be recreated, the data in it won't.<\/p><\/div>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.3\/migrations.md"},{"title":"Validations","icon":"fal fa-file-check","path":"docs\/hyn\/5.3\/validation.md","slug":"validation","package":"hyn","version":"5.3","contents":"<h2 id=\"exists-and-unique-validation-rule\"><a href=\"#exists-and-unique-validation-rule\" class=\"anchor-link\"><\/a>Exists and Unique Validation Rule<\/h2>\n<p>Among all the built-in validation in Laravel, only the <a href=\"https:\/\/laravel.com\/docs\/5.6\/validation#rule-exists\">exists<\/a> and <a href=\"https:\/\/laravel.com\/docs\/5.6\/validation#rule-unique\">unique<\/a> validation rules interact with the database.<\/p>\n<p>We can leverage these two rules with tenancy by adding the connection parameter. Both use the same validation rule\nsignature which is <code>rule:connection.table,column<\/code>.<\/p>\n<p>So for example, to use <code>Exists (Database)<\/code> use <code>'email' =&gt; 'exists:tenant.staff,email'<\/code>. Where <code>tenant<\/code> is the <code>'tenant-connection-name'<\/code> you specified in your <code>tenancy.php<\/code> config file.<\/p>\n<p>You can change the <code>exists<\/code> keyword to <code>unique<\/code> to use the <code>unique<\/code> rule instead, eg: <code>'email' =&gt; 'unique:tenant.staff,email'<\/code>.<\/p>\n<div class=\"alert alert-info\"><p>Validating against the system database is possible using the method described above but replacing <code>tenant<\/code> with <code>system<\/code>.<\/p><\/div>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.3\/validation.md"},{"title":"Queues","icon":"fal fa-conveyor-belt","path":"docs\/hyn\/5.3\/queues.md","slug":"queues","package":"hyn","version":"5.3","contents":"<p>One of the strongest features of Laravel are its queues. One drawback of sending\nJobs into the Queue is that these are executed in a completely different process\ndepending on your queue configuration including redis and beanstalk.<\/p>\n<p>In order to assist you with tenant aware jobs, a <code>TenantAwareJob<\/code> is available to you.\nInstead of applying the <code>SerializesModel<\/code> trait as per suggestion in the Laravel\ndocumentation, you should use this Trait instead.<\/p>\n<pre><code class=\"language-php\">namespace App\\Jobs;\n\nuse Illuminate\\Bus\\Queueable;\nuse Hyn\\Tenancy\\Queue\\TenantAwareJob;\nuse Illuminate\\Queue\\InteractsWithQueue;\nuse Illuminate\\Contracts\\Queue\\ShouldQueue;\nuse Illuminate\\Foundation\\Bus\\Dispatchable;\n\nclass ProcessPodcast implements ShouldQueue\n{\n    use Dispatchable, InteractsWithQueue, Queueable, TenantAwareJob;\n    \n    \/\/ ..\n}\n<\/code><\/pre>\n<p>Once you've applied this custom trait the currently active tenant website will be\nparsed into the Job with property <code>$website_id<\/code>. During processing of the job\nthis property is read and the Environment is automatically setting that website\nas active tenant.<\/p>\n<p>In case you'd like to manually set a specific tenant for the job, use the <code>onTenant()<\/code>\nmethod:<\/p>\n<pre><code class=\"language-php\">dispatch((new ProcessPodcast($podcast))-&gt;onTenant($website));\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 18:29:42.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.3\/queues.md"},{"title":"Events","icon":"fal fa-hourglass-end","path":"docs\/hyn\/5.3\/events.md","slug":"events","package":"hyn","version":"5.3","contents":"<p>To create a fluid ecosystem around Laravel, this package uses events heavily.<\/p>\n<div class=\"alert alert-info\"><p>It's highly recommended to read up on the native <a href=\"https:\/\/laravel.com\/docs\/5.6\/events\">events<\/a> by Laravel\nin case you are unaware about its purposes.<\/p><\/div>\n<h1 id=\"model-events\"><a href=\"#model-events\" class=\"anchor-link\"><\/a>Model events<\/h1>\n<p>Namespaces:<\/p>\n<ul>\n<li>\n<code>Hyn\\Tenancy\\Events\\Hostnames<\/code>\n<\/li>\n<li>\n<code>Hyn\\Tenancy\\Events\\Websites<\/code>\n<\/li>\n<\/ul>\n<p>All of the models have the following events per default, these should be\nself explanatory.<\/p>\n<ul>\n<li>Creating<\/li>\n<li>Created<\/li>\n<li>Updating<\/li>\n<li>Updated<\/li>\n<li>Deleting<\/li>\n<li>Deleted<\/li>\n<\/ul>\n<h2 id=\"websites\"><a href=\"#websites\" class=\"anchor-link\"><\/a>Websites<\/h2>\n<p>Namespace: <code>Hyn\\Tenancy\\Events\\Websites<\/code>.<\/p>\n<ul>\n<li>Identified: a tenant website was identified.<\/li>\n<li>NoneFound: no tenant website was identified.<\/li>\n<li>Migrated: a website was auto migrated (not fired from console commands).<\/li>\n<li>Switched: the current tenant website was changed.<\/li>\n<\/ul>\n<h2 id=\"hostnames\"><a href=\"#hostnames\" class=\"anchor-link\"><\/a>Hostnames<\/h2>\n<p>Namespace: <code>Hyn\\Tenancy\\Events\\Hostnames<\/code>.<\/p>\n<p>The hostname models has a few additional events:<\/p>\n<ul>\n<li>Attached: the hostname was attached to a website.<\/li>\n<li>Detached: the hostname was removed from a website.<\/li>\n<li>Identified: the hostname is identified based on the request.<\/li>\n<li>NoneFound: no hostname was found during identification.<\/li>\n<li>Redirected: the hostname is configured to redirect to another url.<\/li>\n<li>Secured: the hostname is configured to upgrade the request to https.<\/li>\n<li>Switched: currently active hostname was changed.<\/li>\n<li>UnderMaintenance: the hostname is configured to be in maintenance.<\/li>\n<\/ul>\n<h1 id=\"database\"><a href=\"#database\" class=\"anchor-link\"><\/a>Database<\/h1>\n<p>Namespace: <code>Hyn\\Tenancy\\Events\\Database<\/code>.<\/p>\n<ul>\n<li>Creating<\/li>\n<li>Created<\/li>\n<li>Deleting<\/li>\n<li>Deleted<\/li>\n<li>Renaming<\/li>\n<li>Renamed<\/li>\n<li>ConfigurationLoading: the configuration for a tenant database connection\nis loading.<\/li>\n<li>ConfigurationLoaded: the configuration for a tenant database connection\nwas loaded.<\/li>\n<li>ConnectionSet: a connection was set and possibly an old one purged.<\/li>\n<\/ul>\n<h1 id=\"webservers\"><a href=\"#webservers\" class=\"anchor-link\"><\/a>Webservers<\/h1>\n<p>Namespace: <code>Hyn\\Tenancy\\Events\\Webservers<\/code>.<\/p>\n<ul>\n<li>ConfigurationSaved: the configuration for the webserver was saved to disk.<\/li>\n<\/ul>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.3\/events.md"},{"title":"Cache","icon":"fal fa-window-restore","path":"docs\/hyn\/5.3\/cache.md","slug":"cache","package":"hyn","version":"5.3","contents":"<p>Currently the Laravel cache will use the same cache key for all tenants.\nThis can and will cause issues in the long run. The config key for tenants\nshould be automatically changed and the ability to disable overriding the cache key should be configurable inside <code>tenancy.php<\/code>.<\/p>\n<p>The following is an easy implementation to allow per-tenant prefixes.<\/p>\n<p>Add a <code>CacheServiceProvider<\/code> with these contents in boot method:<\/p>\n<pre><code class=\"language-php\">public function boot()\n{\n    Cache::extend('redis_tenancy', function ($app) {\n        if (PHP_SAPI === 'cli') {\n            $uuid = $app['config']['driver'];\n        } else {\n            \/\/ ok, this is basically a hack to set the redis cache store\n            \/\/ prefix to the UUID of the current website being called\n            $fqdn = request()-&gt;getHost();\n\n            $uuid = DB::table('hostnames')\n                -&gt;select('websites.uuid')\n                -&gt;join('websites', 'hostnames.website_id', '=', 'websites.id')\n                -&gt;where('fqdn', $fqdn)\n                -&gt;value('uuid');\n        }\n\n        return Cache::repository(new RedisStore(\n            $app['redis'],\n            $uuid,\n            $app['config']['cache.stores.redis.connection']\n        ));\n    });\n}\n<\/code><\/pre>\n<p>This does not require a new Cache driver, as it's re-using\nthe existing Redis driver. All this does is override the default prefix and\nallows you to set a custom cache driver in <code>config\/cache.php<\/code>:<\/p>\n<pre><code class=\"language-php\">'redis' =&gt; [\n    'driver'     =&gt; 'redis_tenancy',\n    'connection' =&gt; 'default',\n],\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Make sure the CacheServiceProvider is registered in <code>config\/app.php<\/code>. Or your driver will not be\navailable for use.<\/p><\/div>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.3\/cache.md"},{"title":"Commands","icon":"fal fa-screwdriver","path":"docs\/hyn\/5.3\/commands.md","slug":"commands","package":"hyn","version":"5.3","contents":"<p>Aside from the tenant aware <a href=\"migrations\">migration<\/a> command, the following\nis a list of additional commands provided by this package.<\/p>\n<h1 id=\"run-proxy-command\"><a href=\"#run-proxy-command\" class=\"anchor-link\"><\/a>Run proxy command<\/h1>\n<p>If you'd like to run any command for a tenant, you can use the <code>tenancy:run<\/code> command.<\/p>\n<p>You can execute and check the signature with<\/p>\n<pre><code class=\"language-bash\">$ php artisan tenancy:run --help\n<\/code><\/pre>\n<p>How it works:<\/p>\n<ul>\n<li>Using the <code>--tenant<\/code> option is optional, if you leave it out the command will be run on all tenants.<\/li>\n<li>If your target command requires options or arguments, you can add them like this:<\/li>\n<\/ul>\n<pre><code class=\"language-bash\">$ php artisan tenancy:run &lt;command&gt; --option=&quot;key=value&quot; --option=&quot;live=1&quot; --argument=&quot;key=value&quot;\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Make sure you include the argument or option key!<\/p><\/div>\n<p>Please note this command does not do any checking and will forward any exceptions it hits.<\/p>\n<p>Also, <strong>don't<\/strong> run tenancy:run like this:<\/p>\n<pre><code class=\"language-bash\">$ php artisan tenancy:run tenancy:run --argument=&quot;run=tenancy:run&quot;\n<\/code><\/pre>\n<h1 id=\"recreate-command\"><a href=\"#recreate-command\" class=\"anchor-link\"><\/a>Recreate command<\/h1>\n<p>The recreate command allows you to create databases and filesystem directories for\nall tenants. It will check whether a database already exists, if not it will recreate\nit and dispatch a &quot;Created&quot; event that causes the folders and possible vhost configurations\nto be made.<\/p>\n<pre><code class=\"language-bash\">$ php artisan tenancy:recreate\n<\/code><\/pre>\n<h1 id=\"tenant-aware-tinker-command\"><a href=\"#tenant-aware-tinker-command\" class=\"anchor-link\"><\/a>Tenant Aware Tinker Command<\/h1>\n<p>This article describes how to enable tenant awareness for the native Laravel tinker command.<\/p>\n<p>First, create a trait named <code>MutatesTinkerCommand<\/code> with the following content:<\/p>\n<pre><code class=\"language-php\">namespace App\\Traits;\n\nuse Hyn\\Tenancy\\Contracts\\Repositories\\WebsiteRepository;\nuse Hyn\\Tenancy\\Database\\Connection;\nuse Illuminate\\Database\\Eloquent\\ModelNotFoundException;\nuse Symfony\\Component\\Console\\Exception\\RuntimeException;\nuse Symfony\\Component\\Console\\Input\\InputOption;\n\ntrait MutatesTinkerCommand\n{\n    \/**\n     * @var Connection\n     *\/\n    private $connection;\n\n    \/**\n     * @var WebsiteRepository\n     *\/\n    private $websites;\n\n    public function __construct()\n    {\n        parent::__construct();\n        $this-&gt;setName('tenancy:' . $this-&gt;getName());\n        $this-&gt;websites = app(WebsiteRepository::class);\n        $this-&gt;connection = app(Connection::class);\n    }\n\n    \/**\n     * Execute the console command.\n     *\n     * @return void\n     *\n     * @throws \\Hyn\\Tenancy\\Exceptions\\ConnectionException\n     *\/\n    public function handle()\n    {\n        $website_id = $this-&gt;option('website_id');\n        try{\n            $website = $this-&gt;websites-&gt;query()-&gt;where('id', $website_id)-&gt;firstOrFail();\n            $this-&gt;connection-&gt;set($website);\n            $this-&gt;info('Running Tinker on website_id: ' . $website_id);\n\n            parent::handle();\n            \n            $this-&gt;connection-&gt;purge();\n        } catch (ModelNotFoundException $e) {\n            throw new RuntimeException(sprintf('The tenancy website_id=%d does not exist.', $website_id));\n        }\n    }\n\n    protected function getOptions()\n    {\n        return array_merge([$this-&gt;addWebsiteOption()], parent::getOptions());\n    }\n\n    protected function addWebsiteOption()\n    {\n        return ['website_id', null, InputOption::VALUE_REQUIRED, 'The tenancy website_id (not uuid) to tinker specifically.', null];\n    }\n}\n<\/code><\/pre>\n<p>You can only tinker on one database at a time, therefore, the <code>website_id<\/code> needs to be a required option. Utilizing the <code>AddWebsiteFilterOnCommand<\/code> trait available in the Tenancy package would not work in this instance; it is tailored to run processes on multiple websites and makes the <code>website_id<\/code> parameter optional.<\/p>\n<p>Second, create a new console command <code>TinkerCommand<\/code> that uses the trait above.<\/p>\n<pre><code class=\"language-php\">namespace App\\Console\\Tinker;\n\nuse Laravel\\Tinker\\Console\\TinkerCommand as BaseCommand;\nuse App\\Traits\\MutatesTinkerCommand;\n\nclass TinkerCommand extends BaseCommand\n{\n    use MutatesTinkerCommand;\n}\n<\/code><\/pre>\n<p>Third, add the <code>TinkerCommand<\/code> to your Console Kernel <code>$commands<\/code> array.<\/p>\n<pre><code class=\"language-php\">namespace App\\Console;\n\nuse Illuminate\\Console\\Scheduling\\Schedule;\nuse Illuminate\\Foundation\\Console\\Kernel as ConsoleKernel;\nuse App\\Console\\Tinker\\TinkerCommand;\n\nclass Kernel extends ConsoleKernel\n{\n    \/**\n     * The Artisan commands provided by your application.\n     *\n     * @var array\n     *\/\n    protected $commands = [\n        TinkerCommand::class,\n    ];\n    \/\/ ...\n}\n<\/code><\/pre>\n<p>Now we have created a new <code>tenancy:tinker<\/code> artisan command. The <code>tenancy:tinker<\/code> requires the <code>--website_id=<\/code> option as a parameter. So, in order to run tinker on, let\u2019s say with a <code>website_id<\/code> of 1, you\u2019ll need to run:<\/p>\n<pre><code class=\"language-bash\">$ php artisan tenancy:tinker --website_id=1\n\nRunning Tinker on website_id: 1\nPsy Shell v0.9.6 (PHP 7.2.7 \u2014 cli) by Justin Hileman\n&gt;&gt;&gt;\n<\/code><\/pre>\n<p>It will throw an error if the <code>--website_id=<\/code> option is missing:<\/p>\n<pre><code class=\"language-bash\">$ php artisan tenancy:tinker\n\n\n  The tenancy website_id=0 does not exist.\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 18:29:42.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.3\/commands.md"}]},{"name":"customization","links":["custom-models","logging"],"slug":"customization","articles":[{"title":"Custom system models","icon":"fal fa-theater-masks","path":"docs\/hyn\/5.3\/custom-models.md","slug":"custom-models","package":"hyn","version":"5.3","contents":"<p>This package allows you to specify different models to be used for the\nHostname and Website models. Tenancy will take care of the relationships on the\npackage-end. You also need to implement <code>Hyn\\Tenancy\\Contracts\\{Model}<\/code><\/p>\n<p>Take this example:<\/p>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Contracts\\Website as Contract;\n\nclass Website implements Contract\n{\n}\n<\/code><\/pre>\n<p>All you need to do is update the <code>tenancy.php<\/code> configuration file:<\/p>\n<pre><code class=\"language-php\">return [\n  'models' =&gt; [\n      \/\/ ..\n      \/\/ Must implement \\Hyn\\Tenancy\\Contracts\\Hostname\n      'hostname' =&gt; \\Hyn\\Tenancy\\Models\\Hostname::class,\n      \/\/ Must implement \\Hyn\\Tenancy\\Contracts\\Website\n      'website' =&gt; \\App\\Website::class\n  ],\n  \/\/ ...\n];\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 18:29:42.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.3\/custom-models.md"},{"title":"Logging","icon":"fal fa-book","path":"docs\/hyn\/5.3\/logging.md","slug":"logging","package":"hyn","version":"5.3","contents":"<p>Especially in production you might want to split the default laravel log by tenants.\nTenancy ships with a custom tenant aware logger which you can register in the logger config.<\/p>\n<ul>\n<li>If a tenant is detected it will create a <code>logs<\/code> folder within the tenant directory:\n<code>storage\/app\/tenancy\/tenants\/&lt;tenant uuid&gt;\/logs\/&lt;log_level&gt;_&lt;YYYY&gt;-&lt;MM&gt;-&lt;DD&gt;.log<\/code>\n<\/li>\n<li>If no tenant is detected it will store the log file to:\n<code>storage\/logs\/<\/code>.<\/li>\n<\/ul>\n<p>Add a new <code>tenant<\/code> channel to the channels array in your <code>config\/logging.php<\/code> like below:<\/p>\n<pre><code class=\"language-php\">\/\/ ...\n'channels' =&gt; [\n        \/\/ ...\n        'tenant' =&gt; [\n            'driver' =&gt; 'custom',\n            'via' =&gt; \\Hyn\\Tenancy\\Logging\\TenantAwareLogger::class,\n            'level' =&gt; 'debug',\n        ],\n\/\/ ...\n<\/code><\/pre>\n<p>Then just change the 'single' channel to 'tenant' channel your stack channel:<\/p>\n<pre><code class=\"language-php\">\/\/ ...\n'stack' =&gt; [\n            'driver' =&gt; 'stack',\n            'channels' =&gt; ['tenant'],\n        ],\n\/\/ ...\n<\/code><\/pre>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.3\/logging.md"}]},{"name":"webserver","links":["apache","nginx"],"slug":"webserver","articles":[{"title":"Apache","icon":"fal fa-server","path":"docs\/hyn\/5.3\/apache.md","slug":"apache","package":"hyn","version":"5.3","contents":"<h1 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h1>\n<p>Tenancy natively integrates with the Apache webserver. For that to work you need\nto do a minor configuration.<\/p>\n<p>Edit the <code>\/etc\/apache2\/apache2.conf<\/code> and below the last <code>IncludeOptional<\/code> statement\nadd:<\/p>\n<pre><code class=\"language-apacheconfig\">IncludeOptional &lt;path&gt;\/*.conf\n<\/code><\/pre>\n<p>Where <code>&lt;path&gt;<\/code> has to be replaced by the location of your vhost files generated by this package.<\/p>\n<div class=\"alert alert-info\"><p>Your vhost files are saved by default inside the <code>storage\/app\/tenancy\/webserver\/apache<\/code> and\ncan be reconfigured in the <code>webserver.php<\/code> configuration file.<\/p><\/div>\n<p>Make sure to reload apache afterwards:<\/p>\n<pre><code class=\"language-bash\">sudo apache2ctl graceful\n<\/code><\/pre>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.3\/apache.md"},{"title":"Nginx","icon":"fal fa-server","path":"docs\/hyn\/5.3\/nginx.md","slug":"nginx","package":"hyn","version":"5.3","contents":"<h1 id=\"set-up\"><a href=\"#set-up\" class=\"anchor-link\"><\/a>Set up<\/h1>\n<p>You need to set up your own PHP FPM. The preferred way of running php is through a <a href=\"https:\/\/coderwall.com\/p\/hmsr5a\/have-php-fpm-listen-on-unix-socket\">socket<\/a> by\nconfiguring the <code>listen<\/code> value in your pool correctly. Make sure to copy the path to your\nsock and update your <code>webserver.php<\/code> configuration file in your app to reflect that value, for instance:<\/p>\n<pre><code class=\"language-php\">    \/**\n     * Nginx webserver support.\n     *\n     * @see http:\/\/nginx.org\n     *\/\n    'nginx' =&gt; [\n        \/\/ ..\n\n        \/**\n         * The php sock to be used.\n         *\/\n        'php-sock' =&gt; 'unix:\/var\/run\/php\/php-fpm.sock',\n        \n        \/\/ ..\n    ],\n<\/code><\/pre>\n<h1 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h1>\n<p>Tenancy natively integrates with the Nginx webserver. For that to work you need\nto do a minor configuration.<\/p>\n<p>Edit the <code>\/etc\/nginx\/nginx.conf<\/code> and below the last <code>include<\/code> statement\nadd:<\/p>\n<pre><code class=\"language-apacheconfig\">include &lt;path&gt;\/*.conf;\n<\/code><\/pre>\n<p>Where <code>&lt;path&gt;<\/code> has to be replaced by the location of your vhost files generated by this package.<\/p>\n<div class=\"alert alert-info\"><p>Your vhost files are saved by default inside the <code>storage\/app\/tenancy\/webserver\/nginx<\/code> and\ncan be reconfigured in the <code>webserver.php<\/code> configuration file.<\/p><\/div>\n<p>Make sure to restart nginx afterwards:<\/p>\n<pre><code class=\"language-bash\">sudo systemctl restart nginx\n<\/code><\/pre>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.3\/nginx.md"}]},{"name":"tutorials","links":["spatie-laravel-permission","spatie-medialibrary"],"slug":"tutorials","articles":[{"title":"Spatie permission","excerpt":"A tutorial on setting up spatie\/laravel-permission.","icon":"fal fa-file-archive","tags":["spatie","permission","tutorial"],"path":"docs\/hyn\/5.3\/spatie-laravel-permission.md","slug":"spatie-laravel-permission","package":"hyn","version":"5.3","contents":"<ol>\n<li>Create a fresh install of Laravel.  If you have installed the Laravel Terminal Installer run: <code>$ laravel new app<\/code>\n<\/li>\n<li>\n<code>$ cd app<\/code>\n<\/li>\n<li>Install <code>hyn\/multi-tenant<\/code> package by running:<\/li>\n<\/ol>\n<pre><code class=\"language-bash\">composer require hyn\/multi-tenant\n<\/code><\/pre>\n<ol start=\"4\">\n<li>Follow the instructions until &quot;Deploy configuration&quot; section.<\/li>\n<li>If you are using MySQL DB, you need to add the entry <code>LIMIT_UUID_LENGTH_32=true<\/code> in your <code>.env<\/code> file.<\/li>\n<\/ol>\n<h2 id=\"install-spatie-permissions\"><a href=\"#install-spatie-permissions\" class=\"anchor-link\"><\/a>Install Spatie Permissions<\/h2>\n<p>To install the package follow the entire installation section\nat <a href=\"https:\/\/github.com\/spatie\/laravel-permission#installation\">GitHub - spatie\/laravel-permission: Associate users with roles and permissions<\/a>.<\/p>\n<h2 id=\"integration\"><a href=\"#integration\" class=\"anchor-link\"><\/a>Integration<\/h2>\n<p>This section of the tutorial assumes that you have successfully created at least 2 hostnames\nand successfully have accessed them via your local environment setup.<\/p>\n<p>We need to extend the two eloquent models (<code>Permission<\/code>, <code>Role<\/code>) of the Permissions\npackage so that we can add the necessary changes we need in order for these two models\nto be tenant aware.<\/p>\n<ol>\n<li>Create a <code>Permission.php<\/code> and <code>Role.php<\/code> file and place them inside your <code>app<\/code> directory,\nnext to your <code>User.php<\/code>. Make sure that these files extend <code>Spatie\\Permission\\Models\\Permission::class<\/code>\nand <code>Spatie\\Permission\\Models\\Role::class<\/code> respectively.<\/li>\n<\/ol>\n<p><code>App\\Permission.php<\/code> - extends from <code>SpatiePermission<\/code> and uses the <code>UsesTenantConnection<\/code> trait.<\/p>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Traits\\UsesTenantConnection;\nuse Spatie\\Permission\\Models\\Permission as SpatiePermission;\n\nclass Permission extends SpatiePermission\n{\n    use UsesTenantConnection;\n}\n<\/code><\/pre>\n<p><code>App\\Role.php<\/code> - extends from <code>SpatieRole<\/code> and uses the <code>UsesTenantConnection<\/code> trait.<\/p>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Traits\\UsesTenantConnection;\nuse Spatie\\Permission\\Models\\Role as SpatieRole;\n\nclass Role extends SpatieRole\n{\n    use UsesTenantConnection;\n}\n<\/code><\/pre>\n<p><code>App\\User.php<\/code> - notice the <code>HasRoles<\/code>, <code>UsesTenantConnection<\/code> traits we added.<\/p>\n<pre><code class=\"language-php\">use Spatie\\Permission\\Traits\\HasRoles;\nuse Illuminate\\Notifications\\Notifiable;\nuse Hyn\\Tenancy\\Traits\\UsesTenantConnection;\nuse Illuminate\\Foundation\\Auth\\User as Authenticatable;\n\nclass User extends Authenticatable\n{\n    use Notifiable, UsesTenantConnection, HasRoles;\n\n    \/**\n     * The attributes that are mass assignable.\n     *\n     * @var array\n     *\/\n    protected $fillable = [\n        'name', 'email', 'password',\n    ];\n\n    \/**\n     * The attributes that should be hidden for arrays.\n     *\n     * @var array\n     *\/\n    protected $hidden = [\n        'password', 'remember_token',\n    ];\n}\n<\/code><\/pre>\n<ol start=\"3\">\n<li>Modify your <code>config\/permission.php<\/code> file and modify the permission and role models\nthat is being used here to point to your newly created models. e.g. <code>App\\Permission::class<\/code>\n<\/li>\n<\/ol>\n<p><code>config\\permisssion.php<\/code><\/p>\n<pre><code class=\"language-php\">return [\n\n    'models' =&gt; [\n\n        'permission' =&gt; App\\Permission::class,\n\n        'role' =&gt; App\\Role::class,\n\n    ],\n\n    ...\n];\n<\/code><\/pre>\n<ol start=\"4\">\n<li>Creating a user in your first hostname.<\/li>\n<\/ol>\n<pre><code class=\"language-php\">use App\\User;\nuse App\\Role;\nuse App\\Permission;\nuse Hyn\\Tenancy\\Models\\Hostname;\n\n\/\/ Switch the environment to use first hostname\n$environment = app(\\Hyn\\Tenancy\\Environment::class);\n$hostname = Hostname::find(1);\n$environment-&gt;hostname($hostname);\n\n\/\/ creates role and permission on your first hostname\n$role = Role::create(['name' =&gt; 'writer']);\n$permission = Permission::create(['name' =&gt; 'edit articles']);\n\n\/\/ Retrieve user and check to make sure it has no roles yet\n$user = User::find(1);\n$user-&gt;getRoleNames();\n\n\/\/ Assign writer role and save the $user instance to DB.\n$user-&gt;assignRole('writer');\n$user-&gt;save();\n\n\/\/ Requery and check if the newly assigned roles exists.\n$user = User::find(1);\n$user-&gt;getRoleNames();\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 18:29:42.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.3\/spatie-laravel-permission.md"},{"title":"Spatie media library","excerpt":"A tutorial on setting up spatie\/laravel-medialibrary.","icon":"fal fa-file-archive","tags":["spatie","medialibrary","tutorial"],"path":"docs\/hyn\/5.3\/spatie-medialibrary.md","slug":"spatie-medialibrary","package":"hyn","version":"5.3","contents":"<ol>\n<li>Create a fresh install of Laravel 5.7.  If you have installed the Laravel Terminal Installer run:<\/li>\n<\/ol>\n<pre><code class=\"language-bash\">$ laravel new app\n<\/code><\/pre>\n<ol start=\"2\">\n<li>\n<code>$ cd app<\/code>\n<\/li>\n<li>Install <code>hyn\/multi-tenant<\/code> package by running:<\/li>\n<\/ol>\n<pre><code class=\"language-bash\">$ composer require hyn\/multi-tenant\n<\/code><\/pre>\n<ol start=\"4\">\n<li>Follow the instructions until the &quot;Deploy configuration&quot; section.<\/li>\n<li>If you are using MySQL as a database, make sure to add the entry <code>LIMIT_UUID_LENGTH_32=true<\/code> in your <code>.env<\/code> file.<\/li>\n<\/ol>\n<h2 id=\"install-spatie-medialibrary\"><a href=\"#install-spatie-medialibrary\" class=\"anchor-link\"><\/a>Install Spatie Medialibrary<\/h2>\n<p>Install this package via composer.<\/p>\n<pre><code class=\"language-bash\">$ composer require spatie\/laravel-medialibrary\n<\/code><\/pre>\n<p>Publish the migration with:<\/p>\n<pre><code class=\"language-bash\">$ php artisan vendor:publish --provider=&quot;Spatie\\MediaLibrary\\MediaLibraryServiceProvider&quot; --tag=&quot;migrations&quot;\n<\/code><\/pre>\n<p>Move the migration file from <code>database\/migrations\/2018_10_10_085035_create_media_table.php<\/code> to <code>database\/migrations\/tenant\/<\/code>.<\/p>\n<p>After the migration has been published you can create the media-table in your tenant databases by running the migrations:<\/p>\n<pre><code class=\"language-bash\">$ php artisan tenancy:migrate\n<\/code><\/pre>\n<p>You need to publish the config-file with:<\/p>\n<pre><code class=\"language-bash\">$ php artisan vendor:publish --provider=&quot;Spatie\\MediaLibrary\\MediaLibraryServiceProvider&quot; --tag=&quot;config&quot;\n<\/code><\/pre>\n<h2 id=\"integration\"><a href=\"#integration\" class=\"anchor-link\"><\/a>Integration<\/h2>\n<p>This section of the tutorial assumes that you have successfully <a href=\"creating-tenants\">created at least 2 hostnames<\/a>\nand successfully have accessed them via your local environment setup.<\/p>\n<p>We need to extend the <code>Media<\/code> eloquent model of the Medialibrary package so that we can add the\nnecessary changes we need in order for these two models to be tenant aware.<\/p>\n<ol>\n<li>Create a Media.php file and place them inside your <code>app<\/code> directory,\nnext to your <code>User.php<\/code>. Make sure that these files extend <code>Spatie\\MediaLibrary\\Models\\Media::class<\/code>.<\/li>\n<\/ol>\n<p><code>App\\Media.php<\/code> - extends from <code>SpatieMedia<\/code> and uses the <code>UsesTenantConnection<\/code> trait.<\/p>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Traits\\UsesTenantConnection;\nuse Spatie\\MediaLibrary\\Models\\Media as SpatieMedia;\n\nclass Media extends SpatieMedia\n{\n    use UsesTenantConnection;\n}\n<\/code><\/pre>\n<ol start=\"2\">\n<li>Prepare your model<\/li>\n<\/ol>\n<p>To associate media with a model, the tenant aware model must implement the following interface and trait:<\/p>\n<pre><code class=\"language-php\">use Illuminate\\Database\\Eloquent\\Model;\nuse Spatie\\MediaLibrary\\HasMedia\\HasMedia;\nuse Hyn\\Tenancy\\Traits\\UsesTenantConnection;\nuse Spatie\\MediaLibrary\\HasMedia\\HasMediaTrait;\n\nclass User extends Model implements HasMedia\n{\n    use UsesTenantConnection, HasMediaTrait;\n   ...\n}\n<\/code><\/pre>\n<ol start=\"3\">\n<li>Modify your <code>config\/medialibrary.php<\/code> file and modify the <code>media_model<\/code> that is being used here to point to your newly created model. e.g. <code>App\\Media::class<\/code>\n<\/li>\n<\/ol>\n<p><code>config\\medialibrary.php<\/code><\/p>\n<pre><code class=\"language-php\">return [\n\n    \/*\n     * The fully qualified class name of the media model.\n     *\/\n    'media_model' =&gt; App\\Media::class,\n\n    ...\n];\n<\/code><\/pre>\n<ol start=\"4\">\n<li>Attaching a media to your user model.<\/li>\n<\/ol>\n<pre><code class=\"language-php\">\/\/ Retrieve your user model.\n$user = App\\User::find(1);\n\n\/\/ Add a media from url and attach it to your model.\n$user-&gt;addMediaFromUrl('http:\/\/url-to-your-media-to-attach.png')-&gt;toMediaCollection();\n\n\/\/ Retrieve the media you just attached.\n$media = $user-&gt;media-&gt;last();\n<\/code><\/pre>\n<p>That's about it. You can read more on how to customize the medialibrary on their website: <a href=\"https:\/\/docs.spatie.be\/laravel-medialibrary\">https:\/\/docs.spatie.be\/laravel-medialibrary<\/a><\/p>\n","updated_at":{"date":"2020-07-18 18:29:42.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.3\/spatie-medialibrary.md"}]}],"hidden_articles":{"index":{"title":"Hyn documentation","path":"docs\/hyn\/5.3\/index.md","slug":"index","package":"hyn","version":"5.3","contents":"","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.3\/index.md"}}},"5.2":{"slug":"5.2","name":5.2,"status":"Deprecated","suggestion_using":null,"branch":"5.x","package":"hyn","tree":[{"name":"getting started","links":["requirements","upgrade-from-5.1","installation","configuration"],"slug":"getting-started","articles":[{"title":"Requirements","icon":"fal fa-clipboard-check","path":"docs\/hyn\/5.2\/requirements.md","slug":"requirements","package":"hyn","version":"5.2","contents":"<ul>\n<li>Laravel 5.6.<\/li>\n<li>PHP 7.1 or up.<\/li>\n<li>MySQL 5.7+, MariaDB 10.1.13+ or PostgreSQL 9+.<\/li>\n<li>Optionally Apache 2.4+ or Nginx 1.12+.<\/li>\n<li>\n<a href=\"#experience\">Applied experience with Laravel<\/a>.<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>Please note that MySQL limits username and database length to 32,\nenable in the <code>tenancy.php<\/code> configuration file:  <code>website &gt; uuid-limit-length-to-32<\/code>\nto fix this.<\/p><\/div>\n<h2 id=\"experience\"><a href=\"#experience\" class=\"anchor-link\"><\/a>Experience<\/h2>\n<p>In case you are new to Laravel we urge you to get familiar with that\nbefore jumping into building something with this package. Having built\nat least one project with the framework (for fun) makes it much easier\ngrasping the concepts at hand.<\/p>\n<p>The following resources we recommend:<\/p>\n<ul>\n<li>\n<a href=\"https:\/\/laravel.com\/docs\">Laravel documentation<\/a>\n<\/li>\n<li>\n<a href=\"https:\/\/laracasts.com\/series\/laravel-from-scratch-2017\">Laravel from scratch free series at Laracasts<\/a>\n<\/li>\n<\/ul>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.2\/requirements.md"},{"title":"Upgrading from 5.1","icon":"fal fa-level-up-alt","path":"docs\/hyn\/5.2\/upgrade-from-5.1.md","slug":"upgrade-from-5.1","package":"hyn","version":"5.2","contents":"<p>The 5.2 release cleans up the codebase in an attempt to clarify\nthe required models and the subject of tenancy. In addition\nit offers even better integration for SaaS apps with the improved\nglobal routes handling.<\/p>\n<h2 id=\"backward-breaking-changes\"><a href=\"#backward-breaking-changes\" class=\"anchor-link\"><\/a>Backward breaking changes<\/h2>\n<ul>\n<li>The <code>tenancy:install<\/code> command has been removed, instead you'll have to\npublish and\/or run the migration files provided by the package using\n<code>php artisan vendor:publish --tag tenancy<\/code> and <code>php artisan migrate<\/code>.<\/li>\n<li>The <code>Customer<\/code> model has been dropped, make sure to copy it to your code base\nbefore upgrading. There's no migration to drop the existing\ntables, to prevent existing installations from losing stored data. You can\nsafely remove the tables with a migration of your own in case you've\nnever used the model in your app.<\/li>\n<li>As the documentation has been pointing out, the tenant in this package\nhas always been the Website class. However, due to legacy code, the identified\nHostname had become the subject of identification. In order to straighten this\nout, from now whenever an identified Hostname is connected to a website, that\nwebsite is bound to the new <code>Tenant<\/code> contract. All logic related to connections,\ncustom tenant configuration files etc are now all following the Tenant Website.<\/li>\n<li>Using <code>Environment::hostname($hostname)<\/code> to set a hostname no longer switches\nthe tenant, you'll need to use <code>Environment::tenant($website)<\/code> for this now.<\/li>\n<li>The <code>TenantAwareJob<\/code> trait now uses the <code>website_id<\/code> and the fluent setter <code>onTenant()<\/code>.<\/li>\n<li>The <code>Hostname<\/code> and <code>Website<\/code> models now have the <code>SoftDeletes<\/code> trait applied.<\/li>\n<\/ul>\n<h2 id=\"new-features\"><a href=\"#new-features\" class=\"anchor-link\"><\/a>New features<\/h2>\n<ul>\n<li>Setting the <code>tenancy.website.disk<\/code> configuration to <code>false<\/code> will fully disable\nall filesystem related functionality for tenants, including configs, vendor and\ntranslations.<\/li>\n<li>Creating a <code>routes\/tenants.php<\/code> file now allows automatically overriding or replacing\nglobal routes. This allows for far easier landing\/fallback pages. Check the\n<code>tenancy.php<\/code> config files under <code>routes<\/code>.<\/li>\n<li>The Connection class now offers an <code>exists($name)<\/code> method to check whether a\nspecific connection was configured.<\/li>\n<\/ul>\n<h2 id=\"minor\"><a href=\"#minor\" class=\"anchor-link\"><\/a>Minor<\/h2>\n<ul>\n<li>Improved local testing of the package. All traces of the tests are removed.<\/li>\n<li>The clean-local-dbs bash script has been slightly improved to clean up the\nlocal database better.<\/li>\n<li>Dropped all references to <code>$ssl<\/code> which was meant to be included somewhere in\nversion 2.x, let's encrypt has great binaries to solve the certificate question.<\/li>\n<li>\n<code>WebsiteRepository::findById<\/code> now allows both integer and string argument, which\nLaravel natively allows.<\/li>\n<\/ul>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.2\/upgrade-from-5.1.md"},{"title":"Installation","icon":"fal fa-arrow-alt-to-bottom","path":"docs\/hyn\/5.2\/installation.md","slug":"installation","package":"hyn","version":"5.2","contents":"<h1 id=\"elevated-database-user\"><a href=\"#elevated-database-user\" class=\"anchor-link\"><\/a>Elevated database user<\/h1>\n<p>Tenancy requires a system connection that allows creating new databases for her\ntenants. In order to do so, we need to have a database user with elevated\npermissions.<\/p>\n<p>A user for both <a href=\"https:\/\/mariadb.com\/kb\/en\/library\/grant\/#the-grant-option-privilege\">MariaDB or MySQL<\/a> and <a href=\"https:\/\/www.postgresql.org\/docs\/9.6\/static\/sql-grant.html\">PostgreSQL<\/a> would require the &quot;GRANT OPTION&quot; to be\napplied. You can either use the root user (for PostgreSQL that is user postgres) or create\nyour own (recommended):<\/p>\n<p>For MariaDB or MySQL:<\/p>\n<pre><code class=\"language-sql\">CREATE DATABASE IF NOT EXISTS tenancy;\nCREATE USER IF NOT EXISTS tenancy@localhost IDENTIFIED BY 'someRandomPassword';\nGRANT ALL PRIVILEGES ON *.* TO tenancy@localhost WITH GRANT OPTION;\n<\/code><\/pre>\n<p>For PostgreSQL:<\/p>\n<pre><code class=\"language-sql\">CREATE DATABASE tenancy;\nCREATE USER tenancy WITH CREATEDB CREATEROLE PASSWORD 'someRandomPassword';\nGRANT ALL PRIVILEGES ON DATABASE tenancy to tenancy WITH GRANT OPTION;\n<\/code><\/pre>\n<p>Make sure you configure this user as your system connection in your <code>database.php<\/code>.\nUnder connections:<\/p>\n<pre><code class=\"language-php\">'system' =&gt; [\n    'driver' =&gt; 'mysql',\n    'host' =&gt; env('TENANCY_HOST', '127.0.0.1'),\n    'port' =&gt; env('TENANCY_PORT', '3306'),\n    'database' =&gt; env('TENANCY_DATABASE', 'tenancy'),\n    'username' =&gt; env('TENANCY_USERNAME', 'tenancy'),\n    'password' =&gt; env('TENANCY_PASSWORD', ''),\n    'unix_socket' =&gt; env('DB_SOCKET', ''),\n    'charset' =&gt; 'utf8mb4',\n    'collation' =&gt; 'utf8mb4_unicode_ci',\n    'prefix' =&gt; '',\n    'strict' =&gt; true,\n    'engine' =&gt; null,\n]\n<\/code><\/pre>\n<p>Most often it makes sense to use either <code>system<\/code> or <code>tenant<\/code> as your default database connection setting; this is <code>DB_CONNECTION<\/code> in your <code>.env<\/code> file. This environment variable is assigned to the <code>default<\/code> key in the <code>config\/database.php<\/code> configuration file.<\/p>\n<p>In case you use the <code>tenant<\/code> make sure to enable <a href=\"identification\">early identification<\/a> and configure\na decent <a href=\"fallback\">fallback<\/a> later on.<\/p>\n<div class=\"alert alert-info\"><p>There is no need to configure the <code>tenant<\/code> connection in the <code>database.php<\/code>\nconfiguration file. This connection is set up automatically during runtime. Pre-\nconfiguring this connection may cause unwanted behaviour.<\/p><\/div>\n<h1 id=\"package-installation\"><a href=\"#package-installation\" class=\"anchor-link\"><\/a>Package installation<\/h1>\n<p>Run the composer command to add the tenancy package as dependency:<\/p>\n<pre><code class=\"language-bash\">composer require &quot;hyn\/multi-tenant:5.2.*&quot;\n<\/code><\/pre>\n<p>Laravel offers <a href=\"https:\/\/medium.com\/@taylorotwell\/package-auto-discovery-in-laravel-5-5-ea9e3ab20518\">package auto discovery<\/a>\nin version 5.6. So that's all you need to do; no need to register any\nservice providers manually in your <code>config\/app.php<\/code>.<\/p>\n<p>Publish the configuration files and migrations for tenancy, which allows you\nto configure the behavior of the package.<\/p>\n<pre><code class=\"language-bash\">php artisan vendor:publish --tag=tenancy\n<\/code><\/pre>\n<p>Then edit <code>config\/tenancy.php<\/code> accordingly.<\/p>\n<p>Adapt the system migrations to your liking inside <code>database\/migrations<\/code>, make sure to run them:<\/p>\n<pre><code class=\"language-bash\">php artisan migrate --database=system\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Change <code>system<\/code> to your system connection name.<\/p><\/div>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.2\/installation.md"},{"title":"Configuration","icon":"fal fa-sliders-v","path":"docs\/hyn\/5.2\/configuration.md","slug":"configuration","package":"hyn","version":"5.2","contents":"<h1 id=\"system-connection\"><a href=\"#system-connection\" class=\"anchor-link\"><\/a>System connection<\/h1>\n<p>Tenancy needs a database connection with elevated permission to create databases\nto be used by its tenants.<\/p>\n<p>Make sure you set up this connection by following the instructions\nin the <a href=\"requirements#elevated-database-user\">requirements<\/a>, it also explains how to publish\nthe configuration files.<\/p>\n<h1 id=\"configuration-files\"><a href=\"#configuration-files\" class=\"anchor-link\"><\/a>Configuration Files<\/h1>\n<p>The inline documentation in both files should be self explanatory. Nevertheless,\nI've listed some of the basic settings below.<\/p>\n<h2 id=\"tenancyphp\"><a href=\"#tenancyphp\" class=\"anchor-link\"><\/a>tenancy.php<\/h2>\n<p>The tenancy configuration file holds every setting related to tenants. This includes how to generate a unique\nwebsite, but also how database connections are set up. In addition it allows for;<\/p>\n<ul>\n<li>custom random id logic.<\/li>\n<li>manual tenant identification.<\/li>\n<li>on what disk (see <code>config\/filesystems.php<\/code>) to store the tenant specific files.<\/li>\n<li>and much, much more.<\/li>\n<\/ul>\n<h2 id=\"webserverphp\"><a href=\"#webserverphp\" class=\"anchor-link\"><\/a>webserver.php<\/h2>\n<p>With the webserver.php one can more closely fine tune integration of this package with your webserver.\nPorts, vhost configuration files and the location to save these files are all contained in this config.<\/p>\n<p>In general you can expect the following settings for each webserver;<\/p>\n<ul>\n<li>enabled; whether the service is enabled and thus the package will write files for it and reload the service.<\/li>\n<li>ports; which ports we should use, this is required to configure the vhost files properly.<\/li>\n<li>generator; the class handling the generation of vhost files.<\/li>\n<li>disk; the disk to write the vhost files to, you can have it point to any configured disk in your <code>config\/filesystems.php<\/code>.<\/li>\n<li>paths; specific locations we need to know about to in order to mutate the webserver behavior.<\/li>\n<\/ul>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.2\/configuration.md"}]},{"name":"tenant principles","links":["concepts","structure","identification","fallback","middleware"],"slug":"tenant-principles","articles":[{"title":"Concepts","icon":"fal fa-vials","path":"docs\/hyn\/5.2\/concepts.md","slug":"concepts","package":"hyn","version":"5.2","contents":"<h1 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h1>\n<p>The principle of multi tenancy is about a single instance of software running\non a server and serving multiple tenants. The interpretation of such a tenancy\napplication is quite diverse.<\/p>\n<p>Hyn tenancy is focused on providing a drop-in solution for Laravel without\nsacrificing flexibility or hacks of the Laravel ecosystem.<\/p>\n<p>Make sure you understand that the <code>Website<\/code> model is the subject of tenancy.<\/p>\n<p>The default method for identifying such a tenant website is by using the requested\ndomain aka hostname. Taking a URL <code>http:\/\/yourdomain.com\/foo\/bar<\/code> only <code>yourdomain.com<\/code>\nis taken into account although modifications to this logic is easy to implement. The\n<code>yourdomain.com<\/code> part of the URL is called a Fully Qualified Domain Name or <code>fqdn<\/code> for short.<\/p>\n<p>A website can have zero or more hostnames connected to it. This allows for easier\nattachment of additional hostnames or serving, for instance, an ad campaign page\non different domains.<\/p>\n<h1 id=\"website\"><a href=\"#website\" class=\"anchor-link\"><\/a>Website<\/h1>\n<p>You can think of a website as a single mirror of the code base, re-using your default\napp code. In addition it is also possible to have very <a href=\"structure\">tenant specific logic<\/a>,\nfor instance routes, a vendor folder, media and language files.<\/p>\n<h1 id=\"hostname\"><a href=\"#hostname\" class=\"anchor-link\"><\/a>Hostname<\/h1>\n<p>A hostname is a <a href=\"https:\/\/www.godaddy.com\/garage\/industry\/tech-svcs\/it\/whats-a-fully-qualified-domain-name-fqdn-and-whats-it-good-for\/\">Fully Qualified Domain Name<\/a> (for instance <code>sub.example.com<\/code>).\nYour application handles incoming requests to specific hostnames. Tenancy inspects\nthese requests and <a href=\"identification\">sets up the tenancy environment<\/a> according to a\nmatching hostname or falls back to the default one.<\/p>\n<h1 id=\"runtime\"><a href=\"#runtime\" class=\"anchor-link\"><\/a>Runtime<\/h1>\n<p>By default, the package will identify the current requested hostname and bind it\ninto the <code>Hyn\\Tenancy\\Contracts\\CurrentHostname<\/code> contract. In case that hostname belongs to\na website, the latter will be bound into the <code>Hyn\\Tenancy\\Contracts\\Tenant<\/code> contract. Whenever\na Tenant is identified or switched the package will automatically infuse additional functionality\ninto Laravel, including <a href=\"fallback#tenant-routes-override\">global tenant routes<\/a>, <a href=\"structure\">tenant overrides<\/a>\nand <a href=\"queues\">queues<\/a>.<\/p>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.2\/concepts.md"},{"title":"Structure","icon":"fal fa-sitemap","path":"docs\/hyn\/5.2\/structure.md","slug":"structure","package":"hyn","version":"5.2","contents":"<h1 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h1>\n<p>The location of the tenant specific files is configured inside the <code>config\/tenancy.php<\/code>\nfile under <code>website &gt; disk<\/code>. By default tenant files\nare stored in <code>storage\/app\/tenancy\/tenants<\/code>.<\/p>\n<p>Inside this tenant directory you are able to override global logic by\ngenerating the necessary files. Check the tenancy configuration file under\n<code>folders<\/code> to see which ones are enabled by default.<\/p>\n<h2 id=\"config\"><a href=\"#config\" class=\"anchor-link\"><\/a>Config<\/h2>\n<p>Any php files stored inside a <code>config\/<\/code> directory of the tenant is read\nduring runtime. Existing configuration values are replaced and new ones\nare appended.<\/p>\n<p>A great use case for this feature is the ability to configure client\nspecific mail settings.<\/p>\n<p>The tenancy configuration file allows you to refuse overrides of specific\nconfiguration settings using the <code>folders &gt; config &gt; blacklist<\/code> setting.\nBy default it disallows database, tenancy and webserver changes.<\/p>\n<h2 id=\"routes\"><a href=\"#routes\" class=\"anchor-link\"><\/a>Routes<\/h2>\n<p>Create a <code>routes.php<\/code> file inside your tenant directory to configure\nnew routes during runtime. Using a configurable prefix, any unique\nurl's will be matched for this specific tenant only.<\/p>\n<h2 id=\"trans\"><a href=\"#trans\" class=\"anchor-link\"><\/a>Trans<\/h2>\n<p>New translations can be easily added by creating a <code>lang\/<\/code> folder.\nThe native Laravel translator will parse any files contained within\nto be used in the application of this specific tenant.<\/p>\n<p>You are able to specify whether these language files should override\nthe global, system-wide translation. In case you decide against that\nfeel free to set up a translation namespace.<\/p>\n<h2 id=\"views\"><a href=\"#views\" class=\"anchor-link\"><\/a>Views<\/h2>\n<p>Additional or overriding views is possible by creating a <code>views\/<\/code> folder\ninside the tenant directory. There are three possible scenarios to\nconfigure how views are picked up by Laravel:<\/p>\n<ol>\n<li>By adding views inside the global namespace, overriding existing\nglobal views.<\/li>\n<li>By adding views inside the global namespace, but where existing\nglobal views take precedence.<\/li>\n<li>By adding views inside their own namespace.<\/li>\n<\/ol>\n<h2 id=\"vendor\"><a href=\"#vendor\" class=\"anchor-link\"><\/a>Vendor<\/h2>\n<p>A very powerful addition is the ability to inject new packages and code.\nWhenever the tenant directory has a <code>vendor\/autoload.php<\/code> file it will\nbe loaded during runtime. Using that specific file allows you to fully\nutilize the power of composer inside your tenant directories.<\/p>\n<div class=\"alert alert-info\"><p>Please be aware that no compatibility checks are executed against your app.\nIdentifying whether a composer conflict could happen is something you should test\noutside production environments.<\/p><\/div>\n<h2 id=\"media\"><a href=\"#media\" class=\"anchor-link\"><\/a>Media<\/h2>\n<p>The media folder can be used by creating a <code>media\/<\/code> folder inside the\ntenant directory. Files inside that directory will become automatically\navailable as a public directory inside an equally named directory <code>media\/<\/code>.<\/p>\n<p>Eg, storing a file <code>media\/bg.jpg<\/code> will allow you to use <code>\/media\/bg.jpg<\/code> inside\nyour html. This applies to any file you store.<\/p>\n<h2 id=\"media-webserver\"><a href=\"#media-webserver\" class=\"anchor-link\"><\/a>\/media webserver<\/h2>\n<p>An alias is set up binding the private tenant media directory to the public\nmedia directory. This is implemented using the auto generated web server\nconfiguration files for apache and nginx.<\/p>\n<h2 id=\"media-fallback-controller\"><a href=\"#media-fallback-controller\" class=\"anchor-link\"><\/a>\/media fallback controller<\/h2>\n<p>In case you're not using the webserver vhost configuration files provided\nby this package you can choose to map the <code>MediaController<\/code> to the path, eg:<\/p>\n<pre><code class=\"language-php\">Route::get('\/media\/{path}', '\\Hyn\\Tenancy\\Controllers\\MediaController')\n    -&gt;where('path', '.+')\n    -&gt;name('tenant.media');\n<\/code><\/pre>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.2\/structure.md"},{"title":"Identification","icon":"fal fa-street-view","path":"docs\/hyn\/5.2\/identification.md","slug":"identification","package":"hyn","version":"5.2","contents":"<p>During runtime, the <code>Environment<\/code> class is bound into Laravel's container. The\ntenancy environment holds one single responsibility, which is telling our code\nwhat hostname was currently identified and resolving the related website.<\/p>\n<h1 id=\"early-identification\"><a href=\"#early-identification\" class=\"anchor-link\"><\/a>Early identification<\/h1>\n<p>By default tenancy will identify the tenant after all Middleware has been processed.\nOne could simply resolve the Environment class through the service container\ninside a middleware to force identification of the tenant early on. If you want the\npackage to handle this on your behalf you can now simply enable the <code>early-identification<\/code> flag in\nyour <code>tenancy.php<\/code> configuration file under <code>hostname<\/code>.<\/p>\n<h1 id=\"manual-identification\"><a href=\"#manual-identification\" class=\"anchor-link\"><\/a>Manual identification<\/h1>\n<p>The environment can be used to manually set any active tenant. This is one of the\nreasons why the tenancy configuration file has the <code>hostname &gt; auto-identification<\/code>\nsetting. Turn it off to implement your own tenancy identification.<\/p>\n<p>Manual identification is pretty straightforward. Take for example the following\nsnippet for a custom (app) service provider:<\/p>\n<pre><code class=\"language-php\">public function boot()\n{\n    $environment = $this-&gt;app-&gt;make(\\Hyn\\Tenancy\\Environment::class);\n\n    \/\/ Retrieve your website\n\n    \/\/ Now switch the environment to a new tenant.\n    $environment-&gt;tenant($website);\n}\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Be wary about switching tenants. I recommend switching only once during code\nexecution. Use a background job to run mass changes on tenant databases.<\/p><\/div>\n<h1 id=\"retrieve-current-tenant\"><a href=\"#retrieve-current-tenant\" class=\"anchor-link\"><\/a>Retrieve current tenant<\/h1>\n<p>In case you like to work with the current environment, you can do the following:<\/p>\n<pre><code class=\"language-php\"> \n \/\/ Get current Website (Tenant)\n $website   = \\Hyn\\Tenancy\\Facades\\TenancyFacade::website();\n \n \/\/ prefered option\n $website   = app(\\Hyn\\Tenancy\\Environment::class)-&gt;tenant();\n \n \/\/ alternative (outdated) \n $website   = app(\\Hyn\\Tenancy\\Environment::class)-&gt;website();\n \n $websiteId = $website-&gt;id;\n \n \/\/ Get current Hostname\n $hostname  = app(\\Hyn\\Tenancy\\Environment::class)-&gt;hostname();\n \n \/\/ Get FQDN (Fully-Qualified Domain Name) by current hostname\n $fqdn      = $hostname-&gt;fqdn;\n\n \n<\/code><\/pre>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.2\/identification.md"},{"title":"Fallback","excerpt":"Configure a landing page using different approaches","icon":"fal fa-compass","path":"docs\/hyn\/5.2\/fallback.md","slug":"fallback","package":"hyn","version":"5.2","contents":"<p>There are several ways to organize a fallback domain. These are commonly used to offer\na landing page and\/or admin area for your clients to configure their tenant website.<\/p>\n<h1 id=\"disabling-abort-to-pass-through\"><a href=\"#disabling-abort-to-pass-through\" class=\"anchor-link\"><\/a>Disabling abort to pass through<\/h1>\n<p>By default a 404 not found is served whenever auto identification is enabled and no\nmatching hostname entry was found in the system database.<\/p>\n<p>You can disable this in the <code>tenancy.php<\/code> configuration file by setting the\n<code>abort-without-identified-hostname<\/code> option to <code>false<\/code>. This will prevent tenancy\nfrom throwing a 404 (not found) whenever it failed to identify a registered hostname.<\/p>\n<p>Depending on how you set up your app, the code will now pass through to any registered routes.\nFor applications that have global routes defined for tenant specific functionality, you'll\nrun into the issue that no &quot;tenant&quot; connection was defined.<\/p>\n<h1 id=\"tenant-routes-override\"><a href=\"#tenant-routes-override\" class=\"anchor-link\"><\/a>Tenant routes override<\/h1>\n<p>Whenever you create a file <code>routes\/tenants.php<\/code> and you have <code>tenancy.hostname.auto-identification<\/code>\nenabled, all routes contained in that file will automatically override any declared global routes\nfrom <code>routes\/web.php<\/code> or <code>routes\/api.php<\/code>. Make sure to apply the proper middleware to those routes.<\/p>\n<p>In case you enable <code>tenancy.routes.replace-global<\/code> all previously declared routes\nwill be removed and replaced with the contents of the tenants.php routes file.<\/p>\n<h1 id=\"routing-with-domain\"><a href=\"#routing-with-domain\" class=\"anchor-link\"><\/a>Routing with domain<\/h1>\n<p>One of the easiest solutions is using the <code>::domain()<\/code> option in routing called\n<a href=\"https:\/\/laravel.com\/docs\/5.6\/routing#route-group-sub-domain-routing\">sub domain routing in Laravel<\/a>.<\/p>\n<pre><code class=\"language-php\">Route::domain('master.your.app')-&gt;group(function () {\n    \/\/ .. your landing page routes\n});\n<\/code><\/pre>\n<h1 id=\"create-a-tenant-as-fallback\"><a href=\"#create-a-tenant-as-fallback\" class=\"anchor-link\"><\/a>Create a tenant as fallback<\/h1>\n<p>Another quick method is to simply seed a default tenant that has a specific\nhostname. Set the environment <code>TENANCY_DEFAULT_HOSTNAME<\/code> to the exact FQDN used\nfor that tenant.<\/p>\n<p>Now every time no other tenant was identified, it will revert to this tenant. A\ndrawback of this method is the need to set up a tenant hostname.<\/p>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.2\/fallback.md"},{"title":"Middleware","icon":"fal fa-shield-alt","excerpt":"Automatic actions per tenant","path":"docs\/hyn\/5.2\/middleware.md","slug":"middleware","package":"hyn","version":"5.2","contents":"<p>This package offers additional automation to make your life easier. Using\nmiddleware, you can mutate how specific requests are handled.<\/p>\n<h1 id=\"maintenance\"><a href=\"#maintenance\" class=\"anchor-link\"><\/a>Maintenance<\/h1>\n<p>Set the property <code>under_maintenance_since<\/code> of the hostname to show a\nLaravel generic maintenance page.<\/p>\n<h1 id=\"redirection\"><a href=\"#redirection\" class=\"anchor-link\"><\/a>Redirection<\/h1>\n<p>Set the property <code>redirect_to<\/code> to a valid URL to automatically redirect all\nrequests to this hostname.<\/p>\n<h1 id=\"secure\"><a href=\"#secure\" class=\"anchor-link\"><\/a>Secure<\/h1>\n<p>Set the property <code>force_https<\/code> to true to force all connections on this\nhostname to be handled using a SSL encrypted connection.<\/p>\n<h1 id=\"abort\"><a href=\"#abort\" class=\"anchor-link\"><\/a>Abort<\/h1>\n<p>In case no tenant was identified the application will generate a default\nnot found page. You can disable this functionality globally in\nthe tenancy configuration file <code>hostname &gt; abort-without-identified-hostname<\/code>.<\/p>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.2\/middleware.md"}]},{"name":"implementation","links":["models","repositories","filesystem","migrations","connections","validation","queues","events","cache","logging","tinker"],"slug":"implementation","articles":[{"title":"Models","icon":"fal fa-hand-holding-box","path":"docs\/hyn\/5.2\/models.md","slug":"models","package":"hyn","version":"5.2","contents":"<p>For you to more easily connect with the correct database a few ways are possible.<\/p>\n<h4 id=\"traits\"><a href=\"#traits\" class=\"anchor-link\"><\/a>Traits<\/h4>\n<p>Two traits exist to force a model onto either the tenant or system connection.<\/p>\n<ul>\n<li>\n<code>Hyn\\Tenancy\\Traits\\UsesSystemConnection<\/code> to make a model use the system connection.<\/li>\n<li>\n<code>Hyn\\Tenancy\\Traits\\UsesTenantConnection<\/code> to make a model use the tenant connection.<\/li>\n<\/ul>\n<p>The below snippet shows an example of how to force the User model to use the tenant\nconnection.<\/p>\n<pre><code class=\"language-php\">namespace App;\n\nuse Hyn\\Tenancy\\Traits\\UsesTenantConnection;\nuse Illuminate\\Notifications\\Notifiable;\nuse Illuminate\\Foundation\\Auth\\User as Authenticatable;\n\nclass User extends Authenticatable\n{\n    use Notifiable, UsesTenantConnection;\n    \n    \/\/ ..\n}\n<\/code><\/pre>\n<h4 id=\"abstract-models\"><a href=\"#abstract-models\" class=\"anchor-link\"><\/a>Abstract models<\/h4>\n<p>Instead of using the traits one can also simply have the models extend the abstract\nmodels provided in the package.<\/p>\n<ul>\n<li>\n<code>Hyn\\Tenancy\\Abstracts\\SystemModel<\/code> can be extended to give easy access to\nthe system database connection.<\/li>\n<li>\n<code>Hyn\\Tenancy\\Abstracts\\TenantModel<\/code> can be extended to have your Eloquent models\nuse the connection of the identified tenant per default.<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>Please note these models are using their respective traits.<\/p><\/div>\n<h4 id=\"system-model-override\"><a href=\"#system-model-override\" class=\"anchor-link\"><\/a>System model override<\/h4>\n<p>This package allows you to specify different models to be used for the\nHostname and Website models. Tenancy will take care of the relationships on the\npackage-end. You also need to implement <code>Hyn\\Tenancy\\Contracts\\{Model}<\/code><\/p>\n<p>Take this example:<\/p>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Contracts\\Website as Contract;\n\nclass Website implements Contract\n{\n}\n<\/code><\/pre>\n<p>All you need to do is update the <code>tenancy.php<\/code> configuration file:<\/p>\n<pre><code class=\"language-php\">return [\n  'models' =&gt; [\n      \/\/ ..\n      \/\/ Must implement \\Hyn\\Tenancy\\Contracts\\Hostname\n      'hostname' =&gt; \\Hyn\\Tenancy\\Models\\Hostname::class,\n      \/\/ Must implement \\Hyn\\Tenancy\\Contracts\\Website\n      'website' =&gt; \\App\\Website::class\n  ],\n  \/\/ ...\n];\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 18:29:42.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.2\/models.md"},{"title":"Repositories","icon":"fal fa-dolly-flatbed","path":"docs\/hyn\/5.2\/repositories.md","slug":"repositories","package":"hyn","version":"5.2","contents":"<p>Tenancy is heavily driven by events. For event listeners to properly work, you\nhave to use the repositories to create new websites and hostnames.<\/p>\n<h1 id=\"create-website\"><a href=\"#create-website\" class=\"anchor-link\"><\/a>Create website<\/h1>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Models\\Website;\nuse Hyn\\Tenancy\\Contracts\\Repositories\\WebsiteRepository;\n\n$website = new Website;\napp(WebsiteRepository::class)-&gt;create($website);\ndd($website-&gt;uuid); \/\/ Unique id\n<\/code><\/pre>\n<h2 id=\"uuid\"><a href=\"#uuid\" class=\"anchor-link\"><\/a>UUID<\/h2>\n<p>Each website will be given a unique identifier automatically. To prevent\nguessing URLs and to add a slight increased level of security this is a\nrandom hash.<\/p>\n<p>The UUID is used for the database username and database name. In addition\nI'd recommend using this unique string for every public facing URL, eg\nan admin dashboard.<\/p>\n<p>By default tenancy will create a <code>uuid<\/code> automatically\nusing a UUID generator, you can replace that class in the\n<code>tenancy.php &gt; website &gt; random-id-generator<\/code>, make sure it implements\n<code>Hyn\\Tenancy\\Contracts\\Website\\UuidGenerator<\/code>.<\/p>\n<p>If you want to force your own UUID for the website, without creating a full\nfledged UUID generator, set the <code>uuid<\/code> property of your website before passing\nit to the repository.<\/p>\n<pre><code class=\"language-php\">$website = new Website;\n\/\/ Implement custom random hash using Laravels Str::random\n$website-&gt;uuid = str_random(10);\napp(WebsiteRepository::class)-&gt;create($website);\ndd($website-&gt;uuid); \/\/ Random string of length 10\n<\/code><\/pre>\n<h2 id=\"managing-connection\"><a href=\"#managing-connection\" class=\"anchor-link\"><\/a>Managing connection<\/h2>\n<p>Whenever you are using multiple databases, to separate tenants over different\nregions for instance, you can easily specify the connection with which tenancy\nshould create, update and delete tenant databases and users.<\/p>\n<pre><code class=\"language-php\">$website = new Website;\n$website-&gt;managed_by_database_connection = 'system.asia';\napp(WebsiteRepository::class)-&gt;create($website);\n\/\/ Information of website is stored in the default system connection,\n\/\/ the tenant database is created using the system.asia connection.\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Make sure the provided connection name is configured in your <code>config\/database.php<\/code>.<\/p><\/div>\n<h1 id=\"create-and-connect-hostname\"><a href=\"#create-and-connect-hostname\" class=\"anchor-link\"><\/a>Create and connect hostname<\/h1>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Models\\Hostname;\nuse Hyn\\Tenancy\\Contracts\\Repositories\\HostnameRepository;\n\n$hostname = new Hostname;\n$hostname-&gt;fqdn = 'luceos.demo.app';\napp(HostnameRepository::class)-&gt;attach($hostname, $website);\ndd($website-&gt;hostnames); \/\/ Collection with $hostname\n<\/code><\/pre>\n<h1 id=\"switch-to-new-tenant\"><a href=\"#switch-to-new-tenant\" class=\"anchor-link\"><\/a>Switch to new tenant<\/h1>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Environment;\n$tenancy = app(Environment::class);\n\n$tenancy-&gt;hostname($hostname);\n\n$tenancy-&gt;hostname(); \/\/ resolves $hostname as currently active hostname\n\n$tenancy-&gt;tenant($website); \/\/ switches the tenant and reconfigures the app\n\n$tenancy-&gt;website(); \/\/ resolves $website\n$tenancy-&gt;tenant(); \/\/ resolves $website\n\n$tenancy-&gt;identifyHostname(); \/\/ resets resolving $hostname by using the Request\n<\/code><\/pre>\n<h1 id=\"querying\"><a href=\"#querying\" class=\"anchor-link\"><\/a>Querying<\/h1>\n<p>In case you would like to query the database for hostnames or websites. Use the\n<code>query()<\/code> method of the repositories, this will return a <a href=\"https:\/\/laravel.com\/docs\/5.6\/queries\"><code>Illuminate\\Database\\Eloquent\\Builder<\/code><\/a>\ninstance.<\/p>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.2\/repositories.md"},{"title":"Filesystem","icon":"fal fa-hdd","path":"docs\/hyn\/5.2\/filesystem.md","slug":"filesystem","package":"hyn","version":"5.2","contents":"<p>You are now, most likely, aware about the <a href=\"structure\">directory structure<\/a>\navailable to tenants.<\/p>\n<h1 id=\"tenant-disk\"><a href=\"#tenant-disk\" class=\"anchor-link\"><\/a>Tenant disk<\/h1>\n<p>To access the directory of the active tenant, you can use the <code>tenant<\/code> disk.<\/p>\n<pre><code class=\"language-php\">Storage::disk('tenant')-&gt;put('readme.md', 'Hi John.');\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Tenants files are by default stored to <code>storage\/app\/tenancy<\/code>, but this can be reconfigured\nin the <code>tenancy.php<\/code> under <code>website &gt; disk<\/code>.<\/p><\/div>\n<p>Read more about disks on the <a href=\"https:\/\/laravel.com\/docs\/5.6\/filesystem\">Laravel documentation<\/a>.<\/p>\n<h1 id=\"directory\"><a href=\"#directory\" class=\"anchor-link\"><\/a>Directory<\/h1>\n<p>In order to assist with mutating these contents, you can use the\nDirectory class available in this package.<\/p>\n<pre><code class=\"language-php\">$directory = app(Hyn\\Tenancy\\Website\\Directory::class);\n<\/code><\/pre>\n<p>This class is set to use the tenant currently active, but also allows you to activate\nany other tenant whenever you need to using the <code>setWebsite(Website $website)<\/code> method.<\/p>\n<p>The Directory class implements <code>Illuminate\\Contracts\\Filesystem\\Filesystem<\/code> which offers\nthe same methods you are used to, including; <code>get<\/code>, <code>put<\/code> and <code>setVisibility<\/code>.<\/p>\n<h1 id=\"tenancy-directory\"><a href=\"#tenancy-directory\" class=\"anchor-link\"><\/a>Tenancy directory<\/h1>\n<p>In case you prefer having a higher level access to the files for tenants. You can use the ioc bound\nFilesystem.<\/p>\n<pre><code class=\"language-php\">\/** @var \\Illuminate\\Contracts\\Filesystem\\Filesystem $tenancy *\/\n$tenancy = app('tenancy.disk');\n<\/code><\/pre>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.2\/filesystem.md"},{"title":"Migrations","icon":"fal fa-pallet-alt","path":"docs\/hyn\/5.2\/migrations.md","slug":"migrations","package":"hyn","version":"5.2","contents":"<p>Migrations are extremely important in the Laravel ecosystem. To facilitate\ntenants with this flow, without interfering with its logic migration commands\nfor tenants have been given their own namespace <code>tenancy:<\/code>.<\/p>\n<h1 id=\"about-the-databasemigrations-path\"><a href=\"#about-the-databasemigrations-path\" class=\"anchor-link\"><\/a>About the database\/migrations path<\/h1>\n<p>It's not wise to store the tenants migrations inside your global\n<code>database\/migrations<\/code> directory. Laravel by default runs these migrations\nwhen calling the <code>php artisan migrate<\/code> command. Even though you can suggest\na connection during that command, it's much cleaner to store these migrations\ninside a separate directory, e.g. <code>database\/migrations\/tenant<\/code>.\nThe migrations for the system database can stay in <code>database\/migrations<\/code>.<\/p>\n<h1 id=\"default-migrations-for-new-tenants\"><a href=\"#default-migrations-for-new-tenants\" class=\"anchor-link\"><\/a>Default migrations for new tenants<\/h1>\n<p>If you want new tenants to be migrated by default, you can easily do so. In\nyour <code>tenancy.php<\/code> configuration set <code>db &gt; tenant-migrations-path<\/code> to a valid\nabsolute path and all your new tenants will run these migrations per default.<\/p>\n<pre><code class=\"language-php\">  \/\/ ..\n  &quot;tenant-migrations-path&quot; =&gt; database_path('migrations\/tenant'),\n  \/\/ ..\n<\/code><\/pre>\n<h1 id=\"default-seeds-for-newly-auto-migrated-tenants\"><a href=\"#default-seeds-for-newly-auto-migrated-tenants\" class=\"anchor-link\"><\/a>Default seeds for newly auto-migrated tenants<\/h1>\n<p>In case you would also like to seed the databases of your newly created\nand migrated tenants, you can enable <code>db &gt; tenant-seed-class<\/code> in your <code>tenancy.php<\/code>\nconfiguration file. Change this setting to a fully namespaced class name\nand the package will automatically run this seed after it has ran the\nautomatic migrations.<\/p>\n<h1 id=\"migration-related-commands\"><a href=\"#migration-related-commands\" class=\"anchor-link\"><\/a>Migration related commands<\/h1>\n<p>Obviously tenancy is also able to run migrations running through artisan.<\/p>\n<p>Tenancy has added the <code>--website_id[=WEBSITE_ID]<\/code> option to each of the following native Laravel migrate and seed\ncommand and namespaced it accordingly, for instance.<\/p>\n<ul>\n<li>\n<code>tenancy:migrate<\/code> - Run the database migrations<\/li>\n<li>\n<code>tenancy:migrate:refresh<\/code> - Reset and re-run all migrations<\/li>\n<li>\n<code>tenancy:migrate:reset<\/code> - Rollback all database migrations<\/li>\n<li>\n<code>tenancy:migrate:rollback<\/code> - Rollback the last database migration<\/li>\n<li>\n<code>tenancy:db:seed<\/code> - Seed the database with records<\/li>\n<\/ul>\n<p>The --website_id optional option accepts multiple values. Though optional, but if you leave the option out it will\nrun the command against all tenant. For example:<\/p>\n<ul>\n<li>\n<code>php artisan tenancy:migrate --website_id=1<\/code> to migrate just tenant website 1.<\/li>\n<li>\n<code>php artisan tenancy:migrate --website_id=1 --website_id=2<\/code> to migrate tenant website 1 &amp; 2.<\/li>\n<li>\n<code>php artisan tenancy:migrate<\/code> to migrate all tenant websites.<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>The website_id reflects the auto incremented <code>id<\/code> column of the Website and <strong>NOT<\/strong> the UUID.<\/p><\/div>\n<p>Please check the separate signatures for more information of valid arguments\nand options.<\/p>\n<div class=\"alert alert-info\"><p>Running tenancy:migrate without any path or realpath option and\nwithout having configured tenant-migrations-path will migrate your\ntenants with the files inside the database\/migrations directory.<\/p><\/div>\n<h1 id=\"reconstructing-tenant-databases\"><a href=\"#reconstructing-tenant-databases\" class=\"anchor-link\"><\/a>Reconstructing tenant databases<\/h1>\n<p>As long as your system database is intact, there's a way to recreate all tenant databases. You can use the <code>tenancy:recreate<\/code> artisan command to recreate all tenant databases that do not exist. The command will run the migrations and seeds according to your configuration in <code>tenancy.php<\/code>.<\/p>\n<div class=\"alert alert-info\"><p>Though the structure of all of your tenant databases will be recreated, the data in it won't.<\/p><\/div>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.2\/migrations.md"},{"title":"Connections","icon":"fal fa-warehouse-alt","path":"docs\/hyn\/5.2\/connections.md","slug":"connections","package":"hyn","version":"5.2","contents":"<h1 id=\"database-connections\"><a href=\"#database-connections\" class=\"anchor-link\"><\/a>Database Connections<\/h1>\n<p>One of the core aspects of tenancy is the database connection. Tenancy\ngives you access to two key database connections; <code>tenant<\/code> and <code>system<\/code>.<\/p>\n<h2 id=\"system-connection\"><a href=\"#system-connection\" class=\"anchor-link\"><\/a>System Connection<\/h2>\n<p>Out of the box, the package gives you a <code>system<\/code> database connection which acts as\nthe master database where <code>hostnames<\/code> and <code>websites<\/code> are stored.<\/p>\n<p>If for some reason you need to create an Eloquent Model that would need to connect\nto the system connection, you can apply the <code>Hyn\\Tenancy\\Traits\\UsesSystemConnection<\/code>\ntrait on your given Model. In doing so, the model\u2019s connection will always default to use the <code>system<\/code>.<\/p>\n<p>One reason for using the <code>system<\/code> connection is when you have data which you'd like\nto share between all tenants or which you need to influence the tenant identification\nprocess. For instance when you are creating an admin portal that would manage all of your\ntenants in one place.<\/p>\n<h2 id=\"tenant-connection\"><a href=\"#tenant-connection\" class=\"anchor-link\"><\/a>Tenant Connection<\/h2>\n<p>This is maybe the most used database connection. Data in use by single tenant instances,\nnot shared with others, is persisted into the database using the tenant connection. The\nimplementation of the tenant connection ensures that no tenant can access another tenants data.<\/p>\n<p>By using the <code>Hyn\\Tenancy\\Traits\\UsesTenantConnection<\/code> trait, the package will make sure\nthat it is using the right database connection.<\/p>\n<p>All tenant related models should use the <code>UsesTenantConnection<\/code> trait.<\/p>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.2\/connections.md"},{"title":"Validations","icon":"fal fa-file-check","path":"docs\/hyn\/5.2\/validation.md","slug":"validation","package":"hyn","version":"5.2","contents":"<h2 id=\"exists-and-unique-validation-rule\"><a href=\"#exists-and-unique-validation-rule\" class=\"anchor-link\"><\/a>Exists and Unique Validation Rule<\/h2>\n<p>Among all the built-in validation in Laravel, only the <a href=\"https:\/\/laravel.com\/docs\/5.6\/validation#rule-exists\">exists<\/a> and <a href=\"https:\/\/laravel.com\/docs\/5.6\/validation#rule-unique\">unique<\/a> validation rules interact with the database.<\/p>\n<p>We can leverage these two rules with tenancy by adding the connection parameter. Both use the same validation rule\nsignature which is <code>rule:connection.table,column<\/code>.<\/p>\n<p>So for example, to use <code>Exists (Database)<\/code> use <code>'email' =&gt; 'exists:tenant.staff,email'<\/code>. Where <code>tenant<\/code> is the <code>'tenant-connection-name'<\/code> you specified in your <code>tenancy.php<\/code> config file.<\/p>\n<p>You can change the <code>exists<\/code> keyword to <code>unique<\/code> to use the <code>unique<\/code> rule instead, eg: <code>'email' =&gt; 'unique:tenant.staff,email'<\/code>.<\/p>\n<div class=\"alert alert-info\"><p>Validating against the system database is possible using the method described above but replacing <code>tenant<\/code> with <code>system<\/code>.<\/p><\/div>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.2\/validation.md"},{"title":"Queues","icon":"fal fa-conveyor-belt","path":"docs\/hyn\/5.2\/queues.md","slug":"queues","package":"hyn","version":"5.2","contents":"<p>One of the strongest features of Laravel are its queues. One drawback of sending\nJobs into the Queue is that these are executed in a completely different process\ndepending on your queue configuration including redis and beanstalk.<\/p>\n<p>In order to assist you with tenant aware jobs, a <code>TenantAwareJob<\/code> is available to you.\nInstead of applying the <code>SerializesModel<\/code> trait as per suggestion in the Laravel\ndocumentation, you should use this Trait instead.<\/p>\n<pre><code class=\"language-php\">namespace App\\Jobs;\n\nuse Illuminate\\Bus\\Queueable;\nuse Hyn\\Tenancy\\Queue\\TenantAwareJob;\nuse Illuminate\\Queue\\InteractsWithQueue;\nuse Illuminate\\Contracts\\Queue\\ShouldQueue;\nuse Illuminate\\Foundation\\Bus\\Dispatchable;\n\nclass ProcessPodcast implements ShouldQueue\n{\n    use Dispatchable, InteractsWithQueue, Queueable, TenantAwareJob;\n    \n    \/\/ ..\n}\n<\/code><\/pre>\n<p>Once you've applied this custom trait the currently active tenant website will be\nparsed into the Job with property <code>$website_id<\/code>. During processing of the job\nthis property is read and the Environment is automatically setting that website\nas active tenant.<\/p>\n<p>In case you'd like to manually set a specific tenant for the job, use the <code>onTenant()<\/code>\nmethod:<\/p>\n<pre><code class=\"language-php\">dispatch(new ProcessPodcast($podcast)-&gt;onTenant($website));\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 18:29:42.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.2\/queues.md"},{"title":"Events","icon":"fal fa-hourglass-end","path":"docs\/hyn\/5.2\/events.md","slug":"events","package":"hyn","version":"5.2","contents":"<p>To create a fluid ecosystem around Laravel, this package uses events heavily.<\/p>\n<p>I highly recommend reading up on the native <a href=\"https:\/\/laravel.com\/docs\/5.6\/events\">events<\/a> by Laravel\nin case you are unaware about its purposes.<\/p>\n<h1 id=\"model-events\"><a href=\"#model-events\" class=\"anchor-link\"><\/a>Model events<\/h1>\n<p>Namespaces:<\/p>\n<ul>\n<li>\n<code>Hyn\\Tenancy\\Events\\Hostnames<\/code>\n<\/li>\n<li>\n<code>Hyn\\Tenancy\\Events\\Websites<\/code>\n<\/li>\n<\/ul>\n<p>All of the models have the following events per default, these should be\nself explanatory.<\/p>\n<ul>\n<li>Creating<\/li>\n<li>Created<\/li>\n<li>Updating<\/li>\n<li>Updated<\/li>\n<li>Deleting<\/li>\n<li>Deleted<\/li>\n<\/ul>\n<h2 id=\"websites\"><a href=\"#websites\" class=\"anchor-link\"><\/a>Websites<\/h2>\n<p>Namespace: 'Hyn\\Tenancy\\Events\\Websites'.<\/p>\n<ul>\n<li>Identified: a tenant website was identified.<\/li>\n<li>NoneFound: no tenant website was identified.<\/li>\n<li>Migrated: a website was auto migrated (not fired from console commands).<\/li>\n<li>Switched: the current tenant website was changed.<\/li>\n<\/ul>\n<h2 id=\"hostnames\"><a href=\"#hostnames\" class=\"anchor-link\"><\/a>Hostnames<\/h2>\n<p>Namespace: <code>Hyn\\Tenancy\\Events\\Hostnames<\/code>.<\/p>\n<p>The hostname models has a few additional events:<\/p>\n<ul>\n<li>Attached: the hostname was attached to a website.<\/li>\n<li>Detached: the hostname was removed from a website.<\/li>\n<li>Identified: the hostname is identified based on the request.<\/li>\n<li>NoneFound: no hostname was found during identification.<\/li>\n<li>Redirected: the hostname is configured to redirect to another url.<\/li>\n<li>Secured: the hostname is configured to upgrade the request to https.<\/li>\n<li>Switched: currently active hostname was changed.<\/li>\n<li>UnderMaintenance: the hostname is configured to be in maintenance.<\/li>\n<\/ul>\n<h1 id=\"database\"><a href=\"#database\" class=\"anchor-link\"><\/a>Database<\/h1>\n<p>Namespace: <code>Hyn\\Tenancy\\Events\\Database<\/code>.<\/p>\n<ul>\n<li>Creating<\/li>\n<li>Created<\/li>\n<li>Deleting<\/li>\n<li>Deleted<\/li>\n<li>Renaming<\/li>\n<li>Renamed<\/li>\n<li>ConfigurationLoading: the configuration for a tenant database connection\nis loading.<\/li>\n<li>ConfigurationLoaded: the configuration for a tenant database connection\nwas loaded.<\/li>\n<li>ConnectionSet: a connection was set and possibly an old one purged.<\/li>\n<\/ul>\n<h1 id=\"webservers\"><a href=\"#webservers\" class=\"anchor-link\"><\/a>Webservers<\/h1>\n<p>Namespace: <code>Hyn\\Tenancy\\Events\\Webservers<\/code>.<\/p>\n<ul>\n<li>ConfigurationSaved: the configuration for the webserver was saved to disk.<\/li>\n<\/ul>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.2\/events.md"},{"title":"Cache","icon":"fal fa-window-restore","path":"docs\/hyn\/5.2\/cache.md","slug":"cache","package":"hyn","version":"5.2","contents":"<p>Currently the Laravel cache will use the same cache key for all tenants.\nThis can and will cause issues in the long run. The config key for tenants\nshould be automatically changed and the ability to disable overriding the cache key should be configurable inside <code>tenancy.php<\/code>.<\/p>\n<p>The following example is an easy implementation to allow per-tenant prefixes.<\/p>\n<p>First turn off auto-discovery for hyn\/multi-tenant.<\/p>\n<pre><code class=\"language-json\">&quot;extra&quot;: {\n        &quot;laravel&quot;: {\n            &quot;dont-discover&quot;: [\n              &quot;hyn\/multi-tenant&quot;\n            ]\n        }\n    },\n<\/code><\/pre>\n<p>Now run <code>composer update<\/code> with <code>php artisan package:discover<\/code>.<\/p>\n<p>Add a <code>TenancyCacheServiceProvider<\/code> with these contents\n(in this example <code>app\/Providers\/TenancyCacheServiceProvider.php<\/code>):<\/p>\n<pre><code class=\"language-php\">namespace App\\Providers;\n\nuse Illuminate\\Cache\\CacheServiceProvider;\nuse Illuminate\\Support\\Facades\\DB;\nuse Illuminate\\Support\\Facades\\Cache;\nuse Illuminate\\Cache\\RedisStore;\n\nclass TenancyCacheServiceProvider extends CacheServiceProvider\n{\n    \/**\n     * Indicates if loading of the provider is deferred.\n     *\n     * @var bool\n     *\/\n    protected $defer = false;\n    \n    public function boot()\n    {\n        Cache::extend('redis_tenancy', function ($app) {\n            if (PHP_SAPI === 'cli') {\n                $uuid = $app['config']['driver'];\n            } else {\n                \/\/ ok, this is basically a hack to set the redis cache store\n                \/\/ prefix to the UUID of the current website being called\n                $fqdn = $_SERVER['SERVER_NAME'];\n\n                $uuid = DB::table('hostnames')\n                    -&gt;select('websites.uuid')\n                    -&gt;join('websites', 'hostnames.website_id', '=', 'websites.id')\n                    -&gt;where('fqdn', $fqdn)\n                    -&gt;value('uuid');\n            }\n\n            return Cache::repository(new RedisStore(\n                $app['redis'],\n                $uuid,\n                $app['config']['cache.stores.redis.connection']\n            ));\n        });\n    }\n}\n<\/code><\/pre>\n<p>This does not require a new Cache driver, as it's re-using\nthe existing Redis driver. All this does is override the default prefix and\nallows you to set a custom cache driver in <code>config\/cache.php<\/code>:<\/p>\n<div class=\"alert alert-info\"><p>Make sure to run <code>composer update<\/code> and <code>php artisan package:discover<\/code> before this step or else you will get &quot;redis_tenancy driver not found&quot; error.<\/p><\/div>\n<pre><code class=\"language-php\">'redis' =&gt; [\n    'driver'     =&gt; 'redis_tenancy',\n    'connection' =&gt; 'default',\n],\n<\/code><\/pre>\n<p>Now manually add hyn\/multi-tenant provider to your app.php under 'providers'<br \/>\nMake sure to disable Laravel's CacheServiceProvider as TenancyCacheServiceProvider extends that one.<\/p>\n<pre><code class=\"language-php\">'providers' =&gt; [\n    \/\/Tenant aware redis cache\n    App\\Providers\\TenancyCacheServiceProvider::class,\n    \/\/ Hyn multi tenancy.\n    Hyn\\Tenancy\\Providers\\TenancyProvider::class,\n    Hyn\\Tenancy\\Providers\\WebserverProvider::class,\n    ...\n    #Illuminate\\Cache\\CacheServiceProvider::class, \/\/this is now disabled\n    ...\n],\n<\/code><\/pre>\n<p>Now you can use CACHE and SESSION redis drivers<\/p>\n<div class=\"alert alert-info\"><p>Note: If you are using spatie\/laravel-permission package remove that package from auto-discovery same as hyn\/multi-tenant and add the provider below Tenancy providers.<\/p><\/div>\n","updated_at":{"date":"2020-07-18 18:29:42.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.2\/cache.md"},{"title":"Logging","icon":"fal fa-book","path":"docs\/hyn\/5.2\/logging.md","slug":"logging","package":"hyn","version":"5.2","contents":"<p>Especially in production you might want to split the default laravel log by tenants.\nTenancy ships with a custom tenant aware logger which you can register in the logger config.<\/p>\n<ul>\n<li>If a tenant is detected it will create a <code>logs<\/code> folder within the tenant directory:\n<code>storage\/app\/tenancy\/tenants\/&lt;tenant uuid&gt;\/logs\/&lt;log_level&gt;_&lt;YYYY&gt;-&lt;MM&gt;-&lt;DD&gt;.log<\/code>\n<\/li>\n<li>If no tenant is detected it will store the log file to:\n<code>storage\/logs\/<\/code>.<\/li>\n<\/ul>\n<p>Add a new <code>tenant<\/code> channel to the channels array in your <code>config\/logging.php<\/code> like below:<\/p>\n<pre><code class=\"language-php\">\/\/ ...\n'channels' =&gt; [\n        \/\/ ...\n        'tenant' =&gt; [\n            'driver' =&gt; 'custom',\n            'via' =&gt; \\Hyn\\Tenancy\\Logging\\TenantAwareLogger::class,\n            'level' =&gt; 'debug',\n        ],\n\/\/ ...\n<\/code><\/pre>\n<p>Then just change the 'single' channel to 'tenant' channel your stack channel:<\/p>\n<pre><code class=\"language-php\">\/\/ ...\n'stack' =&gt; [\n            'driver' =&gt; 'stack',\n            'channels' =&gt; ['tenant'],\n        ],\n\/\/ ...\n<\/code><\/pre>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.2\/logging.md"},{"title":"Tinker","icon":"fal fa-screwdriver","path":"docs\/hyn\/5.2\/tinker.md","slug":"tinker","package":"hyn","version":"5.2","contents":"<h1 id=\"tenant-aware-tinker-command\"><a href=\"#tenant-aware-tinker-command\" class=\"anchor-link\"><\/a>Tenant Aware Tinker Command<\/h1>\n<p>This article describes how to enable tenant awareness for the native Laravel tinker command.<\/p>\n<p>First, create a trait named <code>MutatesTinkerCommand<\/code> with the following content:<\/p>\n<pre><code class=\"language-php\">namespace App\\Traits;\n\nuse Hyn\\Tenancy\\Contracts\\Repositories\\WebsiteRepository;\nuse Hyn\\Tenancy\\Database\\Connection;\nuse Illuminate\\Database\\Eloquent\\ModelNotFoundException;\nuse Symfony\\Component\\Console\\Exception\\RuntimeException;\nuse Symfony\\Component\\Console\\Input\\InputOption;\n\ntrait MutatesTinkerCommand\n{\n    \/**\n     * @var Connection\n     *\/\n    private $connection;\n\n    \/**\n     * @var WebsiteRepository\n     *\/\n    private $websites;\n\n    public function __construct()\n    {\n        parent::__construct();\n        $this-&gt;setName('tenancy:' . $this-&gt;getName());\n        $this-&gt;websites = app(WebsiteRepository::class);\n        $this-&gt;connection = app(Connection::class);\n    }\n\n    \/**\n     * Execute the console command.\n     *\n     * @return void\n     *\n     * @throws \\Hyn\\Tenancy\\Exceptions\\ConnectionException\n     *\/\n    public function handle()\n    {\n        $website_id = $this-&gt;option('website_id');\n        try{\n            $website = $this-&gt;websites-&gt;query()-&gt;where('id', $website_id)-&gt;firstOrFail();\n            $this-&gt;connection-&gt;set($website);\n            $this-&gt;info('Running Tinker on website_id: ' . $website_id);\n\n            parent::handle();\n            $this-&gt;connection-&gt;purge();\n        } catch (ModelNotFoundException $e) {\n            throw new RuntimeException(sprintf('The tenancy website_id=%d does not exist.', $website_id));\n        }\n    }\n\n    protected function getOptions()\n    {\n        return array_merge([$this-&gt;addWebsiteOption()], parent::getOptions());\n    }\n\n    protected function addWebsiteOption()\n    {\n        return ['website_id', null, InputOption::VALUE_REQUIRED, 'The tenancy website_id (not uuid) to tinker specifically.', null];\n    }\n}\n<\/code><\/pre>\n<p>You can only tinker on one database at a time, therefore, the <code>website_id<\/code> needs to be a required option. Utilizing the <code>AddWebsiteFilterOnCommand<\/code> trait available in the Tenancy package would not work in this instance; it is tailored to run processes on multiple websites and makes the <code>website_id<\/code> parameter optional.<\/p>\n<p>Second, create a new console command <code>TinkerCommand<\/code> that uses the trait above.<\/p>\n<pre><code class=\"language-php\">namespace App\\Console\\Tinker;\n\nuse Laravel\\Tinker\\Console\\TinkerCommand as BaseCommand;\nuse App\\Traits\\MutatesTinkerCommand;\n\nclass TinkerCommand extends BaseCommand\n{\n    use MutatesTinkerCommand;\n}\n<\/code><\/pre>\n<p>Third, add the <code>TinkerCommand<\/code> to your Console Kernel <code>$commands<\/code> array.<\/p>\n<pre><code class=\"language-php\">namespace App\\Console;\n\nuse Illuminate\\Console\\Scheduling\\Schedule;\nuse Illuminate\\Foundation\\Console\\Kernel as ConsoleKernel;\nuse App\\Console\\Tinker\\TinkerCommand;\n\nclass Kernel extends ConsoleKernel\n{\n    \/**\n     * The Artisan commands provided by your application.\n     *\n     * @var array\n     *\/\n    protected $commands = [\n        TinkerCommand::class,\n    ];\n    ...\n}\n<\/code><\/pre>\n<p>Now we have created a new <code>tenancy:tinker<\/code> artisan command. The <code>tenancy:tinker<\/code> requires the <code>--website_id=<\/code> option as a parameter. So, in order to run tinker on, let\u2019s say with a <code>website_id<\/code> of 1, you\u2019ll need to run:<\/p>\n<p><code>php artisan tenancy:tinker --website_id=1<\/code><\/p>\n<pre><code class=\"language-sh\">\u2601  app [development] \u26a1  php artisan tenancy:tinker --website_id=1\nRunning Tinker on website_id: 1\nPsy Shell v0.9.6 (PHP 7.2.7 \u2014 cli) by Justin Hileman\n&gt;&gt;&gt;\n<\/code><\/pre>\n<p>It will throw an error if the <code>--website_id=<\/code> option is missing:<\/p>\n<pre><code class=\"language-sh\">\u2601  app [development] \u26a1  php artisan tenancy:tinker\n\n\n  The tenancy website_id=0 does not exist.\n\n\n\u2601  app [development] \u26a1\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 18:29:42.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.2\/tinker.md"}]},{"name":"webserver","links":["apache","nginx"],"slug":"webserver","articles":[{"title":"Apache","icon":"fal fa-server","path":"docs\/hyn\/5.2\/apache.md","slug":"apache","package":"hyn","version":"5.2","contents":"<h1 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h1>\n<p>Tenancy natively integrates with the Apache webserver. For that to work you need\nto do a minor configuration.<\/p>\n<p>Edit the <code>\/etc\/apache2\/apache2.conf<\/code> and below the last <code>IncludeOptional<\/code> statement\nadd:<\/p>\n<pre><code class=\"language-apacheconfig\">IncludeOptional &lt;path&gt;\/*.conf\n<\/code><\/pre>\n<p>Where <code>&lt;path&gt;<\/code> has to be replaced by the location of your vhost files generated by this package.<\/p>\n<div class=\"alert alert-info\"><p>Your vhost files are saved by default inside the <code>storage\/app\/tenancy\/webserver\/apache<\/code> and\ncan be reconfigured in the <code>webserver.php<\/code> configuration file.<\/p><\/div>\n<p>Make sure to reload apache afterwards:<\/p>\n<pre><code class=\"language-bash\">sudo apache2ctl graceful\n<\/code><\/pre>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.2\/apache.md"},{"title":"Nginx","icon":"fal fa-server","path":"docs\/hyn\/5.2\/nginx.md","slug":"nginx","package":"hyn","version":"5.2","contents":"<h1 id=\"set-up\"><a href=\"#set-up\" class=\"anchor-link\"><\/a>Set up<\/h1>\n<p>You need to set up your own PHP FPM. The preferred way of running php is through a <a href=\"https:\/\/coderwall.com\/p\/hmsr5a\/have-php-fpm-listen-on-unix-socket\">socket<\/a> by\nconfiguring the <code>listen<\/code> value in your pool correctly. Make sure to copy the path to your\nsock and update your <code>webserver.php<\/code> configuration file in your app to reflect that value, for instance:<\/p>\n<pre><code class=\"language-php\">    \/**\n     * Nginx webserver support.\n     *\n     * @see http:\/\/nginx.org\n     *\/\n    'nginx' =&gt; [\n        \/\/ ..\n\n        \/**\n         * The php sock to be used.\n         *\/\n        'php-sock' =&gt; 'unix:\/var\/run\/php\/php-fpm.sock',\n        \n        \/\/ ..\n    ],\n<\/code><\/pre>\n<h1 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h1>\n<p>Tenancy natively integrates with the Nginx webserver. For that to work you need\nto do a minor configuration.<\/p>\n<p>Edit the <code>\/etc\/nginx\/nginx.conf<\/code> and below the last <code>include<\/code> statement\nadd:<\/p>\n<pre><code class=\"language-apacheconfig\">include &lt;path&gt;\/*.conf;\n<\/code><\/pre>\n<p>Where <code>&lt;path&gt;<\/code> has to be replaced by the location of your vhost files generated by this package.<\/p>\n<div class=\"alert alert-info\"><p>Your vhost files are saved by default inside the <code>storage\/app\/tenancy\/webserver\/nginx<\/code> and\ncan be reconfigured in the <code>webserver.php<\/code> configuration file.<\/p><\/div>\n<p>Make sure to restart nginx afterwards:<\/p>\n<pre><code class=\"language-bash\">sudo systemctl restart nginx\n<\/code><\/pre>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.2\/nginx.md"}]}],"hidden_articles":{"index":{"title":"Hyn documentation","path":"docs\/hyn\/5.2\/index.md","slug":"index","package":"hyn","version":"5.2","contents":"","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.2\/index.md"}}},"5.1":{"slug":"5.1","name":5.1,"status":"Deprecated","suggestion_using":null,"branch":5.1,"package":"hyn","tree":[{"name":"getting started","links":["requirements","installation","configuration"],"slug":"getting-started","articles":[{"title":"Requirements","icon":"fal fa-clipboard-check","path":"docs\/hyn\/5.1\/requirements.md","slug":"requirements","package":"hyn","version":"5.1","contents":"<ul>\n<li>Latest Laravel Long Term Support (5.5) or latest (5.6).<\/li>\n<li>PHP 7.0 or up, check the requirements for your Laravel version.<\/li>\n<li>Preferably Ubuntu. But most linux-based operating systems should work.<\/li>\n<li>Apache 2.4+ or Nginx 1.12+.<\/li>\n<li>MySQL 5.7+, MariaDB 10.1.13+ or PostgreSQL 9+.<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>Please note that MySQL limits username and database length to 32,\nenable in the <code>tenancy.php<\/code> configuration file:  <code>website &gt; uuid-limit-length-to-32<\/code>\nto fix this.<\/p><\/div>\n<h1 id=\"elevated-database-user\"><a href=\"#elevated-database-user\" class=\"anchor-link\"><\/a>Elevated database user<\/h1>\n<p>Tenancy requires a system connection that allows creating new databases for her\ntenants. In order to do so we need to have a database user with elevated\npermissions.<\/p>\n<p>A user for both <a href=\"https:\/\/mariadb.com\/kb\/en\/library\/grant\/#the-grant-option-privilege\">MariaDB or MySQL<\/a> and <a href=\"https:\/\/www.postgresql.org\/docs\/9.6\/static\/sql-grant.html\">PostgreSQL<\/a> would require the &quot;GRANT OPTION&quot; to be\napplied. You can either use the root user (for PostgreSQL that is user postgres) or create\nyour own (recommended):<\/p>\n<p>For MariaDB:<\/p>\n<pre><code class=\"language-sql\">CREATE DATABASE IF NOT EXISTS tenancy;\nCREATE USER IF NOT EXISTS tenancy@localhost IDENTIFIED BY 'someRandomPassword';\nGRANT ALL PRIVILEGES ON *.* TO tenancy@localhost WITH GRANT OPTION;\n<\/code><\/pre>\n<p>For PostgreSQL:<\/p>\n<pre><code class=\"language-sql\">CREATE DATABASE tenancy;\nCREATE USER tenancy WITH CREATEDB CREATEROLE PASSWORD 'someRandomPassword';\nGRANT ALL PRIVILEGES ON tenancy to tenancy WITH GRANT OPTION;\n<\/code><\/pre>\n<p>Make sure you configure this user as your system connection in your <code>database.php<\/code>.\nUnder connections:<\/p>\n<pre><code class=\"language-php\">'system' =&gt; [\n    'driver' =&gt; 'mysql',\n    'host' =&gt; env('TENANCY_HOST', '127.0.0.1'),\n    'port' =&gt; env('TENANCY_PORT', '3306'),\n    'database' =&gt; env('TENANCY_DATABASE', 'tenancy'),\n    'username' =&gt; env('TENANCY_USERNAME', 'tenancy'),\n    'password' =&gt; env('TENANCY_PASSWORD', ''),\n    'unix_socket' =&gt; env('DB_SOCKET', ''),\n    'charset' =&gt; 'utf8mb4',\n    'collation' =&gt; 'utf8mb4_unicode_ci',\n    'prefix' =&gt; '',\n    'strict' =&gt; true,\n    'engine' =&gt; null,\n]\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>There is no need to configure the <code>tenant<\/code> connection in the <code>database.php<\/code>\nconfiguration file. This connection is set up automatically during runtime. Pre-\nconfiguring this connection may cause unwanted behaviour.<\/p><\/div>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.1\/requirements.md"},{"title":"Installation","icon":"fal fa-arrow-alt-to-bottom","path":"docs\/hyn\/5.1\/installation.md","slug":"installation","package":"hyn","version":"5.1","contents":"<p>Run the composer command to add the tenancy package as dependency:<\/p>\n<pre><code class=\"language-bash\">composer require hyn\/multi-tenant:5.1.*\n<\/code><\/pre>\n<p>Laravel offers <a href=\"https:\/\/medium.com\/@taylorotwell\/package-auto-discovery-in-laravel-5-5-ea9e3ab20518\">package auto discovery<\/a>\nin version 5.5. So that's all you need to do, no need to register any\nservice providers manually in your <code>config\/app.php<\/code>.<\/p>\n<p>Optionally you can publish the configuration files for tenancy. This allows you to configure\nthe system database before migrating tables into your tenancy system database, run:<\/p>\n<pre><code class=\"language-bash\">php artisan vendor:publish --tag=tenancy\n<\/code><\/pre>\n<p>Then edit <code>config\/tenancy.php<\/code> accordingly.<\/p>\n<p>Now enable the tenancy environment by running the installation procedure;<\/p>\n<pre><code class=\"language-bash\">php artisan tenancy:install\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>The <code>tenancy:install<\/code> command migrates the system tables.<\/p><\/div>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.1\/installation.md"},{"title":"Configuration","icon":"fal fa-sliders-v","path":"docs\/hyn\/5.1\/configuration.md","slug":"configuration","package":"hyn","version":"5.1","contents":"<h1 id=\"system-connection\"><a href=\"#system-connection\" class=\"anchor-link\"><\/a>System connection<\/h1>\n<p>Tenancy needs a database connection with elevated permission to create databases\nto be used by its tenants.<\/p>\n<p>Make sure you set up this connection by following the instructions\nin the <a href=\"requirements#elevated-database-user\">requirements<\/a>, it also explains how to publish\nthe configuration files.<\/p>\n<h1 id=\"configuration-files\"><a href=\"#configuration-files\" class=\"anchor-link\"><\/a>Configuration Files<\/h1>\n<p>The inline documentation in both files should be self explanatory. Nevertheless,\nI've listed some of the basic settings below.<\/p>\n<h2 id=\"tenancyphp\"><a href=\"#tenancyphp\" class=\"anchor-link\"><\/a>tenancy.php<\/h2>\n<p>The tenancy configuration file holds every setting related to tenants. This includes how to generate a unique\nwebsite, but also how database connections are set up. In addition it allows for;<\/p>\n<ul>\n<li>custom random id logic.<\/li>\n<li>manual tenant identification.<\/li>\n<li>on what disk (see <code>config\/filesystems.php<\/code>) to store the tenant specific files.<\/li>\n<li>and much, much more.<\/li>\n<\/ul>\n<h2 id=\"webserverphp\"><a href=\"#webserverphp\" class=\"anchor-link\"><\/a>webserver.php<\/h2>\n<p>With the webserver.php one can more closely fine tune integration of this package with your webserver.\nPorts, vhost configuration files and the location to save these files are all contained in this config.<\/p>\n<p>In general you can expect the following settings for each webserver;<\/p>\n<ul>\n<li>enabled; whether the service is enabled and thus the package will write files for it and reload the service.<\/li>\n<li>ports; which ports we should use, this is required to configure the vhost files properly.<\/li>\n<li>generator; the class handling the generation of vhost files.<\/li>\n<li>disk; the disk to write the vhost files to, you can have it point to any configured disk in your <code>config\/filesystems.php<\/code>.<\/li>\n<li>paths; specific locations we need to know about to in order to mutate the webserver behavior.<\/li>\n<\/ul>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.1\/configuration.md"}]},{"name":"tenant principles","links":["concepts","structure","identification","fallback","middleware"],"slug":"tenant-principles","articles":[{"title":"Concepts","icon":"fal fa-vials","path":"docs\/hyn\/5.1\/concepts.md","slug":"concepts","package":"hyn","version":"5.1","contents":"<h1 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h1>\n<p>The principle of multi tenancy is about a single instance of software running\non a server and serving multiple tenants. The interpretation of such a tenancy\napplication is quite diverse, the possible implementations is even without\nboundary.<\/p>\n<p>Hyn tenancy is focused to provide a drop-in solution for Laravel without\nsacrificing flexibility or hacks of the Laravel ecosystem.<\/p>\n<p>This packages holds onto one core belief though; <strong>the tenant is the website<\/strong>, so;<\/p>\n<ul>\n<li>A tenant is a website.<\/li>\n<li>A website can have zero or more hostnames.\n<ul>\n<li>A website is identified when a specific hostname is requested.<\/li>\n<\/ul>\n<\/li>\n<li>Customers allow for easier grouping.\n<ul>\n<li>Using customers is optional.<\/li>\n<li>A website can belong to a customer.<\/li>\n<li>A hostname can belong to a customer.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<h1 id=\"website\"><a href=\"#website\" class=\"anchor-link\"><\/a>Website<\/h1>\n<p>You can think of a website as a single mirror of the code base, re-using your default\napp code. In addition it is also possible to have very <a href=\"structure\">tenant specific logic<\/a>,\nfor instance routes, a vendor folder, media and language files.<\/p>\n<h1 id=\"hostname\"><a href=\"#hostname\" class=\"anchor-link\"><\/a>Hostname<\/h1>\n<p>A hostname is a <a href=\"https:\/\/www.godaddy.com\/garage\/industry\/tech-svcs\/it\/whats-a-fully-qualified-domain-name-fqdn-and-whats-it-good-for\/\">Fully Qualified Domain Name<\/a> (for instance sub.example.com).\nYour application handles incoming requests to specific hostnames. Tenancy inspects\nthese requests and <a href=\"identification\">sets up the tenancy environment<\/a> according to a\nmatching hostname or default fallback.<\/p>\n<h1 id=\"customer\"><a href=\"#customer\" class=\"anchor-link\"><\/a>Customer<\/h1>\n<p>A customer is the binding entity between websites and hostnames. They allow freely\ncombining the two. A website and hostname can have a customer, they don't need to be\nthe same by the way.<\/p>\n<div class=\"alert alert-info\"><p>Using customers in your application is optional.<\/p><\/div>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.1\/concepts.md"},{"title":"Structure","icon":"fal fa-sitemap","path":"docs\/hyn\/5.1\/structure.md","slug":"structure","package":"hyn","version":"5.1","contents":"<h1 id=\"introduction\"><a href=\"#introduction\" class=\"anchor-link\"><\/a>Introduction<\/h1>\n<p>The location of the tenant specific files is configured inside the <code>config\/tenancy.php<\/code>\nfile under <code>website &gt; disk<\/code>. By default tenant files\nare stored in <code>storage\/app\/tenancy\/tenants<\/code>.<\/p>\n<p>Inside this tenant directory you are able to override global logic by\ngenerating the necessary files. Check the tenancy configuration file under\n<code>folders<\/code> to see which ones are enabled by default.<\/p>\n<h2 id=\"config\"><a href=\"#config\" class=\"anchor-link\"><\/a>Config<\/h2>\n<p>Any php files stored inside a <code>config\/<\/code> directory of the tenant is read\nduring runtime. Existing configuration values are replaced and new ones\nare appended.<\/p>\n<p>A great use case for this feature is the ability to configure client\nspecific mail settings.<\/p>\n<p>The tenancy configuration file allows you to refuse overrides of specific\nconfiguration settings using the <code>folders &gt; config &gt; blacklist<\/code> setting.\nBy default it disallows database, tenancy and webserver changes.<\/p>\n<h2 id=\"routes\"><a href=\"#routes\" class=\"anchor-link\"><\/a>Routes<\/h2>\n<p>Create a <code>routes.php<\/code> file inside your tenant directory to configure\nnew routes during runtime. Using a configurable prefix, any unique\nurl's will be matched for this specific tenant only.<\/p>\n<h2 id=\"trans\"><a href=\"#trans\" class=\"anchor-link\"><\/a>Trans<\/h2>\n<p>New translations can be easily added by creating a <code>lang\/<\/code> folder.\nThe native Laravel translator will parse any files contained within\nto be used in the application of this specific tenant.<\/p>\n<p>You are able to specify whether these language files should override\nthe global, system-wide translation. In case you decide against that\nfeel free to set up a translation namespace.<\/p>\n<h2 id=\"views\"><a href=\"#views\" class=\"anchor-link\"><\/a>Views<\/h2>\n<p>Additional or overriding views is possible by creating a <code>views\/<\/code> folder\ninside the tenant directory. There are three possible scenarios to\nconfigure how views are picked up by Laravel:<\/p>\n<ol>\n<li>By adding views inside the global namespace, overriding existing\nglobal views.<\/li>\n<li>By adding views inside the global namespace, but where existing\nglobal views take precedence.<\/li>\n<li>By adding views inside their own namespace.<\/li>\n<\/ol>\n<h2 id=\"vendor\"><a href=\"#vendor\" class=\"anchor-link\"><\/a>Vendor<\/h2>\n<p>A very powerful addition is the ability to inject new packages and code.\nWhenever the tenant directory has a <code>vendor\/autoload.php<\/code> file it will\nbe loaded during runtime. Using that specific file allows you to fully\nutilize the power of composer inside your tenant directories.<\/p>\n<div class=\"alert alert-info\"><p>Please be aware that no compatibility checks are executed against your app.\nIdentifying whether a composer conflict could happen is something you should test\noutside production environments.<\/p><\/div>\n<h2 id=\"media\"><a href=\"#media\" class=\"anchor-link\"><\/a>Media<\/h2>\n<p>The media folder can be used by creating a <code>media\/<\/code> folder inside the\ntenant directory. Files inside that directory will become automatically\navailable as a public directory inside an equally named directory <code>media\/<\/code>.<\/p>\n<p>Eg, storing a file <code>media\/bg.jpg<\/code> will allow you to use <code>\/media\/bg.jpg<\/code> inside\nyour html. This applies to any file you store.<\/p>\n<h2 id=\"media-webserver\"><a href=\"#media-webserver\" class=\"anchor-link\"><\/a>\/media webserver<\/h2>\n<p>An alias is set up binding the private tenant media directory to the public\nmedia directory. This is implemented using the auto generated web server\nconfiguration files for apache and nginx.<\/p>\n<h2 id=\"media-fallback-controller\"><a href=\"#media-fallback-controller\" class=\"anchor-link\"><\/a>\/media fallback controller<\/h2>\n<p>In case you're not using the webserver vhost configuration files provided\nby this package you can choose to map the <code>MediaController<\/code> to the path, eg:<\/p>\n<pre><code class=\"language-php\">Route::get('\/media\/{path}', \\Hyn\\Tenancy\\Controllers\\MediaController::class)\n    -&gt;where('path', '.+')\n    -&gt;name('tenant.media');\n<\/code><\/pre>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.1\/structure.md"},{"title":"Identification","icon":"fal fa-street-view","path":"docs\/hyn\/5.1\/identification.md","slug":"identification","package":"hyn","version":"5.1","contents":"<p>During runtime, the <code>Environment<\/code> class is bound into Laravels container. The\ntenancy environment holds one single responsibility, which is telling our code\nwhat hostname was currently identified and resolving the related website and\ncustomer.<\/p>\n<h1 id=\"early-identification\"><a href=\"#early-identification\" class=\"anchor-link\"><\/a>Early identification<\/h1>\n<p>By default tenancy will identify the tenant after all Middleware has been processed.\nPreviously when could simply resolve the Environment class through the container\nto force identification of the tenant early on. If you want the package to handle\nthis on your behalf you can now simply enable the <code>early-identification<\/code> flag in\nyour <code>tenancy.php<\/code> configuration file under <code>hostname<\/code>.<\/p>\n<h1 id=\"manual-identification\"><a href=\"#manual-identification\" class=\"anchor-link\"><\/a>Manual identification<\/h1>\n<p>The environment can be used to manually set any active tenant. This is one of the\nreasons why the tenancy configuration file has the <code>hostname &gt; auto-identification<\/code>\nsetting. Turn it off to implement your own tenancy identification.<\/p>\n<p>Manual identification is pretty straightforward. Take for example the following\nsnippet for a custom (app) service provider:<\/p>\n<pre><code class=\"language-php\">public function boot()\n{\n    $environment = $this-&gt;app-&gt;make(\\Hyn\\Tenancy\\Environment::class);\n\n    \/\/ Retrieve your hostname\n\n    \/\/ Now switch the environment to a new tenant.\n    $environment-&gt;hostname($hostname);\n}\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Be wary about switching tenants. I recommend switching only once during code\nexecution. Use a background job to run mass changes on tenant databases.<\/p><\/div>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.1\/identification.md"},{"title":"Fallback","excerpt":"Configure a landing page using different approaches","icon":"fal fa-barcode-scan","path":"docs\/hyn\/5.1\/fallback.md","slug":"fallback","package":"hyn","version":"5.1","contents":"<p>There are several ways to organize a fallback domain. These are commonly used to offer\na landing page or admin area for your clients to configure their tenant website.<\/p>\n<h1 id=\"routing-with-domain\"><a href=\"#routing-with-domain\" class=\"anchor-link\"><\/a>Routing with domain<\/h1>\n<p>One of the easiest solutions is using the <code>::domain()<\/code> option in routing called\n<a href=\"https:\/\/laravel.com\/docs\/5.5\/routing#route-group-sub-domain-routing\">sub domain routing in Laravel<\/a>.<\/p>\n<pre><code class=\"language-php\">Route::domain('master.your.app')-&gt;group(function () {\n    \/\/ .. your landing page routes\n});\n<\/code><\/pre>\n<h1 id=\"create-a-tenant-as-fallback\"><a href=\"#create-a-tenant-as-fallback\" class=\"anchor-link\"><\/a>Create a tenant as fallback<\/h1>\n<p>Another quick method is to simply seed a default tenant that has a specific\nhostname. Set the environment <code>TENANCY_DEFAULT_HOSTNAME<\/code> to the exact FQDN used\nfor that tenant.<\/p>\n<p>Now every time no other tenant was identified, it will revert to this tenant. A\ndrawback of this method is the need to set up a tenant website.<\/p>\n<h1 id=\"disabling-abort-to-pass-through\"><a href=\"#disabling-abort-to-pass-through\" class=\"anchor-link\"><\/a>Disabling abort to pass through<\/h1>\n<p>Disable in the <code>tenancy.php<\/code> configuration file the <code>abort-without-identified-hostname<\/code> option\nby setting it to <code>false<\/code>. This will prevent tenancy from throwing a 404 (not found) whenever\nit failed to identify a tenant.<\/p>\n<p>Depending on how you set up your app, the code will now pass through to any registered routes.\nFor applications that have global routes defined for tenant specific functionality, you'll\nrun into the issue that no &quot;tenant&quot; connection was defined.<\/p>\n<p>An easy solution to this is writing a custom middleware that sets up the tenant database configuration\nfor the specific landing page site. Something like the following might already be sufficient;<\/p>\n<pre><code class=\"language-php\">namespace App\\Http\\Middleware;\n\nuse Closure;\nuse Illuminate\\Http\\Request;\n\nclass FallbackHandler\n{\n    public function handle(Request $request, Closure $next)\n    {\n        if ($request-&gt;getHost() === env('FALLBACK_HOST')) {\n            config(['database.connections.tenant' =&gt; [\n                'driver' =&gt; 'mysql',\n                'host' =&gt; env('DB_HOST', '127.0.0.1'),\n                'port' =&gt; env('DB_PORT', '3306'),\n                'database' =&gt; env('DB_DATABASE', 'forge'),\n                'username' =&gt; env('DB_USERNAME', 'forge'),\n                'password' =&gt; env('DB_PASSWORD', ''),\n                'unix_socket' =&gt; env('DB_SOCKET', ''),\n                'charset' =&gt; 'utf8mb4',\n                'collation' =&gt; 'utf8mb4_unicode_ci',\n                'prefix' =&gt; '',\n                'strict' =&gt; true,\n                'engine' =&gt; null,\n            ]);\n        }    \n    \n        return $next($request);\n    }\n}\n<\/code><\/pre>\n<p>An alternative could be to extend the hostnames table to add a flag and use that flag in\nthe above middleware to signify it should re-use (or set up) a specific connection.<\/p>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.1\/fallback.md"},{"title":"Middleware","icon":"fal fa-shield-alt","excerpt":"Automatic actions per tenant","path":"docs\/hyn\/5.1\/middleware.md","slug":"middleware","package":"hyn","version":"5.1","contents":"<p>This package offers additional automation to make your life easier. Using\nmiddleware, you can mutate how specific requests are handled.<\/p>\n<h1 id=\"maintenance\"><a href=\"#maintenance\" class=\"anchor-link\"><\/a>Maintenance<\/h1>\n<p>Set the property <code>under_maintenance_since<\/code> of the hostname to show a\nLaravel generic maintenance page.<\/p>\n<h1 id=\"redirection\"><a href=\"#redirection\" class=\"anchor-link\"><\/a>Redirection<\/h1>\n<p>Set the property <code>redirect_to<\/code> to a valid URL to automatically redirect all\nrequests to this hostname.<\/p>\n<h1 id=\"secure\"><a href=\"#secure\" class=\"anchor-link\"><\/a>Secure<\/h1>\n<p>Set the property <code>force_https<\/code> to true to force all connections on this\nhostname to be handled using a SSL encrypted connection.<\/p>\n<h1 id=\"abort\"><a href=\"#abort\" class=\"anchor-link\"><\/a>Abort<\/h1>\n<p>In case no tenant was identified the application will generate a default\nnot found page. You can disable this functionality globally in\nthe tenancy configuration file <code>hostname &gt; abort-without-identified-hostname<\/code>.<\/p>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.1\/middleware.md"}]},{"name":"implementation","links":["models","repositories","filesystem","migrations","connections","validation","queues","events","cache"],"slug":"implementation","articles":[{"title":"Models","icon":"fal fa-hand-holding-box","path":"docs\/hyn\/5.1\/models.md","slug":"models","package":"hyn","version":"5.1","contents":"<p>For you to more easily connect with the correct database a few ways are possible.<\/p>\n<h4 id=\"traits\"><a href=\"#traits\" class=\"anchor-link\"><\/a>Traits<\/h4>\n<p>Two traits exist to force a model onto either the tenant or system connection.<\/p>\n<ul>\n<li>\n<code>Hyn\\Tenancy\\Traits\\UsesSystemConnection<\/code> to make a model use the system connection.<\/li>\n<li>\n<code>Hyn\\Tenancy\\Traits\\UsesTenantConnection<\/code> to make a model use the tenant connection.<\/li>\n<\/ul>\n<p>The below snippet shows an example of how to force the User model to use the tenant\nconnection.<\/p>\n<pre><code class=\"language-php\">namespace App;\n\nuse Hyn\\Tenancy\\Traits\\UsesTenantConnection;\nuse Illuminate\\Notifications\\Notifiable;\nuse Illuminate\\Foundation\\Auth\\User as Authenticatable;\n\nclass User extends Authenticatable\n{\n    use Notifiable, UsesTenantConnection;\n    \n    \/\/ ..\n}\n<\/code><\/pre>\n<h4 id=\"abstract-models\"><a href=\"#abstract-models\" class=\"anchor-link\"><\/a>Abstract models<\/h4>\n<p>Instead of using the traits one can also simply have the models extend the abstract\nmodels provided in the package.<\/p>\n<ul>\n<li>\n<code>Hyn\\Tenancy\\Abstracts\\SystemModel<\/code> can be extended to give easy access to\nthe system database connection.<\/li>\n<li>\n<code>Hyn\\Tenancy\\Abstracts\\TenantModel<\/code> can be extended to have your Eloquent models\nuse the connection of the identified tenant per default.<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>Please note these models are using their respective traits.<\/p><\/div>\n<h4 id=\"system-model-override\"><a href=\"#system-model-override\" class=\"anchor-link\"><\/a>System model override<\/h4>\n<p>This package allows you to specify different models to be used for the Customer,\nHostname and Website models. Tenancy will take care of the relationships on the\npackage-end. You also need to implement <code>Hyn\\Tenancy\\Contracts\\{Model}<\/code><\/p>\n<p>Take this example to add billing from <code>laravel\/cashier<\/code> to our application:<\/p>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Contracts\\Customer as Contract;\nuse Laravel\\Cashier\\Billable;\n\nclass Customer extends Authenticatable implements Contract\n{\n  use Billable;\n}\n<\/code><\/pre>\n<p>All you need to do is update the <code>tenancy.php<\/code> configuration file:<\/p>\n<pre><code class=\"language-php\">return [\n  'models' =&gt; [\n      \/\/ ..\n      \n      \/\/ Must implement \\Hyn\\Tenancy\\Contracts\\Customer\n      'customer' =&gt; \\App\\Customer::class,\n      \/\/ Must implement \\Hyn\\Tenancy\\Contracts\\Hostname\n      'hostname' =&gt; \\Hyn\\Tenancy\\Models\\Hostname::class,\n      \/\/ Must implement \\Hyn\\Tenancy\\Contracts\\Website\n      'website' =&gt; \\Hyn\\Tenancy\\Models\\Website::class\n  ],\n  \/\/ ...\n];\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 18:29:42.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.1\/models.md"},{"title":"Repositories","icon":"fal fa-dolly-flatbed","path":"docs\/hyn\/5.1\/repositories.md","slug":"repositories","package":"hyn","version":"5.1","contents":"<p>Tenancy is heavily driven by events. For event listeners to properly work, you\nhave to use the repositories to create new websites, hostnames and customers.<\/p>\n<h1 id=\"create-website\"><a href=\"#create-website\" class=\"anchor-link\"><\/a>Create website<\/h1>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Models\\Website;\nuse Hyn\\Tenancy\\Contracts\\Repositories\\WebsiteRepository;\n\n$website = new Website;\napp(WebsiteRepository::class)-&gt;create($website);\ndd($website-&gt;uuid); \/\/ Unique id\n<\/code><\/pre>\n<h2 id=\"uuid\"><a href=\"#uuid\" class=\"anchor-link\"><\/a>UUID<\/h2>\n<p>Each website will be given a unique identifier automatically. To prevent\nguessing URLs and to add a slight increased level of security this is a\nrandom hash.<\/p>\n<p>The UUID is used for the database username and database name. In addition\nI'd recommend using this unique string for every public facing URL, eg\nan admin dashboard.<\/p>\n<p>By default tenancy will create a <code>uuid<\/code> automatically\nusing a UUID generator, you can replace that class in the\n<code>tenancy.php &gt; website &gt; random-id-generator<\/code>, make sure it implements\n<code>Hyn\\Tenancy\\Contracts\\Website\\UuidGenerator<\/code>.<\/p>\n<p>If you want to force your own UUID for the website, without creating a full\nfledged UUID generator, set the <code>uuid<\/code> property of your website before passing\nit to the repository.<\/p>\n<pre><code class=\"language-php\">$website = new Website;\n\/\/ Implement custom random hash using Laravels Str::random\n$website-&gt;uuid = str_random(10);\napp(WebsiteRepository::class)-&gt;create($website);\ndd($website-&gt;uuid); \/\/ Random string of length 10\n<\/code><\/pre>\n<h2 id=\"managing-connection\"><a href=\"#managing-connection\" class=\"anchor-link\"><\/a>Managing connection<\/h2>\n<p>Whenever you are using multiple databases, to separate tenants over different\nregions for instance, you can easily specify the connection with which tenancy\nshould create, update and delete tenant databases and users.<\/p>\n<pre><code class=\"language-php\">$website = new Website;\n$website-&gt;managed_by_database_connection = 'system.asia';\napp(WebsiteRepository::class)-&gt;create($website);\n\/\/ Information of website is stored in the default system connection,\n\/\/ the tenant database is created using the system.asia connection.\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Make sure the provided connection name is configured in your <code>config\/database.php<\/code>.<\/p><\/div>\n<h1 id=\"create-and-connect-hostname\"><a href=\"#create-and-connect-hostname\" class=\"anchor-link\"><\/a>Create and connect hostname<\/h1>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Models\\Hostname;\nuse Hyn\\Tenancy\\Contracts\\Repositories\\HostnameRepository;\n\n$hostname = new Hostname;\n$hostname-&gt;fqdn = 'luceos.demo.app';\napp(HostnameRepository::class)-&gt;attach($hostname, $website);\ndd($website-&gt;hostnames); \/\/ Collection with $hostname\n<\/code><\/pre>\n<h1 id=\"switch-to-new-tenant\"><a href=\"#switch-to-new-tenant\" class=\"anchor-link\"><\/a>Switch to new tenant<\/h1>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Environment;\n\n$tenancy = app(Environment::class);\n\n$tenancy-&gt;hostname($hostname);\n\n$tenancy-&gt;hostname(); \/\/ resolves $hostname as currently active hostname\n$tenancy-&gt;website(); \/\/ resolves $website\n$tenancy-&gt;customer(); \/\/ resolves $customer\n\n$tenancy-&gt;identifyHostname(); \/\/ resets resolving $hostname by using the Request\n<\/code><\/pre>\n<h1 id=\"querying\"><a href=\"#querying\" class=\"anchor-link\"><\/a>Querying<\/h1>\n<p>In case you would like to query the database for hostnames, websites or customers. Use the\n<code>query()<\/code> method of the repositories, this will return a <a href=\"https:\/\/laravel.com\/docs\/5.5\/queries\"><code>Illuminate\\Database\\Eloquent\\Builder<\/code><\/a>\ninstance.<\/p>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.1\/repositories.md"},{"title":"Filesystem","icon":"fal fa-hdd","path":"docs\/hyn\/5.1\/filesystem.md","slug":"filesystem","package":"hyn","version":"5.1","contents":"<p>You are now, most likely, aware about the <a href=\"structure\">directory structure<\/a>\navailable to tenants.<\/p>\n<h1 id=\"tenant-disk\"><a href=\"#tenant-disk\" class=\"anchor-link\"><\/a>Tenant disk<\/h1>\n<p>To access the directory of the active tenant, you can use the <code>tenant<\/code> disk.<\/p>\n<pre><code class=\"language-php\">Storage::disk('tenant')-&gt;put('readme.md', 'Hi John.');\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>Tenants files are by default stored to <code>storage\/app\/tenancy<\/code>, but this can be reconfigured\nin the <code>tenancy.php<\/code> under <code>website &gt; disk<\/code>.<\/p><\/div>\n<p>Read more about disks on the <a href=\"https:\/\/laravel.com\/docs\/5.5\/filesystem\">Laravel documentation<\/a>.<\/p>\n<h1 id=\"directory\"><a href=\"#directory\" class=\"anchor-link\"><\/a>Directory<\/h1>\n<p>In order to assist with mutating these contents, you can use the\nDirectory class available in this package.<\/p>\n<pre><code class=\"language-php\">$directory = app(\\Hyn\\Tenancy\\Website\\Directory::class);\n<\/code><\/pre>\n<p>This class is set to use the tenant currently active, but also allows you to activate\nany other tenant whenever you need to using the <code>setWebsite(Website $website)<\/code> method.<\/p>\n<p>The Directory class implements <code>Illuminate\\Contracts\\Filesystem\\Filesystem<\/code> which offers\nthe same methods you are used to, including; <code>get<\/code>, <code>put<\/code> and <code>setVisibility<\/code>.<\/p>\n<h1 id=\"tenancy-directory\"><a href=\"#tenancy-directory\" class=\"anchor-link\"><\/a>Tenancy directory<\/h1>\n<p>In case you prefer having a higher level access to the files for tenants. You can use the ioc bound\nFilesystem.<\/p>\n<pre><code class=\"language-php\">\/** @var \\Illuminate\\Contracts\\Filesystem\\Filesystem $tenancy *\/\n$tenancy = app('tenancy.disk');\n<\/code><\/pre>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.1\/filesystem.md"},{"title":"Migrations","icon":"fal fa-pallet-alt","path":"docs\/hyn\/5.1\/migrations.md","slug":"migrations","package":"hyn","version":"5.1","contents":"<p>Migrations are extremely important in the Laravel ecosystem. To facilitate\ntenants with this flow, without interfering with its logic migration commands\nfor tenants have been given their own namespace <code>tenancy:<\/code>.<\/p>\n<h1 id=\"about-the-databasemigrations-path\"><a href=\"#about-the-databasemigrations-path\" class=\"anchor-link\"><\/a>About the database\/migrations path<\/h1>\n<p>It's not wise to store the tenants migrations inside your global\n<code>database\/migrations<\/code> directory. Laravel by default runs these migrations\nwhen calling the <code>php artisan migrate<\/code> command. Even though you can suggest\na connection during that command, it's much cleaner to store these migrations\ninside a separate directory, e.g. <code>database\/migrations\/tenant<\/code>.\nThe migrations for the system database can stay in <code>database\/migrations<\/code>.<\/p>\n<h1 id=\"default-migrations-for-new-tenants\"><a href=\"#default-migrations-for-new-tenants\" class=\"anchor-link\"><\/a>Default migrations for new tenants<\/h1>\n<p>If you want new tenants to be migrated by default, you can easily do so. In\nyour <code>tenancy.php<\/code> configuration set <code>db &gt; tenant-migrations-path<\/code> to a valid\nabsolute path and all your new tenants will run these migrations per default.<\/p>\n<pre><code class=\"language-php\">  \/\/ ..\n  &quot;tenant-migrations-path&quot; =&gt; database_path('migrations\/tenant'),\n  \/\/ ..\n<\/code><\/pre>\n<h1 id=\"default-seeds-for-newly-auto-migrated-tenants\"><a href=\"#default-seeds-for-newly-auto-migrated-tenants\" class=\"anchor-link\"><\/a>Default seeds for newly auto-migrated tenants<\/h1>\n<p>In case you would also like to seed the databases of your newly created\nand migrated tenants, you can enable <code>db &gt; tenant-seed-class<\/code> in your <code>tenancy.php<\/code>\nconfiguration file. Change this setting to a fully namespaced class name\nand the package will automatically run this seed after it has ran the\nautomatic migrations.<\/p>\n<h1 id=\"migration-related-commands\"><a href=\"#migration-related-commands\" class=\"anchor-link\"><\/a>Migration related commands<\/h1>\n<p>Obviously tenancy is also able to run migrations running through artisan.<\/p>\n<p>Tenancy has added the <code>--website_id[=WEBSITE_ID]<\/code> option to each of the following native Laravel migrate and seed\ncommand and namespaced it accordingly, for instance.<\/p>\n<ul>\n<li>\n<code>tenancy:migrate<\/code> - Run the database migrations<\/li>\n<li>\n<code>tenancy:migrate:refresh<\/code> - Reset and re-run all migrations<\/li>\n<li>\n<code>tenancy:migrate:reset<\/code> - Rollback all database migrations<\/li>\n<li>\n<code>tenancy:migrate:rollback<\/code> - Rollback the last database migration<\/li>\n<li>\n<code>tenancy:db:seed<\/code> - Seed the database with records<\/li>\n<\/ul>\n<p>The --website_id optional option accepts multiple values. Though optional, but if you leave the option out it will\nrun the command against all tenant. For example:<\/p>\n<ul>\n<li>\n<code>php artisan tenancy:migrate --website_id=1<\/code> to migrate just tenant website 1.<\/li>\n<li>\n<code>php artisan tenancy:migrate --website_id=1 --website_id=2<\/code> to migrate tenant website 1 &amp; 2.<\/li>\n<li>\n<code>php artisan tenancy:migrate<\/code> to migrate all tenant websites.<\/li>\n<\/ul>\n<div class=\"alert alert-info\"><p>The website_id reflects the auto incremented <code>id<\/code> column of the Website and <strong>NOT<\/strong> the UUID.<\/p><\/div>\n<p>Please check the separate signatures for more information of valid arguments\nand options.<\/p>\n<div class=\"alert alert-info\"><p>Running tenancy:migrate without any path or realpath option and\nwithout having configured tenant-migrations-path will migrate your\ntenants with the files inside the database\/migrations directory.<\/p><\/div>\n<h1 id=\"reconstructing-tenant-databases\"><a href=\"#reconstructing-tenant-databases\" class=\"anchor-link\"><\/a>Reconstructing tenant databases<\/h1>\n<p>As long as your system database is intact, there's a way to recreate all tenant databases. You can use the <code>tenancy:recreate<\/code> artisan command to recreate all tenant databases that do not exist. The command will run the migrations and seeds according to your configuration in <code>tenancy.php<\/code>.<\/p>\n<div class=\"alert alert-info\"><p>Though the structure of all of your tenant databases will be recreated, the data in it won't.<\/p><\/div>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.1\/migrations.md"},{"title":"Connections","icon":"fal fa-warehouse-alt","path":"docs\/hyn\/5.1\/connections.md","slug":"connections","package":"hyn","version":"5.1","contents":"<h4 id=\"database-connections\"><a href=\"#database-connections\" class=\"anchor-link\"><\/a>Database Connections<\/h4>\n<p>One of the core aspects of tenancy is the database connection. Tenancy\ngives you access to two key database connections; <code>tenant<\/code> and <code>system<\/code>.<\/p>\n<h4 id=\"system-connection\"><a href=\"#system-connection\" class=\"anchor-link\"><\/a>System Connection<\/h4>\n<p>Out of the box, the package gives you a <code>system<\/code> database connection which acts as\nthe master database where <code>hostnames<\/code>, <code>websites<\/code> and <code>customers<\/code> are stored.<\/p>\n<p>If for some reason you need to create an Eloquent Model that would need to connect\nto the system connection, you can apply the <code>Hyn\\Tenancy\\Traits\\UsesSystemConnection<\/code>\ntrait on your given Model. In doing so, the model\u2019s connection will always default to use the <code>system<\/code>.<\/p>\n<p>One reason for using the <code>system<\/code> connection is when you have data which you'd like\nto share between all tenants or which you need to influence the tenant identification\nprocess. For instance when you are creating an admin portal that would manage all of your\ntenants in one place.<\/p>\n<h4 id=\"tenant-connection\"><a href=\"#tenant-connection\" class=\"anchor-link\"><\/a>Tenant Connection<\/h4>\n<p>This is maybe the most used database connection. Data in use by single tenant instances,\nnot shared with others, is persisted into the database using the tenant connection. The\nimplementation of the tenant connection ensures that no tenant can access another tenants data.<\/p>\n<p>By using the <code>Hyn\\Tenancy\\Traits\\UsesTenantConnection<\/code> trait, the package will make sure\nthat it is using the right database connection.<\/p>\n<p>All tenant related models should use the <code>UsesTenantConnection<\/code> trait.<\/p>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.1\/connections.md"},{"title":"Validations","icon":"fal fa-file-check","path":"docs\/hyn\/5.1\/validation.md","slug":"validation","package":"hyn","version":"5.1","contents":"<h2 id=\"exists-and-unique-validation-rule\"><a href=\"#exists-and-unique-validation-rule\" class=\"anchor-link\"><\/a>Exists and Unique Validation Rule<\/h2>\n<p>Among all the built-in validation in Laravel, only the <a href=\"https:\/\/laravel.com\/docs\/5.6\/validation#rule-exists\">exists<\/a> and <a href=\"https:\/\/laravel.com\/docs\/5.6\/validation#rule-unique\">unique<\/a> validation rules interact with the database.<\/p>\n<p>We can leverage these two rules with tenancy by adding the connection parameter. Both use the same validation rule\nsignature which is <code>rule:connection.table,column<\/code>.<\/p>\n<p>So for example, to use <code>Exists (Database)<\/code> use <code>'email' =&gt; 'exists:tenant.staff,email'<\/code>. Where <code>tenant<\/code> is the <code>'tenant-connection-name'<\/code> you specified in your <code>tenancy.php<\/code> config file.<\/p>\n<p>You can change the <code>exists<\/code> keyword to <code>unique<\/code> to use the <code>unique<\/code> rule instead, eg: <code>'email' =&gt; 'unique:tenant.staff,email'<\/code>.<\/p>\n<div class=\"alert alert-info\"><p>Validating against the system database is possible using the method described above but replacing <code>tenant<\/code> with <code>system<\/code>.<\/p><\/div>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.1\/validation.md"},{"title":"Queues","icon":"fal fa-conveyor-belt","path":"docs\/hyn\/5.1\/queues.md","slug":"queues","package":"hyn","version":"5.1","contents":"<p>One of the strongest features of Laravel are its queues. One drawback of sending\nJobs into the Queue is that these are executed in a completely different process\ndepending on your queue configuration including redis and beanstalk.<\/p>\n<p>In order to assist you with tenant aware jobs, a <code>TenantAwareJob<\/code> is available to you.\nInstead of applying the <code>SerializesModel<\/code> trait as per suggestion in the Laravel\ndocumentation, you should use this Trait instead.<\/p>\n<pre><code class=\"language-php\">namespace App\\Jobs;\n\nuse Illuminate\\Bus\\Queueable;\nuse Hyn\\Tenancy\\Queue\\TenantAwareJob;\nuse Illuminate\\Queue\\InteractsWithQueue;\nuse Illuminate\\Contracts\\Queue\\ShouldQueue;\nuse Illuminate\\Foundation\\Bus\\Dispatchable;\n\nclass ProcessPodcast implements ShouldQueue\n{\n    use Dispatchable, InteractsWithQueue, Queueable, TenantAwareJob;\n    \n    \/\/ ..\n}\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 18:29:42.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.1\/queues.md"},{"title":"Events","icon":"fal fa-hourglass-end","path":"docs\/hyn\/5.1\/events.md","slug":"events","package":"hyn","version":"5.1","contents":"<p>To create a fluid ecosystem around Laravel, this package uses events heavily.<\/p>\n<p>I highly recommend reading up on the native <a href=\"https:\/\/laravel.com\/docs\/5.5\/events\">events<\/a> by Laravel\nin case you are unaware about its purposes.<\/p>\n<h1 id=\"model-events\"><a href=\"#model-events\" class=\"anchor-link\"><\/a>Model events<\/h1>\n<p>Namespaces:<\/p>\n<ul>\n<li>\n<code>Hyn\\Tenancy\\Events\\Customers<\/code>\n<\/li>\n<li>\n<code>Hyn\\Tenancy\\Events\\Hostnames<\/code>\n<\/li>\n<li>\n<code>Hyn\\Tenancy\\Events\\Websites<\/code>\n<\/li>\n<\/ul>\n<p>All of the models have the following events per default, these should be\nself explanatory.<\/p>\n<ul>\n<li>Creating<\/li>\n<li>Created<\/li>\n<li>Updating<\/li>\n<li>Updated<\/li>\n<li>Deleting<\/li>\n<li>Deleted<\/li>\n<\/ul>\n<h2 id=\"hostnames\"><a href=\"#hostnames\" class=\"anchor-link\"><\/a>Hostnames<\/h2>\n<p>Namespace: <code>Hyn\\Tenancy\\Events\\Hostnames<\/code>.<\/p>\n<p>The hostname models has a few additional events;<\/p>\n<ul>\n<li>Attached; the hostname was attached to a website.<\/li>\n<li>Detached; the hostname was removed from a website.<\/li>\n<li>Identified; the hostname is identified based on the request.<\/li>\n<li>NoneFound; no hostname was found during identification.<\/li>\n<li>Redirected; the hostname is configured to redirect to another url.<\/li>\n<li>Secured; the hostname is configured to upgrade the request to https.<\/li>\n<li>Switched; currently active tenant was changed.<\/li>\n<li>UnderMaintenance; the hostname is configured to be in maintenance.<\/li>\n<\/ul>\n<h1 id=\"database\"><a href=\"#database\" class=\"anchor-link\"><\/a>Database<\/h1>\n<p>Namespace: <code>Hyn\\Tenancy\\Events\\Database<\/code>.<\/p>\n<ul>\n<li>Creating<\/li>\n<li>Created<\/li>\n<li>Deleting<\/li>\n<li>Deleted<\/li>\n<li>Renaming<\/li>\n<li>Renamed<\/li>\n<li>ConfigurationLoading; the configuration for a tenant database connection\nis loading.<\/li>\n<li>ConfigurationLoaded; the configuration for a tenant database connection\nwas loaded.<\/li>\n<\/ul>\n<h1 id=\"webservers\"><a href=\"#webservers\" class=\"anchor-link\"><\/a>Webservers<\/h1>\n<p>Namespace: <code>Hyn\\Tenancy\\Events\\Webservers<\/code>.<\/p>\n<ul>\n<li>ConfigurationSaved; the configuration for the webserver was saved to disk.<\/li>\n<\/ul>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.1\/events.md"},{"title":"Cache","icon":"fal fa-window-restore","path":"docs\/hyn\/5.1\/cache.md","slug":"cache","package":"hyn","version":"5.1","contents":"<p>Currently the Laravel cache will use the same cache key for all tenants.\nThis can and will cause issues in the long run. The config key for tenants\nshould be automatically changed and the ability to disable overriding the cache key should be configurable inside <code>tenancy.php<\/code>.<\/p>\n<p>The following is an easy implementation to allow per-tenant prefixes.<\/p>\n<p>Add a <code>CacheServiceProvider<\/code> with these contents in boot method:<\/p>\n<pre><code class=\"language-php\">public function boot()\n{\n    Cache::extend('redis_tenancy', function ($app) {\n        if (PHP_SAPI === 'cli') {\n            $uuid = $app['config']['driver'];\n        } else {\n            \/\/ ok, this is basically a hack to set the redis cache store\n            \/\/ prefix to the UUID of the current website being called\n            $fqdn = $_SERVER['SERVER_NAME'];\n            \n            $uuid = \\DB::table('hostnames')\n                -&gt;select('websites.uuid')\n                -&gt;join('websites', 'hostnames.website_id', '=', 'websites.id')\n                -&gt;where('fqdn', $fqdn)\n                -&gt;value('uuid');\n        }\n\n        return Cache::repository(new RedisStore(\n            $app['redis'],\n            $uuid,\n            $app['config']['cache.stores.redis.connection']\n        ));\n    });\n}\n<\/code><\/pre>\n<p>This does not require a new Cache driver, as it's re-using\nthe existing Redis driver. All this does is override the default prefix and\nallows you to set a custom cache driver in <code>config\/cache.php<\/code>:<\/p>\n<pre><code class=\"language-php\">'redis' =&gt; [\n    'driver'     =&gt; 'redis_tenancy',\n    'connection' =&gt; 'default',\n],\n<\/code><\/pre>\n<div class=\"alert alert-info\"><p>If you want to use the custom cache driver, you should disable package auto discovery for this package and register the package provider <code>\\Hyn\\Tenancy\\Providers\\TenancyProvider::class<\/code> by adding it under <code>providers<\/code> in your <code>config\/app.app<\/code> just after this cache provider.<\/p><\/div>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.1\/cache.md"}]},{"name":"webserver","links":["apache","nginx"],"slug":"webserver","articles":[{"title":"Apache","icon":"fal fa-server","path":"docs\/hyn\/5.1\/apache.md","slug":"apache","package":"hyn","version":"5.1","contents":"<h1 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h1>\n<p>Tenancy natively integrates with the Apache webserver. For that to work you need\nto do a minor configuration.<\/p>\n<p>Edit the <code>\/etc\/apache2\/apache2.conf<\/code> and below the last <code>IncludeOptional<\/code> statement\nadd:<\/p>\n<pre><code class=\"language-apacheconfig\">IncludeOptional &lt;path&gt;\/*.conf\n<\/code><\/pre>\n<p>Where <code>&lt;path&gt;<\/code> has to be replaced by the location of your vhost files generated by this package.<\/p>\n<div class=\"alert alert-info\"><p>Your vhost files are saved by default inside the <code>storage\/app\/tenancy\/webserver\/apache<\/code> and\ncan be reconfigured in the <code>webserver.php<\/code> configuration file.<\/p><\/div>\n<p>Make sure to reload apache afterwards:<\/p>\n<pre><code class=\"language-bash\">sudo apache2ctl graceful\n<\/code><\/pre>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.1\/apache.md"},{"title":"Nginx","icon":"fal fa-server","path":"docs\/hyn\/5.1\/nginx.md","slug":"nginx","package":"hyn","version":"5.1","contents":"<h1 id=\"set-up\"><a href=\"#set-up\" class=\"anchor-link\"><\/a>Set up<\/h1>\n<p>You need to set up your own PHP FPM. The preferred way of running php is through a <a href=\"https:\/\/coderwall.com\/p\/hmsr5a\/have-php-fpm-listen-on-unix-socket\">socket<\/a> by\nconfiguring the <code>listen<\/code> value in your pool correctly. Make sure to copy the path to your\nsock and update your <code>webserver.php<\/code> configuration file in your app to reflect that value, for instance:<\/p>\n<pre><code class=\"language-php\">    \/**\n     * Nginx webserver support.\n     *\n     * @see http:\/\/nginx.org\n     *\/\n    'nginx' =&gt; [\n        \/\/ ..\n\n        \/**\n         * The php sock to be used.\n         *\/\n        'php-sock' =&gt; 'unix:\/var\/run\/php\/php-fpm.sock',\n        \n        \/\/ ..\n    ],\n<\/code><\/pre>\n<h1 id=\"configuration\"><a href=\"#configuration\" class=\"anchor-link\"><\/a>Configuration<\/h1>\n<p>Tenancy natively integrates with the Nginx webserver. For that to work you need\nto do a minor configuration.<\/p>\n<p>Edit the <code>\/etc\/nginx\/nginx.conf<\/code> and below the last <code>include<\/code> statement\nadd:<\/p>\n<pre><code class=\"language-apacheconfig\">include &lt;path&gt;\/*.conf;\n<\/code><\/pre>\n<p>Where <code>&lt;path&gt;<\/code> has to be replaced by the location of your vhost files generated by this package.<\/p>\n<div class=\"alert alert-info\"><p>Your vhost files are saved by default inside the <code>storage\/app\/tenancy\/webserver\/nginx<\/code> and\ncan be reconfigured in the <code>webserver.php<\/code> configuration file.<\/p><\/div>\n<p>Make sure to restart nginx afterwards:<\/p>\n<pre><code class=\"language-bash\">sudo systemctl restart nginx\n<\/code><\/pre>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.1\/nginx.md"}]},{"name":"tutorials","links":["getting-started-tutorial","full-featured-tutorial","spatie-laravel-permission"],"slug":"tutorials","articles":[{"title":"Getting started with Tenancy","author":"Eduardo Geschonke","author_link":"https:\/\/github.com\/jobcerto","path":"docs\/hyn\/5.1\/getting-started-tutorial.md","slug":"getting-started-tutorial","package":"hyn","version":"5.1","contents":"<p>Eduardo Geschonke created a medium post that helps you get started with Tenancy. If you're having trouble on how to get\nstarted or just wished someone would guide you in setting things up, then you're in good hands with Eduardo.<\/p>\n<p>Head over to his medium.com post: <a href=\"https:\/\/medium.com\/@edu_96787\/4f1cdbf99de\">Building a Multi-Tenancy Laravel App with Multi-Database using hyn\/multi-tenant<\/a> and get the ball rolling.<\/p>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.1\/getting-started-tutorial.md"},{"title":"Full-featured app","author":"Ashok Gelal","author_link":"http:\/\/getcleaver.com","path":"docs\/hyn\/5.1\/full-featured-tutorial.md","slug":"full-featured-tutorial","package":"hyn","version":"5.1","contents":"<p>Ashok Gelal has been very kind to create an extensive tutorial to create a feature rich\nmulti tenant Laravel app.<\/p>\n<ul>\n<li>\n<a href=\"https:\/\/medium.com\/@ashokgelal\/writing-a-full-featured-multi-tenant-laravel-app-from-scratch-a0e1a7350d9d\">Part 0<\/a> - Introduction<\/li>\n<li>\n<a href=\"https:\/\/medium.com\/@ashokgelal\/a-full-featured-multi-tenant-app-with-laravel-part-1-4049a3cc229d\">Part 1<\/a> - Installation<\/li>\n<li>\n<a href=\"https:\/\/medium.com\/@ashokgelal\/a-full-featured-multi-tenant-app-with-laravel-part-2-roles-and-permissions-d9a5bfe5d525\">Part 2<\/a> - Roles and permissions<\/li>\n<li>\n<a href=\"https:\/\/medium.com\/@ashokgelal\/a-full-featured-multi-tenant-app-with-laravel-part-3-invitation-c982dca55eb9\">Part 3<\/a> - Invitation<\/li>\n<li>\n<a href=\"https:\/\/medium.com\/@ashokgelal\/a-full-featured-multi-tenant-app-with-laravel-part-4-tenancy-aware-authentication-e0ee37270bc8\">Part 4<\/a> - Authentication<\/li>\n<li>\n<a href=\"https:\/\/medium.com\/@ashokgelal\/a-full-featured-multi-tenant-app-with-laravel-part-2-unit-tests-96d6dfbf0617\">Part 5<\/a> - Testing<\/li>\n<li>\n<a href=\"https:\/\/medium.com\/@ashokgelal\/a-full-featured-multi-tenant-app-with-laravel-part-5-user-profile-5c3d0c655f3a\">Part 6<\/a> - User Profile<\/li>\n<li>\n<a href=\"https:\/\/medium.com\/@ashokgelal\/a-full-featured-multi-tenant-app-with-laravel-part-7-deployment-40bb3c895627\">Part 7<\/a> - Deployment<\/li>\n<\/ul>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.1\/full-featured-tutorial.md"},{"title":"Spatie permission","excerpt":"A tutorial on setting up spatie\/laravel-permission.","tags":["spatie","permission","tutorial"],"path":"docs\/hyn\/5.1\/spatie-laravel-permission.md","slug":"spatie-laravel-permission","package":"hyn","version":"5.1","contents":"<ol>\n<li>Create a fresh install of Laravel 5.5.  If you have installed the Laravel Terminal Installer run: <code>$ laravel new app<\/code>\n<\/li>\n<li>\n<code>$ cd app<\/code>\n<\/li>\n<li>Install <code>hyn\/multi-tenant<\/code> package by running:<\/li>\n<\/ol>\n<pre><code class=\"language-bash\">composer require hyn\/multi-tenant\n<\/code><\/pre>\n<ol start=\"4\">\n<li>Follow the instructions until &quot;Deploy configuration&quot; section.<\/li>\n<li>If you are using MySQL DB, you need to add the entry <code>LIMIT_UUID_LENGTH_32=true<\/code> in your <code>.env<\/code> file.<\/li>\n<\/ol>\n<h2 id=\"install-spatie-permissions\"><a href=\"#install-spatie-permissions\" class=\"anchor-link\"><\/a>Install Spatie Permissions<\/h2>\n<p>To install the package follow the entire installation section\nat <a href=\"https:\/\/github.com\/spatie\/laravel-permission#installation\">GitHub - spatie\/laravel-permission: Associate users with roles and permissions<\/a>.<\/p>\n<h2 id=\"integration\"><a href=\"#integration\" class=\"anchor-link\"><\/a>Integration<\/h2>\n<p>This section of the tutorial assumes that you have successfully created at least 2 hostnames\nand successfully have accessed them via your local environment setup.<\/p>\n<p>We need to extend the two eloquent models (<code>Permission<\/code>, <code>Role<\/code>) of the Permissions\npackage so that we can add the necessary changes we need in order for these two models\nto be tenant aware.<\/p>\n<ol>\n<li>Create a Permission.php and Role.php file and place them inside your <code>app<\/code> directory,\nnext to your <code>User.php<\/code>. Make sure that these files extend <code>Spatie\\Permission\\Models\\Permission::class<\/code>\nand <code>Spatie\\Permission\\Models\\Role::class<\/code> respectively.<\/li>\n<\/ol>\n<p><code>App\\Permission.php<\/code> - extends from <code>SpatiePermission<\/code> and uses the <code>UsesTenantConnection<\/code> trait.<\/p>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Traits\\UsesTenantConnection;\nuse Spatie\\Permission\\Models\\Permission as SpatiePermission;\n\nclass Permission extends SpatiePermission\n{\n    use UsesTenantConnection;\n}\n<\/code><\/pre>\n<p><code>App\\Role.php<\/code> - extends from <code>SpatieRole<\/code> and uses the <code>UsesTenantConnection<\/code> trait.<\/p>\n<pre><code class=\"language-php\">use Hyn\\Tenancy\\Traits\\UsesTenantConnection;\nuse Spatie\\Permission\\Models\\Role as SpatieRole;\n\nclass Role extends SpatieRole\n{\n    use UsesTenantConnection;\n}\n<\/code><\/pre>\n<p><code>App\\User.php<\/code> - notice the <code>HasRoles<\/code>, <code>UsesTenantConnection<\/code> traits we added.<\/p>\n<pre><code class=\"language-php\">use Spatie\\Permission\\Traits\\HasRoles;\nuse Illuminate\\Notifications\\Notifiable;\nuse Hyn\\Tenancy\\Traits\\UsesTenantConnection;\nuse Illuminate\\Foundation\\Auth\\User as Authenticatable;\n\nclass User extends Authenticatable\n{\n    use Notifiable, UsesTenantConnection, HasRoles;\n\n    \/**\n     * The attributes that are mass assignable.\n     *\n     * @var array\n     *\/\n    protected $fillable = [\n        'name', 'email', 'password',\n    ];\n\n    \/**\n     * The attributes that should be hidden for arrays.\n     *\n     * @var array\n     *\/\n    protected $hidden = [\n        'password', 'remember_token',\n    ];\n}\n<\/code><\/pre>\n<ol start=\"3\">\n<li>Modify your <code>config\/permission.php<\/code> file and modify the permission and role models\nthat is being used here to point to your newly created models. e.g. <code>App\\Permission::class<\/code>\n<\/li>\n<\/ol>\n<p><code>config\\permisssion.php<\/code><\/p>\n<pre><code class=\"language-php\">return [\n\n    'models' =&gt; [\n\n        'permission' =&gt; App\\Permission::class,\n\n        'role' =&gt; App\\Role::class,\n\n    ],\n\n    ...\n];\n<\/code><\/pre>\n<ol start=\"4\">\n<li>Creating a user in your first hostname.<\/li>\n<\/ol>\n<pre><code class=\"language-php\">use App\\User;\nuse App\\Role;\nuse App\\Permission;\nuse Hyn\\Tenancy\\Models\\Hostname;\n\n\/\/ Switch the environment to use first hostname\n$environment = app(\\Hyn\\Tenancy\\Environment::class);\n$hostname = Hostname::find(1);\n$environment-&gt;hostname($hostname);\n\n\/\/ creates role and permission on your first hostname\n$role = Role::create(['name' =&gt; 'writer']);\n$permission = Permission::create(['name' =&gt; 'edit articles']);\n\n\/\/ Retrieve user and check to make sure it has no roles yet\n$user = User::find(1);\n$user-&gt;getRoleNames();\n\n\/\/ Assign writer role and save the $user instance to DB.\n$user-&gt;assignRole('writer');\n$user-&gt;save();\n\n\/\/ Requery and check if the newly assigned roles exists.\n$user = User::find(1);\n$user-&gt;getRoleNames();\n<\/code><\/pre>\n","updated_at":{"date":"2020-07-18 18:29:42.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.1\/spatie-laravel-permission.md"}]}],"hidden_articles":{"index":{"title":"Hyn documentation","path":"docs\/hyn\/5.1\/index.md","slug":"index","package":"hyn","version":"5.1","contents":"","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/hyn\/5.1\/index.md"}}}}},"governance":{"slug":"governance","name":"Governance","description":"Understanding our processes for contributions and how we manage our projects, team and funding.\n","repository":null,"downloads":null,"stargazers":null,"versions":{"tenancy":{"slug":"tenancy","name":"tenancy","status":"dev","suggestion_using":null,"branch":"master","package":"governance","tree":[{"name":"organisation","links":["team","strategy","donations","reward-system"],"slug":"organisation","articles":[{"title":"Team","icon":"fal fa-hard-hat","path":"docs\/governance\/tenancy\/team.md","slug":"team","package":"governance","version":"tenancy","contents":"<p>Let's start by saying the Tenancy packages would never have\nexisted without the investment made by team members and many\ncommunity members.<\/p>\n<p>Even though everyone in the team is a developer, not everyone\nplays a role in development, here's what our team takes care of;<\/p>\n<ul>\n<li>\n<strong>Package maintenance<\/strong>. Taking care of bugs and keeping up with\nnew releases of the Laravel framework.<\/li>\n<li>\n<strong>Feature development<\/strong>. Adding or extending functionality in our\npackages.<\/li>\n<li>\n<strong>Support<\/strong>. Helping other developers with their implementation through\nour chat server, GitHub issues or discussion forum.<\/li>\n<li>\n<strong>Project planning<\/strong>. Carving out new releases and describing the best path\nforward is a necessity for our project.<\/li>\n<li>\n<strong>Communication<\/strong>. With new releases comes the responsibility to inform\nour community about them and the changes they hold. We also do our best\nto respond to twitter messages related to our packages and promoting them.<\/li>\n<li>\n<strong>Documentation<\/strong>. We hope to focus actual support to specific questions.\nEvery regular question and the package fundamentals are written down in\nclear, understandable articles in our documentation.<\/li>\n<\/ul>\n<p>It would seem that only code-related roles are important to a package. But\nthat's not the case. We are exceptionally proud of the people providing\nsupport, they are experienced with the package and patiently assist people\nat different levels of skill and implementation without losing their cool.<\/p>\n<p>We strongly dislike hierarchy, preferring an open, transparent team environment. Team\nmembers are valued for their opinion. In fact, all team members are equals and even our founder prefers being a\n&quot;<a href=\"https:\/\/en.wikipedia.org\/wiki\/Primus_inter_pares\">Primus inter pares<\/a>&quot; or first among equals!<\/p>\n<p><strong>Thank you for your dedication for any and all contributions!<\/strong><\/p>\n<p>Our team roster is listed on the <a href=\"\/\">homepage<\/a> and if you're interested in joining\ncheck the <a href=\"team-membership\">team membership page<\/a>.<\/p>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/governance\/tenancy\/team.md"},{"title":"Strategy","icon":"fab fa-fort-awesome","path":"docs\/governance\/tenancy\/strategy.md","slug":"strategy","package":"governance","version":"tenancy","contents":"<h2 id=\"goal\"><a href=\"#goal\" class=\"anchor-link\"><\/a>Goal<\/h2>\n<p>We empower Laravel developers of all backgrounds in building Software\nas a Service by creating multi tenant packages and applications.<\/p>\n<h2 id=\"values\"><a href=\"#values\" class=\"anchor-link\"><\/a>Values<\/h2>\n<ul>\n<li>\n<strong>Respect is given, not earned<\/strong>.<\/li>\n<li>\n<strong>We respect other people\u2019s time when we learn to value it as much as our own<\/strong>.<\/li>\n<\/ul>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/governance\/tenancy\/strategy.md"},{"title":"Donations","icon":"fal fa-treasure-chest","path":"docs\/governance\/tenancy\/donations.md","slug":"donations","package":"governance","version":"tenancy","contents":"<p>Laravel Tenancy is an MIT licensed open source project and completely free to use. However,\nthe amount of effort needed to maintain and develop new features for the project\nis not sustainable without proper financial backing. You can support development\nvia the following methods:<\/p>\n<h2 id=\"github-sponsors\"><a href=\"#github-sponsors\" class=\"anchor-link\"><\/a>GitHub Sponsors<\/h2>\n<p>On all our repositories you will find a button with a heart to sponsor the project through Open Collective or our sponsorable developers separately.<\/p>\n<h2 id=\"open-collective\"><a href=\"#open-collective\" class=\"anchor-link\"><\/a>Open Collective<\/h2>\n<p>Our Open Collective offers one-time and recurring pledges. Open Collective works as our\nfiscal sponsor, is heavily vested in promoting sustainable open source financing and\ndoes so by allowing transparent use of collective funds.<\/p>\n<ul>\n<li>\n<a href=\"https:\/\/opencollective.com\/tenancy\">Choose your tier<\/a>. Tiers are required to become a sponsor and be listed on our website.<\/li>\n<li>\n<a href=\"https:\/\/opencollective.com\/tenancy\/donate\">One time or freely configurable pledge<\/a>.<\/li>\n<\/ul>\n<h2 id=\"developers\"><a href=\"#developers\" class=\"anchor-link\"><\/a>Developers<\/h2>\n<p>You can also choose to back each of our developers separately. On our <a href=\"\/\">homepage<\/a> you will find a\nteam roster. Team members you can support have an orange Patreon or GitHub button.<\/p>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/governance\/tenancy\/donations.md"},{"title":"Reward system","icon":"fal fa-award","path":"docs\/governance\/tenancy\/reward-system.md","slug":"reward-system","package":"governance","version":"tenancy","contents":"<p>Team members who consistently invest their time into our\nprojects can expect to be rewarded occasionally. We don't\nindulge the team, but do show appreciation for repeatedly\nchoosing open source contributions over alternative obligations\nor opportunities.<\/p>\n<p>We are transparent about these rewards. A selection of rewards\nwe might offer to valuable team members and outside contributors:<\/p>\n<ul>\n<li>\n<strong>Paying for development time.<\/strong>\n<em>This is the default method for making our projects sustainable.\nIt is literally paying someone for time spent on this project instead\nof for instance client work. Developers are often paid for large\ntime investments on their end.<\/em>\n<\/li>\n<li>\n<strong>Merchandise.<\/strong>\n<em>Like a unique Tenancy t-shirt or stickers.<\/em>\n<\/li>\n<li>\n<strong>Greeting or gift card.<\/strong>\n<em>Just a spontaneous minor thank you or for a birthday.<\/em>\n<\/li>\n<li>\n<strong>Conference tickets.<\/strong>\n<em>Aside from making a perfect moment for a get together, allowing team members\nto visit conferences allows them to market our projects and grow their\nknowledge.<\/em>\n<\/li>\n<\/ul>\n<p>These awards are introduced to guarantee continued development of the Tenancy projects.\nCosts involved are withdrawn from our <a href=\"donations\">Open Collective<\/a> where expenses are\nvisible to the public.<\/p>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/governance\/tenancy\/reward-system.md"}]},{"name":"conventions","links":["code-style","versioning"],"slug":"conventions","articles":[{"title":"Code style","icon":"fal fa-laptop-code","path":"docs\/governance\/tenancy\/code-style.md","slug":"code-style","package":"governance","version":"tenancy","contents":"<p>We do our best to provide clear guidelines on how we collaborate on our packages. This is not always easy as opinions differ, we nevertheless try to stick to these guidelines as much as we can:<\/p>\n<ul>\n<li>We configured StyleCI to automatically patch code changes, including those in PR's. This allows us to focus on the quality of the code, instead of the cosmetics.<\/li>\n<li>StyleCI is configured to use the <a href=\"https:\/\/docs.styleci.io\/presets#recommended\">recommended preset<\/a>, feel free to read over them and adopt the guidelines you agree with.<\/li>\n<li>Do not change styling of code outside of your changes, this makes it incredibly hard to review pull requests.<\/li>\n<\/ul>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/governance\/tenancy\/code-style.md"},{"title":"Versioning","icon":"fal fa-tags","path":"docs\/governance\/tenancy\/versioning.md","slug":"versioning","package":"governance","version":"tenancy","contents":"","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/governance\/tenancy\/versioning.md"}]},{"name":"processes","links":["issues","pull-requests","team-membership"],"slug":"processes","articles":[{"title":"Issues","icon":"fal fa-dumpster-fire","path":"docs\/governance\/tenancy\/issues.md","slug":"issues","package":"governance","version":"tenancy","contents":"","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/governance\/tenancy\/issues.md"},{"title":"Pull requests","icon":"fal fa-code-merge","path":"docs\/governance\/tenancy\/pull-requests.md","slug":"pull-requests","package":"governance","version":"tenancy","contents":"<p>We rely heavily on pull requests to our code base, not just for others but also ourselves. Using\npull requests leverages the knowledge and experience of the team and collaborators in order to\nachieve the best result in terms of feature and code.<\/p>\n<p>Everyone is different and therefor we won't expect you to comply to our complete list of requirements\nfor making a pull request. Nevertheless we will provide a list that gives an indication of what an\nexcellent pull request looks like. Doing so, helps understanding how we can speed up the process of\nmerging code into our projects.<\/p>\n<h2 id=\"pr-checklist\"><a href=\"#pr-checklist\" class=\"anchor-link\"><\/a>PR checklist<\/h2>\n<p>An <strong>excellent<\/strong> pull request:<\/p>\n<ul>\n<li>Provides sufficient <strong>information<\/strong>.\nUnderstanding what exactly your pull request does is fundamental when reading the changes in the code. Ensure\nyour pull request has a clear description and offers specific questions for maintainers to look at.<\/li>\n<li>Relates to an <strong>issue<\/strong>.\nPull requests usually refer to an issue. Issues are used to discuss features, bugs and enhancements.\nIncluding ways to solve them. Pull requests based off of issues often reduce the need to correct\nthe implementation.<\/li>\n<li>Has successful <strong>checks<\/strong>.\nEach pull request will automatically dispatch our Continuous Integration pipeline. This pipeline will\nrun tests, find coding conventions errors and identify the change in code coverage. Satisfying these\nchecks will ensure we can merge sooner.<\/li>\n<li>Implements or updates <strong>tests<\/strong>.\nOur projects rely heavily on tests. New or updated functionality has to implement tests to confirm\nit works during implementation and thereafter. Tests are a great way to understand how our package\nbreaks while refactoring or introducing new functionality. If you don't write the tests, we will\nhave to.<\/li>\n<\/ul>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/governance\/tenancy\/pull-requests.md"},{"title":"Team membership","icon":"fal fa-user-hard-hat","path":"docs\/governance\/tenancy\/team-membership.md","slug":"team-membership","package":"governance","version":"tenancy","contents":"<p>All our team members have contributed in one way or another consistently.\nStanding out like that made them pop up on our radar. Nevertheless if you\ncan give us a reason for your membership we'll obviously consider it.<\/p>\n<p>Team membership does not give you a higher rank and even though we do\n<a href=\"reward-system\">reward<\/a> outstanding contributions, these are not guaranteed.\nChoosing to become a team member is more about the willingness to support\nour <a href=\"strategy\">cause<\/a>.<\/p>\n","updated_at":{"date":"2020-01-17 17:16:27.000000","timezone_type":3,"timezone":"UTC"},"suggestionsLink":"https:\/\/github.com\/tenancy\/docs\/edit\/master\/docs\/governance\/tenancy\/team-membership.md"}]}],"hidden_articles":[]}}}}