mirror of
https://github.com/codeigniter4/CodeIgniter4.git
synced 2025-02-20 11:44:28 +08:00
514 lines
37 KiB
HTML
514 lines
37 KiB
HTML
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" >
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>Creating Composer Packages — CodeIgniter 4.4.1 documentation</title>
|
||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="../_static/css/citheme.css" type="text/css" />
|
||
<link rel="stylesheet" href="../_static/css/citheme_dark.css" type="text/css" />
|
||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||
<!--[if lt IE 9]>
|
||
<script src="../_static/js/html5shiv.min.js"></script>
|
||
<![endif]-->
|
||
|
||
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
|
||
<script src="../_static/jquery.js"></script>
|
||
<script src="../_static/underscore.js"></script>
|
||
<script src="../_static/doctools.js"></script>
|
||
<script src="../_static/js/citheme.js"></script>
|
||
<script src="../_static/js/carbon.js"></script>
|
||
<script src="../_static/js/theme.js"></script>
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
<link rel="next" title="Contributing to CodeIgniter" href="contributing.html" />
|
||
<link rel="prev" title="Authentication" href="authentication.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
<div class="wy-grid-for-nav">
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
|
||
|
||
|
||
<a href="../index.html">
|
||
|
||
<img src="../_static/ci-logo-text.svg" class="logo" alt="Logo"/>
|
||
</a>
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../intro/index.html">Welcome to CodeIgniter4</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../intro/index.html">Welcome to CodeIgniter4</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../intro/requirements.html">Server Requirements</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../intro/credits.html">Credits</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../intro/psr.html">PSR Compliance</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../license.html">License Agreement</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../installation/installing_composer.html">Composer Installation</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../installation/installing_manual.html">Manual Installation</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../installation/running.html">Running Your App</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../installation/troubleshooting.html">Troubleshooting</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../changelogs/index.html">Change Logs</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../installation/upgrading.html">Upgrading From a Previous Version</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../installation/repositories.html">CodeIgniter Repositories</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Build Your First Application</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../tutorial/static_pages.html">Static Pages</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../tutorial/news_section.html">News Section</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../tutorial/create_news_items.html">Create News Items</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../tutorial/conclusion.html">Conclusion</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../concepts/index.html">CodeIgniter4 Overview</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../concepts/structure.html">Application Structure</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../concepts/mvc.html">Models, Views, and Controllers</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../concepts/autoloader.html">Autoloading Files</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../concepts/services.html">Services</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../concepts/factories.html">Factories</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../concepts/http.html">Working with HTTP Requests</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../concepts/security.html">Security Guidelines</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../general/index.html">General Topics</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../general/configuration.html">Configuration</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../general/urls.html">CodeIgniter URLs</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../general/helpers.html">Helper Functions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../general/common_functions.html">Global Functions and Constants</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../general/logging.html">Logging Information</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../general/errors.html">Error Handling</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../general/caching.html">Web Page Caching</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../general/ajax.html">AJAX Requests</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../general/modules.html">Code Modules</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../general/managing_apps.html">Managing your Applications</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../general/environments.html">Handling Multiple Environments</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../incoming/index.html">Controllers and Routing</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../incoming/routing.html">URI Routing</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../incoming/controllers.html">Controllers</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../incoming/filters.html">Controller Filters</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../incoming/message.html">HTTP Messages</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../incoming/request.html">Request Class</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../incoming/incomingrequest.html">IncomingRequest Class</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../incoming/content_negotiation.html">Content Negotiation</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../incoming/methodspoofing.html">HTTP Method Spoofing</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../incoming/restful.html">RESTful Resource Handling</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../outgoing/index.html">Building Responses</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../outgoing/views.html">Views</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../outgoing/view_cells.html">View Cells</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../outgoing/view_renderer.html">View Renderer</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../outgoing/view_layouts.html">View Layouts</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../outgoing/view_parser.html">View Parser</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../outgoing/view_decorators.html">View Decorators</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../outgoing/table.html">HTML Table Class</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../outgoing/response.html">HTTP Responses</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../outgoing/api_responses.html">API Response Trait</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../outgoing/localization.html">Localization</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../outgoing/alternative_php.html">Alternate PHP Syntax for View Files</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../database/index.html">Working with Databases</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../database/examples.html">Quick Start: Usage Examples</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../database/configuration.html">Database Configuration</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../database/connecting.html">Connecting to a Database</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../database/queries.html">Running Queries</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../database/results.html">Generating Query Results</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../database/helpers.html">Query Helper Functions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../database/query_builder.html">Query Builder Class</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../database/transactions.html">Transactions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../database/metadata.html">Getting MetaData</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../database/call_function.html">Custom Function Calls</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../database/events.html">Database Events</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../database/utilities.html">Database Utilities</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../models/index.html">Modeling Data</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../models/model.html">Using CodeIgniter's Model</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../models/entities.html">Using Entity Classes</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../dbmgmt/index.html">Managing Databases</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../dbmgmt/forge.html">Database Manipulation with Database Forge</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../dbmgmt/migration.html">Database Migrations</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../dbmgmt/seeds.html">Database Seeding</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../dbmgmt/db_commands.html">Database Commands</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../libraries/index.html">Library Reference</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/caching.html">Caching Driver</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/cookies.html">Cookies</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/curlrequest.html">CURLRequest Class</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/email.html">Email Class</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/encryption.html">Encryption Service</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/files.html">Working with Files</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/file_collections.html">File Collections</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/honeypot.html">Honeypot Class</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/images.html">Image Manipulation Class</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/pagination.html">Pagination</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/publisher.html">Publisher</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/security.html">Security</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/sessions.html">Session Library</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/throttler.html">Throttler</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/time.html">Times and Dates</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/typography.html">Typography</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/uploaded_files.html">Working with Uploaded Files</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/uri.html">Working with URIs</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/user_agent.html">User Agent Class</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/validation.html">Validation</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../helpers/index.html">Helpers</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../helpers/array_helper.html">Array Helper</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../helpers/cookie_helper.html">Cookie Helper</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../helpers/date_helper.html">Date Helper</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../helpers/filesystem_helper.html">Filesystem Helper</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../helpers/form_helper.html">Form Helper</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../helpers/html_helper.html">HTML Helper</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../helpers/inflector_helper.html">Inflector Helper</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../helpers/number_helper.html">Number Helper</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../helpers/security_helper.html">Security Helper</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../helpers/test_helper.html">Test Helper</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../helpers/text_helper.html">Text Helper</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../helpers/url_helper.html">URL Helper</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../helpers/xml_helper.html">XML Helper</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../testing/index.html">Testing</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../testing/overview.html">Getting Started</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../testing/database.html">Database</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../testing/fabricator.html">Generating Data</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../testing/controllers.html">Controller Testing</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../testing/feature.html">HTTP Testing</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../testing/response.html">Testing Responses</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../testing/benchmark.html">Benchmarking</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../testing/debugging.html">Debugging Your Application</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../testing/mocking.html">Mocking</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../cli/index.html">Command Line Usage</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../cli/cli_overview.html">CLI Overview</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../cli/cli_controllers.html">Running Controllers via CLI</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../cli/spark_commands.html">Spark Commands</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../cli/cli_commands.html">Creating Spark Commands</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../cli/cli_generators.html">CLI Generators</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../cli/cli_library.html">CLI Library</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../cli/cli_request.html">CLIRequest Class</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul class="current">
|
||
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Extending CodeIgniter</a><ul class="current">
|
||
<li class="toctree-l2"><a class="reference internal" href="core_classes.html">Creating Core System Classes</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="common.html">Replacing Common Functions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="events.html">Events</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="basecontroller.html">Extending the Controller</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="authentication.html">Authentication</a></li>
|
||
<li class="toctree-l2 current"><a class="current reference internal" href="#">Creating Composer Packages</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="contributing.html">Contributing to CodeIgniter</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../libraries/official_packages.html">Official Packages</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="../index.html">CodeIgniter</a>
|
||
</nav>
|
||
|
||
<div class="wy-nav-content">
|
||
<div class="rst-content">
|
||
<a class="btn btn-neutral float-right" href="https://github.com/codeigniter4/CodeIgniter4/edit/develop/user_guide_src/source/extending/composer_packages.rst">Edit this page</a>
|
||
|
||
<div role="navigation" aria-label="Page navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||
<li class="breadcrumb-item"><a href="index.html">Extending CodeIgniter</a></li>
|
||
<li class="breadcrumb-item active">Creating Composer Packages</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
</li>
|
||
</ul>
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<section id="creating-composer-packages">
|
||
<h1>Creating Composer Packages<a class="headerlink" href="#creating-composer-packages" title="Permalink to this headline"></a></h1>
|
||
<p>You can make the <a class="reference internal" href="../general/modules.html"><span class="doc">Code Modules</span></a> you create into Composer packages,
|
||
or can create a Composer package for CodeIgniter 4.</p>
|
||
<div class="contents local topic" id="contents">
|
||
<ul class="simple">
|
||
<li><p><a class="reference internal" href="#folder-structure" id="id1">Folder Structure</a></p></li>
|
||
<li><p><a class="reference internal" href="#creating-composer-json" id="id2">Creating composer.json</a></p>
|
||
<ul>
|
||
<li><p><a class="reference internal" href="#package-name" id="id3">Package Name</a></p></li>
|
||
<li><p><a class="reference internal" href="#namespace" id="id4">Namespace</a></p></li>
|
||
<li><p><a class="reference internal" href="#choosing-license" id="id5">Choosing License</a></p></li>
|
||
</ul>
|
||
</li>
|
||
<li><p><a class="reference internal" href="#preparing-development-tools" id="id6">Preparing Development Tools</a></p>
|
||
<ul>
|
||
<li><p><a class="reference internal" href="#installing-devkit" id="id7">Installing DevKit</a></p></li>
|
||
<li><p><a class="reference internal" href="#configuring-coding-standards-fixer" id="id8">Configuring Coding Standards Fixer</a></p></li>
|
||
</ul>
|
||
</li>
|
||
<li><p><a class="reference internal" href="#config-files" id="id9">Config Files</a></p>
|
||
<ul>
|
||
<li><p><a class="reference internal" href="#allowing-users-to-override-settings" id="id10">Allowing Users to Override Settings</a></p></li>
|
||
<li><p><a class="reference internal" href="#overriding-settings-in-app-config" id="id11">Overriding Settings in app/Config</a></p></li>
|
||
</ul>
|
||
</li>
|
||
<li><p><a class="reference internal" href="#references" id="id12">References</a></p></li>
|
||
</ul>
|
||
</div>
|
||
<section id="folder-structure">
|
||
<h2><a class="toc-backref" href="#id1">Folder Structure</a><a class="headerlink" href="#folder-structure" title="Permalink to this headline"></a></h2>
|
||
<p>Here’s a typical directory structure for a Composer package:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nx">your</span><span class="o">-</span><span class="nx">package</span><span class="o">-</span><span class="nx">name</span><span class="o">/</span>
|
||
<span class="nx">├──</span> <span class="o">.</span><span class="nx">gitattributes</span>
|
||
<span class="nx">├──</span> <span class="o">.</span><span class="nx">gitignore</span>
|
||
<span class="nx">├──</span> <span class="nx">LICENSE</span>
|
||
<span class="nx">├──</span> <span class="nx">README</span><span class="o">.</span><span class="nx">md</span>
|
||
<span class="nx">├──</span> <span class="nx">composer</span><span class="o">.</span><span class="nx">json</span>
|
||
<span class="nx">├──</span> <span class="nx">src</span><span class="o">/</span>
|
||
<span class="nx">│ </span> <span class="nx">└──</span> <span class="nx">YourClass</span><span class="o">.</span><span class="nx">php</span>
|
||
<span class="nx">└──</span> <span class="nx">tests</span><span class="o">/</span>
|
||
<span class="nx">└──</span> <span class="nx">YourClassTest</span><span class="o">.</span><span class="nx">php</span>
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="creating-composer-json">
|
||
<h2><a class="toc-backref" href="#id2">Creating composer.json</a><a class="headerlink" href="#creating-composer-json" title="Permalink to this headline"></a></h2>
|
||
<p>In the root of your package directory, create a <strong>composer.json</strong> file. This file
|
||
defines metadata about your package and its dependencies.</p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">composer</span> <span class="pre">init</span></code> command helps you create it.</p>
|
||
<p>For example, <strong>composer.json</strong> might look like this:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"your-vendor/your-package"</span><span class="p">,</span>
|
||
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"Your package description"</span><span class="p">,</span>
|
||
<span class="s2">"type"</span><span class="o">:</span> <span class="s2">"library"</span><span class="p">,</span>
|
||
<span class="s2">"license"</span><span class="o">:</span> <span class="s2">"MIT"</span><span class="p">,</span>
|
||
<span class="s2">"autoload"</span><span class="o">:</span> <span class="p">{</span>
|
||
<span class="s2">"psr-4"</span><span class="o">:</span> <span class="p">{</span>
|
||
<span class="s2">"YourVendor</span><span class="se">\\</span><span class="s2">YourPackage</span><span class="se">\\</span><span class="s2">"</span><span class="o">:</span> <span class="s2">"src/"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">},</span>
|
||
<span class="s2">"authors"</span><span class="o">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"name"</span><span class="o">:</span> <span class="s2">"Your Name"</span><span class="p">,</span>
|
||
<span class="s2">"email"</span><span class="o">:</span> <span class="s2">"yourname@example.com"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">],</span>
|
||
<span class="s2">"require"</span><span class="o">:</span> <span class="p">{</span>
|
||
<span class="c1">// Any dependencies required by your package go here</span>
|
||
<span class="p">},</span>
|
||
<span class="s2">"require-dev"</span><span class="o">:</span> <span class="p">{</span>
|
||
<span class="c1">// Any development dependencies (e.g., PHPUnit) go here</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
<section id="package-name">
|
||
<h3><a class="toc-backref" href="#id3">Package Name</a><a class="headerlink" href="#package-name" title="Permalink to this headline"></a></h3>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">name</span></code> field is important here. Package names are generally written in the
|
||
format “vendor-name/package-name” with all lowercase. Here is a common example:</p>
|
||
<ul class="simple">
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">your-vendor-name</span></code>: The name that identifies the vendor (creator of the package),
|
||
such as your name or your organization.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">your-package-name</span></code>: The name of the package you are creating.</p></li>
|
||
</ul>
|
||
<p>Thus, it is important to make the name unique to distinguish it from other packages.
|
||
Uniqueness is especially important when publishing.</p>
|
||
</section>
|
||
<section id="namespace">
|
||
<h3><a class="toc-backref" href="#id4">Namespace</a><a class="headerlink" href="#namespace" title="Permalink to this headline"></a></h3>
|
||
<p>The package name then determines the vendor namespace in <code class="docutils literal notranslate"><span class="pre">autoload.psr4</span></code>.</p>
|
||
<p>If your package name is <code class="docutils literal notranslate"><span class="pre">your-vendor/your-package</span></code>, the vendor namespace must
|
||
be <code class="docutils literal notranslate"><span class="pre">YourVendor</span></code>. So you would write like the following:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="s2">"autoload"</span><span class="o">:</span> <span class="p">{</span>
|
||
<span class="s2">"psr-4"</span><span class="o">:</span> <span class="p">{</span>
|
||
<span class="s2">"YourVendor</span><span class="se">\\</span><span class="s2">YourPackage</span><span class="se">\\</span><span class="s2">"</span><span class="o">:</span> <span class="s2">"src/"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">},</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>This setting instructs Composer to autoload the source code for your package.</p>
|
||
</section>
|
||
<section id="choosing-license">
|
||
<h3><a class="toc-backref" href="#id5">Choosing License</a><a class="headerlink" href="#choosing-license" title="Permalink to this headline"></a></h3>
|
||
<p>If you are not familiar with open source licenses, see <a class="reference external" href="https://choosealicense.com/">https://choosealicense.com/</a>.
|
||
Many PHP packages, including CodeIgniter, use the MIT license.</p>
|
||
</section>
|
||
</section>
|
||
<section id="preparing-development-tools">
|
||
<h2><a class="toc-backref" href="#id6">Preparing Development Tools</a><a class="headerlink" href="#preparing-development-tools" title="Permalink to this headline"></a></h2>
|
||
<p>There are many tools that help ensure quality code. So you should use them.
|
||
You can easily install and configure such tools with
|
||
<a class="reference external" href="https://github.com/codeigniter4/devkit">CodeIgniter DevKit</a>.</p>
|
||
<section id="installing-devkit">
|
||
<h3><a class="toc-backref" href="#id7">Installing DevKit</a><a class="headerlink" href="#installing-devkit" title="Permalink to this headline"></a></h3>
|
||
<p>In the root of your package directory, run the following commands:</p>
|
||
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">composer config minimum-stability dev</span>
|
||
<span class="go">composer config prefer-stable true</span>
|
||
<span class="go">composer require --dev codeigniter4/devkit</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>The DevKit installs various Composer packages that helps your development, and
|
||
installs templates for them in <strong>vendor/codeigniter4/devkit/src/Template</strong>.
|
||
Copy the files in it to your project root folder, and edit them for your needs.</p>
|
||
</section>
|
||
<section id="configuring-coding-standards-fixer">
|
||
<h3><a class="toc-backref" href="#id8">Configuring Coding Standards Fixer</a><a class="headerlink" href="#configuring-coding-standards-fixer" title="Permalink to this headline"></a></h3>
|
||
<p>DevKit provides Coding Standards Fixer with
|
||
<a class="reference external" href="https://github.com/CodeIgniter/coding-standard">CodeIgniter Coding Standard</a>
|
||
based on <a class="reference external" href="https://github.com/PHP-CS-Fixer/PHP-CS-Fixer">PHP-CS-Fixer</a>.</p>
|
||
<p>Copy <strong>vendor/codeigniter4/devkit/src/Template/.php-cs-fixer.dist.php</strong> to your
|
||
project root folder.</p>
|
||
<p>Create the <strong>build</strong> folder for the cache file:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nx">your</span><span class="o">-</span><span class="nx">package</span><span class="o">-</span><span class="nx">name</span><span class="o">/</span>
|
||
<span class="nx">├──</span> <span class="o">.</span><span class="nx">php</span><span class="o">-</span><span class="nx">cs</span><span class="o">-</span><span class="nx">fixer</span><span class="o">.</span><span class="nx">dist</span><span class="o">.</span><span class="nx">php</span>
|
||
<span class="nx">├──</span> <span class="nx">build</span><span class="o">/</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Open <strong>.php-cs-fixer.dist.php</strong> in your editor, and fix the folder path:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o">---</span> <span class="nx">a</span><span class="o">/.</span><span class="nx">php</span><span class="o">-</span><span class="nx">cs</span><span class="o">-</span><span class="nx">fixer</span><span class="o">.</span><span class="nx">dist</span><span class="o">.</span><span class="nx">php</span>
|
||
<span class="o">+++</span> <span class="nx">b</span><span class="o">/.</span><span class="nx">php</span><span class="o">-</span><span class="nx">cs</span><span class="o">-</span><span class="nx">fixer</span><span class="o">.</span><span class="nx">dist</span><span class="o">.</span><span class="nx">php</span>
|
||
<span class="o">@@</span> <span class="o">-</span><span class="mi">7</span><span class="p">,</span><span class="mi">7</span> <span class="o">+</span><span class="mi">7</span><span class="p">,</span><span class="mi">7</span> <span class="o">@@</span> <span class="k">use</span> <span class="nx">PhpCsFixer\Finder</span><span class="p">;</span>
|
||
<span class="nv">$finder</span> <span class="o">=</span> <span class="nx">Finder</span><span class="o">::</span><span class="na">create</span><span class="p">()</span>
|
||
<span class="o">-></span><span class="na">files</span><span class="p">()</span>
|
||
<span class="o">-></span><span class="na">in</span><span class="p">([</span>
|
||
<span class="o">-</span> <span class="no">__DIR__</span> <span class="o">.</span> <span class="s1">'/app/'</span><span class="p">,</span>
|
||
<span class="o">+</span> <span class="no">__DIR__</span> <span class="o">.</span> <span class="s1">'/src/'</span><span class="p">,</span>
|
||
<span class="no">__DIR__</span> <span class="o">.</span> <span class="s1">'/tests/'</span><span class="p">,</span>
|
||
<span class="p">])</span>
|
||
<span class="o">-></span><span class="na">exclude</span><span class="p">([</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>That’t it. Now you can run Coding Standards Fixer:</p>
|
||
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">vendor/bin/php-cs-fixer fix --ansi --verbose --diff</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>If you add <code class="docutils literal notranslate"><span class="pre">scripts.cs-fix</span></code> in your <strong>composer.json</strong>, you can run it with
|
||
<code class="docutils literal notranslate"><span class="pre">composer</span> <span class="pre">cs-fix</span></code> command:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||
<span class="c1">// ...</span>
|
||
<span class="p">},</span>
|
||
<span class="s2">"scripts"</span><span class="o">:</span> <span class="p">{</span>
|
||
<span class="s2">"cs-fix"</span><span class="o">:</span> <span class="s2">"php-cs-fixer fix --ansi --verbose --diff"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section id="config-files">
|
||
<h2><a class="toc-backref" href="#id9">Config Files</a><a class="headerlink" href="#config-files" title="Permalink to this headline"></a></h2>
|
||
<section id="allowing-users-to-override-settings">
|
||
<h3><a class="toc-backref" href="#id10">Allowing Users to Override Settings</a><a class="headerlink" href="#allowing-users-to-override-settings" title="Permalink to this headline"></a></h3>
|
||
<p>If your package has a configuration file and you want users to be able to override
|
||
the settings, use <a class="reference internal" href="../general/common_functions.html#config" title="config"><code class="xref php php-func docutils literal notranslate"><span class="pre">config()</span></code></a> with the short classname like <code class="docutils literal notranslate"><span class="pre">config('YourConfig')</span></code>
|
||
to call the configuration file.</p>
|
||
<p>Users can then override the package configuration by placing a configuration class
|
||
with the same short classname in <strong>app/Config</strong> that extends the package Config
|
||
class like <code class="docutils literal notranslate"><span class="pre">YourVendor\YourPackage\Config\YourConfig</span></code>.</p>
|
||
</section>
|
||
<section id="overriding-settings-in-app-config">
|
||
<h3><a class="toc-backref" href="#id11">Overriding Settings in app/Config</a><a class="headerlink" href="#overriding-settings-in-app-config" title="Permalink to this headline"></a></h3>
|
||
<p>If you need to override or add to known configurations in the <strong>app/Config</strong> folder,
|
||
you can use <a class="reference internal" href="../general/configuration.html#registrars"><span class="std std-ref">Implicit Registrars</span></a>.</p>
|
||
</section>
|
||
</section>
|
||
<section id="references">
|
||
<h2><a class="toc-backref" href="#id12">References</a><a class="headerlink" href="#references" title="Permalink to this headline"></a></h2>
|
||
<p>We have published some official packages. You can use these packages as references
|
||
when creating your own packages:</p>
|
||
<ul class="simple">
|
||
<li><p><a class="reference external" href="https://github.com/codeigniter4/shield">https://github.com/codeigniter4/shield</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/codeigniter4/settings">https://github.com/codeigniter4/settings</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/codeigniter4/tasks">https://github.com/codeigniter4/tasks</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/codeigniter4/cache">https://github.com/codeigniter4/cache</a></p></li>
|
||
</ul>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="authentication.html" class="btn btn-neutral float-left" title="Authentication" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
<a href="contributing.html" class="btn btn-neutral float-right" title="Contributing to CodeIgniter" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2019-2023 CodeIgniter Foundation.
|
||
<span class="lastupdated">Last updated on Sep 08, 2023.
|
||
</span></p>
|
||
</div>
|
||
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(false);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |