Notion PHP SDK

Codecycler

Last update: Nov 29, 2022

Related tags

API php sdk notion notion-api notion-sdk

Overview

Notion PHP SDK

This is an unofficial PHP SDK for the new public Notion API. It's work in progress as we didn't get the change to be included to the private beta.

Installation

You can install the package via composer:

composer require codecycler/notion

Usage

Getting all databases attached to your integration.

use Notion\Notion;

$databaseOptions = new Notion($token)
    ->database()
    ->ids();

Querying a database by id

use Notion\Notion;

$databaseOptions = new Notion($token)
    ->database($databaseId)
    ->query()
    ->get();

Query database by property (WIP)

$database = $client->database('e3161af3-ff12-43c5-9f42-02eea4ab4cbf')
  ->query()
  ->where('Show on website', 'checkbox', 'equals', true)
  ->get();

foreach ($database->pages as $page) {
  $name = $page->name;
  $status = $page->status;
}

Getting a page by id

$page = $client->page('9b0ff081-1af8-4751-92d6-9e07fbd5c20d')->get();

$name           = $page->name;          // Property: 'Name'
$showOnWebsite  = $page->showOnWebsite; // Property: 'Show on website'

Creating a new page in a database

$database = $client->database('e3161af3-ff12-43c5-9f42-02eea4ab4cbf')->get();

$page = $database->newPage();

$page->name = 'New page created with the Notion API';
$page->showOnWebsite = true;

$page->save();

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

Comments

Better support for empty properties
Changes

Proper support for empty Date, Select, and People properties.

The People property now returns an array instead of the name of the first person.
opened by andreascreten 2
fix: init "select" property on set when not isset

When the select configuration on the Notion page is empty and if we are trying to set a value with your API, we got a warning message:

PHP Warning: Creating default object from empty value in Notion/Properties/Select.php on line 14

Adding a isset() condition and setting the select property fix this issue. Please note that this issue may appear on other child classes of PropertyBase.

opened by Divi 1
Fix for body failed validation: body.parent should be defined, instead was undefined.

Fixes empty array being passed to the 'Notion\Objects\Page->initProperties' method, causing error from Notion API: body failed validation: body.parent should be defined, instead was undefined.

opened by cy-josh 1
[Bug] Icon on new Pages will not get saved

Currently if you add a new Page to a Database ($notion->database('id')->get()->newPage()) you cannot set the icon. If I do $page->icon = '💬'; and save that page ($page->save();) the icon will not get saved.

Is this planned for the future?

opened by riyuk 0
Undefined "ray()" function

Hi, I cannot send a new page request as an undefined function is being used here :

https://github.com/codecyclernl/notion-php-sdk/blob/965ab2e013dd226fdc955a9dc395efcf22611cb7/src/Notion/Objects/Page.php#L68

Maybe I'm missing something? Let me know! Thank you.

opened by p-cauty 1
Properties array key generation method change
Proposal: Change key generation method from $this->properties[Str::camel($label)] to this $this->properties[sha1($label)]

Reason:

non-Latin titles are "camelcased" incorrectly

some non-letter titles become empty strings (for example: _)

thus, different titles have same keys in some cases (for example: _ and __)

If we generate sha1 from the title - we get the unique array key with a fairly high probability. Now we can refer to properties with their Notion titles: $page->Name, $page->Status, etc. Also, we can refer to properties with space in title $page->{'Show On Website'} and to non-latin properties: $page->{'Дата просмотра'}

Code style and backward compatibility To follow code style for latin-letter-named properties case and for providing backward compatibility we store camelcased titles as aliases to sha1-keys. So, the $page->showOnWebsite still works the same as $page->{'Show On Website'}

Testing Although I checked this on my tables, it's better to be tested additionally ;)

p.s. Added function_exists check for the ray call
opened by xpundel 0

Releases(0.11.0)

0.11.0(Feb 10, 2022)
What's Changed

Allow installation of illuminate/support 9.x by @jdrieghe in https://github.com/codecyclernl/notion-php-sdk/pull/12

New Contributors

@jdrieghe made their first contribution in https://github.com/codecyclernl/notion-php-sdk/pull/12

Full Changelog: https://github.com/codecyclernl/notion-php-sdk/compare/0.10.0...0.11.0
Source code(tar.gz)
Source code(zip)
0.10.0(Jan 31, 2022)
What's Changed

fix: init "select" property on set when not isset by @Divi in https://github.com/codecyclernl/notion-php-sdk/pull/9

Better support for empty properties by @andreascreten in https://github.com/codecyclernl/notion-php-sdk/pull/10

New Contributors

@Divi made their first contribution in https://github.com/codecyclernl/notion-php-sdk/pull/9

@andreascreten made their first contribution in https://github.com/codecyclernl/notion-php-sdk/pull/10

Full Changelog: https://github.com/codecyclernl/notion-php-sdk/compare/0.9.0...0.10.0
Source code(tar.gz)
Source code(zip)
0.6.0(May 17, 2021)

More information in the documentation soon!
Source code(tar.gz)
Source code(zip)
0.5.0(May 15, 2021)

More coming very soon!
Source code(tar.gz)
Source code(zip)

Owner

Codecycler

GitHub

Shopware PHP SDK is a simple SDK implementation of Shopware 6 APIs

Shopware PHP SDK is a simple SDK implementation of Shopware 6 APIs. It helps to access the API in an object-oriented way.

77 Dec 19, 2022

Zoho CRM API SDK is a wrapper to Zoho CRM APIs. By using this sdk, user can build the application with ease

Archival Notice: This SDK is archived. You can continue to use it, but no new features or support requests will be accepted. For the new version, refe

81 Nov 4, 2022

The 1Password Connect PHP SDK provides your PHP applications access to the 1Password Connect API hosted on your infrastructure and leverage the power of 1Password Secrets Automation

1Password Connect PHP SDK The 1Password Connect PHP SDK provides your PHP applications access to the 1Password Connect API hosted on your infrastructu