2024-02-15 11:13:57 +01:00
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html lang="en">
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8">
|
|
|
|
|
<title>PHP Basics</title>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
|
<base href="../../">
|
|
|
|
|
<link rel="icon" href="images/favicon.ico"/>
|
|
|
|
|
<link rel="stylesheet" href="css/normalize.css">
|
|
|
|
|
<link rel="stylesheet" href="css/base.css">
|
|
|
|
|
<link rel="preconnect" href="https://fonts.gstatic.com">
|
|
|
|
|
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
|
|
|
|
|
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
|
|
|
|
|
<link rel="stylesheet" href="css/template.css">
|
|
|
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
|
|
|
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
|
|
|
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
|
|
|
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
|
|
|
|
|
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
|
|
|
|
|
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
|
|
|
|
|
<script src="js/template.js"></script>
|
|
|
|
|
<script src="js/search.js"></script>
|
|
|
|
|
<script defer src="js/searchIndex.js"></script>
|
|
|
|
|
</head>
|
|
|
|
|
<body id="top">
|
|
|
|
|
<header class="phpdocumentor-header phpdocumentor-section">
|
|
|
|
|
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP Basics</a></h1>
|
|
|
|
|
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
|
|
|
|
|
<label class="phpdocumentor-header__menu-icon" for="menu-button">
|
|
|
|
|
<i class="fas fa-bars"></i>
|
|
|
|
|
</label>
|
|
|
|
|
<section data-search-form class="phpdocumentor-search">
|
|
|
|
|
<label>
|
|
|
|
|
<span class="visually-hidden">Search for</span>
|
|
|
|
|
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
|
|
|
|
|
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
|
|
|
|
|
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
|
|
|
|
|
</svg>
|
|
|
|
|
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
|
|
|
|
|
</label>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<nav class="phpdocumentor-topnav">
|
|
|
|
|
<ul class="phpdocumentor-topnav__menu">
|
|
|
|
|
<li class="phpdocumentor-topnav__menu-item -menu">
|
|
|
|
|
<a href="https://packagist.org/packages/opencultureconsulting/basics">
|
|
|
|
|
<span>
|
|
|
|
|
<i class="fab fa-php"></i>
|
|
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class="phpdocumentor-topnav__menu-item -menu">
|
|
|
|
|
<a href="https://github.com/opencultureconsulting/php-basics">
|
|
|
|
|
<span>
|
|
|
|
|
<i class="fab fa-github"></i>
|
|
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
</a>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</nav>
|
|
|
|
|
</header>
|
|
|
|
|
|
|
|
|
|
<main class="phpdocumentor">
|
|
|
|
|
<div class="phpdocumentor-section">
|
|
|
|
|
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
|
|
|
|
|
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
|
|
|
|
|
Menu
|
|
|
|
|
</label>
|
|
|
|
|
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
|
|
|
|
|
<section class="phpdocumentor-sidebar__category -documentation">
|
|
|
|
|
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
|
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
|
|
|
<a href="guides/overview/index.html#overview" class="">Overview</a>
|
|
|
|
|
</h4>
|
2024-03-26 20:10:30 +01:00
|
|
|
<ul class="phpdocumentor-list">
|
|
|
|
|
<li>
|
|
|
|
|
<a href="guides/overview/datastructures.html#typed-datastructures" class="">Typed Datastructures</a>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<a href="guides/overview/errorhandlers.html#error-and-exception-handlers" class="">Error and Exception Handlers</a>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<a href="guides/overview/interfaces.html#interface-traits" class="">Interface Traits</a>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<a href="guides/overview/traits.html#traits" class="">Traits</a>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
2024-02-15 11:13:57 +01:00
|
|
|
|
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
|
|
|
<a href="guides/usage/index.html#user-guide" class="">User Guide</a>
|
|
|
|
|
</h4>
|
|
|
|
|
<ul class="phpdocumentor-list">
|
|
|
|
|
<li>
|
|
|
|
|
<a href="guides/usage/requirements.html#requirements" class="">Requirements</a>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<a href="guides/usage/installation.html#installation" class="">Installation</a>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
|
|
|
<a href="guides/changelog.html#changelog" class="">Changelog</a>
|
|
|
|
|
</h4>
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
|
<section class="phpdocumentor-sidebar__category -namespaces">
|
|
|
|
|
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
|
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
|
|
|
<a href="namespaces/occ.html" class="">OCC</a>
|
|
|
|
|
</h4>
|
|
|
|
|
<ul class="phpdocumentor-list">
|
|
|
|
|
<li>
|
|
|
|
|
<a href="namespaces/occ-basics.html" class="">Basics</a>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
|
<section class="phpdocumentor-sidebar__category -packages">
|
|
|
|
|
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
|
|
|
|
|
<h4 class="phpdocumentor-sidebar__root-namespace">
|
|
|
|
|
<a href="packages/Basics.html" class="">Basics</a>
|
|
|
|
|
</h4>
|
|
|
|
|
<ul class="phpdocumentor-list">
|
|
|
|
|
<li>
|
|
|
|
|
<a href="packages/Basics-DataStructures.html" class="">DataStructures</a>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<a href="packages/Basics-ErrorHandlers.html" class="">ErrorHandlers</a>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<a href="packages/Basics-Interfaces.html" class="">Interfaces</a>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<a href="packages/Basics-Traits.html" class="">Traits</a>
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-sidebar__category -reports">
|
|
|
|
|
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
|
|
|
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
|
|
|
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
|
|
|
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
|
|
|
|
|
</section>
|
|
|
|
|
|
2024-02-19 14:52:57 +01:00
|
|
|
<section class="phpdocumentor-sidebar__category -indices">
|
|
|
|
|
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
|
2024-02-15 11:13:57 +01:00
|
|
|
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
|
|
|
|
|
</section>
|
|
|
|
|
</aside>
|
|
|
|
|
|
|
|
|
|
<div class="phpdocumentor-column -nine phpdocumentor-content">
|
|
|
|
|
<div class="section" id="installation">
|
|
|
|
|
<h1>Installation</h1>
|
|
|
|
|
|
2024-03-26 20:10:30 +01:00
|
|
|
<div class="admonition-wrapper">
|
|
|
|
|
<div class="admonition admonition-sidebar"><p class="sidebar-title">Table of Contents</p>
|
|
|
|
|
<div class="contents"><ul class="phpdocumentor-list"><li class="toc-item"><a href="guides/usage/installation.html#composer">Composer</a></li><li class="toc-item"><a href="guides/usage/installation.html#git">Git</a></li><li class="toc-item"><a href="guides/usage/installation.html#download">Download</a></li></ul></div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
|
2024-02-19 14:52:57 +01:00
|
|
|
<div class="section" id="composer">
|
|
|
|
|
<h2>Composer</h2>
|
|
|
|
|
|
|
|
|
|
<p>The intended and recommended way of re-using this package is via <a href="https://getcomposer.org/">Composer</a>. The following
|
|
|
|
|
command will get you the latest version and make it a dependency of your project. It will also register all classes and
|
|
|
|
|
traits with the autoloader to make them available inside the application.</p>
|
|
|
|
|
<pre><code class="language-shell"># This will install the latest stable version suitable for your project
|
|
|
|
|
composer require "opencultureconsulting/basics"</code></pre>
|
|
|
|
|
<p>If you want to use a specific version other than the latest available for your environment, you can do so by appending
|
|
|
|
|
the desired version constraint:</p>
|
|
|
|
|
<pre><code class="language-shell"># This will install the latest patch level version of 2.0 (i. e. >=2.0.0 && <2.1.0)
|
|
|
|
|
composer require "opencultureconsulting/basics:~2.0"</code></pre>
|
|
|
|
|
<p>All available versions as well as further information about <a href="guides/usage/requirements.html">Requirements</a>
|
|
|
|
|
and dependencies can be found on
|
|
|
|
|
<a href="https://packagist.org/packages/opencultureconsulting/basics">Packagist</a>.</p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="section" id="git">
|
|
|
|
|
<h2>Git</h2>
|
|
|
|
|
|
|
|
|
|
<p>Alternatively, you can fetch the files from <a href="https://github.com/opencultureconsulting/php-basics">GitHub</a> and add
|
|
|
|
|
them to your project manually. The best way is by cloning the repository, because then you can easily update to a newer
|
|
|
|
|
version by just pulling the changes and checking out a different version tag.</p>
|
|
|
|
|
<pre><code class="language-shell"># This will clone the repository into the "basics" directory
|
|
|
|
|
git clone https://github.com/opencultureconsulting/php-basics.git basics</code></pre>
|
|
|
|
|
<p>If you want to use a specific version other than the latest development state, you have to specify the desired tag as
|
|
|
|
|
well:</p>
|
|
|
|
|
<pre><code class="language-shell"># This will clone the repository state at version "2.0.0" into the "basics" directory
|
|
|
|
|
git clone --branch=v2.0.0 https://github.com/opencultureconsulting/php-basics.git basics</code></pre>
|
|
|
|
|
<p>Be aware that you also need to make the classes and traits available in your application by either adding them to your
|
|
|
|
|
autoloader or by including all files individually in PHP.</p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="section" id="download">
|
|
|
|
|
<h2>Download</h2>
|
|
|
|
|
|
|
|
|
|
<p>As a last resort you can also just download the files. You can find all available versions as well as the current
|
|
|
|
|
development state on the <a href="https://github.com/opencultureconsulting/php-basics/releases">GitHub release page</a>.</p>
|
|
|
|
|
</div>
|
|
|
|
|
|
2024-02-15 11:13:57 +01:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
|
|
|
|
|
<section class="phpdocumentor-search-results__dialog">
|
|
|
|
|
<header class="phpdocumentor-search-results__header">
|
|
|
|
|
<h2 class="phpdocumentor-search-results__title">Search results</h2>
|
|
|
|
|
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
|
|
|
|
|
</header>
|
|
|
|
|
<section class="phpdocumentor-search-results__body">
|
|
|
|
|
<ul class="phpdocumentor-search-results__entries"></ul>
|
|
|
|
|
</section>
|
|
|
|
|
</section>
|
|
|
|
|
</section>
|
|
|
|
|
</div>
|
|
|
|
|
<a href="guides/usage/installation.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
|
|
|
|
|
|
|
|
|
|
</main>
|
|
|
|
|
|
|
|
|
|
<script>
|
|
|
|
|
cssVars({});
|
|
|
|
|
</script>
|
|
|
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
|
|
|
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
|
|
|
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
|
|
|
|
|
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
