Yii Framework 2.0 API ドキュメント

これはYii FrameworkのAPIドキュメンテーションです。ここでは、フレームワークが提供するすべてのクラスに関する詳細な情報が提供されています。以下に、存在するクラス、インターフェース、およびトレイトのリストを、完全修飾名(名前空間を含む)で並べたものがあります。それぞれのクラスには、そのクラスの目的に関する説明、利用可能なメソッド、プロパティ、定数のリスト、およびそれらの使用方法に関する詳細な説明が含まれた専用のページがあります。

このページには、フレームワークのバージョン2.0に含まれるすべてのクラスが含まれています。

クラス名説明
YiiYiiは共通のフレームワーク機能を提供するヘルパークラスです。
YiiRequirementCheckerYiiRequirementCheckerはYiiアプリケーションの実行要件を満たしているかどうかを確認するためのクラスです。
yii\BaseYii BaseYiiYiiフレームワークの中核となるヘルパークラスです。
yii\base\ActionActionはすべてのコントローラーアクションクラスの基本クラスです。
yii\base\ActionEventActionEventはアクションイベントに使用されるイベントパラメーターを表します。
yii\base\ActionFilterActionFilterはアクションフィルターの基本クラスです。
yii\base\ApplicationApplicationはすべてのアプリケーションクラスの基本クラスです。
yii\base\ArrayAccessTraitArrayAccessTraitはIteratorAggregate、ArrayAccess、およびCountableの実装を提供します。
yii\base\ArrayableArrayableはインスタンスのカスタマイズ可能な表現をサポートしたいクラスで実装すべきインターフェースです。
yii\base\ArrayableTraitArrayableTraitはyii\base\Arrayableインターフェースの共通実装を提供します。
yii\base\BaseObjectBaseObjectはプロパティ機能を実装する基本クラスです
yii\base\BehaviorBehaviorはすべてのビヘイビアクラスの基本クラスです
yii\base\BootstrapInterfaceBootstrapInterfaceはアプリケーションのブートストラッププロセスに参加したいクラスが実装すべきインターフェースです。
yii\base\ComponentComponentはプロパティ、イベント、およびビヘイビアの機能を実装する基本クラスです。
yii\base\ConfigurableConfigurableはプロパティをコンストラクターの最後のパラメーターを介して設定するサポートを提供するクラスが実装すべきインターフェースです。
yii\base\ControllerControllerはコントローラーロジックを含むクラスの基本クラスです。
yii\base\DynamicContentAwareInterfaceDynamicContentAwareInterfaceはyii\base\Viewの動的コンテンツ機能をサポートするクラスが実装すべきインターフェースです。
yii\base\DynamicContentAwareTraitDynamicContentAwareTraitはyii\base\Viewの動的コンテンツ機能をサポートするクラスの共通メソッドを実装します。
yii\base\DynamicModelDynamicModelは実行時に属性を定義できるモデルクラスで、そのコンストラクターまたはdefineAttribute()を使用して「動的属性」と呼ばれる属性をサポートします。DynamicModelはアドホックなデータ検証をサポートするために使用できます。
yii\base\ErrorExceptionErrorExceptionはPHPエラーを表します。
yii\base\ErrorHandlerErrorHandlerはキャッチされていないPHPエラーや例外を処理します。
yii\base\EventEventはすべてのイベントクラスの基本クラスです。
yii\base\ExceptionExceptionはすべての目的のための一般的な例外を表します。
yii\base\ExitExceptionExitExceptionはアプリケーションの通常の終了を表します。
yii\base\InlineActionInlineActionはコントローラーメソッドとして定義されたアクションを表します。
yii\base\InvalidArgumentExceptionInvalidArgumentExceptionはメソッドに渡された無効な引数によって引き起こされる例外を表します。
yii\base\InvalidCallExceptionInvalidCallExceptionは誤った方法でメソッドを呼び出すことによって引き起こされる例外を表します
yii\base\InvalidConfigExceptionInvalidConfigExceptionは正しくないオブジェクトの設定によって引き起こされる例外を表します。
yii\base\InvalidParamExceptionInvalidParamExceptionはメソッドに渡された無効なパラメーターによって引き起こされる例外を表します。
yii\base\InvalidRouteExceptionInvalidRouteExceptionは無効なルートによって引き起こされる例外を表します。
yii\base\InvalidValueExceptionInvalidValueExceptionは予期しない型の値を返す関数によって引き起こされる例外を表します。
yii\base\ModelModelはデータモデルの基本クラスです。
yii\base\ModelEventModelEventはyii\base\Modelイベントに必要なパラメーターを表します。
yii\base\ModuleModuleはモジュールおよびアプリケーションクラスの基本クラスです。
yii\base\NotSupportedExceptionNotSupportedExceptionはサポートされていない機能にアクセスすることによって引き起こされる例外を表します。
yii\base\ObjectObjectはプロパティ機能を実装する基本クラスです。
yii\base\RequestRequestはyii\base\Applicationで処理されるリクエストを表します。
yii\base\ResponseResponseはyii\base\Applicationのyii\base\Requestに対する応答を表します。
yii\base\SecuritySecurityは一般的なセキュリティ関連のタスクを処理するためのメソッドセットを提供します。
yii\base\StaticInstanceInterfaceStaticInstanceInterfaceはクラスに静的なインスタンスを提供するためのインターフェースであり、静的なメソッドでは表現できないクラスのメタ情報を取得するために使用できます。
yii\base\StaticInstanceTraitStaticInstanceTraitはyii\base\StaticInstanceInterfaceインターフェースを満たすためのメソッドを提供します
yii\base\ThemeThemeはアプリケーションのテーマを表します。
yii\base\UnknownClassExceptionUnknownClassExceptionは未知のクラスを使用することによって引き起こされる例外を表します。
yii\base\UnknownMethodExceptionUnknownMethodExceptionは未知のオブジェクトメソッドにアクセスすることによって引き起こされる例外を表します。
yii\base\UnknownPropertyExceptionUnknownPropertyExceptionは未知のオブジェクトプロパティにアクセスすることによって引き起こされる例外を表します。
yii\base\UserExceptionUserExceptionはエンドユーザーに表示するための例外の基本クラスです。
yii\base\ViewViewはMVCパターンでのビューオブジェクトを表します。
yii\base\ViewContextInterfaceViewContextInterfaceは相対的なビュー名をサポートするために実装されるべきインターフェースです。
yii\base\ViewEventViewEventはyii\base\Viewコンポーネントによってトリガーされるイベントを表します。
yii\base\ViewNotFoundExceptionViewNotFoundExceptionはビューファイルが見つからないことによって引き起こされる例外を表します。
yii\base\ViewRendererViewRendererはビューレンダラクラスの基本クラスです。
yii\base\WidgetWidgetはウィジェットの基本クラスです。
yii\base\WidgetEventWidgetEventはウィジェットイベントのために使用されるイベントパラメータを表します。
yii\behaviors\AttributeBehaviorAttributeBehaviorは、特定のイベントが発生したときに、ActiveRecordオブジェクトの1つまたは複数の属性に指定された値を自動的に割り当てます。
yii\behaviors\AttributeTypecastBehaviorAttributeTypecastBehaviorは、モデル属性の自動型変換機能を提供します。
yii\behaviors\AttributesBehaviorAttributesBehaviorは、特定のイベントが発生したときに、ActiveRecordオブジェクトの1つまたは複数の属性に指定された値を自動的に割り当てます。
yii\behaviors\BlameableBehaviorBlameableBehaviorは指定された属性を現在のユーザーIDで自動的に埋めます。
yii\behaviors\CacheableWidgetBehaviorCacheableウィジェットビヘイビアは、指定された期間と依存関係に従ってウィジェットのコンテンツを自動的にキャッシュします。
yii\behaviors\OptimisticLockBehaviorOptimisticLockBehaviorは、optimisticLock()によって返された列名を使用してモデルのロックバージョンを自動的にアップグレードします。
yii\behaviors\SluggableBehaviorSluggableBehaviorは、URL内のスラッグとして使用できる値で指定された属性を自動的に埋めます。
yii\behaviors\TimestampBehaviorTimestampBehaviorは指定された属性を現在のタイムスタンプで自動的に埋めます。
yii\caching\ApcCacheApcCacheはアプリケーションコンポーネントとしてAPCキャッシュを提供します。
yii\caching\ArrayCacheArrayCacheは値を配列に格納することで、現在のリクエストに対するキャッシュを提供します。
yii\caching\CacheCacheは異なるキャッシュストレージ実装をサポートするキャッシュクラスの基本クラスです。
yii\caching\CacheInterfaceCacheInterfaceはキャッシュの基本インターフェースです。
yii\caching\ChainedDependencyChainedDependencyは他の依存関係のリストで構成される依存関係を表します。
yii\caching\DbCacheDbCacheはデータベースにキャッシュデータを保存することでキャッシュアプリケーションコンポーネントを実装します
yii\caching\DbDependencyDbDependencyはSQLステートメントのクエリ結果に基づく依存関係を表します。
yii\caching\DbQueryDependencyDbQueryDependencyはyii\db\QueryInterfaceインスタンスのクエリ結果に基づく依存関係を表します。
yii\caching\DependencyDependencyはキャッシュ依存関係クラスの基本クラスです。
yii\caching\DummyCacheDummyCacheはプレースホルダーキャッシュコンポーネントです。
yii\caching\ExpressionDependencyExpressionDependencyはPHP式の結果に基づく依存関係を表します。
yii\caching\FileCacheFileCacheはファイルを使用してキャッシュコンポーネントを実装します。
yii\caching\FileDependencyFileDependencyはファイルの最終更新日時に基づく依存関係を表します。
yii\caching\MemCacheMemCacheはmemcacheとmemcachedに基づいたキャッシュアプリケーションコンポーネント
yii\console\controllers\ServeControllerPHPの組み込みウェブサーバーを実行します。
yii\console\widgets\TableTableクラスはコンソールでテーブルを表示します。
yii\data\ActiveDataFilterActiveDataFilterはyii\db\QueryInterface::where()向けのフィルタリング条件を構成することを可能にします。
yii\data\ActiveDataProviderActiveDataProviderはyii\db\Queryおよびyii\db\ActiveQueryに基づくデータプロバイダを実装します。
yii\data\ArrayDataProviderArrayDataProviderはデータ配列に基づくデータプロバイダを実装します。
yii\data\BaseDataProviderBaseDataProviderはyii\data\DataProviderInterfaceを実装する基本クラスを提供します。
yii\data\DataFilterDataFilterはクエリのフィルタリング仕様を処理するための特別なyii\base\Modelです。
yii\data\DataProviderInterfaceDataProviderInterfaceはデータプロバイダクラスによって実装されるインターフェースです。
yii\data\PaginationPaginationはデータアイテムのページネーションに関連する情報を表します。
yii\data\SortSortはソートに関連する情報を表します。
yii\data\SqlDataProviderSqlDataProviderはプレーンなSQLステートメントに基づくデータプロバイダを実装します。
yii\db\ActiveQueryActiveQueryはActive Recordクラスに関連付けられたDBクエリを表します。
yii\db\ActiveQueryInterfaceActiveQueryInterfaceはアクティブレコードクエリクラスによって実装される共通インターフェースを定義します。
yii\db\ActiveQueryTraitActiveQueryTraitはアクティブレコードクエリクラスの共通メソッドとプロパティを実装します。
yii\db\ActiveRecordActiveRecordはオブジェクト形式で関係データを表すクラスの基本クラスです。
yii\db\ActiveRecordInterfaceActiveRecordInterface。
yii\db\ActiveRelationTraitActiveRelationTraitはアクティブレコード関連クエリの共通メソッドとプロパティを実装します。
yii\db\AfterSaveEventAfterSaveEventはyii\db\ActiveRecord::EVENT_AFTER_INSERTおよびyii\db\ActiveRecord::EVENT_AFTER_UPDATEで利用可能な情報を表します。
yii\db\ArrayExpressionArrayExpressionクラスは配列SQL式を表します。
yii\db\BaseActiveRecordActiveRecordはオブジェクト形式で関係データを表すクラスの基本クラスです。
yii\db\BatchQueryResultBatchQueryResultはデータをバッチで取得できるバッチクエリを表します。
yii\db\CheckConstraintCheckConstraintはテーブルのCHECK制約のメタデータを表します。
yii\db\ColumnSchemaColumnSchemaクラスはデータベーステーブルの列のメタデータを説明します。
yii\db\ColumnSchemaBuilderColumnSchemaBuilderはPHPインターフェースを使用してデータベーススキーマタイプを定義するのに役立ちます。
yii\db\CommandCommandはデータベースに対して実行するSQLステートメントを表します。
yii\db\Connection ConnectionConnectionはPDOを介してデータベースへの接続を表します。
yii\db\ConstraintConstraintはテーブル制約のメタデータを表します。
yii\db\ConstraintFinderInterfaceConstraintFinderInterfaceはテーブル制約情報を取得するためのメソッドを定義します。
yii\db\ConstraintFinderTraitConstraintFinderTraitはテーブル制約情報を取得するためのメソッドを提供します。
yii\db\DataReaderDataReaderはクエリ結果セットから行の前方向ストリームを表します。
yii\db\DefaultValueConstraintDefaultValueConstraintはテーブルDEFAULT制約のメタデータを表します。
yii\db\ExceptionExceptionはDB関連の操作によって引き起こされる例外を表します。
yii\db\ExpressionExpressionはエスケープやクォーティングが不要なDB式を表します。
yii\db\ExpressionBuilderExpressionBuilderクラスはyii\db\Expressionクラスのオブジェクトを構築します。
yii\db\ExpressionBuilderInterfaceInterface ExpressionBuilderInterfaceはyii\db\ExpressionInterfaceを実装する特定の式オブジェクトから生のSQLを構築するために設計されています。
yii\db\ExpressionBuilderTraitTrait ExpressionBuilderTraitはyii\db\ExpressionBuilderInterfaceを実装するクラスに共通のコンストラクタを提供します。
yii\db\ExpressionInterfaceInterface ExpressionInterfaceは特別な方法で構築されるべきクラスをマークするために使用されるべきです。
yii\db\ForeignKeyConstraintForeignKeyConstraintはテーブルFOREIGN KEY制約のメタデータを表します。
yii\db\IndexConstraintIndexConstraintはテーブルINDEX制約のメタデータを表します。
yii\db\IntegrityExceptionExceptionはDB制約の違反によって引き起こされる例外を表します。
yii\db\JsonExpressionClass JsonExpressionはJSONにエンコードする必要があるデータを表します。
タイトルとURLをコピーしました