8000 📚 Mobile v1.1 Documentation Updates by shanerbaner82 · Pull Request #178 · NativePHP/nativephp.com · GitHub
[go: up one dir, main page]

Skip to content

📚 Mobile v1.1 Documentation Updates #178

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
4 changes: 2 additions & 2 deletions app/Http/Controllers/ShowDocumentationController.php
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ public function __invoke(Request $request, string $platform, string $version, ?s
} catch (InvalidArgumentException $e) {
return $this->redirectToFirstNavigationPage($navigation, $page);
}

SEOTools::setTitle($pageProperties['title'].' - NativePHP '.$platform.' v'.$version);
SEOTools::setDescription(Arr::exists($pageProperties, 'description') ? $pageProperties['description'] : '');

Expand All @@ -65,7 +64,8 @@ protected function getPageProperties($platform, $version, $page = null): array
$pageProperties = $document->matter();

$versionProperties = YamlFrontMatter::parseFile(resource_path("views/docs/{$platform}/{$version}/_index.md"));
$pageProperties = array_merge($pageProperties, $versionProperties->matter());

$pageProperties = array_merge($versionProperties->matter(), $pageProperties);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not necessarily an issue but can you help me understand why the order of arguments were switched here? Was something being overwritten we wasn't expecting? 👀

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually yeah, and maybe you can verify, locally for me every page showed "Mobile" as the title of the document, reversing this fixed it for me. On the website currently it works fine now, not sure what's going on tbh and I didn't switch it back.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On my end I see the title NativePHP on every page. Looks like the title tag is present in the head twice.

By editing $pageProperties the second title tag does change, but my browser only picks up the first one so I can't see it.


$pageProperties['platform'] = $platform;
$pageProperties['version'] = $version;
Expand Down
99 changes: 99 additions & 0 deletions resources/views/docs/mobile/1/_index.md
F438
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
---
title: Mobile
order: 1
---

# NativePHP for Mobile

**Build native iOS and Android apps with PHP and Laravel**

NativePHP for Mobile revolutionizes mobile development by allowing PHP developers to create native mobile applications using the languages and frameworks they already know and love. No need to learn Swift, Kotlin, or React Native - just pure PHP and Laravel.

## What Makes NativePHP Mobile Special?

📱**Native Performance** - Your app runs natively on device with embedded PHP runtime
🔥**True Mobile APIs** - Access camera, biometrics, push notifications, and more
⚡ **Laravel Powered** - Use your existing Laravel skills and ecosystem
🚫**No Web Server** - Your app runs entirely on-device
🔄**Cross Platform** - Single codebase for iOS and Android

## Quick Start

Get your first mobile app running in minutes:

```bash
# Install NativePHP Mobile
composer require nativephp/mobile

# Configure your app
php artisan native:install

# Run your app
php artisan native:run
```

## Current Features (v1.1)

**Available now:**
- 📷 Camera & Gallery access
- 🔐 Biometric authentication (Face ID, Touch ID, Fingerprint)
- 🔔 Push notifications via Firebase
- 💬 Native dialogs & toasts
- 🔗 Deep links & universal links
- 📱 NFC support
- 📳 Haptic feedback & vibration
- 🔦 Flashlight control
- 📤 Native sharing
- 🔒 Secure storage (Keychain/Keystore)
- 📍 Location services

[See the complete roadmap 🗺️](/docs/mobile/1/getting-started/roadmap)

## Documentation Sections

### [Getting Started](/docs/mobile/1/getting-started)
Everything you need to start building mobile apps with PHP:
- [Introduction](/docs/mobile/1/getting-started/introduction) - Learn how NativePHP Mobile works
- [Installation](/docs/mobile/1/getting-started/installation) - Set up your development environment
- [Environment Setup](/docs/mobile/1/getting-started/environment-setup) - Configure iOS and Android tools
- [Configuration](/docs/mobile/1/getting-started/configuration) - App settings and permissions
- [Development](/docs/mobile/1/getting-started/development) - Development workflow
- [Roadmap](/docs/mobile/1/getting-started/roadmap) - Current and planned features

### [The Basics](/docs/mobile/1/the-basics)
Core concepts and fundamental knowledge:
- [Native Functions](/docs/mobile/1/the-basics/native-functions) - Understanding sync vs async APIs
- [Asynchronous Methods](/docs/mobile/1/the-basics/asynchronous-methods) - Event-driven mobile development
- [ICU Support](/docs/mobile/1/the-basics/icu-support) - International components for Unicode

### [Concepts](/docs/mobile/1/concepts)
Important concepts for mobile app development:
- [CI/CD](/docs/mobile/1/concepts/ci-cd) - Continuous integration and deployment
- [Deep Links](/docs/mobile/1/concepts/deep-links) - Universal links, app links, and NFC
- [Push Notifications](/docs/mobile/1/concepts/push-notifications) - Firebase Cloud Messaging setup
- [Splash Screen/Icons](/docs/mobile/1/concepts/splash-screen-icons) - App branding and assets
- [Versioning](/docs/mobile/1/concepts/versioning) - App version management

### [APIs](/docs/mobile/1/apis)
Complete API reference for all native features:
- [Biometrics](/docs/mobile/1/apis/biometrics) - Face ID, Touch ID, fingerprint authentication
- [Camera](/docs/mobile/1/apis/camera) - Photo capture and gallery access
- [Dialog](/docs/mobile/1/apis/dialog) - Alerts, toasts, and sharing
- [Geolocation](/docs/mobile/1/apis/geolocation) - GPS and location services
- [Haptics](/docs/mobile/1/apis/haptics) - Vibration and tactile feedback
- [PushNotifications](/docs/mobile/1/apis/push-notifications) - FCM token management
- [SecureStorage](/docs/mobile/1/apis/secure-storage) - Keychain and keystore operations
- [System](/docs/mobile/1/apis/system) - Flashlight and legacy methods

### [Digging Deeper](/docs/mobile/1/digging-deeper)
Advanced topics for production apps:
- [Databases](/docs/mobile/1/digging-deeper/databases) - SQLite and data management
- [Security](/docs/mobile/1/digging-deeper/security) - Best practices and secure storage

## Need Help?

- **License Required** - [Purchase your license](https://nativephp.com/mobile) to get started
- **Community** - Join our Discord for support and discussions
- **Examples** - Check out the Kitchen Sink demo app (coming soon to app stores)

Ready to build your first mobile app with PHP? [Let's get started! 🚀](/docs/mobile/1/getting-started/introduction)
4 changes: 4 additions & 0 deletions resources/views/docs/mobile/1/apis/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: APIs
order: 4
---
93 changes: 93 additions & 0 deletions resources/views/docs/mobile/1/apis/biometrics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
---
title: Biometrics
order: 100
---

## Overview

The Biometrics API allows you to authenticate users using their device's biometric sensors like Face ID, Touch ID, or fingerprint scanners.

```php
use Native\Mobile\Facades\Biometrics;
```

## Methods

### `promptForBiometricID()`

Prompts the user for biometric authentication.

## Events

### `Completed`

Fired when biometric authentication completes (success or failure).

```php
use Livewire\Attributes\On;
use Native\Mobile\Events\Biometric\Completed;

#[On('native:' . Completed::class)]
public function handleBiometricAuth(bool $success)
{
if ($success) {
// User authenticated successfully
$this->unlockSecureFeature();
} else {
// Authentication failed
$this->showErrorMessage();
}
}
```

## Example Usage

```php
use Livewire\Component;
use Livewire\Attributes\On;
use Native\Mobile\Facades\Biometrics;
use Native\Mobile\Events\Biometric\Completed;

class SecureArea extends Component
{
public bool $isUnlocked = false;
public bool $isAuthenticating = false;

public function authenticate()
{
$this->isAuthenticating = true;
Biometrics::promptForBiometricID();
}

#[On('native:' . Completed::class)]
public function handleBiometricAuth(bool $success)
{
$this->isAuthenticating = false;

if ($success) {
$this->isUnlocked = true;
session(['biometric_authenticated' => true]);
} else {
$this->addError('auth', 'Biometric authentication failed');
}
}

public function render()
{
return view('livewire.secure-area');
}
}
```

## Platform Support

- **iOS:** Face ID, Touch ID
- **Android:** Fingerprint, Face unlock, other biometric methods
- **Fallback:** System authentication (PIN, password, pattern)

## Security Notes

- Biometric authentication provides **convenience**, not absolute security
- Always combine with other authentication factors for sensitive operations
- Consider implementing session timeouts for unlocked states
- Users can potentially bypass biometrics if their device is compromised
161 changes: 161 additions & 0 deletions resources/views/docs/mobile/1/apis/camera.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
---
title: Camera
order: 200
---

## Overview

The Camera API provides access to the device's camera for taking photos and selecting images from the gallery.

```php
use Native\Mobile\Facades\Camera;
```

## Methods

### `getPhoto()`

Opens the camera interface to take a photo.

```php
Camera::getPhoto();
```

### `pickImages()`

Opens the gallery/photo picker to select existing images.

**Parameters:**
- `string $media_type` - Type of media to pick: `'all'`, `'images'`, `'videos'` (default: `'all'`)
- `bool $multiple` - Allow multiple selection (default: `false`)

**Returns:** `bool` - `true` if picker opened successfully

```php
// Pick a single image
Camera::pickImages('images', false);

// Pick multiple images
Camera::pickImages('images', true);

// Pick any media type
Camera::pickImages('all', true);
```

## Events

### `PhotoTaken`

Fired when a photo is taken with the camera.

**Payload:** `string $path` - File path to the captured photo

```php
use Livewire\Attributes\On;
use Native\Mobile\Events\Camera\PhotoTaken;

#[On('native:' . PhotoTaken::class)]
public function handlePhotoTaken(string $path)
{
// Process the captured photo
$this->processPhoto($path);
}
```

### `MediaSelected`

Fired when media is selected from the gallery.

**Payload:** `array $media` - Array of selected media items

```php
use Livewire\Attributes\On;
use Native\Mobile\Events\Gallery\MediaSelected;

#[On('native:' . MediaSelected::class)]
public function handleMediaSelected($success, $files, $count)
{
foreach ($files as $file) {
// Process each selected media item
$this->processMedia($file);
}
}
```

## Example Usage

```php
use Livewire\Component;
use Livewire\Attributes\On;
use Native\Mobile\Facades\Camera;
use Native\Mobile\Events\Camera\PhotoTaken;
use Native\Mobile\Events\Gallery\MediaSelected;

class PhotoManager extends Component
{
public array $photos = [];
public bool $isCapturing = false;

public function takePhoto()
{
$this->isCapturing = true;
Camera::getPhoto();
}

public function pickFromGallery()
{
Camera::pickImages('images', true, 5);
}

#[On('native:' . PhotoTaken::class)]
public function handlePhotoTaken(string $path)
{
$this->isCapturing = false;
$this->addPhoto($path);
}

#[On('native:' . MediaSelected::class)]
public function handleMediaSelected($success, $files, $count)
{
foreach ($files as $file) {
$this->addPhoto($file);
}
}

private function addPhoto(string $path)
{
$this->photos[] = [
'path' => $path,
'data_url' => $this->createDataUrl($path),
'timestamp' => now()
];
}

private function createDataUrl(string $path): string
{
$data = base64_encode(file_get_contents($path));
$mime = mime_content_type($path);
return "data:$mime;base64,$data";
}

public function render()
{
return view('livewire.photo-manager');
}
}
```

## Platform Support

- **iOS:** Uses UIImagePickerController and Photos framework
- **Android:** Uses `Intent.ACTION_IMAGE_CAPTURE` and gallery intents
- **Permissions:** Camera permission required for photo capture
- **File Location:** Photos saved to app's temporary directory

## Notes

- The first time your app requests camera access, users will be prompted for permission
- If permission is denied, camera functions will fail silently
- Captured photos are stored in the app's temporary directory
- Consider implementing cleanup for old temporary photos
- File formats are platform-dependent (typically JPEG)
Loading
0