| <!DOCTYPE html><html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-bindings/php" data-has-hydrated="false"><head> |
| <meta charset="UTF-8"> |
| <meta name="generator" content="Docusaurus v3.6.1"> |
| <title data-rh="true">PHP 🚧 | Apache OpenDAL™</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://opendal.apache.org/bindings/php/"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="PHP 🚧 | Apache OpenDAL™"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://opendal.apache.org/bindings/php/"><link data-rh="true" rel="alternate" href="https://opendal.apache.org/bindings/php/" hreflang="en"><link data-rh="true" rel="alternate" href="https://opendal.apache.org/bindings/php/" hreflang="x-default"><link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="Apache OpenDAL™ RSS Feed"> |
| <link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="Apache OpenDALâ„¢ Atom Feed"><link rel="stylesheet" href="/assets/css/styles.9369d349.css"> |
| <script src="/assets/js/runtime~main.1757baa1.js" defer="defer"></script> |
| <script src="/assets/js/main.0ab4cabc.js" defer="defer"></script> |
| </head> |
| <body class="navigation-with-keyboard"> |
| <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"light")}(),function(){try{const n=new URLSearchParams(window.location.search).entries();for(var[t,e]of n)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_mbPH" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" target="_self" href="/"><div class="navbar__logo"><img src="/img/logo.svg" alt="Apache OpenDAL" class="themedComponent_uAN0 themedComponent--light_SXb1" height="32"><img src="/img/logo_dark.svg" alt="Apache OpenDAL" class="themedComponent_uAN0 themedComponent--dark_SjJw" height="32"></div></a></div><div class="navbar__items navbar__items--right"><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/">Docs</a><a class="navbar__item navbar__link" href="/blog/">Blog</a><a class="navbar__item navbar__link" href="/community/">Community</a><a class="navbar__item navbar__link" href="/download/">Download</a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">ASF</a><ul class="dropdown__menu"><li><a href="https://www.apache.org/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Foundation</a></li><li><a href="https://www.apache.org/licenses/" target="_blank" rel="noopener noreferrer" class="dropdown__link">License</a></li><li><a href="https://www.apache.org/events/current-event.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Events</a></li><li><a href="https://privacy.apache.org/policies/privacy-policy-public.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Privacy</a></li><li><a href="https://www.apache.org/security/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Security</a></li><li><a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Sponsorship</a></li><li><a href="https://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Thanks</a></li><li><a href="https://www.apache.org/foundation/policies/conduct.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Code of Conduct</a></li></ul></div><a href="https://github.com/apache/opendal" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link header-github-link" aria-label="GitHub repository"></a><a href="https://discord.gg/XQy8yGR2dg" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link header-discord-link" aria-label="Discord"></a><div class="navbarSearchContainer_cX17"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_NfWm"><div class="docsWrapper_EXDp"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_FqST" type="button"></button><div class="docRoot_FdVe"><aside class="theme-doc-sidebar-container docSidebarContainer_MTQP"><div class="sidebarViewport_zfgy"><div class="sidebar_qrCB"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_Mn2C"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/">Overview</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/vision/">Vision</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/core/">Core</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" href="/category/bindings/">Bindings</a><button aria-label="Collapse sidebar category 'Bindings'" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/bindings/c/">C 🚧</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/bindings/cpp/">Cpp 🚧</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/bindings/d/">D 🚧</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/bindings/dart/">Dart 🚧</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/bindings/dotnet/">Dotnet 🚧</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/bindings/go/">Go</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/bindings/haskell/">Haskell 🚧</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/bindings/java/">Java</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/bindings/lua/">Lua 🚧</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/bindings/nodejs/">Node.js</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/bindings/ocaml/">OCaml 🚧</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/bindings/php/">PHP 🚧</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/bindings/python/">Python</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/bindings/ruby/">Ruby 🚧</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/bindings/swift/">Swift 🚧</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/bindings/zig/">Zig 🚧</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/category/integrations/">Integrations</a><button aria-label="Collapse sidebar category 'Integrations'" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/integrations/cloud_filter/">Cloud Filter</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/integrations/dav_server/">Dav Server</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/integrations/fuse3/">Fuse3</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/integrations/object_store/">Object Store</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/integrations/parquet/">Parquet</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/integrations/spring/">Spring</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/integrations/unftp_sbe/">Unftp Sbe</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/integrations/virtiofs/">Virtiofs</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/category/applications/">Applications</a><button aria-label="Collapse sidebar category 'Applications'" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/apps/oay/">Oay</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/apps/ofs/">Ofs</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/apps/oli/">Oli</a></li></ul></li></ul></nav></div></div></aside><main class="docMainContainer_Ztw0"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_fzqc"><div class="docItemContainer_mgxp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_jTIh" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_crCa"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/category/bindings/"><span itemprop="name">Bindings</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">PHP 🚧</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible__3CD theme-doc-toc-mobile tocMobile_l2EP"><button type="button" class="clean-btn tocCollapsibleButton_Vl9O">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>PHP 🚧</h1></header><header><h2 id="apache-opendal-php-binding-wip">Apache OpenDAL™ PHP Binding (WIP)</h2></header> |
| <p><a href="https://opendal.apache.org/bindings/php/"><img decoding="async" loading="lazy" src="/img/external/552ab0d9376d217ab2e8b0ade233afb8.svg" alt="" class="img_hjxC"></a></p> |
| <h2 class="anchor anchorWithStickyNavbar_hDRy" id="example">Example<a href="#example" class="hash-link" aria-label="Direct link to Example" title="Direct link to Example">​</a></h2> |
| <div class="language-php codeBlockContainer_HoUO theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_fLNQ"><pre tabindex="0" class="prism-code language-php codeBlock_OwT2 thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_CaTV"><span class="token-line" style="color:#393A34"><span class="token plain">use OpenDAL\Operator;</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">$op = new Operator("fs", ["root" => "/tmp"]);</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">$op->write("test.txt", "hello world");</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">echo $op->read("test.txt"); // hello world</span><br></span></code></pre><div class="buttonGroup_ry9d"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_hlAx" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_e2oV"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_Kvv3"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> |
| <h2 class="anchor anchorWithStickyNavbar_hDRy" id="requirements">Requirements<a href="#requirements" class="hash-link" aria-label="Direct link to Requirements" title="Direct link to Requirements">​</a></h2> |
| <ul> |
| <li>PHP 8.1+</li> |
| <li>Composer</li> |
| </ul> |
| <h2 class="anchor anchorWithStickyNavbar_hDRy" id="install-extension">Install Extension<a href="#install-extension" class="hash-link" aria-label="Direct link to Install Extension" title="Direct link to Install Extension">​</a></h2> |
| <p>We use <a href="https://github.com/davidcole1340/ext-php-rs">ext-php-rs</a> to build PHP extensions natively in Rust, it's different from the traditional PHP extension development and cannot be installed using <code>pecl</code> or <code>phpize</code>. Before installing the extension, it is necessary to install Rust and Cargo. For instructions on how to install them, please refer to <a href="https://www.rust-lang.org/tools/install">Rust's website</a>.</p> |
| <ol> |
| <li>Clone the repository</li> |
| </ol> |
| <div class="language-bash codeBlockContainer_HoUO theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_fLNQ"><pre tabindex="0" class="prism-code language-bash codeBlock_OwT2 thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_CaTV"><span class="token-line" style="color:#393A34"><span class="token plain">git clone git@github.com:apache/opendal.git</span><br></span></code></pre><div class="buttonGroup_ry9d"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_hlAx" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_e2oV"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_Kvv3"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> |
| <ol start="2"> |
| <li>Build the opendal-php extension</li> |
| </ol> |
| <div class="language-bash codeBlockContainer_HoUO theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_fLNQ"><pre tabindex="0" class="prism-code language-bash codeBlock_OwT2 thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_CaTV"><span class="token-line" style="color:#393A34"><span class="token plain">cd opendal/bindings/php</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">cargo build</span><br></span></code></pre><div class="buttonGroup_ry9d"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_hlAx" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_e2oV"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_Kvv3"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> |
| <blockquote> |
| <p>don't forget to add <code>--release</code> flag for production use.</p> |
| </blockquote> |
| <ol start="3"> |
| <li>Enable extension for PHP Manually</li> |
| </ol> |
| <div class="language-bash codeBlockContainer_HoUO theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_fLNQ"><pre tabindex="0" class="prism-code language-bash codeBlock_OwT2 thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_CaTV"><span class="token-line" style="color:#393A34"><span class="token plain">cd opendal</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># Linux</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">cp target/debug/libopendal_php.so $(php -r "echo ini_get('extension_dir');")/libopendal_php.so</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">echo "extension=libopendal_php.so" >> $(php -r "echo php_ini_loaded_file();")</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># macOS</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">cp target/debug/libopendal_php.dylib $(php -r "echo ini_get('extension_dir');")/libopendal_php.dylib</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">echo "extension=libopendal_php.dylib" >> $(php -r "echo php_ini_loaded_file();")</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># Windows</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">cp target/debug/libopendal_php.dll $(php -r "echo ini_get('extension_dir');")/libopendal_php.dll</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">echo "extension=libopendal_php.dll" >> $(php -r "echo php_ini_loaded_file();")</span><br></span></code></pre><div class="buttonGroup_ry9d"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_hlAx" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_e2oV"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_Kvv3"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> |
| <ol start="4"> |
| <li>Enable extension for PHP using cargo-php</li> |
| </ol> |
| <p>You can also use cargo-php directly to install the extension, see <a href="https://davidcole1340.github.io/ext-php-rs/getting-started/cargo-php.html">cargo-php</a> for more details.</p> |
| <div class="language-bash codeBlockContainer_HoUO theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_fLNQ"><pre tabindex="0" class="prism-code language-bash codeBlock_OwT2 thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_CaTV"><span class="token-line" style="color:#393A34"><span class="token plain">cargo install cargo-php</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">cd opendal/bindings/php</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">cargo php install</span><br></span></code></pre><div class="buttonGroup_ry9d"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_hlAx" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_e2oV"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_Kvv3"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> |
| <p>This command will automatically build the extension and copy it to the extension directory of the current PHP version.</p> |
| <ol start="5"> |
| <li>Test</li> |
| </ol> |
| <p>use <code>php -m</code> to check if the extension is installed successfully.</p> |
| <div class="language-bash codeBlockContainer_HoUO theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_fLNQ"><pre tabindex="0" class="prism-code language-bash codeBlock_OwT2 thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_CaTV"><span class="token-line" style="color:#393A34"><span class="token plain">php -m | grep opendal-php</span><br></span></code></pre><div class="buttonGroup_ry9d"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_hlAx" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_e2oV"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_Kvv3"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> |
| <p>Composer test:</p> |
| <div class="language-bash codeBlockContainer_HoUO theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_fLNQ"><pre tabindex="0" class="prism-code language-bash codeBlock_OwT2 thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_CaTV"><span class="token-line" style="color:#393A34"><span class="token plain">cd opendal/bindings/php</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">composer install</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">composer test</span><br></span></code></pre><div class="buttonGroup_ry9d"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_hlAx" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_e2oV"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_Kvv3"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> |
| <h2 class="anchor anchorWithStickyNavbar_hDRy" id="license-and-trademarks">License and Trademarks<a href="#license-and-trademarks" class="hash-link" aria-label="Direct link to License and Trademarks" title="Direct link to License and Trademarks">​</a></h2> |
| <p>Licensed under the Apache License, Version 2.0: <a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a></p> |
| <p>Apache OpenDAL, OpenDAL, and Apache are either registered trademarks or trademarks of the Apache Software Foundation.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/apache/opendal/tree/main/website/docs/20-bindings/php.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_vgs4" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_l9Jf"><span class="theme-last-updated">Last updated<!-- --> on <b><time datetime="2025-03-14T08:46:01.000Z" itemprop="dateModified">Mar 14, 2025</time></b> by <b>Friends A.</b></span></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/bindings/ocaml/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">OCaml 🚧</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/bindings/python/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Python</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_f6Mq thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#example" class="table-of-contents__link toc-highlight">Example</a></li><li><a href="#requirements" class="table-of-contents__link toc-highlight">Requirements</a></li><li><a href="#install-extension" class="table-of-contents__link toc-highlight">Install Extension</a></li><li><a href="#license-and-trademarks" class="table-of-contents__link toc-highlight">License and Trademarks</a></li></ul></div></div></div></div></main></div></div></div><footer class="footer"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="margin-bottom--sm"><a href="https://www.apache.org/" rel="noopener noreferrer" class="footerLogoLink_iEtV"><img src="/./img/asf_logo_wide.svg" alt="Apache Software Foundation" class="footer__logo themedComponent_uAN0 themedComponent--light_SXb1" width="300"><img src="/./img/asf_logo_wide.svg" alt="Apache Software Foundation" class="footer__logo themedComponent_uAN0 themedComponent--dark_SjJw" width="300"></a></div><div class="footer__copyright">Copyright © 2022-2025, The Apache Software Foundation<br>Apache OpenDAL, OpenDAL, Apache, the Apache feather and the Apache OpenDAL project logo are either registered trademarks or trademarks of the Apache Software Foundation.</div></div></div></footer></div> |
| |
| </body></html> |
