BlogPostsService
in package
implements
BlogPostsServiceInterface
uses
BcContainerTrait
BlogPostsService
Table of Contents
Interfaces
- BlogPostsServiceInterface
- BlogPostsServiceInterface
Properties
- $BlogPosts : BlogPostsTable
- $BlogPosts : BlogPostsTable|Table
- BlogPostsTable
Methods
- __construct() : mixed
- Constructor
- allowPublish() : bool
- 公開状態を取得する
- batch() : bool
- 一括処理
- copy() : false|mixed
- ブログ記事をコピーする
- create() : EntityInterface
- 新規登録
- createCategoryCondition() : array<string|int, mixed>
- カテゴリ条件を生成する
- createKeywordCondition() : array<string|int, mixed>
- キーワード条件を生成する
- createOrder() : string
- 並び替え設定を生成する
- createTagCondition() : QueryInterface
- タグ条件を生成する
- createYearMonthDayCondition() : array<string|int, mixed>
- 年月日条件を生成する
- delete() : bool
- ブログ記事を削除する
- get() : EntityInterface
- 単一データを取得する
- getControlSource() : array<string|int, mixed>|false
- コントロールソースを取得する
- getIndex() : Query
- ブログ記事一覧を取得する
- getIndexByAuthor() : Query
- 著者別記事一覧を取得
- getIndexByCategory() : Query
- カテゴリ別記事一覧を取得
- getIndexByDate() : Query
- 日付別記事一覧を取得
- getIndexByTag() : Query
- タグ別記事一覧を取得
- getNew() : EntityInterface
- 初期データ用のエンティティを取得
- getNextPost() : BlogPost|EntityInterface|null
- 次の記事を取得する
- getPrevPost() : BlogPost|EntityInterface|null
- 前の記事を取得する
- getRelatedPosts() : array<string|int, mixed>|Query
- 関連するブログ記事を取得する
- getService() : array<string|int, mixed>|mixed|object
- Get Service
- getTitlesById() : array<string|int, mixed>
- IDからタイトルリストを取得する
- getUrl() : string
- ブログ記事のURLを取得する
- hasService() : bool
- Has Service
- publish() : EntityInterface|false
- 記事を公開状態に設定する
- selectContains() : Query
- Contains を select を前提として適用する select を利用した場合、関連テーブルのカラムを指定しないと、取得できないため
- setupUpload() : void
- BlogPostsTable のファイルアップロードの設定を実施
- unpublish() : EntityInterface|false
- 記事を非公開状態に設定する
- update() : EntityInterface
- ブログ記事を更新する
- createIndexConditions() : Query
- ページ一覧用の検索条件を生成する
Properties
$BlogPosts
public
BlogPostsTable
$BlogPosts
$BlogPosts
BlogPostsTable
public
BlogPostsTable|Table
$BlogPosts
Methods
__construct()
Constructor
public
__construct() : mixed
BlogPosts テーブルを初期化してセットする
Tags
allowPublish()
公開状態を取得する
public
allowPublish(EntityInterface $post) : bool
Parameters
- $post : EntityInterface
Tags
Return values
bool —公開状態
batch()
一括処理
public
batch(string $method, array<string|int, mixed> $ids) : bool
Parameters
- $method : string
- $ids : array<string|int, mixed>
Tags
Return values
boolcopy()
ブログ記事をコピーする
public
copy(int $id) : false|mixed
Parameters
- $id : int
Tags
Return values
false|mixedcreate()
新規登録
public
create(array<string|int, mixed> $postData) : EntityInterface
Parameters
- $postData : array<string|int, mixed>
Tags
Return values
EntityInterfacecreateCategoryCondition()
カテゴリ条件を生成する
public
createCategoryCondition(array<string|int, mixed> $conditions, string $category[, int $blogContentId = null ][, array<string|int, mixed>|string $contentUrl = null ][, bool $force = false ]) : array<string|int, mixed>
Parameters
- $conditions : array<string|int, mixed>
- $category : string
- $blogContentId : int = null
- $contentUrl : array<string|int, mixed>|string = null
- $force : bool = false
Tags
Return values
array<string|int, mixed>createKeywordCondition()
キーワード条件を生成する
public
createKeywordCondition(array<string|int, mixed> $conditions, string $keyword) : array<string|int, mixed>
Parameters
- $conditions : array<string|int, mixed>
- $keyword : string
Tags
Return values
array<string|int, mixed>createOrder()
並び替え設定を生成する
public
createOrder(string $sort, string $direction) : string
Parameters
- $sort : string
- $direction : string
Tags
Return values
stringcreateTagCondition()
タグ条件を生成する
public
createTagCondition(Query $query, mixed $tag) : QueryInterface
Parameters
- $query : Query
- $tag : mixed
-
タグ(配列可)
Tags
Return values
QueryInterfacecreateYearMonthDayCondition()
年月日条件を生成する
public
createYearMonthDayCondition(array<string|int, mixed> $conditions, int $year, int $month, int $day) : array<string|int, mixed>
Parameters
- $conditions : array<string|int, mixed>
- $year : int
- $month : int
- $day : int
Tags
Return values
array<string|int, mixed>delete()
ブログ記事を削除する
public
delete(int $id) : bool
Parameters
- $id : int
Tags
Return values
boolget()
単一データを取得する
public
get(int $id[, array<string|int, mixed> $options = [] ]) : EntityInterface
Parameters
- $id : int
- $options : array<string|int, mixed> = []
Tags
Return values
EntityInterfacegetControlSource()
コントロールソースを取得する
public
getControlSource(string $field[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>|false
blog_category_id / user_id / blog_tag_id を対象とする
Parameters
- $field : string
- $options : array<string|int, mixed> = []
Tags
Return values
array<string|int, mixed>|falsegetIndex()
ブログ記事一覧を取得する
public
getIndex([array<string|int, mixed> $queryParams = [] ]) : Query
Parameters
- $queryParams : array<string|int, mixed> = []
Tags
Return values
QuerygetIndexByAuthor()
著者別記事一覧を取得
public
getIndexByAuthor(int $userId[, array<string|int, mixed> $options = [] ]) : Query
Parameters
- $userId : int
- $options : array<string|int, mixed> = []
Tags
Return values
QuerygetIndexByCategory()
カテゴリ別記事一覧を取得
public
getIndexByCategory(string $category[, array<string|int, mixed> $options = [] ]) : Query
Parameters
- $category : string
- $options : array<string|int, mixed> = []
Tags
Return values
QuerygetIndexByDate()
日付別記事一覧を取得
public
getIndexByDate(string $year, string $month, string $day[, array<string|int, mixed> $options = [] ]) : Query
Parameters
- $year : string
- $month : string
- $day : string
- $options : array<string|int, mixed> = []
Tags
Return values
QuerygetIndexByTag()
タグ別記事一覧を取得
public
getIndexByTag(string $tag[, array<string|int, mixed> $options = [] ]) : Query
Parameters
- $tag : string
- $options : array<string|int, mixed> = []
Tags
Return values
QuerygetNew()
初期データ用のエンティティを取得
public
getNew(int $blogContentId, int $userId) : EntityInterface
Parameters
- $blogContentId : int
- $userId : int
Tags
Return values
EntityInterfacegetNextPost()
次の記事を取得する
public
getNextPost(BlogPost $post) : BlogPost|EntityInterface|null
Parameters
- $post : BlogPost
-
ブログ記事
Tags
Return values
BlogPost|EntityInterface|nullgetPrevPost()
前の記事を取得する
public
getPrevPost(BlogPost $post) : BlogPost|EntityInterface|null
Parameters
- $post : BlogPost
-
ブログ記事
Tags
Return values
BlogPost|EntityInterface|nullgetRelatedPosts()
関連するブログ記事を取得する
public
getRelatedPosts(BlogPost $post[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>|Query
Parameters
- $post : BlogPost
- $options : array<string|int, mixed> = []
Tags
Return values
array<string|int, mixed>|QuerygetService()
Get Service
public
getService(mixed $service) : array<string|int, mixed>|mixed|object
Parameters
- $service : mixed
Tags
Return values
array<string|int, mixed>|mixed|objectgetTitlesById()
IDからタイトルリストを取得する
public
getTitlesById(array<string|int, mixed> $ids) : array<string|int, mixed>
Parameters
- $ids : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>getUrl()
ブログ記事のURLを取得する
public
getUrl(Content $content, BlogPost $post, mixed $full) : string
Parameters
Tags
Return values
stringhasService()
Has Service
public
hasService(mixed $service) : bool
Parameters
- $service : mixed
Tags
Return values
boolpublish()
記事を公開状態に設定する
public
publish(int $id) : EntityInterface|false
公開期間指定は初期化する
Parameters
- $id : int
Tags
Return values
EntityInterface|falseselectContains()
Contains を select を前提として適用する select を利用した場合、関連テーブルのカラムを指定しないと、取得できないため
public
selectContains(Query $query[, array<string|int, mixed> $contains = [] ]) : Query
Parameters
- $query : Query
- $contains : array<string|int, mixed> = []
Tags
Return values
QuerysetupUpload()
BlogPostsTable のファイルアップロードの設定を実施
public
setupUpload(int $blogContentId) : void
Parameters
- $blogContentId : int
Tags
unpublish()
記事を非公開状態に設定する
public
unpublish(int $id) : EntityInterface|false
公開期間指定は初期化する
Parameters
- $id : int
Tags
Return values
EntityInterface|falseupdate()
ブログ記事を更新する
public
update(EntityInterface|BlogPost $post, array<string|int, mixed> $postData) : EntityInterface
POSTデータのサイズが設定ファイルで定義されたpost_max_sizeを超えた場合は例外処理される
Parameters
- $post : EntityInterface|BlogPost
- $postData : array<string|int, mixed>
Tags
Return values
EntityInterfacecreateIndexConditions()
ページ一覧用の検索条件を生成する
protected
createIndexConditions(Query $query, array<string|int, mixed> $params) : Query
Parameters
- $query : Query
- $params : array<string|int, mixed>
-
- title: タイトル
- user_id: 作成者
- status: 公開状態。publish もしくは 1 の場合、公開期間も加味する。
- blog_content_id: ブログコンテンツID
- blog_tag_id: ブログタグID
- blog_category_id: ブログカテゴリID